Adds instructions for adding Nightwatch capability to local environment

README.md

@@ -85,3 +85,15 @@ Linux            | Docker CE, docker-compose  | Your preferred terminal applicat
 
 This may take a few minutes and will provide you with a set of URLs and further instructions for using your contribution environment.
 
+#### Optional configuration
+
+To add Nightwatch to your local environment,
+
+1. Open the `examples/commands/web/` directory.
+2. Copy the `nightwatch`, `yarn` and `phpunit` files into the .ddev/commands/web directory of your local instance.
+3. Copy the `docker-compose.testing.yaml` file into the .ddev/ directory of your local instance.
+4. Open a terminal in the drupal directory of your local instance.
+5. Run `ddev restart` if your local instance is running or `ddev start` to start your local instance.
+6. Run `ddev yarn install` or change directory into drupal/core and run `yarn install`
+7. Run `ddev nightwatch --tags=core` to run all core Nightwatch tests!
+

examples/commands/web/nightwatch

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+## Description: Run Nightwatch
+## Usage: nightwatch [flags] [args]
+## Example: "ddev nightwatch" or "ddev nightwatch --tag core"
+
+yarn --cwd /var/www/html/core test:nightwatch $@

examples/commands/web/phpunit

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+## Description: Run PHPUnit
+## Usage: phpunit [flags] [args]
+## Example: "ddev phpunit --group big_pipe" or "ddev phpunit core/modules/action"
+
+php ./vendor/bin/phpunit -c core/phpunit.xml.dist $@

examples/commands/web/yarn

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+## Description: Run Yarn inside Drupal Core
+## Usage: yarn <command>
+## Example: "ddev yarn install"
+
+yarn --cwd /var/www/html/core $@

examples/docker-compose.testing.yaml

@@ -0,0 +1,32 @@
+---
+# Adds Chromedriver and Drupal PHPUnit test environment variables for running tests.
+version: '3.6'
+services:
+  chromedriver:
+    image: drupalci/chromedriver:production
+    container_name: ddev-${DDEV_SITENAME}-chromedriver
+    labels:
+      com.ddev.site-name: ${DDEV_SITENAME}
+      com.ddev.approot: $DDEV_APPROOT
+
+  web:
+    links:
+      - chromedriver:$DDEV_HOSTNAME
+    environment:
+      # PHPUnit
+      SYMFONY_DEPRECATIONS_HELPER: weak
+      SIMPLETEST_DB: mysql://db:db@db:3306/db
+      SIMPLETEST_BASE_URL: http://web
+      BROWSERTEST_OUTPUT_DIRECTORY: /var/www/html/private/browsertest_output
+      BROWSERTEST_OUTPUT_BASE_URL: $DDEV_PRIMARY_URL
+      MINK_DRIVER_ARGS_WEBDRIVER: '["chrome", {"browserName":"chrome","chromeOptions":{"args":["--disable-gpu","--headless", "--no-sandbox"]}}, "http://chromedriver:9515"]'
+
+      # Nightwatch
+      DRUPAL_TEST_BASE_URL: http://web
+      DRUPAL_TEST_DB_URL: mysql://db:db@db:3306/db
+      DRUPAL_TEST_WEBDRIVER_HOSTNAME: chromedriver
+      DRUPAL_TEST_WEBDRIVER_PORT: 9515
+      DRUPAL_TEST_CHROMEDRIVER_AUTOSTART: 'false'
+      DRUPAL_TEST_WEBDRIVER_CHROME_ARGS: "--disable-gpu --headless --no-sandbox"
+      DRUPAL_NIGHTWATCH_OUTPUT: reports/nightwatch
+      DRUPAL_NIGHTWATCH_IGNORE_DIRECTORIES: node_modules,vendor,.*,sites/*/files,sites/*/private,sites/simpletest

package_drupal_script.sh

@@ -150,6 +150,9 @@ popd >/dev/null
 cp -r ${REPO_DIR}/licenses ${REPO_DIR}/COPYING "$STAGING_DIR/"
 cp ${REPO_DIR}/.quicksprint_release.txt $REPO_DIR/.ddev_version.txt "$STAGING_DIR/sprint"
 
+# Copy ddev optional commands and configuration.
+cp -r ${REPO_DIR}/examples "${STAGING_DIR}/"
+
 cd ${STAGING_DIR}
 
 echo "Creating sprint.tar.xz..."