feat(testWithSpectron): allow using custom version of spectron

Author: nklayman

__tests__/commands.spec.js

@@ -10,6 +10,7 @@ const portfinder = require('portfinder')
 const Application = require('spectron').Application
 const { chainWebpack, getExternals } = require('../lib/webpackConfig')
 const chokidar = require('chokidar')
+const spectron = require('spectron')
 // #endregion
 
 // #region Mocks
@@ -826,7 +827,7 @@ describe('testWithSpectron', async () => {
         }
       }
     })
-    const testPromise = testWithSpectron(spectronOptions)
+    const testPromise = testWithSpectron(spectron, spectronOptions)
     // Mock console.log from electron:serve
     if (launchOptions.customLog) await sendData(launchOptions.customLog)
     await sendData(`$outputDir=${launchOptions.outputDir || 'dist_electron'}`)

generator/index.js

@@ -110,6 +110,10 @@ module.exports = (api, options = {}) => {
     devDependencies.electron = electronVersion
   }
   const dependencies = {}
+  if (testFramework) {
+    // Spectron version should be electron version + 2
+    devDependencies.spectron = '^' + (parseInt(electronVersion.match(/^\^(\d*)\./)[1]) + 2) + '.0.0'
+  }
   if (testFramework === 'mocha') {
     dependencies['chai-as-promised'] = '^7.1.1'
   }

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

@@ -1,9 +1,13 @@
+/**
+ * @jest-environment node
+ */
+const spectron = require('spectron')
 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 { app, stopServe } = await testWithSpectron(spectron)
   const win = app.browserWindow
   const client = app.client
 

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

@@ -1,3 +1,4 @@
+import spectron from 'spectron'
 import testWithSpectron from 'vue-cli-plugin-electron-builder/lib/testWithSpectron'
 import chai from 'chai'
 import chaiAsPromised from 'chai-as-promised'
@@ -9,7 +10,7 @@ describe('Application launch', function () {
   this.timeout(30000)
 
   beforeEach(function () {
-    return testWithSpectron().then(instance => {
+    return testWithSpectron(spectron).then(instance => {
       this.app = instance.app
       this.stopServe = instance.stopServe
     })

lib/testWithSpectron.js

@@ -6,14 +6,20 @@ const portfinder = require('portfinder')
 
 portfinder.basePort = 9515
 
-module.exports = (options = {}) =>
+module.exports = (spectron, options = {}) =>
   new Promise(async (resolve, reject) => {
     let log = ''
     let outputDir = ''
     // Launch electron:serve in headless mode
     const child = execa(
-      require.resolve('@vue/cli-service/bin/vue-cli-service'),
-      ['electron:serve', '--headless', '--mode', options.mode || 'test'],
+      'node',
+      [
+        require.resolve('@vue/cli-service/bin/vue-cli-service'),
+        'electron:serve',
+        '--headless',
+        '--mode',
+        options.mode || 'test'
+      ],
       {
         env: {
           ...process.env,
@@ -53,7 +59,7 @@ module.exports = (options = {}) =>
             options.spectronOptions
           )
           // Launch app with spectron
-          app = new Application(spectronOptions)
+          app = new spectron.Application(spectronOptions)
           if (!options.noStart) {
             await app.start()
             await app.client.waitUntilWindowLoaded()

package.json

@@ -39,7 +39,6 @@
     "pumpify": "^1.5.1",
     "semver": "^6.0.0",
     "shebang-loader": "^0.0.1",
-    "spectron": "^9.0.0",
     "split2": "^3.0.0",
     "terser-webpack-plugin": "^2.0.0",
     "through2-filter": "^3.0.0",
@@ -70,6 +69,7 @@
     "jest": "^24.8.0",
     "lnk": "^1.1.0",
     "rimraf": "^3.0.0",
+    "spectron": "^9.0.0",
     "terminal-tasks": "^0.0.5",
     "typescript": "^3.0.1",
     "vue": "^2.5.20",