Add pre-configuration for Nightwatch VRT

.github/workflows/TestFunctional.yml

@@ -252,7 +252,10 @@ jobs:
           echo '      ws: "*"' >> .yarnrc.yml
           echo '      lodash: "*"' >> .yarnrc.yml
           echo '      rimraf: "*"' >> .yarnrc.yml
-          ddev yarn add nightwatch nightwatch-axe-verbose @lullabot/nightwatch-drupal-commands --dev
+          echo '  "@nightwatch/vrt@*":' >> .yarnrc.yml
+          echo '    dependencies:' >> .yarnrc.yml
+          echo '      open: "^8"' >> .yarnrc.yml
+          ddev yarn add nightwatch nightwatch-axe-verbose @nightwatch/vrt @lullabot/nightwatch-drupal-commands --dev
           yarn
 
       - name: Install Drupal

.gitlab-ci.yml

@@ -41,6 +41,7 @@ build:
     - ddev composer require lullabot/drainpipe --with-all-dependencies
     - ddev restart
     - test -f .gitlab/drainpipe/DDEV.gitlab-ci.yml
+    - test -f .gitlab/drainpipe/Nightwatch.gitlab-ci.yml
     - ddev drush site:install minimal -y
     - echo "\$settings['config_sync_directory'] = '../config';" >> web/sites/default/settings.php
     - ddev drush config:export -y

drainpipe-dev/config/nightwatch.conf.js

@@ -4,6 +4,13 @@ const drupalCommandsPath = path.dirname(require.resolve('@lullabot/nightwatch-dr
 const firefoxLaunchUrl = process.env.NIGHTWATCH_DRUPAL_URL_FIREFOX && process.env.NIGHTWATCH_DRUPAL_URL_FIREFOX.length ? process.env.NIGHTWATCH_DRUPAL_URL_FIREFOX.replace(/\/$/, '') : process.env.NIGHTWATCH_DRUPAL_URL;
 const chromeLaunchUrl = process.env.NIGHTWATCH_DRUPAL_URL_CHROME && process.env.NIGHTWATCH_DRUPAL_URL_CHROME.length ? process.env.NIGHTWATCH_DRUPAL_URL_CHROME.replace(/\/$/, '') : process.env.NIGHTWATCH_DRUPAL_URL;
 
+let nightwatchVRT = true;
+try {
+  require.resolve('@nightwatch/vrt');
+} catch(e) {
+  nightwatchVRT = false;
+}
+
 module.exports = {
   // An array of folders (excluding subfolders) where your tests are located;
   // if this is not specified, the test source must be passed as the second argument to the test runner.
@@ -23,6 +30,17 @@ module.exports = {
   // See https://nightwatchjs.org/guide/#external-globals
   globals_path : '',
 
+  plugins: nightwatchVRT ? ['@nightwatch/vrt'] : [],
+
+  '@nightwatch/vrt': {
+    latest_screenshots_path: 'test/nightwatch/vrt/latest',
+    baseline_screenshots_path: 'test/nightwatch/vrt/baseline',
+    diff_screenshots_path: 'test/nightwatch/vrt/diff',
+    threshold: 0.00,
+    prompt: false,
+    updateScreenshots: false
+  },
+
   webdriver: {},
 
   test_workers: {

scaffold/gitignore/common.gitignore

@@ -55,3 +55,6 @@ node_modules
 #########
 test_result
 .prettiercache
+vrt-report
+test/nightwatch/vrt/latest
+test/nightwatch/vrt/diff

scaffold/gitlab/Nightwatch.gitlab-ci.yml

@@ -0,0 +1,33 @@
+report-nightwatch:
+  stage: report
+  when: always
+  needs:
+    - job: functional
+      artifacts: true
+  script:
+    - echo "Nothing to do"
+  artifacts:
+    expose_as: 'Nightwatch Test Report'
+    paths:
+      - test_result/nightwatch-html-report/index.html
+      - test/nightwatch/vrt
+      - test_result
+
+report-nightwatch-vrt:
+  stage: report
+  when: always
+  script:
+    - |
+      if [ -f "vrt-report/index.html" ] && [ $GITLAB_CI = "true" ]; then
+        cp vrt-report/index.html vrt-report/index-gitlab.html
+        sed -i "s|\"/test/nightwatch/vrt/|\"../test/nightwatch/vrt/|g" vrt-report/index-gitlab.html
+      fi
+  needs:
+    - job: functional
+      artifacts: true
+  artifacts:
+    expose_as: 'VRT Test Report'
+    paths:
+      - vrt-report/index-gitlab.html
+      - test/nightwatch/vrt
+      - test_result

src/ScaffoldInstallerPlugin.php

@@ -224,16 +224,17 @@ private function installCICommands(): void
         // GitLab
         $fs->removeDirectory('./.drainpipe/gitlab');
         if (isset($this->extra['drainpipe']['gitlab']) && is_array($this->extra['drainpipe']['gitlab'])) {
+            $fs->ensureDirectoryExists('.gitlab/drainpipe');
             if (file_exists('./.ddev/config.yaml')) {
-                $fs->ensureDirectoryExists('.gitlab/drainpipe');
                 $fs->copy("$scaffoldPath/gitlab/DDEV.gitlab-ci.yml", ".gitlab/drainpipe/DDEV.gitlab-ci.yml");
                 $this->io->write("🪠 [Drainpipe] .gitlab/drainpipe/DDEV.gitlab-ci.yml installed");
             }
             else {
-                $fs->ensureDirectoryExists('./.drainpipe/gitlab');
                 $fs->copy("$scaffoldPath/gitlab/Common.gitlab-ci.yml", ".drainpipe/gitlab/Common.gitlab-ci.yml");
                 $this->io->write("🪠 [Drainpipe] .drainpipe/gitlab/Common.gitlab-ci.yml installed");
             }
+            $fs->copy("$scaffoldPath/gitlab/Nightwatch.gitlab-ci.yml", ".drainpipe/gitlab/Nightwatch.gitlab-ci.yml");
+            $this->io->write("🪠 [Drainpipe] .drainpipe/gitlab/Nightwatch.gitlab-ci.yml installed");
             foreach ($this->extra['drainpipe']['gitlab'] as $gitlab) {
                 $file = "gitlab/$gitlab.gitlab-ci.yml";
                 if (file_exists("$scaffoldPath/$file")) {

tasks/test.yml

@@ -205,7 +205,7 @@ tasks:
     interactive: true
     cmds:
       - |
-        PACKAGES="nightwatch nightwatch-axe-verbose @lullabot/nightwatch-drupal-commands"
+        PACKAGES="nightwatch nightwatch-axe-verbose @nightwatch/vrt @lullabot/nightwatch-drupal-commands"
         if [ ! -f "package.json" ]; then
           echo -n "No package.json exists, would you like to use yarn1, npm, or yarn? "
           read -r PACKAGE_MANAGER
@@ -228,6 +228,9 @@ tasks:
             echo '    dependencies:' >> .yarnrc.yml
             echo '      ws: "*"' >> .yarnrc.yml
             echo '      lodash: "*"' >> .yarnrc.yml
+            echo '  "@nightwatch/vrt@*":' >> .yarnrc.yml
+            echo '    dependencies:' >> .yarnrc.yml
+            echo '      open: "^8"' >> .yarnrc.yml
             yarn add $PACKAGES --dev
           else
             echo "Sorry I'm not aware of that package manager. Please first init package.json with it yourself manually."