Use legacy Firefox for legacy php-webdriver

Author: andrewnicols

docs/CHANGELOG.md

@@ -19,6 +19,9 @@ The format of this change log follows the advice given at [Keep a CHANGELOG](htt
   to avoid memory exhaused errors.
 - Updated project dependencies to current [moodle-local_moodlecheck](https://github.com/moodlehq/moodle-local_moodlecheck) and [moodle-local_ci](https://github.com/moodlehq/moodle-local_ci) versions.
 
+### Added
+- Detect existence of legacy php-webdriver, and use a different Firefox image when it is in use
+
 ## [3.0.3] - 2020-10-16
 ### Changed
 - Updated version of [moodle-local_codechecker](https://github.com/moodlehq/moodle-local_codechecker) to v2.9.8.

src/Command/BehatCommand.php

@@ -31,7 +31,14 @@ class BehatCommand extends AbstractMoodleCommand
      *
      * @var string
      */
-    private $seleniumFirefoxImage = 'selenium/standalone-firefox:2.53.1';
+    private $seleniumLegacyFirefoxImage = 'selenium/standalone-firefox:2.53.1';
+
+    /**
+     * Selenium standalone Firefox image.
+     *
+     * @var string
+     */
+    private $seleniumFirefoxImage = 'selenium/standalone-firefox:3.141.59';
 
     /**
      * Selenium standalone Chrome image.
@@ -124,7 +131,13 @@ private function startServerProcesses(InputInterface $input)
         }
 
         // Start docker container using desired image.
-        $image = ($input->getOption('profile') === 'chrome') ? $this->seleniumChromeImage : $this->seleniumFirefoxImage;
+        if ($input->getOption('profile') === 'chrome') {
+            $image = $this->seleniumChromeImage;
+        } elseif ($this->usesLegacyPhpWebdriver()) {
+            $image = $this->seleniumLegacyFirefoxImage;
+        } else {
+            $image = $this->seleniumFirefoxImage;
+        }
         $cmd   = sprintf('docker run -d --rm -p 127.0.0.1:4444:4444 --name=selenium --net=host --shm-size=2g -v %s:%s %s',
             $this->moodle->directory, $this->moodle->directory, $image);
         $docker = $this->execute->passThrough($cmd);
@@ -165,4 +178,12 @@ private function dumpFailures(OutputInterface $output)
             }
         }
     }
+
+    private function usesLegacyPhpWebdriver(): bool
+    {
+        // The `instaclick/php-webdriver` dependency requires use of a legacy version of Firefox.
+        $composerlock = "{$this->moodle->directory}/composer.lock";
+
+        return strpos(file_get_contents($composerlock), 'instaclick/php-webdriver') !== false;
+    }
 }