TD-1 Add Cypress for testing locally and in CI

.github/workflows/tests.yml

@@ -0,0 +1,30 @@
+name: Run Cypress tests
+
+on:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.1'
+          bundler-cache: true # runs 'bundle install'
+
+      - name: Set up Node.js
+        uses: actions/[email protected]
+        with:
+          node-version: '20'
+
+      - name: Cypress run
+        uses: cypress-io/github-action@v6 # runs 'npm ci'
+        with:
+          start: npm start
+          wait-on: 'http://localhost:4000'

.gitignore

@@ -3,3 +3,4 @@
 /*/.DS_Store
 _site
 .jekyll-cache
+node_modules

cypress.config.js

@@ -0,0 +1,9 @@
+import { defineConfig } from 'cypress';
+
+export default defineConfig({
+  e2e: {
+    setupNodeEvents(on, config) {
+      // implement node event listeners here
+    }
+  }
+});

cypress/e2e/feedback.cy.js

@@ -0,0 +1,41 @@
+const editBaseUrl = 'https://github.com/archivesspace/tech-docs/edit/master/';
+const issueBaseUrl =
+  'https://github.com/archivesspace/tech-docs/issues/new?title=Problem+on+';
+
+describe('Feedback', () => {
+  it('includes an edit this page on GitHub link on every page', () => {
+    let file = 'README.md';
+    cy.visit('http://localhost:4000/');
+    cy.get('a')
+      .contains('Edit this page on GitHub')
+      .should('have.attr', 'href', `${editBaseUrl}${file}`)
+      .children()
+      .should('have.text', file);
+
+    file = 'readme_develop.md';
+    cy.visit('http://localhost:4000/readme_develop');
+    cy.get('a')
+      .contains('Edit this page on GitHub')
+      .should('have.attr', 'href', `${editBaseUrl}${file}`)
+      .children()
+      .should('have.text', file);
+  });
+
+  it('includes a report issue on GitHub link on every page', () => {
+    let file = 'README.md';
+    cy.visit('http://localhost:4000/');
+    cy.get('a')
+      .contains('Report issue on GitHub')
+      .should('have.attr', 'href', `${issueBaseUrl}${file}`)
+      .children()
+      .should('have.text', file);
+
+    file = 'readme_develop.md';
+    cy.visit('http://localhost:4000/readme_develop');
+    cy.get('a')
+      .contains('Report issue on GitHub')
+      .should('have.attr', 'href', `${issueBaseUrl}${file}`)
+      .children()
+      .should('have.text', file);
+  });
+});

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/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')