feat: basic cypress e2e tests

Author: 3cp

README.md

@@ -24,7 +24,8 @@ npx makes aurelia
 - [x] Basic app with FuseBox
 - [x] Basic app with dumber (successor of CLI built-in bundler. Doc WIP)
 - [ ] Basic unit test setup for jest, jasmine, mocha, tape, ava
-- [ ] Basic e2e test setup for cypress, protractor
+- [x] Basic e2e test setup for cypress
+- [ ] Basic e2e test setup for protractor
 - [ ] Aurelia convention support (boilerplate free like Aurelia v1) at bundler level
 
 ## Development

browserify/gulpfile.js

@@ -40,8 +40,8 @@ function startServer(done) {
   browserSync.init({
     ghostMode: false,
     online: false,
-    watch: true, // watch dist/bundle.js
     open: !process.env.CI,
+    port: 9000,
     server: {
       baseDir: ['.'],
       middleware: [

cypress/README.md

@@ -0,0 +1,23 @@
+
+## Cypress e2e test
+
+All e2e tests are in `cypress/integration/`.
+// @if typescript
+Note the source code of the app and unit tests is in TypeScript, but e2e tests are in plain ESNext JavaScript. You can however [write e2e tests in TypeScript too for Cypress](https://docs.cypress.io/guides/tooling/typescript-support.html#Transpiling-TypeScript-test-files).
+// @endif
+
+First, run the app in dev mode
+
+    npm start
+
+Then run e2e tests in another terminal window with
+
+    npm run test:e2e
+
+Note if your dev app is not running on port 9000, you need to modify `cypress.json` to update dev app port.
+
+To run Cypress interactively, do
+
+    npx cypress open
+
+For more information, visit https://www.cypress.io

cypress/cypress.json

@@ -0,0 +1,3 @@
+{
+  "baseUrl": "http://localhost:9000"
+}

cypress/cypress/.eslintrc

@@ -0,0 +1,19 @@
+{
+  "root": true,
+  "extends": "eslint:recommended",
+  "parser": "babel-eslint",
+  "parserOptions": {
+    "ecmaVersion": 6,
+    "sourceType": "module",
+    "ecmaFeatures": {
+      "legacyDecorators": true
+    }
+  },
+  "rules": {
+    "no-console": 0
+  },
+  "env": {
+    "es6": true,
+    "browser": true
+  }
+}

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

@@ -0,0 +1,8 @@
+/// <reference types="Cypress" />
+
+context('The app', () => {
+  it('shows message', () => {
+    cy.visit('/');
+    cy.get('app>div').contains('Hello World!');
+  });
+});

cypress/cypress/plugins/index.js

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

cypress/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 is will overwrite an existing command --
+// Cypress.Commands.overwrite("visit", (originalFn, url, options) => { ... })

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