Add the --dry-run option

php · Dec 3, 2024 · d84dfd2 · d84dfd2
1 parent c6f0f4b
commit d84dfd2
Show file tree

Hide file tree

Showing 21 changed files with 247 additions and 24 deletions.
diff --git a/src/BinaryFile.php b/src/BinaryFile.php
@@ -15,6 +15,8 @@ final class BinaryFile
 {
     private const HASH_TYPE_SHA256 = 'sha256';
 
+    private const DRY_RUN_FAKE_HASH = 'dry_run_fake_hash';
+
     /**
      * @param non-empty-string $filePath
      * @param non-empty-string $checksum
@@ -33,4 +35,13 @@ public static function fromFileWithSha256Checksum(string $filePath): self
             hash_file(self::HASH_TYPE_SHA256, $filePath),
         );
     }
+
+    /** @param non-empty-string $filePath */
+    public static function nonExistentForDryRun(string $filePath): self
+    {
+        return new self(
+            'dry-run::' . $filePath,
+            self::DRY_RUN_FAKE_HASH,
+        );
+    }
 }
diff --git a/src/Building/Build.php b/src/Building/Build.php
@@ -20,5 +20,6 @@ public function __invoke(
         array $configureOptions,
         OutputInterface $output,
         PhpizePath|null $phpizePath,
+        bool $dryRun,
     ): BinaryFile;
 }
diff --git a/src/Building/UnixBuild.php b/src/Building/UnixBuild.php
@@ -31,6 +31,7 @@ public function __invoke(
         array $configureOptions,
         OutputInterface $output,
         PhpizePath|null $phpizePath,
+        bool $dryRun,
     ): BinaryFile {
         $outputCallback = null;
         if ($output->isVerbose()) {
@@ -60,6 +61,7 @@ public function __invoke(
             $downloadedPackage,
             $output,
             $outputCallback,
+            $dryRun,
         );
 
         $output->writeln('<info>phpize complete</info>.');
@@ -69,16 +71,28 @@ public function __invoke(
             $configureOptions[] = '--with-php-config=' . $phpConfigPath;
         }
 
-        $this->configure($downloadedPackage, $configureOptions, $output, $outputCallback);
+        $this->configure(
+            $downloadedPackage,
+            $configureOptions,
+            $output,
+            $outputCallback,
+            $dryRun,
+        );
 
         $optionsOutput = count($configureOptions) ? ' with options: ' . implode(' ', $configureOptions) : '.';
         $output->writeln('<info>Configure complete</info>' . $optionsOutput);
 
-        $this->make($targetPlatform, $downloadedPackage, $output, $outputCallback);
+        $this->make(
+            $targetPlatform,
+            $downloadedPackage,
+            $output,
+            $outputCallback,
+            $dryRun,
+        );
 
         $expectedSoFile = $downloadedPackage->extractedSourcePath . '/modules/' . $downloadedPackage->package->extensionName->name() . '.so';
 
-        if (! file_exists($expectedSoFile)) {
+        if (! $dryRun && ! file_exists($expectedSoFile)) {
             throw ExtensionBinaryNotFound::fromExpectedBinary($expectedSoFile);
         }
 
@@ -87,6 +101,10 @@ public function __invoke(
             $expectedSoFile,
         ));
 
+        if ($dryRun) {
+            return BinaryFile::nonExistentForDryRun($expectedSoFile);
+        }
+
         return BinaryFile::fromFileWithSha256Checksum($expectedSoFile);
     }
 
@@ -96,13 +114,18 @@ private function phpize(
         DownloadedPackage $downloadedPackage,
         OutputInterface $output,
         callable|null $outputCallback,
+        bool $dryRun,
     ): void {
         $phpizeCommand = [$phpize->phpizeBinaryPath];
 
         if ($output->isVerbose()) {
             $output->writeln('<comment>Running phpize step using: ' . implode(' ', $phpizeCommand) . '</comment>');
         }
 
+        if ($dryRun) {
+            return;
+        }
+
         Process::run(
             $phpizeCommand,
             $downloadedPackage->extractedSourcePath,
@@ -120,13 +143,18 @@ private function configure(
         array $configureOptions,
         OutputInterface $output,
         callable|null $outputCallback,
+        bool $dryRun,
     ): void {
         $configureCommand = ['./configure', ...$configureOptions];
 
         if ($output->isVerbose()) {
             $output->writeln('<comment>Running configure step with: ' . implode(' ', $configureCommand) . '</comment>');
         }
 
+        if ($dryRun) {
+            return;
+        }
+
         Process::run(
             $configureCommand,
             $downloadedPackage->extractedSourcePath,
@@ -141,6 +169,7 @@ private function make(
         DownloadedPackage $downloadedPackage,
         OutputInterface $output,
         callable|null $outputCallback,
+        bool $dryRun,
     ): void {
         $makeCommand = ['make'];
 
@@ -154,6 +183,10 @@ private function make(
             $output->writeln('<comment>Running make step with: ' . implode(' ', $makeCommand) . '</comment>');
         }
 
+        if ($dryRun) {
+            return;
+        }
+
         Process::run(
             $makeCommand,
             $downloadedPackage->extractedSourcePath,

diff --git a/src/Building/WindowsBuild.php b/src/Building/WindowsBuild.php
@@ -23,6 +23,7 @@ public function __invoke(
         array $configureOptions,
         OutputInterface $output,
         PhpizePath|null $phpizePath,
+        bool $dryRun,
     ): BinaryFile {
         $prebuiltDll = WindowsExtensionAssetName::determineDllName($targetPlatform, $downloadedPackage);
 

diff --git a/src/Command/BuildCommand.php b/src/Command/BuildCommand.php
@@ -37,6 +37,7 @@ public function configure(): void
         parent::configure();
 
         CommandHelper::configureDownloadBuildInstallOptions($this);
+        CommandHelper::configureDryRunOption($this);
     }
 
     public function execute(InputInterface $input, OutputInterface $output): int
@@ -54,6 +55,7 @@ public function execute(InputInterface $input, OutputInterface $output): int
                 PieOperation::Resolve,
                 [], // Configure options are not needed for resolve only
                 null,
+                CommandHelper::determineDryRunFromInputs($input),
             ),
         );
 
@@ -74,6 +76,7 @@ public function execute(InputInterface $input, OutputInterface $output): int
                 PieOperation::Build,
                 $configureOptionsValues,
                 CommandHelper::determinePhpizePathFromInputs($input),
+                false,
             ),
         );
 

diff --git a/src/Command/CommandHelper.php b/src/Command/CommandHelper.php
@@ -38,6 +38,7 @@ final class CommandHelper
     private const OPTION_WITH_PHP_PATH              = 'with-php-path';
     private const OPTION_WITH_PHPIZE_PATH           = 'with-phpize-path';
     private const OPTION_MAKE_PARALLEL_JOBS         = 'make-parallel-jobs';
+    private const OPTION_DRY_RUN                    = 'dry-run';
 
     /** @psalm-suppress UnusedConstructor */
     private function __construct()
@@ -89,6 +90,16 @@ public static function configureDownloadBuildInstallOptions(Command $command): v
         $command->ignoreValidationErrors();
     }
 
+    public static function configureDryRunOption(Command $command): void
+    {
+        $command->addOption(
+            self::OPTION_DRY_RUN,
+            null,
+            InputOption::VALUE_NONE,
+            'Do not actually build or install the extension, just show the steps that would be run.',
+        );
+    }
+
     public static function validateInput(InputInterface $input, Command $command): void
     {
         $input->bind($command->getDefinition());
@@ -154,6 +165,11 @@ public static function determineTargetPlatformFromInputs(InputInterface $input,
         return $targetPlatform;
     }
 
+    public static function determineDryRunFromInputs(InputInterface $input): bool
+    {
+        return $input->hasOption(self::OPTION_DRY_RUN) && $input->getOption(self::OPTION_DRY_RUN);
+    }
+
     public static function determinePhpizePathFromInputs(InputInterface $input): PhpizePath|null
     {
         if ($input->hasOption(self::OPTION_WITH_PHPIZE_PATH)) {

diff --git a/src/Command/DownloadCommand.php b/src/Command/DownloadCommand.php
@@ -56,6 +56,7 @@ public function execute(InputInterface $input, OutputInterface $output): int
                 PieOperation::Download,
                 [], // Configure options are not needed for download only
                 null,
+                CommandHelper::determineDryRunFromInputs($input),
             ),
         );
 

diff --git a/src/Command/InfoCommand.php b/src/Command/InfoCommand.php
@@ -54,6 +54,7 @@ public function execute(InputInterface $input, OutputInterface $output): int
                 PieOperation::Resolve,
                 [], // Configure options are not needed for resolve only
                 null,
+                CommandHelper::determineDryRunFromInputs($input),
             ),
         );
 

diff --git a/src/Command/InstallCommand.php b/src/Command/InstallCommand.php
@@ -38,6 +38,7 @@ public function configure(): void
         parent::configure();
 
         CommandHelper::configureDownloadBuildInstallOptions($this);
+        CommandHelper::configureDryRunOption($this);
     }
 
     public function execute(InputInterface $input, OutputInterface $output): int
@@ -59,6 +60,7 @@ public function execute(InputInterface $input, OutputInterface $output): int
                 PieOperation::Resolve,
                 [], // Configure options are not needed for resolve only
                 null,
+                CommandHelper::determineDryRunFromInputs($input),
             ),
         );
 
@@ -79,6 +81,7 @@ public function execute(InputInterface $input, OutputInterface $output): int
                 PieOperation::Install,
                 $configureOptionsValues,
                 CommandHelper::determinePhpizePathFromInputs($input),
+                false,
             ),
         );
 

diff --git a/src/ComposerIntegration/InstallAndBuildProcess.php b/src/ComposerIntegration/InstallAndBuildProcess.php
@@ -56,6 +56,7 @@ public function __invoke(
                 $composerRequest->configureOptions,
                 $output,
                 $composerRequest->phpizePath,
+                $composerRequest->dryRun,
             );
 
             $this->installedJsonMetadata->addBuildMetadata(
@@ -77,6 +78,7 @@ public function __invoke(
                 $downloadedPackage,
                 $composerRequest->targetPlatform,
                 $output,
+                $composerRequest->dryRun,
             ),
         );
     }

diff --git a/src/ComposerIntegration/PieComposerRequest.php b/src/ComposerIntegration/PieComposerRequest.php
@@ -24,6 +24,7 @@ public function __construct(
         public readonly PieOperation $operation,
         public readonly array $configureOptions,
         public readonly PhpizePath|null $phpizePath,
+        public readonly bool $dryRun,
     ) {
     }
 }
diff --git a/src/Installing/Install.php b/src/Installing/Install.php
@@ -20,5 +20,6 @@ public function __invoke(
         DownloadedPackage $downloadedPackage,
         TargetPlatform $targetPlatform,
         OutputInterface $output,
+        bool $dryRun,
     ): BinaryFile;
 }
diff --git a/src/Installing/UnixInstall.php b/src/Installing/UnixInstall.php
@@ -22,7 +22,7 @@ final class UnixInstall implements Install
 {
     private const MAKE_INSTALL_TIMEOUT_SECS = 60; // 1 minute
 
-    public function __invoke(DownloadedPackage $downloadedPackage, TargetPlatform $targetPlatform, OutputInterface $output): BinaryFile
+    public function __invoke(DownloadedPackage $downloadedPackage, TargetPlatform $targetPlatform, OutputInterface $output, bool $dryRun): BinaryFile
     {
         $targetExtensionPath = $targetPlatform->phpBinaryPath->extensionPath();
 
@@ -47,18 +47,20 @@ public function __invoke(DownloadedPackage $downloadedPackage, TargetPlatform $t
             array_unshift($makeInstallCommand, 'sudo');
         }
 
-        $makeInstallOutput = Process::run(
-            $makeInstallCommand,
-            $downloadedPackage->extractedSourcePath,
-            self::MAKE_INSTALL_TIMEOUT_SECS,
-        );
+        if (! $dryRun) {
+            $makeInstallOutput = Process::run(
+                $makeInstallCommand,
+                $downloadedPackage->extractedSourcePath,
+                self::MAKE_INSTALL_TIMEOUT_SECS,
+            );
 
-        if ($output->isVeryVerbose()) {
-            $output->writeln($makeInstallOutput);
-        }
+            if ($output->isVeryVerbose()) {
+                $output->writeln($makeInstallOutput);
+            }
 
-        if (! file_exists($expectedSharedObjectLocation)) {
-            throw new RuntimeException('Install failed, ' . $expectedSharedObjectLocation . ' was not installed.');
+            if (! file_exists($expectedSharedObjectLocation)) {
+                throw new RuntimeException('Install failed, ' . $expectedSharedObjectLocation . ' was not installed.');
+            }
         }
 
         $output->writeln('<info>Install complete:</info> ' . $expectedSharedObjectLocation);
@@ -74,6 +76,10 @@ public function __invoke(DownloadedPackage $downloadedPackage, TargetPlatform $t
             $downloadedPackage->package->extensionName->name(),
         ));
 
+        if ($dryRun) {
+            return BinaryFile::nonExistentForDryRun($expectedSharedObjectLocation);
+        }
+
         return BinaryFile::fromFileWithSha256Checksum($expectedSharedObjectLocation);
     }
 }
-Original file line number
+Diff line change
@@ Expand Up @@
                     PieOperation::Download,
                     [], // Configure options are not needed for download only
                     null,
+                    CommandHelper::determineDryRunFromInputs($input),
                 ),
             );
@@ Expand Down @@