feat: test declarative rendering

Author: bahmutov

README.md

@@ -13,11 +13,76 @@
 Requires [Node](https://nodejs.org/en/) version 6 or above.
 
 ```sh
-npm install --save cypress-vue-unit-test
+npm install --save-dev cypress-vue-unit-test
 ```
 
 ## Use
 
+Take a look at the first Vue v2 example:
+[Declarative Rendering](https://vuejs.org/v2/guide/#Declarative-Rendering).
+The code is pretty simple
+
+```html
+<div id="app">
+  {{ message }}
+</div>
+```
+```js
+var app = new Vue({
+  el: '#app',
+  data: {
+    message: 'Hello Vue!'
+  }
+})
+```
+It shows the message when running in the browser
+```
+Hello Vue!
+```
+
+Let's test it in [Cypress.io][cypress.io] (for the current version see
+[cypress/integration/spec.js](cypress/integration/spec.js)).
+
+```js
+const mountVue = require('cypress-vue-unit-test')
+
+/* eslint-env mocha */
+describe('Declarative rendering', () => {
+  // Vue code from https://vuejs.org/v2/guide/#Declarative-Rendering
+  const template = `
+    <div id="app">
+      {{ message }}
+    </div>
+  `
+
+  const data = {
+    message: 'Hello Vue!'
+  }
+
+  // that's all you need to do
+  beforeEach(mountVue({ template, data }))
+
+  it('shows hello', () => {
+    cy.contains('Hello Vue!')
+  })
+
+  it('changes message if data changes', () => {
+    // mounted Vue instance is available under Cypress.vue
+    Cypress.vue.$data.message = 'Vue rocks!'
+    cy.contains('Vue rocks!')
+  })
+})
+```
+
+Fire up Cypress test runner and have real browser (Electron, Chrome) load
+Vue and mount your test code and be able to interact with the instance through
+the reference `Cypress.vue.$data` and via GUI. The full power of the
+[Cypress API](https://on.cypress.io/api) is available.
+
+![Hello world tested](images/spec.png)
+
+[cypress.io]: https://www.cypress.io/
+
 ### Small print
 
 Author: Gleb Bahmutov &lt;[email protected]&gt; &copy; 2017

cypress.json

@@ -0,0 +1,4 @@
+{
+  "viewportWidth": 300,
+  "viewportHeight": 100
+}

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/integration/spec.js

@@ -0,0 +1,27 @@
+const mountVue = require('../..')
+
+/* eslint-env mocha */
+describe('Declarative rendering', () => {
+  // Vue code from https://vuejs.org/v2/guide/#Declarative-Rendering
+  const template = `
+    <div id="app">
+      {{ message }}
+    </div>
+  `
+
+  const data = {
+    message: 'Hello Vue!'
+  }
+
+  beforeEach(mountVue({ template, data }))
+
+  it('shows hello', () => {
+    cy.contains('Hello Vue!')
+  })
+
+  it('changes message if data changes', () => {
+    // mounted Vue instance is available under Cypress.vue
+    Cypress.vue.$data.message = 'Vue rocks!'
+    cy.contains('Vue rocks!')
+  })
+})

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

images/spec.png

@@ -58,10 +58,12 @@
     "pretty": "prettier-standard 'src/*.js'",
     "secure": "nsp check",
     "size": "t=\"$(npm pack .)\"; wc -c \"${t}\"; tar tvf \"${t}\"; rm \"${t}\";",
-    "test": "npm run unit",
+    "test": "npm run cy:run",
     "unit": "mocha src/*-spec.js",
     "unused-deps": "dependency-check --unused --no-dev .",
-    "semantic-release": "semantic-action pre && npm publish && semantic-action post"
+    "semantic-release": "semantic-action pre && npm publish && semantic-action post",
+    "cy:open": "cypress open",
+    "cy:run": "cypress run"
   },
   "release": {
     "analyzeCommits": "simple-commit-message"
@@ -78,7 +80,11 @@
     "pre-git": "3.16.0",
     "prettier-standard": "8.0.0",
     "semantic-action": "1.1.0",
+    "simple-commit-message": "3.3.2",
     "standard": "10.0.3",
     "vue": "2.5.13"
+  },
+  "standard": {
+    "globals": [ "Cypress", "cy" ]
   }
 }

package.json

@@ -42,8 +42,21 @@ function deleteCachedConstructors (component) {
   Cypress._.values(component.components).forEach(deleteConstructor)
 }
 
+const vueHtml = `
+<html>
+<head></head>
+<body>
+  <script src="../node_modules/vue/dist/vue.js"></script>
+  <div id="app"></div>
+</body>
+</html>
+`
+
 const mountVue = component => () => {
-  cy.visit('index.html')
+  cy.document().then(document => {
+    document.write(vueHtml)
+    document.close()
+  })
   cy
     .window()
     .its('Vue')