merge tests into v1-dev branch as they work now (#28)

* initial test setup (broken)

* update file path (still broken with same error)

* write build tests (works now)

No serve tests yet, coming soon.

Author: nklayman

.eslintrc.js

@@ -1,3 +1,6 @@
 module.exports = {
-    "extends": "standard"
-};
+  extends: 'standard',
+  env: {
+    jest: true
+  }
+}

.gitignore

@@ -57,3 +57,5 @@ typings/
 # dotenv environment variables file
 .env
 
+# Vue Cli test projects
+/__tests__/projects

.vscode/launch.json

@@ -0,0 +1,25 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "name": "vscode-jest-tests",
+      "request": "launch",
+      "args": ["--runInBand"],
+      "cwd": "${workspaceFolder}",
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen",
+      "program": "${workspaceFolder}/node_modules/jest/bin/jest"
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Run tests",
+      "console": "integratedTerminal",
+      "program": "${workspaceFolder}\\node_modules/jest/bin/jest"
+    }
+  ]
+}

__tests__/__snapshots__/build.spec.js.snap

@@ -0,0 +1,9 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`build:electron 1`] = `
+"<div id=\\"app\\"><img src=\\"./img/logo.82b9c7a5.png\\"><div data-v-20cac705=\\"\\" class=\\"hello\\"><h1 data-v-20cac705=\\"\\">Welcome to Your Vue.js App</h1><p data-v-20cac705=\\"\\">
+    For guide and recipes on how to configure / customize this project,<br data-v-20cac705=\\"\\">
+    check out the
+    <a data-v-20cac705=\\"\\" href=\\"https://cli.vuejs.org\\" target=\\"_blank\\">vue-cli documentation</a>.
+  </p><h3 data-v-20cac705=\\"\\">Installed CLI Plugins</h3><ul data-v-20cac705=\\"\\"><li data-v-20cac705=\\"\\"><a data-v-20cac705=\\"\\" href=\\"https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/cli-plugin-babel\\" target=\\"_blank\\">babel</a></li><li data-v-20cac705=\\"\\"><a data-v-20cac705=\\"\\" href=\\"https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/cli-plugin-eslint\\" target=\\"_blank\\">eslint</a></li><li data-v-20cac705=\\"\\"><a data-v-20cac705=\\"\\" href=\\"https://www.npmjs.com/package/vue-cli-plugin-electron-builder\\" target=\\"_blank\\">electron-builder</a></li></ul><h3 data-v-20cac705=\\"\\">Essential Links</h3><ul data-v-20cac705=\\"\\"><li data-v-20cac705=\\"\\"><a data-v-20cac705=\\"\\" href=\\"https://vuejs.org\\" target=\\"_blank\\">Core Docs</a></li><li data-v-20cac705=\\"\\"><a data-v-20cac705=\\"\\" href=\\"https://forum.vuejs.org\\" target=\\"_blank\\">Forum</a></li><li data-v-20cac705=\\"\\"><a data-v-20cac705=\\"\\" href=\\"https://chat.vuejs.org\\" target=\\"_blank\\">Community Chat</a></li><li data-v-20cac705=\\"\\"><a data-v-20cac705=\\"\\" href=\\"https://twitter.com/vuejs\\" target=\\"_blank\\">Twitter</a></li></ul><h3 data-v-20cac705=\\"\\">Ecosystem</h3><ul data-v-20cac705=\\"\\"><li data-v-20cac705=\\"\\"><a data-v-20cac705=\\"\\" href=\\"https://router.vuejs.org\\" target=\\"_blank\\">vue-router</a></li><li data-v-20cac705=\\"\\"><a data-v-20cac705=\\"\\" href=\\"https://vuex.vuejs.org\\" target=\\"_blank\\">vuex</a></li><li data-v-20cac705=\\"\\"><a data-v-20cac705=\\"\\" href=\\"https://github.com/vuejs/vue-devtools#vue-devtools\\" target=\\"_blank\\">vue-devtools</a></li><li data-v-20cac705=\\"\\"><a data-v-20cac705=\\"\\" href=\\"https://vue-loader.vuejs.org\\" target=\\"_blank\\">vue-loader</a></li><li data-v-20cac705=\\"\\"><a data-v-20cac705=\\"\\" href=\\"https://github.com/vuejs/awesome-vue\\" target=\\"_blank\\">awesome-vue</a></li></ul></div></div>"
+`;

__tests__/build.spec.js

@@ -0,0 +1,88 @@
+jest.setTimeout(600000)
+
+const create = require('@vue/cli-test-utils/createTestProject')
+const { defaultPreset } = require('@vue/cli/lib/options')
+const path = require('path')
+const fs = require('fs-extra')
+const Application = require('spectron').Application
+
+const projectPath = p => path.join(process.cwd(), '__tests__/projects/build', p)
+
+test('build:electron', async () => {
+  let project
+  // Install vcp-electron-builder
+  defaultPreset.plugins['vue-cli-plugin-electron-builder'] = {
+    version: 'file:../../../'
+  }
+  project = await create(
+    'build',
+    defaultPreset,
+    path.join(process.cwd(), '/__tests__/projects')
+  )
+  //   })
+  const { stdout } = await project.run(
+    'vue-cli-service build:electron --x64 --win zip --linux zip'
+  )
+  //   Ensure built completes
+  expect(stdout.indexOf('Build complete!')).not.toBe(-1)
+  //   Ensure /dist is not modified
+  expect(project.has('dist')).toBe(false)
+  //   Ensure build successfully outputted files
+  expect(project.has('dist_electron/bundled/index.html')).toBe(true)
+  expect(project.has('dist_electron/bundled/favicon.ico')).toBe(true)
+  expect(project.has('dist_electron/bundled/js')).toBe(true)
+  expect(project.has('dist_electron/bundled/css')).toBe(true)
+  expect(project.has('dist_electron/bundled/background.js')).toBe(true)
+  expect(project.has('dist_electron/win-unpacked/build.exe')).toBe(true)
+  expect(project.has('dist_electron/linux-unpacked/build')).toBe(true)
+  //   Ensure that setup file was not created
+  expect(project.has('dist_electron/build Setup 0.1.0.exe')).toBe(false)
+  // Ensure that zip files were created
+  expect(project.has('dist_electron/build-0.1.0-win.zip')).toBe(true)
+  expect(project.has('dist_electron/build-0.1.0.zip')).toBe(true)
+  //   Ensure base is set properly (for app protocol)
+  const index = fs.readFileSync(
+    projectPath('dist_electron/bundled/index.html'),
+    'utf8'
+  )
+  expect(index.indexOf('<base href=app://./ >')).not.toBe(-1)
+  const app = new Application({
+    path: './__tests__/projects/build/dist_electron/win-unpacked/build.exe'
+    //   path: '../electron-test/dist_electron/win-unpacked/electron-test.exe'
+  })
+  await app.start()
+  const win = app.browserWindow
+  const client = app.client
+  await client.waitUntilWindowLoaded()
+
+  await client.getRenderProcessLogs().then(logs => {
+    logs.forEach(log => {
+      //   Make sure there are no fatal errors
+      expect(log.level).not.toBe('SEVERE')
+    })
+  })
+  await client.getMainProcessLogs().then(logs => {
+    logs.forEach(log => {
+      //   Make sure there are no fatal errors
+      expect(log.level).not.toBe('SEVERE')
+    })
+  })
+  //   Window was created
+  expect(await client.getWindowCount()).toBe(1)
+  //   It is not minimized
+  expect(await win.isMinimized()).toBe(false)
+  //   Dev tools is not open
+  expect(await win.isDevToolsOpened()).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)
+  // Load was successful
+  expect(await app.webContents.isLoading()).toBe(false)
+  //   App is loaded properly
+  expect(await client.getHTML('#app')).toMatchSnapshot()
+
+  app.stop()
+})

generator/index.js

@@ -2,17 +2,17 @@ const fs = require('fs')
 
 module.exports = api => {
   api.render('./template')
-  //   Read existing index.html and .gitignore
-  let index = fs.readFileSync(api.resolve('./public/index.html'), 'utf8')
-  let gitignore = fs.readFileSync(api.resolve('./.gitignore'), 'utf8')
-  //   Add base element inside <head> tag
-  index = index.replace(
-    /^\s*?<head.*?>\s*?$/m,
-    `<head>\n    <% if (BASE_URL === './') { %><base href="app://./" /><% } %>`
-  )
-  //   Add /dist_electron to gitignore
-  gitignore = gitignore + '\n#Electron-builder output\n/dist_electron'
   api.onCreateComplete(() => {
+    //   Read existing index.html and .gitignore
+    let index = fs.readFileSync(api.resolve('./public/index.html'), 'utf8')
+    let gitignore = fs.readFileSync(api.resolve('./.gitignore'), 'utf8')
+    //   Add base element inside <head> tag
+    index = index.replace(
+      /^\s*?<head.*?>\s*?$/m,
+      `<head>\n    <% if (BASE_URL === './') { %><base href="app://./" /><% } %>`
+    )
+    //   Add /dist_electron to gitignore
+    gitignore = gitignore + '\n#Electron-builder output\n/dist_electron'
     //   Write updated files
     fs.writeFileSync(api.resolve('./public/index.html'), index)
     fs.writeFileSync(api.resolve('./.gitignore'), gitignore)

jest.config.js

@@ -0,0 +1,16 @@
+module.exports = {
+  //   moduleFileExtensions: ['js', 'json'],
+  //   transform: {
+  //     // '^.+\\.vue$': 'vue-jest',
+  //     // '.+\\.(css|styl|less|sass|scss|png|jpg|ttf|woff|woff2)$': 'jest-transform-stub',
+  //     '^.+\\.jsx?$': 'babel-jest'
+  //   }
+  //   moduleNameMapper: {
+  //     '^@/(.*)$': '<rootDir>/src/$1'
+  //   },
+  // //   snapshotSerializers: ['jest-serializer-vue'],
+  //   testMatch: ['<rootDir>/__tests__/**.spec.js']
+  testEnvironment: 'node',
+  setupFiles: ['<rootDir>/testSetup.js'],
+  testPathIgnorePatterns: ['/node_modules/', '/__tests__/projects/']
+}

package.json

@@ -3,6 +3,10 @@
   "version": "1.0.0-alpha.11",
   "description": "A Vue Cli 3 plugin for Electron with no required configuration",
   "main": "index.js",
+  "scripts": {
+    "test": "jest --runInBand",
+    "pretest": "rimraf __tests__/projects/*"
+  },
   "keywords": [
     "electron",
     "vue",
@@ -28,10 +32,19 @@
     "webpack-target-electron-renderer": "^0.4.0"
   },
   "devDependencies": {
+    "@vue/cli": "^3.0.0-rc.3",
+    "@vue/cli-plugin-babel": "^3.0.0-rc.3",
+    "@vue/cli-plugin-eslint": "^3.0.0-rc.3",
+    "@vue/cli-test-utils": "^3.0.0-rc.3",
     "eslint-config-standard": "^11.0.0",
     "eslint-plugin-import": "^2.12.0",
     "eslint-plugin-node": "^6.0.1",
     "eslint-plugin-promise": "^3.8.0",
-    "eslint-plugin-standard": "^3.1.0"
+    "eslint-plugin-standard": "^3.1.0",
+    "jest": "^23.2.0",
+    "lnk": "^1.1.0",
+    "rimraf": "^2.6.2",
+    "spectron": "^3.8.0",
+    "vue": "^2.5.16"
   }
 }

testSetup.js

@@ -0,0 +1,5 @@
+const lnk = require('lnk')
+const fs = require('fs-extra')
+process.env.VUE_CLI_TEST = true
+fs.removeSync('./node_modules/vue-cli-plugin-electron-builder')
+lnk.sync(['./'], './node_modules/vue-cli-plugin-electron-builder')