feat: Add e2e testing support using Ava (#303)

Author: vinayakkulkarni

template/_package.json

@@ -28,7 +28,11 @@
     <%_ if (eslint) { _%>
     "lint": "eslint --ext .js,.vue --ignore-path .gitignore .",
     <%_ } _%>
-    <%_ if (test !== 'none') { _%>
+    <%_ if (test === 'ava') { _%>
+    "test": "<%= test %>",
+    "test:unit": "cross-env TEST=unit ava --config unit.config.js",
+    "test:e2e": "cross-env TEST=e2e ava --config e2e.config.js",
+    <%_ } else if (test !== 'none') { _%>
     "test": "<%= test %>",
     <%_ } _%>
     "": ""

template/frameworks/ava/ava.config.js

@@ -1,7 +1,6 @@
 export default {
   require: ['./test/ava.setup.js'],
   sources: ['**/*.{js,vue}'],
-  files: ['test/specs/**/*'],
   babel: {
     testOptions: {
       plugins: [

template/frameworks/ava/e2e.config.js

@@ -0,0 +1,6 @@
+import baseConfig from './ava.config.js'
+
+export default {
+  ...baseConfig,
+  files: ['test/e2e/**/*']
+}

template/frameworks/ava/test/e2e/index.js

@@ -0,0 +1,29 @@
+import { resolve } from 'path'
+import test from 'ava'
+import { Nuxt, Builder } from 'nuxt'
+
+// We keep the nuxt and server instance
+// So we can close them at the end of the test
+let nuxt = null
+
+// Init Nuxt.js and create a server listening on localhost:4000
+test.before(async () => {
+  const config = {
+    dev: false,
+    rootDir: resolve(__dirname, '../../')
+  }
+  nuxt = new Nuxt(config)
+  await new Builder(nuxt).build()
+  await nuxt.server.listen(4000, 'localhost')
+}, 30000)
+
+// Example of testing only generated html
+test('Route / exits and render HTML', async (t) => {
+  const { html } = await nuxt.renderRoute('/', {})
+  t.true(html.includes('Documentation'))
+})
+
+// Close server and ask nuxt to stop listening to file changes
+test.after('Closing server and nuxt.js', (t) => {
+  nuxt.close()
+})

template/frameworks/ava/unit.config.js

@@ -0,0 +1,6 @@
+import baseConfig from './ava.config.js'
+
+export default {
+  ...baseConfig,
+  files: ['test/specs/**/*']
+}

test/snapshots/index.test.js.md

@@ -1942,6 +1942,7 @@ Generated by [AVA](https://ava.li).
       'ava.config.js',
       'components/Logo.vue',
       'components/README.md',
+      'e2e.config.js',
       'layouts/README.md',
       'layouts/default.vue',
       'middleware/README.md',
@@ -1954,7 +1955,9 @@ Generated by [AVA](https://ava.li).
       'static/favicon.ico',
       'store/README.md',
       'test/ava.setup.js',
+      'test/e2e/index.js',
       'test/specs/Logo.spec.js',
+      'unit.config.js',
     ]
 
 > package.json
@@ -1979,6 +1982,8 @@ Generated by [AVA](https://ava.li).
         generate: 'nuxt generate',
         start: 'nuxt start',
         test: 'ava',
+        'test:e2e': 'cross-env TEST=e2e ava --config e2e.config.js',
+        'test:unit': 'cross-env TEST=unit ava --config unit.config.js',
       },
     }