Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restore the ability to list the scripts in the 'run-script' command without providing a script #10710

Merged
merged 1 commit into from Apr 7, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions phpstan/baseline.neon
Expand Up @@ -6053,6 +6053,11 @@ parameters:
count: 1
path: ../tests/Composer/Test/CacheTest.php

-
message: "#^Dynamic call to static method Composer\\\\Test\\\\TestCase\\:\\:getUniqueTmpDirectory\\(\\)\\.$#"
count: 1
path: ../tests/Composer/Test/Command/RunScriptCommandTest.php

-
message: "#^Dynamic call to static method Composer\\\\Test\\\\TestCase\\:\\:getUniqueTmpDirectory\\(\\)\\.$#"
count: 1
Expand Down
6 changes: 5 additions & 1 deletion src/Composer/Command/RunScriptCommand.php
Expand Up @@ -54,7 +54,7 @@ protected function configure(): void
->setAliases(array('run'))
->setDescription('Runs the scripts defined in composer.json.')
->setDefinition(array(
new InputArgument('script', InputArgument::REQUIRED, 'Script name to run.'),
new InputArgument('script', InputArgument::OPTIONAL, 'Script name to run.'),
new InputArgument('args', InputArgument::IS_ARRAY | InputArgument::OPTIONAL, ''),
new InputOption('timeout', null, InputOption::VALUE_REQUIRED, 'Sets script timeout in seconds, or 0 for never.'),
new InputOption('dev', null, InputOption::VALUE_NONE, 'Sets the dev mode.'),
Expand All @@ -80,6 +80,10 @@ protected function execute(InputInterface $input, OutputInterface $output): int
}

$script = $input->getArgument('script');
if ($script === null) {
throw new \RuntimeException('Missing required argument "script"');
}

if (!in_array($script, $this->scriptEvents)) {
if (defined('Composer\Script\ScriptEvents::'.str_replace('-', '_', strtoupper($script)))) {
throw new \InvalidArgumentException(sprintf('Script "%s" cannot be run with this command', $script));
Expand Down
51 changes: 51 additions & 0 deletions tests/Composer/Test/Command/RunScriptCommandTest.php
Expand Up @@ -12,13 +12,35 @@

namespace Composer\Test\Command;

use Composer\Command\RunScriptCommand;
use Composer\Composer;
use Composer\Config;
use Composer\Console\Application;
use Composer\Script\Event as ScriptEvent;
use Composer\Test\TestCase;
use Composer\Util\Filesystem;
use Symfony\Component\Console\Tester\ApplicationTester;

class RunScriptCommandTest extends TestCase
{
/**
* @var string
*/
private $home;

public function setUp(): void
{
$this->home = $this->getUniqueTmpDirectory();
}

protected function tearDown(): void
{
parent::tearDown();

$fs = new Filesystem();
$fs->removeDirectory($this->home);
}

/**
* @dataProvider getDevOptions
* @param bool $dev
Expand Down Expand Up @@ -88,6 +110,35 @@ public function testDetectAndPassDevModeToEventAndToDispatching(bool $dev, bool
$command->run($input, $output);
}

public function testCanListScripts(): void
{
$manifest = [
'scripts' => [
'test' => '@php test',
'fix-cs' => 'php-cs-fixer fix',
],
'scripts-descriptions' => [
'fix-cs' => 'Run the codestyle fixer',
],
];

file_put_contents($this->home.'/composer.json', json_encode($manifest));

$application = new Application();
$application->setAutoExit(false);
$application->add(new RunScriptCommand());

$tester = new ApplicationTester($application);
$tester->run(['command' => 'run-script', '--list' => true, '-d' => $this->home]);

$tester->assertCommandIsSuccessful();

$output = $tester->getDisplay();

$this->assertStringContainsString('Runs the test script as defined in composer.json.', $output, 'The default description for the test script should be printed');
$this->assertStringContainsString('Run the codestyle fixer', $output, 'The custom description for the fix-cs script should be printed');
}
mbabker marked this conversation as resolved.
Show resolved Hide resolved

/** @return bool[][] **/
public function getDevOptions(): array
{
Expand Down