Infrastructure: Added E2E testing with Cypress.

Author: shakedlokits

README.md

@@ -18,6 +18,15 @@ The all-in-one DataHack management platform, from registration to communications
 3. Wait for backups to be pulled from AWS automatically
 4. Populate the database by running `./scripts/backup restore lastest`
 
+## Testing
+
+To test the project we use [Cypress](https://www.cypress.io/) running through docker and X11 rendering server.
+
+- In order to run the tests through CLI run `./scripts test cli`
+- If you want to run the tests interactively you should run `./scripts test gui`
+
+> *Note:* On macOS and Windows, and X11 server will be required, [XQuartz](https://www.xquartz.org/) is the standard X11 server for macOS and you will need to tick the [Allow connections from network clients](https://blogs.oracle.com/oraclewebcentersuite/running-gui-applications-on-native-docker-containers-for-mac) and restart Quartz.
+
 ## Contributing
 
 Please read [CONTRIBUTING](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

cypress.json

@@ -0,0 +1 @@
+{}

cypress/fixtures/example.json

@@ -0,0 +1,5 @@
+{
+  "name": "Using fixtures to represent data",
+  "email": "[email protected]",
+  "body": "Fixtures are a great way to mock data for responses to routes"
+}

cypress/integration/sample_spec.js

@@ -0,0 +1,5 @@
+describe('Sample test', function() {
+  it('Does not do much!', function() {
+    expect(true).to.equal(true)
+  })
+})

cypress/plugins/index.js

@@ -0,0 +1,17 @@
+// ***********************************************************
+// This example plugins/index.js can be used to load plugins
+//
+// You can change the location of this file or turn off loading
+// the plugins file with the 'pluginsFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/plugins-guide
+// ***********************************************************
+
+// This function is called when a project is opened or re-opened (e.g. due to
+// the project's config changing)
+
+module.exports = (on, config) => {
+  // `on` is used to hook into various events Cypress emits
+  // `config` is the resolved Cypress config
+}

cypress/support/commands.js

@@ -0,0 +1,25 @@
+// ***********************************************
+// This example commands.js shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+//
+//
+// -- This is a parent command --
+// Cypress.Commands.add("login", (email, password) => { ... })
+//
+//
+// -- This is a child command --
+// Cypress.Commands.add("drag", { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add("dismiss", { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This is will overwrite an existing command --
+// Cypress.Commands.overwrite("visit", (originalFn, url, options) => { ... })

cypress/support/index.js

@@ -0,0 +1,20 @@
+// ***********************************************************
+// This example support/index.js is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import './commands'
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')

scripts/test

@@ -0,0 +1,33 @@
+#!/usr/bin/env bash
+
+SCRIPTS_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" >/dev/null 2>&1 && pwd)"
+ROOT_DIRECTORY=${SCRIPTS_DIR}/..
+
+function test_in_cli() {
+  docker run -it -v "$ROOT_DIRECTORY:/e2e" -e CYPRESS_VIDEO=false -w /e2e cypress/included:3.2.0
+}
+
+function test_in_gui() {
+  if hash xhost 2>/dev/null; then
+    xhost + 127.0.0.1
+    docker run --rm -it -v "$ROOT_DIRECTORY:/e2e" -w /e2e \
+      -e DISPLAY=host.docker.internal:0 -e CYPRESS_VIDEO=false \
+      --entrypoint cypress cypress/included:3.2.0 open --project .
+  else
+    echo "Oh no! You need to install Quartz X11 for GUI binding :("
+  fi
+}
+
+case "$1" in
+cli)
+  test_in_cli
+  ;;
+
+gui)
+  test_in_gui
+  ;;
+*)
+  echo $"Usage: ${0##*/} {cli | gui}"
+  exit 1
+  ;;
+esac