Improve Integration Tests (#39)

NullVoxPopuli · web-flow · commit d9d96e9e28b9 · 2019-10-28T10:38:58.000-04:00
* add ember-truth-helpers and use one of the helpers from the addon in the application template * add newline * pipe veerything out for debugging * use typescript in integration testing * add listr * improve error messaging * do I even want listr? is so nice tho * why is killing a process so hard in node. ugh * correct the output template * #33 confirmed resolved * fix linting * Update package.json Co-Authored-By: Robert Jackson <rjackson@linkedin.com> * Remove listr * upgrade packages
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -13,11 +13,22 @@ module.exports = {
       "prettier/prettier": "error"
     },
     overrides: [
+      {
+        files: ['**/*.ts'],
+        parser: '@typescript-eslint/parser',
+        plugins: ['prettier', '@typescript-eslint'],
+        extends: [
+          'eslint:recommended',
+          'plugin:@typescript-eslint/recommended',
+          'prettier',
+          'prettier/@typescript-eslint',
+        ],
+      },
       {
         files: ['**/*.test.js'],
         env: {
           jest: true
         }
       }
     ]
-  };
+};
diff --git a/package.json b/package.json
@@ -15,7 +15,7 @@
   "scripts": {
     "release": "release-it",
     "test": "codemod-cli test",
-    "test:integration": "node ./test/run-test.js",
+    "test:integration": "ts-node ./test/run-test.ts",
     "update-docs": "codemod-cli update-docs",
     "coveralls": "cat ./coverage/lcov.info | node node_modules/.bin/coveralls",
     "lint:js": "eslint .",
@@ -32,8 +32,8 @@
   ],
   "dependencies": {
     "codemod-cli": "^2.1.0",
-    "ember-codemods-telemetry-helpers": "^1.0.0",
-    "ember-template-recast": "^3.2.0",
+    "ember-codemods-telemetry-helpers": "^1.0.1",
+    "ember-template-recast": "^3.2.8",
     "fs-extra": "^8.1.0",
     "git-repo-info": "^2.1.0",
     "minimatch": "^3.0.4",
@@ -43,7 +43,14 @@
     "winston": "^3.2.1"
   },
   "devDependencies": {
+    "@types/chalk": "^2.2.0",
+    "@types/common-tags": "^1.8.0",
+    "@types/listr": "^0.14.2",
+    "@typescript-eslint/eslint-plugin": "^2.5.0",
+    "@typescript-eslint/parser": "^2.5.0",
     "babel-plugin-htmlbars-inline-precompile": "^3.0.0",
+    "chalk": "^2.4.2",
+    "common-tags": "^1.8.0",
     "coveralls": "^3.0.6",
     "eslint": "^6.5.1",
     "eslint-config-prettier": "^6.3.0",
@@ -52,7 +59,9 @@
     "jest": "^24.9.0",
     "prettier": "^1.18.2",
     "release-it": "^12.4.2",
-    "release-it-lerna-changelog": "^1.0.3"
+    "release-it-lerna-changelog": "^1.0.3",
+    "ts-node": "^8.4.1",
+    "typescript": "~3.6.4"
   },
   "engines": {
     "node": "8.* || 10.* || >= 12"
diff --git a/test/fixtures/3.13/input/app/controllers/application.js b/test/fixtures/3.13/input/app/controllers/application.js
@@ -0,0 +1,5 @@
+import Controller from '@ember/controller';
+
+export default Controller.extend({
+  foo: 'foo',
+});
diff --git a/test/fixtures/3.13/input/app/templates/application.hbs b/test/fixtures/3.13/input/app/templates/application.hbs
@@ -1,5 +1,7 @@
-{{!-- The following component displays Ember's default welcome message. --}}
-<WelcomePage />
-{{!-- Feel free to remove this! --}}
+{{not false}}
+
+{{#if (not foo)}}
+  {{foo}}
+{{/if}}
 
 {{outlet}}
diff --git a/test/fixtures/3.13/input/package.json b/test/fixtures/3.13/input/package.json
@@ -40,6 +40,7 @@
     "ember-qunit": "^4.4.1",
     "ember-resolver": "^5.0.1",
     "ember-source": "~3.13.3",
+    "ember-truth-helpers": "^2.1.0",
     "ember-welcome-page": "^4.0.0",
     "eslint-plugin-ember": "^7.1.0",
     "eslint-plugin-node": "^10.0.0",
diff --git a/test/fixtures/3.13/input/tests/unit/controllers/application-test.js b/test/fixtures/3.13/input/tests/unit/controllers/application-test.js
@@ -0,0 +1,12 @@
+import { module, test } from 'qunit';
+import { setupTest } from 'ember-qunit';
+
+module('Unit | Controller | application', function(hooks) {
+  setupTest(hooks);
+
+  // Replace this with your real tests.
+  test('it exists', function(assert) {
+    let controller = this.owner.lookup('controller:application');
+    assert.ok(controller);
+  });
+});
diff --git a/test/fixtures/3.13/output/app/controllers/application.js b/test/fixtures/3.13/output/app/controllers/application.js
@@ -0,0 +1,5 @@
+import Controller from '@ember/controller';
+
+export default Controller.extend({
+  foo: 'foo',
+});
diff --git a/test/fixtures/3.13/output/app/templates/application.hbs b/test/fixtures/3.13/output/app/templates/application.hbs
@@ -1,5 +1,7 @@
-{{!-- The following component displays Ember's default welcome message. --}}
-<WelcomePage />
-{{!-- Feel free to remove this! --}}
+{{not false}}
+
+{{#if (not this.foo)}}
+  {{this.foo}}
+{{/if}}
 
 {{outlet}}
diff --git a/test/fixtures/3.13/output/package.json b/test/fixtures/3.13/output/package.json
@@ -40,6 +40,7 @@
     "ember-qunit": "^4.4.1",
     "ember-resolver": "^5.0.1",
     "ember-source": "~3.13.3",
+    "ember-truth-helpers": "^2.1.0",
     "ember-welcome-page": "^4.0.0",
     "eslint-plugin-ember": "^7.1.0",
     "eslint-plugin-node": "^10.0.0",
diff --git a/test/fixtures/3.13/output/tests/unit/controllers/application-test.js b/test/fixtures/3.13/output/tests/unit/controllers/application-test.js
@@ -0,0 +1,12 @@
+import { module, test } from 'qunit';
+import { setupTest } from 'ember-qunit';
+
+module('Unit | Controller | application', function(hooks) {
+  setupTest(hooks);
+
+  // Replace this with your real tests.
+  test('it exists', function(assert) {
+    let controller = this.owner.lookup('controller:application');
+    assert.ok(controller);
+  });
+});
diff --git a/test/helpers/sequence.ts b/test/helpers/sequence.ts
@@ -0,0 +1,28 @@
+import Listr from 'listr';
+
+import { TestRunner } from './test-runner';
+import { log } from './utils';
+
+export async function runTestIntegrationSequence(version: string) {
+  const runner = new TestRunner(version);
+
+  log(`Running Integration Test for Ember ${version}`);
+  log(`Installing Dependencies`);
+  await runner.installDeps();
+
+  try {
+    log(`Starting the Ember Dev Server`);
+    await runner.startEmber();
+    log(`Running Codemod`);
+    await runner.runCodemod();
+    log(`Stopping the Ember Dev Server`);
+    await runner.stopEmber();
+  } catch (e) {
+    log(`Stopping the Ember Dev Server`);
+    await runner.stopEmber();
+    throw e;
+  }
+
+  log(`Comparing Results`);
+  await runner.compare();
+}
diff --git a/test/helpers/test-runner.ts b/test/helpers/test-runner.ts
@@ -0,0 +1,79 @@
+import path from 'path';
+import execa, { CommonOptions } from 'execa';
+import { log, timeoutAfter, kill, error } from './utils';
+
+const devServerTimeout = 60000;
+
+export class TestRunner {
+  version: string;
+  inputDir: string;
+  execOpts: CommonOptions<'utf8'>;
+
+  private emberProcess?: execa.ExecaChildProcess;
+
+  constructor(version: string) {
+    this.version = version;
+
+    // resolved from the root of the project
+    const inputPath = path.join('test', 'fixtures', version, 'input');
+    this.inputDir = path.resolve(inputPath);
+    this.execOpts = { cwd: this.inputDir, stderr: 'inherit' };
+  }
+
+  async installDeps(): Promise<void> {
+    await execa('rm', ['-rf', 'node_modules'], { cwd: this.inputDir });
+    await execa('yarn', ['install'], { cwd: this.inputDir });
+  }
+
+  async runCodemod() {
+    await execa('../../../../bin/cli.js', ['http://localhost:4200', 'app'], this.execOpts);
+  }
+
+  async startEmber(): Promise<void> {
+    const emberServe = execa('yarn', ['ember', 'serve'], {
+      cwd: this.inputDir,
+      env: {
+        JOBS: '1',
+      },
+    });
+
+    if (process.env.DEBUG) {
+      emberServe.stdout.pipe(process.stdout);
+      emberServe.stderr.pipe(process.stderr);
+    }
+
+    const serverWaiter = new Promise(resolve => {
+      emberServe.stdout.on('data', data => {
+        if (data.toString().includes('Build successful')) {
+          resolve();
+        }
+      });
+    });
+
+    try {
+      await timeoutAfter(devServerTimeout, serverWaiter);
+    } catch (e) {
+      console.error(e);
+      throw new Error('Ember server failed to start');
+    }
+
+    this.emberProcess = emberServe;
+  }
+
+  async stopEmber(): Promise<void> {
+    await timeoutAfter(devServerTimeout, kill(this.emberProcess));
+  }
+
+  async compare() {
+    try {
+      const actual = path.join('app');
+      const expectedApp = path.join('..', 'output', 'app');
+
+      await execa('diff', ['-rq', actual, expectedApp], { cwd: this.inputDir, stdio: 'inherit' });
+    } catch (e) {
+      console.log(e.stdout);
+
+      throw new Error('codemod did not run successfully');
+    }
+  }
+}
diff --git a/test/helpers/utils.ts b/test/helpers/utils.ts
@@ -0,0 +1,41 @@
+import chalk from 'chalk';
+import execa from 'execa';
+
+export function log(msg: string): void {
+  console.log(chalk.yellowBright(msg));
+}
+
+export function error(msg: string): void {
+  console.error(chalk.redBright(msg));
+}
+
+export function timeoutAfter<T>(ms: number, promise: Promise<T>) {
+  const timeout = new Promise((_, reject) => {
+    const id = setTimeout(() => {
+      clearTimeout(id);
+      reject(`Timed out after ${ms}ms`);
+    }, ms);
+  });
+
+  return Promise.race([promise, timeout]);
+}
+
+export async function kill(subprocess: execa.ExecaChildProcess) {
+  if (!subprocess) {
+    throw new Error('Cannot kill non-running process');
+  }
+
+  try {
+    console.log(`Requesting SIGTERM of ember serve: (PID) ${subprocess.pid}`);
+
+    process.kill(subprocess.pid);
+  } catch (e) {
+    console.log(`PID ${subprocess.pid} has stopped.`);
+    console.log(`\tKilled: ${subprocess.killed}`);
+    console.log(`\tCancelled: ${e.isCanceled}`);
+  }
+
+  return new Promise(resolve => {
+    setTimeout(() => resolve(), 3000);
+  });
+}
diff --git a/test/run-test.js b/test/run-test.js
diff --git a/test/run-test.ts b/test/run-test.ts
diff --git a/tsconfig.json b/tsconfig.json
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -13,11 +13,22 @@ module.exports = {`
`13`	`13`	`"prettier/prettier": "error"`
`14`	`14`	`},`
`15`	`15`	`overrides: [`
	`16`	`+ {`
	`17`	`+ files: ['*/.ts'],`
	`18`	`+ parser: '@typescript-eslint/parser',`
	`19`	`+ plugins: ['prettier', '@typescript-eslint'],`
	`20`	`+ extends: [`
	`21`	`+ 'eslint:recommended',`
	`22`	`+ 'plugin:@typescript-eslint/recommended',`
	`23`	`+ 'prettier',`
	`24`	`+ 'prettier/@typescript-eslint',`
	`25`	`+ ],`
	`26`	`+ },`
`16`	`27`	`{`
`17`	`28`	`files: ['*/.test.js'],`
`18`	`29`	`env: {`
`19`	`30`	`jest: true`
`20`	`31`	`}`
`21`	`32`	`}`
`22`	`33`	`]`
`23`		`- };`
	`34`	`+};`