Update to electron-forge 6 & simplify build pipeline/project structure

blueprints/ember-electron/files/testem-electron.js

@@ -1,5 +1,6 @@
+/* eslint-env node */
 module.exports = {
-  test_page: 'tests/index.html?hidepassed',
+  test_page: 'tests/index.html?hidepassed=1',
   disable_watching: true,
   launchers: {
     Electron: require('ember-electron/lib/test-support/test-runner'),

blueprints/ember-electron/index.js

@@ -1,6 +1,12 @@
 const Blueprint = require('ember-cli/lib/models/blueprint');
 const { api } = require('@electron-forge/core');
 const chalk = require('chalk');
+const { electronProjectPath } = require('../../lib/utils/build-paths');
+const path = require('path');
+const denodeify = require('denodeify');
+const fs = require('fs');
+const readFile = denodeify(fs.readFile);
+const writeFile = denodeify(fs.writeFile);
 
 module.exports = class EmberElectronBlueprint extends Blueprint {
   constructor(options) {
@@ -13,13 +19,36 @@ module.exports = class EmberElectronBlueprint extends Blueprint {
     return entityName;
   }
 
-  async afterInstall(/* options */) {
-    this.ui.writeLine(chalk.green('Creating electron-forge project at `./electron`'));
+  async afterInstall() {
+    this.ui.writeLine(chalk.green(`Creating electron-forge project at './${electronProjectPath}'`));
 
     await api.init({
-      dir: 'electron',
+      dir: electronProjectPath,
       interactive: true,
       template: 'ember-electron/forge/template'
     });
+
+    this.ui.writeLine(chalk.green(`Updating './${electronProjectPath}/package.json'`));
+
+    const keysToCopy = [
+      'name',
+      'version',
+      'description',
+      'author',
+      'license'
+    ];
+
+    let packageJsonPath = path.join(electronProjectPath, 'package.json');
+    let packageJson = JSON.parse(await readFile(packageJsonPath));
+
+    for (let key of keysToCopy) {
+      if (Object.keys(this.project.pkg).includes(key)) {
+        packageJson[key] = this.project.pkg[key];
+      }
+    }
+
+    // special-case productName since forge creates it, but a lot of apps don't
+    packageJson.productName = this.project.pkg.productName || packageJson.name;
+    await writeFile(packageJsonPath, JSON.stringify(packageJson, { spaces: 2 }));
   }
 };

forge/template.js

@@ -4,7 +4,7 @@ const readFile = denodeify(require('fs').readFile);
 const writeFile = denodeify(require('fs').writeFile);
 const rimraf = denodeify(require('rimraf'));
 const ncp = denodeify(require('ncp'));
-const { emberBuildDir } = require('../lib/utils/build-paths');
+const { emberBuildDir, emberTestBuildDir } = require('../lib/utils/build-paths');
 
 module.exports = {
   devDependencies: [
@@ -27,6 +27,7 @@ module.exports = {
       contents.toString(),
       '# Ember build',
       `${emberBuildDir}/`,
+      `${emberTestBuildDir}/`,
       ''
     ].join('\n'));
   }

index.js

@@ -1,5 +1,6 @@
 const fs = require('fs');
 const path = require('path');
+const replace = require('broccoli-string-replace');
 
 function injectScript(scriptName) {
   let dirname = __dirname || process.cwd();
@@ -49,4 +50,17 @@ module.exports = {
       }
     }
   },
+
+  postprocessTree(type, node) {
+    if (type === 'all' && process.env.EMBER_CLI_ELECTRON) {
+      node = replace(node, {
+        files: [ 'tests/index.html' ],
+        pattern: {
+          match: /src="[^"]*testem\.js"/,
+          replacement: 'src="http://testemserver/testem.js"',
+        },
+      });
+    }
+    return node;
+  }
 };

lib/commands/base.js

@@ -4,8 +4,6 @@ const Command = require('ember-cli/lib/models/command');
 const ElectronTask = require('../tasks/electron');
 const ElectronMakeTask = require('../tasks/make');
 const ElectronPackageTask = require('../tasks/package');
-const ElectronTestServerTask = require('../tasks/test-server');
-const ElectronTestTask = require('../tasks/test');
 const YarnOrNpmTask = require('../tasks/yarn-or-npm');
 const Win = require('ember-cli/lib/utilities/windows-admin');
 const fs = require('fs');
@@ -21,8 +19,6 @@ module.exports = Command.extend({
       'Electron': ElectronTask,
       'ElectronMake': ElectronMakeTask,
       'ElectronPackage': ElectronPackageTask,
-      'ElectronTestServer': ElectronTestServerTask,
-      'ElectronTest': ElectronTestTask,
       'YarnOrNpm': YarnOrNpmTask
     });
   },

lib/commands/test.js

@@ -1,18 +1,41 @@
 'use strict';
 
-let TestCommand = require('ember-cli/lib/commands/test');
-let TestTask = require('../tasks/test');
-let TestServerTask = require('../tasks/test-server');
+const TestCommand = require('ember-cli/lib/commands/test');
+const { emberTestBuildPath } = require('../utils/build-paths');
 
 module.exports = TestCommand.extend({
   name: 'electron:test',
   description: 'Runs your app\'s test suite in Electron.',
 
-  init() {
-    this._super(...arguments);
-    this.tasks.TestServer = TestServerTask;
-    this.tasks.Test = TestTask;
-  },
+availableOptions: [
+    {
+      name: 'environment',
+      type: String,
+      default: 'test',
+      aliases: ['e'],
+      description: 'Possible values are "development", "production", and "test".',
+    },
+    {
+      name: 'config-file',
+      type: String,
+      default: 'testem-electron.js',
+      aliases: ['c', 'cf']
+    },
+    { name: 'server', type: Boolean, default: false, aliases: ['s'] },
+    { name: 'filter', type: String, aliases: ['f'], description: 'A string to filter tests to run' },
+    { name: 'module', type: String, aliases: ['m'], description: 'The name of a test module to run' },
+    { name: 'watcher', type: String, default: 'events', aliases: ['w'] },
+    {
+      name: 'reporter',
+      type: String,
+      aliases: ['r'],
+      description: 'Test reporter to use [tap|dot|xunit] (default: tap)',
+    },
+    { name: 'silent', type: Boolean, default: false, description: 'Suppress any output except for the test report' },
+    { name: 'testem-debug', type: String, description: 'File to write a debug log from testem' },
+    { name: 'test-page', type: String, description: 'Test page to invoke' },
+    { name: 'query', type: String, description: 'A query string to append to the test page URL.' },
+  ],
 
   rmTmp() {
     if (process.platform === 'win32') {
@@ -26,8 +49,9 @@ module.exports = TestCommand.extend({
     return this._super(...arguments);
   },
 
-  run() {
+  run(commandOptions) {
     process.env.EMBER_CLI_ELECTRON = true;
+    commandOptions.outputPath = emberTestBuildPath;
     return this._super(...arguments);
   },
 });

lib/resources/shim-test-head.js

@@ -1,12 +1,11 @@
 //
-// This allows testem to extract the ID of this run so it can communicate with
-// the testem server (the query param is added to the test URL by
-// test-runner.js)
+// testem looks for a function called getTestemId, and if present, uses it to
+// determine the ID of this test run so it can communicate back to the testem
+// server -- see https://github.com/testem/testem/commit/4a51acc2fc0c3a23273fea838fd166b4691c2300.
+//
+// The testemId query param is added to the test URL by test-runner.js.
 //
 window.getTestemId = function() {
-  // FIXME: It should be safe to replace "\?" with "?" below due to context -- need to check though
-  // eslint-disable-next-line no-useless-escape
-  let match = window.location.search.match(/[\?&]testemId=([^\?&]+)/);
-
+  let match = window.location.search.match(/[?&]testemId=([^?&]+)/);
   return match ? match[1] : null;
-};
+};

lib/test-support/test-index.js

@@ -24,7 +24,7 @@ if (process.platform === 'win32') {
 
 let emberAppDir = resolve(dirname(indexPath), '..');
 let relPath = relative(emberAppDir, indexPath);
-const emberAppLocation = `serve://dist/${relPath}${indexQuery}`;
+let emberAppLocation = `serve://dist/${relPath}${indexQuery}`;
 
 if (typeof protocol.registerSchemesAsPrivileged === 'function') {
   protocol.registerSchemesAsPrivileged([{

lib/test-support/test-runner.js

@@ -26,24 +26,25 @@ module.exports = {
 };
 
 async function main() {
-  let path = require('path');
-  let url = require('url');
-  let fileUrl = require('file-url');
-  let treeKill = require('tree-kill');
+  const path = require('path');
+  const url = require('url');
+  const fileUrl = require('file-url');
+  const treeKill = require('tree-kill');
   const { api } = require('@electron-forge/core');
+  const { electronProjectPath } = require('ember-electron/lib/utils/build-paths');
 
-  let [, , buildDir, testemUrl, testPageUrl, id] = process.argv;
+  let [, , emberAppDir, testemUrl, testPageUrl, id] = process.argv;
 
   // The testPageUrl points to the testem server, so we need to turn it into a
   // file URL and add the testem ID to the query params.
-  let emberAppDir = path.join(buildDir, 'ember');
   let {
     pathname: testPagePath,
     query: testPageQuery,
   } = url.parse(testPageUrl, true);
   let indexPath = path.resolve(emberAppDir, path.join.apply(null, testPagePath.split('/')));
   let indexObj = url.parse(fileUrl(indexPath));
   indexObj.query = testPageQuery;
+  // Set this so the script in shim-test-head.js can expose it to testem
   indexObj.query.testemId = id;
   let testUrl = url.format(indexObj);
   // On windows the testUrl argv is truncated before the first '&' by the time
@@ -55,8 +56,8 @@ async function main() {
 
   // Start electron
   let { pid } = await api.start({
-    appPath: buildDir,
-    dir: buildDir,
+    dir: path.join(process.cwd(), electronProjectPath),
+    appPath: './tests',
     args: [
       '--', // needed because https://github.com/electron/electron/pull/13039
       testUrl,

lib/utils/build-paths.js

@@ -1,11 +1,17 @@
 const path = require('path');
 
-const electronProjectPath = 'electron';
+const electronProjectPath = 'electron-app';
+
 const emberBuildDir = 'ember-dist';
 const emberBuildPath = path.join(electronProjectPath, emberBuildDir);
 
+const emberTestBuildDir = 'ember-test';
+const emberTestBuildPath = path.join(electronProjectPath, emberTestBuildDir);
+
 module.exports = {
   electronProjectPath,
   emberBuildDir,
-  emberBuildPath
+  emberBuildPath,
+  emberTestBuildDir,
+  emberTestBuildPath
 };

node-tests/acceptance/end-to-end-test.js

@@ -1,19 +1,20 @@
 'use strict';
 
+const { electronProjectPath } = require('../../lib/utils/build-paths');
 const path = require('path');
 const {
-  copySync,
   existsSync,
   readFileSync,
   readJsonSync,
   removeSync,
   writeFileSync,
   writeJsonSync,
 } = require('fs-extra');
+const denodeify = require('denodeify');
+const ncp = denodeify(require('ncp'));
 const execa = require('execa');
 const tmp = require('tmp');
-
-const { expect } = chai;
+const { expect } = require('chai');
 
 function run(cmd, args, opts = {}) {
   opts.stdio = opts.stdio || 'inherit';
@@ -129,7 +130,7 @@ describe('end-to-end', function() {
 
     it('builds', () => {
       return ember('electron:build').then(() => {
-        expect(existsSync(path.join('electron-out', 'ember'))).to.be.ok;
+        expect(existsSync(path.join('electron-app', 'ember-dist'))).to.be.ok;
       });
     });
 
@@ -150,19 +151,17 @@ describe('end-to-end', function() {
     it('extra checks pass', () => {
       let fixturePath = path.resolve(__dirname, '..', 'fixtures', 'ember-test');
 
-      // Append our extra test content to the end of test-main.js
-      let testMainPath = path.join('ember-electron', 'test-main.js');
-      let extraContentPath = path.join(fixturePath, 'test-main-extra.js');
+      // Append our extra test content to the end of test-index.js
+      let testIndexPath = path.join('electron-app', 'tests', 'index.js');
+      let extraContentPath = path.join(fixturePath, 'test-index-extra.js');
       let content = [
-        readFileSync(testMainPath),
+        readFileSync(testIndexPath),
         readFileSync(extraContentPath),
       ].join('\n');
-      writeFileSync(path.join('ember-electron', 'test-main.js'), content);
+      writeFileSync(testIndexPath, content);
 
-      // Copy the lib and resources directories over
-      ['lib', 'resources'].forEach((dir) => {
-        copySync(path.join(fixturePath, dir), path.join('ember-electron', dir));
-      });
+      // Copy the source files over
+      ncp(path.join(fixturePath, 'src'), path.join(electronProjectPath, 'src'));
 
       return expect(ember('electron:test')).to.eventually.be.fulfilled;
     });

node-tests/fixtures/ember-test/test-index-extra.js

@@ -0,0 +1,6 @@
+// Make sure dependencies (node_modules) are loadable
+const fileUrl = require('file-url');
+fileUrl('foo.html');
+// Make sure local libraries are loadable
+const helper = require('../src/helper');
+helper();