Merge pull request #107 from moodleworkplace/fix-behat

Replace Selenium in-built functionality with docker image for Selenium (and Moodle 3.8)

Author: David Castro

.travis.dist.yml

@@ -1,27 +1,26 @@
 language: php
 
-sudo: true
-
 addons:
-  firefox: "47.0.1"
   postgresql: "9.4"
 
 services:
   - mysql
   - postgresql
+  - docker
 
 cache:
   directories:
     - $HOME/.composer/cache
     - $HOME/.npm
 
 php:
- - 7.0
  - 7.1
+ - 7.2
+ - 7.3
 
 env:
  global:
-  - MOODLE_BRANCH=MOODLE_35_STABLE
+  - MOODLE_BRANCH=MOODLE_38_STABLE
  matrix:
   - DB=pgsql
   - DB=mysqli
@@ -33,6 +32,7 @@ before_install:
   - cd ../..
   - composer create-project -n --no-dev --prefer-dist blackboard-open-source/moodle-plugin-ci ci ^2
   - export PATH="$(cd ci/bin; pwd):$(cd ci/vendor/bin; pwd):$PATH"
+  - docker run -d -p 127.0.0.1:4444:4444 --net=host -v /dev/shm:/dev/shm selenium/standalone-firefox:3
 
 install:
   - moodle-plugin-ci install

.travis.yml

@@ -1,18 +1,12 @@
 language: php
 
-# Behat no longer passes when false.
-sudo: true
-
 addons:
-  firefox: "47.0.1"
-  postgresql: "9.4"
-  apt:
-    packages:
-      - chromium-chromedriver
+  postgresql: "9.5"
 
 services:
   - mysql
   - postgresql
+  - docker
 
 cache:
   directories:
@@ -36,7 +30,8 @@ install:
   - nvm install 8.9
   - nvm use 8.9
   - make init
-
+  # Start Selenium Standalone with Chrome/Firefox installed.
+  - docker run -d -p 127.0.0.1:4444:4444 --net=host -v /dev/shm:/dev/shm selenium/standalone-${PROFILE}:3
   # Mimic how a Moodle plugin would be run.
   - cp -R tests/Fixture/moodle-local_travis ../moodle-local_travis
   - export PATH="$(cd bin; pwd):$(cd vendor/bin; pwd):$PATH"
@@ -56,7 +51,7 @@ script:
   - moodle-plugin-ci validate
   - moodle-plugin-ci savepoints
   - moodle-plugin-ci mustache
-  - moodle-plugin-ci grunt
+  - moodle-plugin-ci grunt || [ "$MOODLE_BRANCH" != 'master' -a "$MOODLE_BRANCH" != 'MOODLE_38_STABLE' ]
   - moodle-plugin-ci phpdoc
   - moodle-plugin-ci phpunit --coverage-text
   - moodle-plugin-ci behat --profile $PROFILE
@@ -72,20 +67,13 @@ jobs:
         - make validate
     - stage: Integration tests
     - php: 7.3
+      env: MOODLE_BRANCH=MOODLE_38_STABLE
+    - php: 7.3
+      env: MOODLE_BRANCH=MOODLE_37_STABLE
+    - php: 7.2
       env: MOODLE_BRANCH=MOODLE_36_STABLE
     - php: 7.2
       env: MOODLE_BRANCH=MOODLE_35_STABLE
-    - php: 7.1
-      env: MOODLE_BRANCH=MOODLE_34_STABLE
-    - php: 7.0
-      env: MOODLE_BRANCH=MOODLE_33_STABLE DB=mariadb
-      addons:
-        mariadb: 10.2
-        apt:
-          packages:
-            - chromium-chromedriver
-    - php: 5.6
-      env: MOODLE_BRANCH=MOODLE_32_STABLE DB=mysqli PROFILE=default
     - stage: Deploy
       addons: skip
       install: skip

docs/CHANGELOG.md

@@ -15,6 +15,10 @@ The format of this change log follows the advice given at [Keep a CHANGELOG](htt
   [#91](https://github.com/blackboard-open-source/moodle-plugin-ci/issues/91).
 - Updated verion of `moodlehq/moodle-local_ci` to fix Mustache linting. See
   [#91](https://github.com/blackboard-open-source/moodle-plugin-ci/issues/91).
+- Updated [.travis.dist.yml] to build Moodle 3.8: removed PHP 7.0 and added
+  7.2 and 7.3 (per release notes).
+- Replaced Selenium in-built functionality with docker image for Selenium
+  Standalone server. See [#99](https://github.com/blackboard-open-source/moodle-plugin-ci/issues/99).
 
 ### Added
 - New help document: [CLI commands and options](CLI.md)

docs/CLI.md

@@ -240,7 +240,7 @@ Run Behat on a plugin
 
 ### Usage
 
-* `behat [-m|--moodle MOODLE] [-p|--profile PROFILE] [--suite SUITE] [--start-servers] [--jar JAR] [--auto-rerun AUTO-RERUN] [--dump] [--] <plugin>`
+* `behat [-m|--moodle MOODLE] [-p|--profile PROFILE] [--suite SUITE] [--start-servers] [--auto-rerun AUTO-RERUN] [--dump] [--] <plugin>`
 
 Run Behat on a plugin
 
@@ -285,22 +285,13 @@ Behat suite to use (Moodle theme)
 
 #### `--start-servers`
 
-Start Selenium and PHP servers
+Start PHP server
 
 * Accept value: no
 * Is value required: no
 * Is multiple: no
 * Default: `false`
 
-#### `--jar`
-
-Path to Selenium Jar file
-
-* Accept value: yes
-* Is value required: yes
-* Is multiple: no
-* Default: `NULL`
-
 #### `--auto-rerun`
 
 Number of times to rerun failures
@@ -1993,4 +1984,4 @@ Do not ask any interactive question
 * Accept value: no
 * Is value required: no
 * Is multiple: no
-* Default: `false`
+* Default: `false`

docs/Chrome.md

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

docs/Help.md

@@ -11,14 +11,8 @@ see [Travis CI's documentation](http://docs.travis-ci.com/user/getting-started/)
 # This is the language of our project.
 language: php
 
-# If using Behat, then this should be true due to an issue with Travis CI.
-# If not using Behat, recommended to use `sudo: false` as it is faster.
-sudo: true
-
-# Installs the required version of Firefox for Behat, an updated version
-# of PostgreSQL and extra APT packages.
+# Installs the updated version of PostgreSQL and extra APT packages.
 addons:
-  firefox: "47.0.1"
   postgresql: "9.4"
 
 # Ensure DB services are running.
@@ -36,19 +30,20 @@ cache:
 # listed here will create a separate build and run the tests against that
 # version of PHP.
 php:
- - 7.0
  - 7.1
+ - 7.2
+ - 7.3
 
 # This section sets up the environment variables for the build.
 env:
  global:
 # This line determines which version branch of Moodle to test against.
-  - MOODLE_BRANCH=MOODLE_35_STABLE
+  - MOODLE_BRANCH=MOODLE_38_STABLE
 # This matrix is used for testing against multiple databases.  So for
 # each version of PHP being tested, one build will be created for each
-# database listed here.  EG: for PHP 5.6, one build will be created
-# using PHP 5.6 and pgsql.  In addition, another build will be created
-# using PHP 5.6 and mysqli.
+# database listed here.  EG: for PHP 7.1, one build will be created
+# using PHP 7.1 and pgsql.  In addition, another build will be created
+# using PHP 7.1 and mysqli.
  matrix:
   - DB=pgsql
   - DB=mysqli
@@ -57,7 +52,7 @@ env:
 # (git://github.com/moodle/moodle.git is used by default):
 # - MOODLE_REPO=git://github.com/username/moodle.git
 
-# This lists steps that are run before the installation step. 
+# This lists steps that are run before the installation step.
 before_install:
 # This disables XDebug which should speed up the build.
   - phpenv config-rm xdebug.ini
@@ -71,6 +66,10 @@ before_install:
   - composer create-project -n --no-dev --prefer-dist blackboard-open-source/moodle-plugin-ci ci ^2
 # Update the $PATH so scripts from this project can be called easily.
   - export PATH="$(cd ci/bin; pwd):$(cd ci/vendor/bin; pwd):$PATH"
+# Start Selenium Standalone server with Chrome/Firefox installed. If you
+# prefer to run Behat tests with Chrome profile (see Behat step details below),
+# use selenium/standalone-chrome:3 image instead.
+  - docker run -d -p 127.0.0.1:4444:4444 --net=host -v /dev/shm:/dev/shm selenium/standalone-firefox:3
 
 # This lists steps that are run for installation and setup.
 install:
@@ -115,19 +114,23 @@ script:
 # This step runs Grunt tasks on the plugin.  By default, it tries to run
 # tasks relevant to your plugin and Moodle version, but you can run
 # specific tasks by passing them as options,
-# EG: moodle-plugin-ci grunt -t task1 -t task2 
+# EG: moodle-plugin-ci grunt -t task1 -t task2
   - moodle-plugin-ci grunt
 # This step runs the PHPUnit tests of your plugin.  If your plugin has
 # PHPUnit tests, then it is highly recommended that you keep this step.
   - moodle-plugin-ci phpunit
 # This step runs the Behat tests of your plugin.  If your plugin has
 # Behat tests, then it is highly recommended that you keep this step.
-# There are two important options that you may want to use:
+# There are few important options that you may want to use:
 #   - The auto rerun option allows you to rerun failures X number of times,
 #     default is 2, EG usage: --auto-rerun 3
 #   - The dump option allows you to print the failure HTML to the console,
 #     handy for debugging, EG usage: --dump
 #   - The suite option allows you to set the theme to use for behat test. If
 #     not specified, the default theme is used, EG usage: --suite boost
+#   - The profile option allows you to set the browser driver to use,
+#     default is Firefox. If you need Chrome, set '--profile chrome' and make
+#     sure that you are using correct Selenium server docker image in
+#     before_install section above.
   - moodle-plugin-ci behat
 ```

docs/TravisFileExplained.md

@@ -39,11 +39,11 @@ $CFG->behat_faildump_path = '{{BEHATDUMP}}';
 $CFG->behat_profiles      = [
     'default' => [
         'browser' => 'firefox',
-        'wd_host' => 'http://localhost:4444/wd/hub',
+        'wd_host' => '{{BEHATWDHOST}}',
     ],
     'chrome' => [
         'browser' => 'chrome',
-        'wd_host' => 'http://localhost:4444/wd/hub',
+        'wd_host' => '{{BEHATWDHOST}}',
     ],
 ];
 

res/template/config.php.txt

@@ -45,7 +45,8 @@ public function createContents(AbstractDatabase $database, $dataDir)
             '{{PHPUNITDATAROOT}}' => $dataDir.'/phpu_moodledata',
             '{{BEHATDATAROOT}}'   => $dataDir.'/behat_moodledata',
             '{{BEHATDUMP}}'       => $dataDir.'/behat_dump',
-            '{{BEHATWWWROOT}}'    => 'http://localhost:8000',
+            '{{BEHATWWWROOT}}'    => getenv('MOODLE_BEHAT_WWWROOT') ?: 'http://localhost:8000',
+            '{{BEHATWDHOST}}'     => getenv('MOODLE_BEHAT_WDHOST') ?: 'http://localhost:4444/wd/hub',
             '{{EXTRACONFIG}}'     => self::PLACEHOLDER,
         ];