test: install and e2e test library with cypress

.circleci/config.yml

@@ -2,17 +2,35 @@ version: 2.1
 executors:
   node:
     docker:
-      - image: cimg/node:12.13.0
+      - image: cypress/browsers:node12.13.0-chrome78-ff70
     working_directory: ~/repo
     resource_class: small
 jobs:
   build:
     executor: node
     steps:
       - checkout
+
+      # Install deps and run unit tests
       - run: npm ci
       - run: npm test
 
+      # Install the package as dependency and test that it works in a browser
+      - run: npm run build
+      - run:
+          command: npm ci
+          working_directory: e2e
+      - run:
+          command: npm run build
+          working_directory: e2e
+      - run:
+          command: npx http-server www
+          working_directory: e2e
+          background: true
+      - run:
+          command: npx cypress run
+          working_directory: e2e
+
 workflows:
   version: 2
 

.eslintrc.json

@@ -1,12 +1,14 @@
 {
     "env": {
-        "browser": true,
+      "browser": true,
       "es2020": true,
-      "jest/globals": true
+      "jest/globals": true,
+      "cypress/globals": true
     },
-  "plugins": ["jest"],
+  "plugins": ["jest", "cypress"],
     "extends": [
-        "airbnb-base"
+        "airbnb-base",
+        "plugin:cypress/recommended"
     ],
     "parserOptions": {
         "ecmaVersion": 12,

.gitignore

@@ -102,3 +102,5 @@ dist
 
 # TernJS port file
 .tern-port
+
+e2e/www/index.js

e2e/cypress.json

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

e2e/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"
+}

e2e/cypress/integration/library.spec.js

@@ -0,0 +1,20 @@
+describe('@purple-dot/purple-dot-js', () => {
+  beforeEach(() => {
+    Cypress.on('window:before:load', (win) => {
+      cy.spy(win.console, 'error');
+      cy.spy(win.console, 'warn');
+    });
+
+    cy.visit('http://localhost:8080/');
+  });
+
+  it('Loads the Purple Dot SDK without warnings or errors', () => {
+    // https://on.cypress.io/window
+    cy.window().should('have.property', 'PurpleDot');
+
+    cy.window().then((win) => {
+      expect(win.console.error).to.have.callCount(0);
+      expect(win.console.warn).to.have.callCount(0);
+    });
+  });
+});

e2e/cypress/plugins/index.js

@@ -0,0 +1,21 @@
+/// <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)
+
+/**
+ * @type {Cypress.PluginConfig}
+ */
+module.exports = (on, config) => {
+  // `on` is used to hook into various events Cypress emits
+  // `config` is the resolved Cypress config
+}

e2e/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) => { ... })

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

e2e/index.js

@@ -0,0 +1,3 @@
+import { loadPurpleDot } from '@purple-dot/purple-dot-js';
+
+loadPurpleDot().then(() => console.log('yay')).catch(err => console.error(err));