Tests and test docs

Author: Gabe Fiji

README.md

@@ -136,19 +136,34 @@ ws.start()
 
 At the moment only `SharedWorker` and `Worker` are supported. `ServiceWorker` is not. 
 
-### To develop:
+### Develop
 
 ```bash
 git clone https://github.com/IguMail/socketio-shared-webworker
 cd socketio-shared-webworker
 npm install
-# Start development server with HMR
+# Start example/dev-server.js with HMR
 npm run dev
+# edit example/app.js, src/shared-worker.js, src/socket.io-worker.js etc.
 ``` 
 
 In chrome visit the URL: chrome://inspect/#workers so see shared webworkers and inspect, debug.
 Visit the `index.html` in the browser for the demo. 
 
+### Test
+
+```bash
+git clone https://github.com/IguMail/socketio-shared-webworker
+cd socketio-shared-webworker
+npm install
+# Start development server with HMR
+npm run dev
+# Run unit tests
+npm test 
+# Run e2e tests
+npm run test:e2e
+``` 
+
 ### Production build
 
 ```bash

cypress.json

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

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/socket.io-worker/socket.io-worker.js

@@ -0,0 +1,13 @@
+'use strict'
+
+/// <reference types="cypress" />
+
+context('socket.io-worker', () => {
+    beforeEach(() => {
+        cy.visit('http://localhost:3000')
+    })
+
+    it('creates socket.io-worker', () => {
+        cy.window().should('have.property', 'wio')
+    })
+})

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
+}

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'
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')