Add --dry-run option to install/update command (#2)

Author: mjauvin

src/Commands/Update.php

@@ -48,6 +48,11 @@ class Update extends BaseCommand
      */
     protected bool $ignoreScripts = false;
 
+    /**
+     * Use dry-run mode
+     */
+    protected bool $dryRun = false;
+
     /**
      * Whether this command has already been executed
      */
@@ -102,7 +107,8 @@ public function handle(
         bool $lockFileOnly = false,
         bool $ignorePlatformReqs = false,
         string $installPreference = 'none',
-        bool $ignoreScripts = false
+        bool $ignoreScripts = false,
+        bool $dryRun = false
     ) {
         if ($this->executed) {
             return;
@@ -112,6 +118,7 @@ public function handle(
         $this->lockFileOnly = $lockFileOnly;
         $this->ignorePlatformReqs = $ignorePlatformReqs;
         $this->ignoreScripts = $ignoreScripts;
+        $this->dryRun = $dryRun;
 
         if (in_array($installPreference, [self::PREFER_NONE, self::PREFER_DIST, self::PREFER_SOURCE])) {
             $this->installPreference = $installPreference;
@@ -166,6 +173,11 @@ public function isSuccessful(): bool
         return $this->successful === true;
     }
 
+    public function getRawOutput(): array
+    {
+        return $this->rawOutput;
+    }
+
     /**
      * Returns installed packages.
      *
@@ -335,6 +347,10 @@ public function arguments(): array
     {
         $arguments = [];
 
+        if ($this->dryRun) {
+            $arguments['--dry-run'] = true;
+        }
+
         if ($this->includeDev) {
             $arguments['--dev'] = true;
         } else {

tests/Cases/Commands/UpdateTest.php

@@ -359,4 +359,29 @@ public function itFailsWhenComposerJsonIsInvalidFormat(): void
 
         $this->composer->update();
     }
+
+    /**
+     * @test
+     * @testdox can run a (real) update with --dry-run option
+     * @covers ::handle
+     * @covers ::execute
+     */
+    public function itCanRunAnUpdateRealWithDryRun()
+    {
+        $this->copyToWorkDir($this->testBasePath() . '/fixtures/valid/simple/composer.json');
+
+        // call with dryRun = true
+        $update = $this->composer->update(true, false, false, 'none', false, true);
+
+        // make sure no lock file gets created
+        $this->assertFileDoesNotExist($this->workDir . '/composer.lock');
+
+        // make sure no vendor folder gets created
+        $this->assertDirectoryDoesNotExist($this->workDir . '/vendor');
+
+        $this->assertNotEmpty($update->getRawOutput());
+
+        $this->assertEquals(2, $update->getLockInstalledCount());
+        $this->assertEquals(2, $update->getInstalledCount());
+    }
 }