Add e2e testing using Cypress

.gitignore

@@ -34,3 +34,6 @@ npm-debug.log
 !.yarn/releases
 !.yarn/sdks
 !.yarn/versions
+
+# cypress
+cypress/videos

README.md

@@ -81,6 +81,16 @@ node server.js
 Now you should be able to access the app on http://localhost:3002
 Port can be changed by setting API_PORT environment variable.
 
+## Running Cypress e2e Tests
+
+Base URL is expected via the environment variable `CYPRESS_BASE_URL`.
+
+The following commnad runs the tests against prod:
+
+```
+CYPRESS_BASE_URL=https://waamd.lib.berkeley.edu yarn run cy:run
+```
+
 ## Running search index scripts
 Search indexing scripts will need to run after content is updated, i.e. a record was added or updated.
 Only two tables need indexing, `manuscripts` and `authors`.

cypress.config.js

@@ -0,0 +1,9 @@
+const { defineConfig } = require("cypress");
+
+module.exports = defineConfig({
+  e2e: {
+    setupNodeEvents(on, config) {
+      // implement node event listeners here
+    },
+  },
+});

cypress/e2e/smoke_test.cy.js

@@ -0,0 +1,16 @@
+/// <reference types="cypress" />
+
+context('Smoke test', () => {
+    it('loads the home page', () => {
+        cy.visit('/');
+        cy.contains('What is WAAMD?');
+    });
+
+    it('returns title search result', () => {
+        cy.visit('/titles');
+        const query = 'نوازل';
+        const expected = 'Showing 1 to';
+        cy.get('#search-query-input').type(`${query}{enter}`);
+        cy.contains(expected);
+    });
+});

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/e2e.js

@@ -0,0 +1,20 @@
+// ***********************************************************
+// This example support/e2e.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')

package.json

@@ -13,6 +13,7 @@
     "bluebird": "^3.4.7",
     "body-parser": "^1.18.3",
     "cookie-parser": "^1.4.3",
+    "cypress": "^12.17.2",
     "dotenv": "^16.3.1",
     "express": "^4.16.3",
     "express-session": "^1.15.6",
@@ -38,7 +39,9 @@
     "search-index": "npm run search:authors && npm run search:manuscripts",
     "search:authors": "node ./bin/generate-authors-search-indexes.js",
     "search:manuscripts": "node ./bin/generate-manuscripts-search-indexes.js",
-    "format": "prettier --single-quote --trailing-comma es5 --tab-width 4 --write \"{client/src,server,__{tests,mocks}__}/**/*.js\""
+    "format": "prettier --single-quote --trailing-comma es5 --tab-width 4 --write \"{client/src,server,cypress,__{tests,mocks}__}/**/*.js\"",
+    "cy:open": "cypress open",
+    "cy:run": "cypress run"
   },
   "packageManager": "[email protected]"
 }