Skip to content

[ComposerScriptsConfigurator] Auto-wire @auto-scripts into post-install-cmd and post-update-cmd #1089

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.

Sign up for GitHub

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

Draft
wachterjohannes wants to merge 1 commit into
base: 2.x
Choose a base branch
from
+178 −0
Draft

[ComposerScriptsConfigurator] Auto-wire @auto-scripts into post-install-cmd and post-update-cmd #1089

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions src/Configurator/ComposerScriptsConfigurator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,31 @@ private function configureScripts(array $scripts, JsonFile $json): string
$manipulator = new JsonManipulator(file_get_contents($json->getPath()));
$manipulator->addSubNode('scripts', 'auto-scripts', $autoScripts);

foreach (['post-install-cmd', 'post-update-cmd'] as $hook) {
$current = $jsonContents['scripts'][$hook] ?? null;
$wired = $this->ensureAutoScriptsHook($current);
if ($wired !== $current) {
$manipulator->addSubNode('scripts', $hook, $wired);
}
}

return $manipulator->getContents();
}

private function ensureAutoScriptsHook($current): array
{
if (null === $current) {
return ['@auto-scripts'];
}

if (!\is_array($current)) {
$current = [$current];
}

if (!\in_array('@auto-scripts', $current, true)) {
$current[] = '@auto-scripts';
}

return $current;
}
}
153 changes: 153 additions & 0 deletions tests/Configurator/ComposerScriptsConfiguratorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,159 @@ public function testConfigure()
);
}

public function testConfigureAddsHooksWhenMissing()
{
file_put_contents(FLEX_TEST_DIR.'/composer.json', json_encode([
'scripts' => [
'auto-scripts' => [
'cache:clear' => 'symfony-cmd',
],
],
], \JSON_PRETTY_PRINT));

$configurator = new ComposerScriptsConfigurator(
$this->createMock(Composer::class),
$this->createMock(IOInterface::class),
new Options(['root-dir' => FLEX_TEST_DIR])
);

$recipe = $this->getMockBuilder(Recipe::class)->disableOriginalConstructor()->getMock();
$lock = $this->getMockBuilder(Lock::class)->disableOriginalConstructor()->getMock();

$configurator->configure($recipe, [
'do:cool-stuff' => 'symfony-cmd',
], $lock);
$this->assertEquals(<<<EOF
{
"scripts": {
"auto-scripts": {
"cache:clear": "symfony-cmd",
"do:cool-stuff": "symfony-cmd"
},
"post-install-cmd": ["@auto-scripts"],
"post-update-cmd": ["@auto-scripts"]
}
}

EOF,
file_get_contents(FLEX_TEST_DIR.'/composer.json')
);
}

public function testConfigureAppendsToExistingHookArray()
{
file_put_contents(FLEX_TEST_DIR.'/composer.json', json_encode([
'scripts' => [
'auto-scripts' => [
'cache:clear' => 'symfony-cmd',
],
'post-install-cmd' => ['@some-other'],
'post-update-cmd' => ['@some-other'],
],
], \JSON_PRETTY_PRINT));

$configurator = new ComposerScriptsConfigurator(
$this->createMock(Composer::class),
$this->createMock(IOInterface::class),
new Options(['root-dir' => FLEX_TEST_DIR])
);

$recipe = $this->getMockBuilder(Recipe::class)->disableOriginalConstructor()->getMock();
$lock = $this->getMockBuilder(Lock::class)->disableOriginalConstructor()->getMock();

$configurator->configure($recipe, [
'do:cool-stuff' => 'symfony-cmd',
], $lock);
$this->assertEquals(<<<EOF
{
"scripts": {
"auto-scripts": {
"cache:clear": "symfony-cmd",
"do:cool-stuff": "symfony-cmd"
},
"post-install-cmd": ["@some-other", "@auto-scripts"],
"post-update-cmd": ["@some-other", "@auto-scripts"]
}
}

EOF,
file_get_contents(FLEX_TEST_DIR.'/composer.json')
);
}

public function testConfigureConvertsScalarHookToArray()
{
file_put_contents(FLEX_TEST_DIR.'/composer.json', json_encode([
'scripts' => [
'auto-scripts' => [
'cache:clear' => 'symfony-cmd',
],
'post-install-cmd' => '@some-other',
'post-update-cmd' => '@some-other',
],
], \JSON_PRETTY_PRINT));

$configurator = new ComposerScriptsConfigurator(
$this->createMock(Composer::class),
$this->createMock(IOInterface::class),
new Options(['root-dir' => FLEX_TEST_DIR])
);

$recipe = $this->getMockBuilder(Recipe::class)->disableOriginalConstructor()->getMock();
$lock = $this->getMockBuilder(Lock::class)->disableOriginalConstructor()->getMock();

$configurator->configure($recipe, [
'do:cool-stuff' => 'symfony-cmd',
], $lock);
$this->assertEquals(<<<EOF
{
"scripts": {
"auto-scripts": {
"cache:clear": "symfony-cmd",
"do:cool-stuff": "symfony-cmd"
},
"post-install-cmd": ["@some-other", "@auto-scripts"],
"post-update-cmd": ["@some-other", "@auto-scripts"]
}
}

EOF,
file_get_contents(FLEX_TEST_DIR.'/composer.json')
);
}

public function testConfigureIsIdempotentWhenAutoScriptsAlreadyWired()
{
file_put_contents(FLEX_TEST_DIR.'/composer.json', json_encode([
'scripts' => [
'auto-scripts' => [
'do:cool-stuff' => 'symfony-cmd',
],
'post-install-cmd' => ['@auto-scripts'],
'post-update-cmd' => ['@auto-scripts'],
],
], \JSON_PRETTY_PRINT));

$configurator = new ComposerScriptsConfigurator(
$this->createMock(Composer::class),
$this->createMock(IOInterface::class),
new Options(['root-dir' => FLEX_TEST_DIR])
);

$recipe = $this->getMockBuilder(Recipe::class)->disableOriginalConstructor()->getMock();
$lock = $this->getMockBuilder(Lock::class)->disableOriginalConstructor()->getMock();

$configurator->configure($recipe, [
'do:cool-stuff' => 'symfony-cmd',
], $lock);
$afterFirst = file_get_contents(FLEX_TEST_DIR.'/composer.json');

$configurator->configure($recipe, [
'do:cool-stuff' => 'symfony-cmd',
], $lock);
$this->assertSame($afterFirst, file_get_contents(FLEX_TEST_DIR.'/composer.json'));
}

public function testUnconfigure()
{
file_put_contents(FLEX_TEST_DIR.'/composer.json', json_encode([
Expand Down
Loading