feat: integrate Cypress end-to-end testing (resolves #84)

.github/workflows/cypress.yml

@@ -0,0 +1,25 @@
+name: End-to-end tests
+
+on: [pull_request]
+
+jobs:
+  cypress-run:
+    name: Run end-to-end-tests with Cypress
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Cache node modules
+      uses: actions/cache@v1
+      with:
+        path: node_modules
+        key: ${{ runner.OS }}-build-${{ hashFiles('**/package-lock.json') }}
+    - name: Install dependencies
+      run: npm i
+      env:
+        CI: true
+    - name: Run Cypress
+      uses: cypress-io/github-action@v2
+      with:
+        start: npm start
+        wait-on: 'http://localhost:3000'

.github/workflows/lint.yml

@@ -14,7 +14,8 @@ jobs:
     name: Lint JavaScript and SCSS
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v1
+    - name: Checkout
+      uses: actions/checkout@v2
     - name: Cache node modules
       uses: actions/cache@v1
       with:

.gitignore

@@ -113,6 +113,11 @@ src/_data/assets.json
 # Local Netlify folder
 .netlify
 
+# Cypress data
+cypress/screenshots
+cypress/videos
+cypress/reports
+
 # Backstop data
 backstop_data/*
 !backstop_data/engine_scripts

cypress.json

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

cypress/integration/menu.spec.js

@@ -0,0 +1,10 @@
+describe('Mobile menu', () => {
+	it('Mobile menu expands when clicked', () => {
+		cy.visit('http://localhost:3000');
+
+		// Get an input, type into it and verify that the value has been updated
+		cy.get('.menu-toggle')
+			.click()
+			.should('have.attr', 'aria-expanded', 'true');
+	});
+});

cypress/integration/regression.spec.js

@@ -0,0 +1,5 @@
+describe('Using backstopjs', () => {
+	it('Generate report using Backstop JS', () => {
+		cy.task('backstopTest', {folder: 'idrc'}, {timeout: 820000});
+	});
+});

cypress/plugins/index.js

@@ -0,0 +1,57 @@
+/* eslint camelcase: ["error", {properties: "never"}] */
+
+const backstop = require('backstopjs');
+
+const config = require('../fixtures/backstop.config.js');
+
+/**
+ * Run BackstopJS as code
+ * Scenarios and Report folder name can be set via params
+*/
+function backstopExec(payload, refreshReferences = true) {
+	payload = {
+		scenarios: [],
+		folder: 'default',
+		...payload
+	};
+
+	return new Promise(resolve => {
+		const configuration = config;
+		// Config.scenarios = payload.scenarios
+		config.paths.html_report = `cypress/reports/backstop/${payload.folder}/html_report`;
+		config.paths.json_report = `cypress/reports/backstop/${payload.folder}/json_report`;
+
+		if (refreshReferences) {
+			backstop('reference', {config: configuration, docker: true}).then(() => {
+				resolve(null);
+			}).catch(() => {
+				resolve(null);
+			});
+		} else {
+			backstop('test', {config: configuration, docker: true}).then(() => {
+				resolve(null);
+			}).catch(() => {
+				resolve(null);
+			});
+		}
+	});
+}
+
+/**
+ * @type {Cypress.PluginConfig}
+ */
+module.exports = (on, config) => { // eslint-disable-line no-unused-vars
+	backstop('init');
+	on('task', {
+		log(message) { // eslint-disable-line react/function-component-definition
+			console.log(message);
+			return null;
+		},
+		backstopRefreshReferences(config) {
+			return backstopExec(config);
+		},
+		backstopTest(config) {
+			return backstopExec(config, false);
+		}
+	});
+};

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 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'; // eslint-disable-line import/no-unassigned-import
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')