Merge pull request #620 from CPS-IT/feature/optional-commands

Author: mteu

docs/development/configuration.md

@@ -212,6 +212,11 @@ steps:
       command: 'git init --initial-branch=main'
       skipConfirmation: true
       allowFailure: true
+  - type: runCommand
+    options:
+      command: 'composer update'
+      allowFailure: true
+      required: false
   - type: showNextSteps
     options:
       templateFile: templates/next-steps.html.twig

resources/config.schema.json

@@ -315,6 +315,12 @@
 									"title": "Allow command execution failure",
 									"description": "Ignore errors occurred during command execution and continue as normal",
 									"default": false
+								},
+								"required": {
+									"type": "boolean",
+									"title": "Enforce command execution",
+									"description": "If set to true, the command must be executed and cannot be skipped, otherwise project generation fails",
+									"default": true
 								}
 							},
 							"required": [

src/Builder/Config/ValueObject/StepOptions.php

@@ -41,6 +41,7 @@ public function __construct(
         private readonly ?string $command = null,
         private readonly bool $skipConfirmation = false,
         private readonly bool $allowFailure = false,
+        private readonly bool $required = true,
     ) {}
 
     /**
@@ -75,4 +76,9 @@ public function shouldAllowFailure(): bool
     {
         return $this->allowFailure;
     }
+
+    public function isRequired(): bool
+    {
+        return $this->required;
+    }
 }

src/Builder/Generator/Step/RunCommandStep.php

@@ -57,7 +57,7 @@ public function run(BuildResult $buildResult): bool
         if (!$this->config->getOptions()->shouldSkipConfirmation() && !$this->messenger->confirmRunCommand($command)) {
             $this->stopped = true;
 
-            return false;
+            return !$this->config->getOptions()->isRequired();
         }
 
         $this->messenger->newLine(ComposerIO\IOInterface::VERBOSE);

tests/src/Builder/Generator/Step/RunCommandStepTest.php

@@ -25,6 +25,8 @@
 
 use CPSIT\ProjectBuilder as Src;
 use CPSIT\ProjectBuilder\Tests;
+use Generator;
+use LogicException;
 use PHPUnit\Framework;
 use Symfony\Component\Filesystem;
 
@@ -38,6 +40,7 @@ final class RunCommandStepTest extends Tests\ContainerAwareTestCase
 {
     private Src\Builder\Generator\Step\RunCommandStep $subject;
     private Src\Builder\BuildResult $result;
+    private Filesystem\Filesystem $filesystem;
 
     protected function setUp(): void
     {
@@ -50,6 +53,11 @@ protected function setUp(): void
                 'foo',
             ),
         );
+        $this->filesystem = new Filesystem\Filesystem();
+
+        if (!$this->filesystem->exists($this->result->getWrittenDirectory())) {
+            $this->filesystem->mkdir($this->result->getWrittenDirectory());
+        }
     }
 
     #[Framework\Attributes\Test]
@@ -64,7 +72,7 @@ public function runThrowsExceptionIfNoCommandIsGiven(): void
     #[Framework\Attributes\Test]
     public function runThrowsExceptionIfRevertingIsAttempted(): never
     {
-        $this->expectException('\LogicException');
+        $this->expectException(LogicException::class);
         $this->expectExceptionCode(1687518806);
         $this->expectExceptionMessage('An already run command cannot be reverted.');
         $this->subject->revert($this->result);
@@ -79,7 +87,7 @@ public function runCommandIsSupported(): void
     }
 
     #[Framework\Attributes\Test]
-    public function runExecutesCommandWithoutConfirmationIfSKipConfirmationIsConfigured(): void
+    public function runExecutesCommandWithoutConfirmationIfSkipConfirmationIsConfigured(): void
     {
         $this->subject->setConfig(
             new Src\Builder\Config\ValueObject\Step(
@@ -91,18 +99,30 @@ public function runExecutesCommandWithoutConfirmationIfSKipConfirmationIsConfigu
             ),
         );
 
-        $workingDirectory = $this->result->getWrittenDirectory();
-
-        $fileSystem = new Filesystem\Filesystem();
-        if (!$fileSystem->exists($workingDirectory)) {
-            $fileSystem->mkdir($workingDirectory);
-        }
-
         self::assertTrue($this->subject->run($this->result));
         self::assertFalse($this->subject->isStopped());
         self::assertStringNotContainsString('Do you wish to run this command?', $this->io->getOutput());
     }
 
+    #[Framework\Attributes\Test]
+    #[Framework\Attributes\DataProvider('runDoesNotExecuteCommandAndRespectsExecutionRequirementDataProvider')]
+    public function runDoesNotExecuteCommandAndRespectsExecutionRequirement(bool $required, bool $expected): void
+    {
+        $this->subject->setConfig(
+            new Src\Builder\Config\ValueObject\Step(
+                Src\Builder\Generator\Step\RunCommandStep::getType(),
+                new Src\Builder\Config\ValueObject\StepOptions(
+                    command: 'echo \'foo\'',
+                    required: $required,
+                ),
+            ),
+        );
+
+        $this->io->setUserInputs(['no']);
+        self::assertSame($expected, $this->subject->run($this->result));
+        self::assertTrue($this->subject->isStopped());
+    }
+
     #[Framework\Attributes\Test]
     public function runExecutesCommandAndAllowsExecutionFailures(): void
     {
@@ -116,13 +136,6 @@ public function runExecutesCommandAndAllowsExecutionFailures(): void
             ),
         );
 
-        $workingDirectory = $this->result->getWrittenDirectory();
-
-        $fileSystem = new Filesystem\Filesystem();
-        if (!$fileSystem->exists($workingDirectory)) {
-            $fileSystem->mkdir($workingDirectory);
-        }
-
         self::assertTrue($this->subject->run($this->result));
         self::assertFalse($this->subject->isStopped());
         self::assertStringContainsString('not found', $this->io->getOutput());
@@ -157,19 +170,23 @@ public function invalidCommandPrintProcessErrorMessage(): void
             ),
         );
 
-        $workingDirectory = $this->result->getWrittenDirectory();
-
-        $fileSystem = new Filesystem\Filesystem();
-        if (!$fileSystem->exists($workingDirectory)) {
-            $fileSystem->mkdir($workingDirectory);
-        }
-
         $this->io->setUserInputs(['yes']);
-        $actual = $this->subject->run($this->result);
-        $this->io->getOutput();
+        self::assertFalse($this->subject->run($this->result));
+    }
 
-        self::assertFalse($actual);
+    /**
+     * @return Generator<string, array{bool, bool}>
+     */
+    public static function runDoesNotExecuteCommandAndRespectsExecutionRequirementDataProvider(): Generator
+    {
+        yield 'required' => [true, false];
+        yield 'optional' => [false, true];
+    }
 
-        $fileSystem->remove($workingDirectory);
+    protected function tearDown(): void
+    {
+        if ($this->filesystem->exists($this->result->getWrittenDirectory())) {
+            $this->filesystem->remove($this->result->getWrittenDirectory());
+        }
     }
 }