feat(testWithSpectron): vue add option for testing with spectron

Author: nklayman

generator/index.js

@@ -1,13 +1,22 @@
 const fs = require('fs')
 
 module.exports = (api, options = {}) => {
+  if (!options.electronBuilder) options.electronBuilder = {}
   const usesTS = api.hasPlugin('typescript')
   const hasBackground =
     fs.existsSync(api.resolve(`./src/background.ts`)) ||
     fs.existsSync(api.resolve(`./src/background.js`))
   if (!hasBackground) {
     // If user does not have a background file so it should be created
-    api.render('./template')
+    api.render('./templates/base')
+  }
+  // Add tests
+  if (options.electronBuilder.addTests) {
+    let testFramework
+    // TODO: support mocha
+    // if (api.hasPlugin('unit-mocha')) testFramework = 'mocha'
+    if (api.hasPlugin('unit-jest')) testFramework = 'jest'
+    if (testFramework) api.render(`./templates/tests-${testFramework}`)
   }
   api.onCreateComplete(() => {
     // Update .gitignore if it exists
@@ -63,7 +72,7 @@ module.exports = (api, options = {}) => {
     postinstallScript = 'electron-builder install-app-deps'
   }
   const devDependencies = {}
-  if (options.electronBuilder && options.electronBuilder.electronVersion) {
+  if (options.electronBuilder.electronVersion) {
     // Use provided electron version
     devDependencies.electron = options.electronBuilder.electronVersion
   }

generator/template/src/background.js renamed to generator/templates/base/src/background.js

@@ -0,0 +1,28 @@
+const { testWithSpectron } = require('vue-cli-plugin-electron-builder')
+jest.setTimeout(50000)
+
+test('Window Loads Properly', async () => {
+  // Wait for dev server to start
+  const { app, stopServe } = await testWithSpectron()
+  const win = app.browserWindow
+  const client = app.client
+
+  // Window was created
+  expect(await client.getWindowCount()).toBe(1)
+  // It is not minimized
+  expect(await win.isMinimized()).toBe(false)
+  // Window is visible
+  expect(await win.isVisible()).toBe(true)
+  // Size is correct
+  const { width, height } = await win.getBounds()
+  expect(width).toBeGreaterThan(0)
+  expect(height).toBeGreaterThan(0)
+  // App is loaded properly
+  expect(
+    /Welcome to Your Vue\.js (\+ TypeScript )?App/.test(
+      await client.getHTML('#app')
+    )
+  ).toBe(true)
+
+  await stopServe()
+})

generator/templates/tests-jest/tests/unit/electron.spec.js

@@ -15,6 +15,7 @@ module.exports = {
   testPathIgnorePatterns: [
     '/node_modules/',
     '/__tests__/projects/',
+    '/generator/templates',
     '.*.helper.js'
   ]
 }

jest.config.js

@@ -28,5 +28,24 @@ module.exports = [
         return true
       }
     }
+  },
+  {
+    name: 'electronBuilder.addTests',
+    type: 'confirm',
+    message: 'Add tests with Spectron to your project?',
+    when: () => {
+      try {
+        // Attempt to read package.json
+        const pkg = require(path.join(process.cwd(), 'package.json'))
+        // Don't show if electron version is already set
+        return pkg.devDependencies['@vue/cli-plugin-unit-jest']
+        // TODO: add support for mocha
+        // ||
+        // pkg.devDependencies['@vue/cli-plugin-unit-mocha']
+      } catch (e) {
+        console.log('Unable to read package.json')
+        return false
+      }
+    }
   }
 ]