summaryrefslogtreecommitdiffstats
path: root/tests
diff options
context:
space:
mode:
authorVitor Mattos <vitor@php.rio>2023-03-02 13:04:43 -0300
committerVitor Mattos <vitor@php.rio>2023-03-02 22:00:33 -0300
commit8ca055cc683400635e8825c1e334d19480279905 (patch)
treed163d9350a2dc77e549ca1a1c9f514b62e012524 /tests
parent2e15b55e3e8d29374fd96936b5bb593a5ef1304d (diff)
* Convert arguments and options to table format
* Add the markdown occ to mkdocs * Add GitHub Action to check if the documentation is up to date Signed-off-by: Vitor Mattos <vitor@php.rio>
Diffstat (limited to 'tests')
-rw-r--r--tests/php/Command/DocumentationTest.php56
1 files changed, 0 insertions, 56 deletions
diff --git a/tests/php/Command/DocumentationTest.php b/tests/php/Command/DocumentationTest.php
deleted file mode 100644
index 669cfb86b..000000000
--- a/tests/php/Command/DocumentationTest.php
+++ /dev/null
@@ -1,56 +0,0 @@
-<?php
-/**
- * @copyright Copyright (c) 2023 Vitor Mattos <vitor@php.rio>
- *
- * @author Vitor Mattos <vitor@php.rio>
- *
- * @license GNU AGPL version 3 or any later version
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as
- * published by the Free Software Foundation, either version 3 of the
- * License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- */
-
-namespace OCA\Talk\Tests\php\Command;
-
-use OCP\App\IAppManager;
-use Test\TestCase;
-
-final class DocumentationTest extends TestCase {
- public function testCommandIsDocumented(): void {
- /** @var IAppManager */
- $appManager = \OC::$server->get(IAppManager::class);
- $info = $appManager->getAppInfo('spreed');
- foreach ($info['commands'] as $commandNamespace) {
- $path = str_replace('OCA\Talk', '', $commandNamespace);
- $path = str_replace('\\', '/', $path);
- $path = __DIR__ . '/../../../lib' . $path . '.php';
- $this->assertFileExists($path, 'The class of the follow namespase is not implemented: ' . $commandNamespace);
- $code = file_get_contents($path);
- preg_match("/->setName\('(?<command>[\w:\-_]+)'\)/", $code, $matches);
- if (!array_key_exists('command', $matches)) {
- preg_match("/\tname: '(?<command>[\w:\-_]+)',?\n/", $code, $matches);
- }
- $this->assertArrayHasKey('command', $matches, 'A command need to have a name.');
- $this->commandIsDocummented($matches['command']);
- }
- }
-
- public function commandIsDocummented(string $command): void {
- $docs = file_get_contents(__DIR__ . '/../../../docs/occ.md');
- self::assertStringContainsString(
- $command,
- $docs,
- 'The command ' . $command . " haven't documentation. Run the command talk:developer:update-docs."
- );
- }
-}