1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
<?php declare(strict_types=1);
/*
* This file is part of Composer.
*
* (c) Nils Adermann <naderman@naderman.de>
* Jordi Boggiano <j.boggiano@seld.be>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Composer\Test;
use Composer\Console\Application;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Descriptor\ApplicationDescription;
use PHPUnit\Framework\Attributes\DataProvider;
class DocumentationTest extends TestCase
{
#[DataProvider('provideCommandCases')]
public function testCommand(Command $command): void
{
static $docContent = null;
if ($docContent === null) {
$docContent = file_get_contents(__DIR__ . '/../../../doc/03-cli.md');
}
self::assertStringContainsString(
sprintf(
"\n## %s\n\n",
$this->getCommandName($command)
// TODO: test description
// TODO: test options
),
$docContent
);
}
private function getCommandName(Command $command): string
{
$name = (string) $command->getName();
foreach ($command->getAliases() as $alias) {
$name .= ' / ' . $alias;
}
return $name;
}
public static function provideCommandCases(): \Generator
{
$application = new Application();
$application->setAutoExit(false);
if (method_exists($application, 'setCatchErrors')) {
$application->setCatchErrors(false);
}
$application->setCatchExceptions(false);
$description = new ApplicationDescription($application);
foreach ($description->getCommands() as $command) {
if (in_array($command->getName(), ['about', 'completion', 'list'], true)) {
continue;
}
yield [$command];
}
}
}
|
