feat(tests): add example test for mocha, fixes #128

Author: nklayman

__tests__/testWithSpectron.spec.js

@@ -1,31 +1,31 @@
 jest.setTimeout(100000)
 
 const createProject = require('./createProject.helper.js')
+const { readFile, writeFile } = require('fs-extra')
+const { join } = require('path')
 
-test('basic tests pass', async () => {
-  const { project } = await createProject('spectron', false, {
-    '@vue/cli-plugin-unit-jest': {}
-  })
+test.each(['mocha', 'jest'])(
+  'testWithSpectron works with %s',
+  async testRunner => {
+    const plugins = {}
+    plugins[`@vue/cli-plugin-unit-${testRunner}`] = {}
+    const { project } = await createProject(
+      `spectron-${testRunner}`,
+      false,
+      plugins
+    )
+    // Remove example test
+    await project.rm('tests/unit/example.spec.js')
 
-  // Update jest config to find test
-  const config = JSON.parse(await project.read('package.json'))
-  config.jest.testMatch = ['<rootDir>/tests/unit/spectron.js']
-  await project.write('package.json', JSON.stringify(config))
+    // Copy electron test
+    const testFile = (await readFile(
+      `./generator/templates/tests-${testRunner}/tests/unit/electron.spec.js`,
+      'utf8'
+    ))
+      // Fix some unknown error
+      .replace('testWithSpectron()', 'testWithSpectron({ mode: "production" })')
+    await writeFile(join(project.dir, 'tests/unit/electron.spec.js'), testFile)
 
-  // Create spectron test
-  await project.write(
-    'tests/unit/spectron.js',
-    `jest.setTimeout(60000)
-  const { testWithSpectron } = require('vue-cli-plugin-electron-builder')
-  test('app loads a window', async () => {
-    const { app, stdout, stopServe } = await testWithSpectron({mode: 'production'})
-    expect(await app.client.getWindowCount()).toBe(1)
-    // App is served in production mode
-    expect(stdout.indexOf('App is served in production mode.')).not.toBe(-1)
-    await stopServe()
-  })
-  `
-  )
-  process.env.NODE_ENV = 'production'
-  await project.run('vue-cli-service test:unit')
-})
+    await project.run('vue-cli-service test:unit')
+  }
+)

generator/index.js

@@ -7,14 +7,13 @@ module.exports = (api, options = {}) => {
     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
+    // If user does not have a background file it should be created
     api.render('./templates/base')
   }
   // Add tests
+  let testFramework
   if (options.electronBuilder.addTests) {
-    let testFramework
-    // TODO: support mocha
-    // if (api.hasPlugin('unit-mocha')) testFramework = 'mocha'
+    if (api.hasPlugin('unit-mocha')) testFramework = 'mocha'
     if (api.hasPlugin('unit-jest')) testFramework = 'jest'
     if (testFramework) api.render(`./templates/tests-${testFramework}`)
   }
@@ -89,8 +88,13 @@ module.exports = (api, options = {}) => {
     // Use provided electron version
     devDependencies.electron = options.electronBuilder.electronVersion
   }
+  const dependencies = {}
+  if (testFramework === 'mocha') {
+    dependencies['chai-as-promised'] = '^7.1.1'
+  }
   api.extendPackage({
     scripts,
+    dependencies,
     devDependencies,
     main: 'background.js'
   })

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

@@ -0,0 +1,42 @@
+import testWithSpectron from 'vue-cli-plugin-electron-builder/lib/testWithSpectron'
+import chai from 'chai'
+import chaiAsPromised from 'chai-as-promised'
+
+chai.should()
+chai.use(chaiAsPromised)
+
+describe('Application launch', function () {
+  this.timeout(30000)
+
+  beforeEach(function () {
+    return testWithSpectron().then(instance => {
+      this.app = instance.app
+      this.stopServe = instance.stopServe
+    })
+  })
+
+  beforeEach(function () {
+    chaiAsPromised.transferPromiseness = this.app.transferPromiseness
+  })
+
+  afterEach(function () {
+    if (this.app && this.app.isRunning()) {
+      return this.stopServe()
+    }
+  })
+
+  it('opens a window', function () {
+    return this.app.client
+      .getWindowCount()
+      .should.eventually.have.at.least(1)
+      .browserWindow.isMinimized()
+      .should.eventually.be.false.browserWindow.isVisible()
+      .should.eventually.be.true.browserWindow.isFocused()
+      .should.eventually.be.true.browserWindow.getBounds()
+      .should.eventually.have.property('width')
+      .and.be.above(0)
+      .browserWindow.getBounds()
+      .should.eventually.have.property('height')
+      .and.be.above(0)
+  })
+})

lib/webpackConfig.js

@@ -36,6 +36,22 @@ async function chainWebpack (api, pluginOptions, config) {
     // Apply user config
     rendererProcessChain(config)
   }
+
+  if (process.env.NODE_ENV === 'test') {
+    // Configure for mocha-webpack
+    config.module
+      .rule('shebang')
+      .test(/\.js$/)
+      .use('shebang')
+      .loader('shebang-loader')
+    config.externals({
+      'vue-cli-plugin-electron-builder/lib/testWithSpectron':
+        'require("vue-cli-plugin-electron-builder/lib/testWithSpectron")',
+      'vue-cli-plugin-electron-builder':
+        'require("vue-cli-plugin-electron-builder")'
+    })
+  }
+
   // Older generated files expect this
   process.env.VUE_APP_NODE_MODULES_PATH = false
 }

package.json

@@ -35,6 +35,7 @@
     "lodash.merge": "^4.6.1",
     "portfinder": "^1.0.16",
     "pumpify": "^1.5.1",
+    "shebang-loader": "^0.0.1",
     "spectron": "^5.0.0",
     "split2": "^3.0.0",
     "terser-webpack-plugin": "^1.1.0",
@@ -51,9 +52,12 @@
     "@vue/cli-plugin-eslint": "^3.0.1",
     "@vue/cli-plugin-typescript": "^3.0.1",
     "@vue/cli-plugin-unit-jest": "^3.0.1",
+    "@vue/cli-plugin-unit-mocha": "^3.4.0",
     "@vue/cli-service": "^3.0.1",
     "@vue/cli-test-utils": "^3.0.1",
     "@vue/eslint-config-typescript": "^3.0.1",
+    "chai": "^4.2.0",
+    "chai-as-promised": "^7.1.1",
     "electron": "^4.0.0",
     "eslint-config-standard": "^12.0.0",
     "eslint-plugin-import": "^2.14.0",

prompts.js

@@ -44,10 +44,10 @@ module.exports = [
         // 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']
+        return (
+          pkg.devDependencies['@vue/cli-plugin-unit-jest'] ||
+          pkg.devDependencies['@vue/cli-plugin-unit-mocha']
+        )
       } catch (e) {
         console.log('Unable to read package.json')
         return false