Add support for Chrome for Behat

Author: polothy

Diff for: .travis.yml

@@ -9,6 +9,7 @@ addons:
     packages:
       - oracle-java8-installer
       - oracle-java8-set-default
+      - chromium-chromedriver
 
 cache:
   directories:
@@ -25,6 +26,7 @@ env:
     - MUSTACHE_IGNORE_NAMES=broken.mustache
     - DB=pgsql
     - MOODLE_BRANCH=master
+    - PROFILE=chrome
 
 install:
   - phpenv config-rm xdebug.ini
@@ -52,7 +54,7 @@ script:
   - moodle-plugin-ci mustache
   - moodle-plugin-ci grunt
   - moodle-plugin-ci phpunit --coverage-text
-  - moodle-plugin-ci behat
+  - moodle-plugin-ci behat --profile $PROFILE
 
 jobs:
   include:
@@ -69,7 +71,7 @@ jobs:
     - php: 7.0
       env: MOODLE_BRANCH=MOODLE_33_STABLE
     - php: 5.6
-      env: MOODLE_BRANCH=MOODLE_32_STABLE DB=mysqli
+      env: MOODLE_BRANCH=MOODLE_32_STABLE DB=mysqli PROFILE=default
     - stage: Deploy
       addons: skip
       install: skip

Diff for: docs/AddExtraConfig.md

@@ -7,7 +7,7 @@ Sometimes a plugin may require extra config in the Moodle `config.php` file beca
 non-standard service.  This project provides a way to update the `config.php` file with the `add-config` command.  Here
 is an example of how to use it in your `.travis.yml` file:
 
-```yml
+```yaml
 install:
   - moodle-plugin-ci install
   - moodle-plugin-ci add-config '$CFG->foo = "bar";'

Diff for: docs/AddExtraPlugins.md

@@ -7,7 +7,7 @@ Sometimes the plugin that you are testing may depend on another plugin or even s
 provides a way to Git clone the extra plugins and add them to the Moodle test site. Here is an example of how to use
 it in your `.travis.yml` file:
 
-```yml
+```yaml
 install:
   - moodle-plugin-ci add-plugin moodlehq/moodle-local_hub
   - moodle-plugin-ci install
@@ -21,7 +21,7 @@ By default, the branch that is cloned is the `master` branch.  You can use the `
 this behavior.  If you use the same branch names as Moodle (EG: `MOODLE_XY_STABLE`), then a handy trick is to pass
 the `$MOODLE_BRANCH` build variable to the `add-plugin` command.  Here is an example:
 
-```yml
+```yaml
 install:
   - moodle-plugin-ci add-plugin --branch $MOODLE_BRANCH username/project
   - moodle-plugin-ci install
@@ -30,7 +30,7 @@ install:
 If you are not using GitHub and want to provide your own Git clone URL, then you can use the `--clone` (`-c`) option.
 Here is an example (Note, you can use the `--branch` option together with the `--clone` option if you need to):
 
-```yml
+```yaml
 install:
   - moodle-plugin-ci add-plugin --clone https://bitbucket.org/username/project.git
   - moodle-plugin-ci install

Diff for: docs/CHANGELOG.md

@@ -15,6 +15,9 @@ The format of this change log follows the advice given at [Keep a CHANGELOG](htt
   environment from Precise to Trusy.  On Trusty, the default Firefox version is 55, which is not
   compatible with Selenium.
 
+### Added
+- Can now use Chrome with Behat, see [help document](Chrome.md) for details.
+
 ### Changed
 - Set password via environment when connecting with Postgres.
 
@@ -42,7 +45,7 @@ The format of this change log follows the advice given at [Keep a CHANGELOG](htt
 - The Composer self update step from `.travis.dist.yml`.
 
 ### Added
-- Defining ignore files per command, see [help document](IgnoringFiles.md) for details. 
+- Defining ignore files per command, see [help document](IgnoringFiles.md) for details.
 - `moodle-plugin-ci mustache` command which lints your Mustache template files.
 - `moodle-plugin-ci grunt` command which runs Grunt tasks on the plugin. See [help document](TravisFileExplained.md)
   for more details about the command.

Diff for: docs/Chrome.md

@@ -0,0 +1,51 @@
+---
+layout: page
+title: Using Chrome with Behat
+---
+
+First, a word of warning.  On Travis CI, you cannot specify the version of Chrome to install
+which might lead to compatibility problems as Travis CI updates their environment. So,
+the most _stable_ route is to keep using Firefox.  Currently Chrome is working with the `Trusy`
+Travis CI environment and the versions as of writing this are:
+
+* ChromeDriver 2.29
+* Chromium 60
+
+So, why would you want to use Chrome then?  Speed.  It is much faster than Firefox for executing
+Behat tests.  If you find that you are waiting too long for your build results or if you find
+that your build exceeds max execution time, then using Chrome with Behat could help.  To use
+Chrome, modify your `.travis.yml` file.
+
+Under `addons` add `chromium-chromedriver`:
+
+```yaml
+addons:
+  # ...other stuff.
+  apt:
+    packages:
+      # ...other stuff.
+      - chromium-chromedriver
+```
+
+The under `script` update your Behat command:
+
+```yaml
+script:
+  # ...other stuff.
+  - moodle-plugin-ci behat --profile chrome
+```
+
+## Troubleshooting
+
+If Behat starts to misbehave, please revert back to using Firefox to see if it is an issue with
+using Chrome or not.
+
+If you ever need to see the version of Chrome or ChromeDriver in your build, then you can add these
+to your `.travis.yml` file:
+
+```yaml
+install:
+  - /usr/lib/chromium-browser/chromedriver --version
+  - chromium-browser --version
+  # ...other stuff.
+```

Diff for: docs/Help.md

@@ -14,6 +14,7 @@ changed.  Also a good place to look for new goodies.
 * [Add extra Moodle configs](AddExtraConfig.html): how to add extra configs to Moodle `config.php`.
 * [Add extra plugins](AddExtraPlugins.html): how to add plugin dependencies to Moodle.
 * [Ignoring files](IgnoringFiles.html): how to ignore files that might be causing failures.
+* [Using Chrome with Behat](Chrome.md): how to use Chrome instead of Firefox for Behat.
 * [Testing a plugin against PHP7](PHP7.html): how to test your plugin against PHP7.
 * [Generating code coverage](CodeCoverage.html): how to generate code coverage of your plugin.
 

Diff for: docs/IgnoringFiles.md

@@ -15,7 +15,7 @@ In addition, you can ignore additional files by defining `IGNORE_PATHS` and/or `
 in your `.travis.yml` file.  These environment variables wont work for Grunt tasks, but will for everything else.
 Example:
 
-```yml
+```yaml
 env:
  global:
   - MOODLE_BRANCH=MOODLE_29_STABLE
@@ -34,7 +34,7 @@ like `/\.php$/`.
 If you need to specify ignore paths for a specific command, then you can define additional environment variables.  The
 variable names are the same as above, but prefixed with `COMMANDNAME_`.  Example:
 
-```yml
+```yaml
 env:
  global:
   - MOODLE_BRANCH=MOODLE_29_STABLE

Diff for: res/template/config.php.txt

@@ -38,16 +38,13 @@ $CFG->behat_wwwroot       = '{{BEHATWWWROOT}}';
 $CFG->behat_faildump_path = '{{BEHATDUMP}}';
 $CFG->behat_profiles      = [
     'default' => [
-        'browser'    => 'firefox',
-        'wd_host'    => 'http://localhost:4444/wd/hub',
-        'extensions' => [
-            'Behat\MinkExtension' => [
-                'selenium2' => [
-                    'browser' => 'firefox',
-                ]
-            ]
-        ]
-    ]
+        'browser' => 'firefox',
+        'wd_host' => 'http://localhost:4444/wd/hub',
+    ],
+    'chrome' => [
+        'browser' => 'chrome',
+        'wd_host' => 'http://localhost:4444/wd/hub',
+    ],
 ];
 
 {{EXTRACONFIG}}

Diff for: src/Command/BehatCommand.php

@@ -45,6 +45,7 @@ protected function configure()
         $jar = getenv('MOODLE_SELENIUM_JAR') !== false ? getenv('MOODLE_SELENIUM_JAR') : null;
 
         $this->setName('behat')
+            ->addOption('profile', 'p', InputOption::VALUE_REQUIRED, 'Behat profile to use', 'default')
             ->addOption('start-servers', null, InputOption::VALUE_NONE, 'Start Selenium and PHP servers')
             ->addOption('jar', null, InputOption::VALUE_REQUIRED, 'Path to Selenium Jar file', $jar)
             ->addOption('auto-rerun', null, InputOption::VALUE_REQUIRED, 'Number of times to rerun failures', 2)
@@ -71,12 +72,13 @@ protected function execute(InputInterface $input, OutputInterface $output)
             $servers = $input->getOption('start-servers');
         }
 
-        $servers && $this->startServerProcesses($input->getOption('jar'));
+        $servers && $this->startServerProcesses($input->getOption('jar'), $input);
 
         $builder = ProcessBuilder::create()
             ->setPrefix('php')
             ->add('admin/tool/behat/cli/run.php')
             ->add('--tags=@'.$this->plugin->getComponent())
+            ->add('--profile='.$input->getOption('profile'))
             ->add('--auto-rerun='.$input->getOption('auto-rerun'))
             ->add('--verbose')
             ->add('-vvv')
@@ -97,12 +99,21 @@ protected function execute(InputInterface $input, OutputInterface $output)
         return $process->isSuccessful() ? 0 : 1;
     }
 
-    private function startServerProcesses($seleniumJarFile)
+    private function startServerProcesses($seleniumJarFile, InputInterface $input)
     {
         if (!is_file($seleniumJarFile)) {
             throw new \InvalidArgumentException(sprintf('Invalid Selenium Jar file path: %s', $seleniumJarFile));
         }
-        $selenium = new Process(sprintf('xvfb-run -a --server-args="-screen 0 1024x768x24" java -jar %s', $seleniumJarFile));
+        $cmd = sprintf('xvfb-run -a --server-args="-screen 0 1024x768x24" java -jar %s', $seleniumJarFile);
+        if ($input->getOption('profile') === 'chrome') {
+            $driver = '/usr/lib/chromium-browser/chromedriver';
+            if (!file_exists($driver)) {
+                throw new \RuntimeException('chromedriver not found, please install it, see help docs');
+            }
+            $cmd .= ' -Dwebdriver.chrome.driver='.$driver;
+        }
+
+        $selenium = new Process($cmd);
         $selenium->setTimeout(0);
         $selenium->disableOutput();
         $selenium->start();

Diff for: tests/Fixture/example-config.php

@@ -38,16 +38,13 @@
 $CFG->behat_faildump_path = '/path/to/moodledata/behat_dump';
 $CFG->behat_profiles      = [
     'default' => [
-        'browser'    => 'firefox',
-        'wd_host'    => 'http://localhost:4444/wd/hub',
-        'extensions' => [
-            'Behat\MinkExtension' => [
-                'selenium2' => [
-                    'browser' => 'firefox',
-                ]
-            ]
-        ]
-    ]
+        'browser' => 'firefox',
+        'wd_host' => 'http://localhost:4444/wd/hub',
+    ],
+    'chrome' => [
+        'browser' => 'chrome',
+        'wd_host' => 'http://localhost:4444/wd/hub',
+    ],
 ];
 
 // Extra config.