Merge pull request #49 from mackbrowne/feature/visual-testing

add visual testing

Author: mackbrowne

.circleci/config.yml

@@ -0,0 +1,36 @@
+version: 2.1
+orbs:
+  snyk: snyk/snyk@0.0.8
+  cypress: cypress-io/cypress@1
+jobs:
+  build:
+    docker:
+      - image: circleci/node:12.9.1-browsers
+
+    working_directory: ~/repo
+    steps:
+      - checkout
+
+      - restore_cache:
+          name: Restore Yarn Package Cache
+          keys:
+            - yarn-packages-{{ checksum "yarn.lock" }}
+
+      - run:
+          name: Install Dependencies
+          command: yarn install --frozen-lockfile
+
+      - save_cache:
+          name: Save Yarn Package Cache
+          key: yarn-packages-{{ checksum "yarn.lock" }}
+          paths:
+            - ~/.cache/yarn
+
+      - run:
+          name: Run Cypress Tests
+          command: yarn ci
+
+      - snyk/scan:
+          fail-on-issues: false
+          monitor-on-build: false
+          severity-threshold: high

.gitignore

@@ -24,4 +24,7 @@ yarn-error.log*
 
 # Firebase
 .firebase/
-firebase-debug.log*
+firebase-debug.log*
+
+# Cypress
+cypress/videos

cypress.json

@@ -0,0 +1,3 @@
+{
+  "projectId": "xp8wm7"
+}

cypress/fixtures/example.json

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

cypress/integration/examples/example.spec.js

@@ -0,0 +1,15 @@
+/* eslint-disable no-undef */
+/// <reference types="cypress" />
+
+context('Example', () => {
+  beforeEach(() => {
+    cy.visit('http://localhost:3000')
+  })
+
+  // https://on.cypress.io/interacting-with-elements
+
+  it('Test', () => {
+    cy.get('body').snapshot();
+    cy.percySnapshot()
+  })
+})

cypress/plugins/index.js

@@ -0,0 +1,24 @@
+/// <reference types="cypress" />
+// ***********************************************************
+// 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)
+
+let percyHealthCheck = require('@percy/cypress/task')
+/**
+ * @type {Cypress.PluginConfig}
+ */
+module.exports = (on, config) => {
+  // `on` is used to hook into various events Cypress emits
+  // `config` is the resolved Cypress config 
+  on("task", percyHealthCheck);
+}
+

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,24 @@
+// ***********************************************************
+// 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 '@percy/cypress';
+import snapshots from '@cypress/snapshot';
+// Import commands.js using ES2015 syntax:
+import './commands';
+
+snapshots.register();
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')

package.json

@@ -7,7 +7,9 @@
     "build": "react-scripts build",
     "print-pdf": "chrome-headless-render-pdf --include-background --url=http://localhost:3000 --pdf=public/resume.pdf --url=http://localhost:3000 --pdf=public/MackenzieBrowneResume.pdf",
     "deploy": "firebase deploy",
-    "test": "react-scripts test",
+    "test": "concurrently \"yarn start\" \"cypress\"",
+    "test:ci": "percy exec -- cypress run --record",
+    "ci": "start-server-and-test start http://localhost:3000 test:ci",
     "eject": "react-scripts eject"
   },
   "dependencies": {
@@ -63,5 +65,12 @@
     "hooks": {
       "pre-commit": "lint-staged"
     }
+  },
+  "devDependencies": {
+    "@cypress/snapshot": "^2.1.7",
+    "@percy/cypress": "^2.3.1",
+    "concurrently": "^5.2.0",
+    "cypress": "^4.5.0",
+    "start-server-and-test": "^1.11.0"
   }
 }