fix(Command) add command to download Chromedriver

lucatume · Aug 22, 2023 · b014c77 · b014c77
1 parent 83cce7f
commit b014c77
Show file tree

Hide file tree

Showing 12 changed files with 761 additions and 36 deletions.
diff --git a/codeception.dist.yml b/codeception.dist.yml
@@ -23,3 +23,4 @@ extensions:
         - "lucatume\\WPBrowser\\Command\\RunOriginal"
         - "lucatume\\WPBrowser\\Command\\RunAll"
         - "lucatume\\WPBrowser\\Command\\GenerateWPUnit"
+        - "lucatume\\WPBrowser\\Command\\ChromedriverUpdate"
diff --git a/composer.json b/composer.json
@@ -24,6 +24,7 @@
     "ext-fileinfo": "*",
     "ext-json": "*",
     "ext-curl": "*",
+    "ext-zip": "*",
     "composer-runtime-api": "^2.2",
     "codeception/codeception": "^5.0",
     "codeception/module-asserts": "^2.0 || ^3.0",

diff --git a/src/Command/ChromedriverUpdate.php b/src/Command/ChromedriverUpdate.php
@@ -0,0 +1,73 @@
+<?php
+
+namespace lucatume\WPBrowser\Command;
+
+use Codeception\CustomCommandInterface;
+use JsonException;
+use lucatume\WPBrowser\Exceptions\InvalidArgumentException;
+use lucatume\WPBrowser\Utils\ChromedriverInstaller;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class ChromedriverUpdate extends Command implements CustomCommandInterface
+{
+    public static function getCommandName(): string
+    {
+        return 'chromedriver:update';
+    }
+
+    public function configure()
+    {
+        $this->setDescription('Updates the Chromedriver binary.')
+            ->addArgument(
+                'version',
+                InputArgument::OPTIONAL,
+                'The version of Chrome to install chromedriver for.',
+                ''
+            )->addOption(
+                'platform',
+                '',
+                InputOption::VALUE_REQUIRED,
+                'The platform to install Chromedriver for.',
+                ''
+            )->addOption(
+                'binary',
+                '',
+                InputOption::VALUE_REQUIRED,
+                'The path to the Chrome binary to download Chromedriver for.',
+                false
+            );
+    }
+
+    /**
+     * @throws JsonException
+     */
+    public function execute(InputInterface $input, OutputInterface $output)
+    {
+        $platform = $input->getOption('platform') ?: null;
+
+        if ($platform && !is_string($platform)) {
+            throw new InvalidArgumentException('The platform option must be a string.');
+        }
+
+        $version = $input->getArgument('version') ?: null;
+
+        if ($version && !is_string($version)) {
+            throw new InvalidArgumentException('The version argument must be a string.');
+        }
+
+        $binary = $input->getOption('binary') ?: null;
+
+        if ($binary && !is_string($binary)) {
+            throw new InvalidArgumentException('The binary option must be a string.');
+        }
+
+        $chromedriverInstaller = new ChromedriverInstaller($version, $platform, $binary, $output);
+        $chromedriverInstaller->install();
+
+        return 0;
+    }
+}
diff --git a/src/Project/ContentProject.php b/src/Project/ContentProject.php
@@ -4,13 +4,15 @@
 
 use Closure;
 use Codeception\InitTemplate;
+use lucatume\WPBrowser\Command\ChromedriverUpdate;
 use lucatume\WPBrowser\Command\DevInfo;
 use lucatume\WPBrowser\Command\DevRestart;
 use lucatume\WPBrowser\Command\DevStart;
 use lucatume\WPBrowser\Command\DevStop;
 use lucatume\WPBrowser\Exceptions\RuntimeException;
 use lucatume\WPBrowser\Extension\BuiltInServerController;
 use lucatume\WPBrowser\Extension\ChromeDriverController;
+use lucatume\WPBrowser\Utils\ChromedriverInstaller;
 use lucatume\WPBrowser\Utils\Filesystem as FS;
 use lucatume\WPBrowser\Utils\Random;
 use lucatume\WPBrowser\WordPress\Database\SQLiteDatabase;
@@ -20,8 +22,6 @@
 
 abstract class ContentProject extends InitTemplate implements ProjectInterface
 {
-    use SetupTemplateTrait;
-
     protected TestEnvironment $testEnvironment;
 
     abstract protected function getProjectType(): string;
@@ -123,7 +123,9 @@ public function setup(): void
         }
         $this->sayInfo('Created database dump in <info>tests/Support/Data/dump.sql</info>.');
 
-        $this->addChromedriverDevDependency();
+        $this->sayInfo('Installing Chromedriver ...');
+        $chromedriverPath = (new ChromedriverInstaller())->install();
+        $this->sayInfo("Chromedriver installed in $chromedriverPath");
         $chromedriverPort = Random::openLocalhostPort();
         $this->testEnvironment->testTablePrefix = 'test_';
         $this->testEnvironment->wpTablePrefix = 'wp_';
@@ -157,6 +159,7 @@ public function setup(): void
         $this->testEnvironment->customCommands[] = DevStop::class;
         $this->testEnvironment->customCommands[] = DevInfo::class;
         $this->testEnvironment->customCommands[] = DevRestart::class;
+        $this->testEnvironment->customCommands[] = ChromedriverUpdate::class;
         $this->testEnvironment->wpRootDir = FS::relativePath($this->workDir, $wpRootDir);
         $this->testEnvironment->dbUrl = 'sqlite://%codecept_root_dir%/tests/_wordpress/data/db.sqlite';
 

diff --git a/src/Project/SetupTemplateTrait.php b/src/Project/SetupTemplateTrait.php
diff --git a/src/Project/SiteProject.php b/src/Project/SiteProject.php
@@ -3,13 +3,15 @@
 namespace lucatume\WPBrowser\Project;
 
 use Codeception\InitTemplate;
+use lucatume\WPBrowser\Command\ChromedriverUpdate;
 use lucatume\WPBrowser\Command\DevInfo;
 use lucatume\WPBrowser\Command\DevRestart;
 use lucatume\WPBrowser\Command\DevStart;
 use lucatume\WPBrowser\Command\DevStop;
 use lucatume\WPBrowser\Exceptions\RuntimeException;
 use lucatume\WPBrowser\Extension\BuiltInServerController;
 use lucatume\WPBrowser\Extension\ChromeDriverController;
+use lucatume\WPBrowser\Utils\ChromedriverInstaller;
 use lucatume\WPBrowser\Utils\Filesystem as FS;
 use lucatume\WPBrowser\Utils\Random;
 use lucatume\WPBrowser\WordPress\Database\SQLiteDatabase;
@@ -22,8 +24,6 @@
 
 class SiteProject extends InitTemplate implements ProjectInterface
 {
-    use SetupTemplateTrait;
-
     private Installation $installation;
     private TestEnvironment $testEnvironment;
 
@@ -117,7 +117,9 @@ public function setup(): void
         }
         $this->sayInfo('Created database dump in <info>tests/Support/Data/dump.sql</info>.');
 
-        $this->addChromedriverDevDependency();
+        $this->sayInfo('Installing Chromedriver ...');
+        $chromedriverPath = (new ChromedriverInstaller())->install();
+        $this->sayInfo("Chromedriver installed in $chromedriverPath");
         $chromedriverPort = Random::openLocalhostPort();
         $this->testEnvironment->testTablePrefix = 'test_';
         $this->testEnvironment->wpTablePrefix = 'wp_';
@@ -152,6 +154,7 @@ public function setup(): void
         $this->testEnvironment->customCommands[] = DevStop::class;
         $this->testEnvironment->customCommands[] = DevInfo::class;
         $this->testEnvironment->customCommands[] = DevRestart::class;
+        $this->testEnvironment->customCommands[] = ChromedriverUpdate::class;
         $this->testEnvironment->wpRootDir = '.';
         $this->testEnvironment->dbUrl = 'sqlite://%codecept_root_dir%/tests/Support/Data/db.sqlite';