Migrate test suite to ES modules

ember-cli · Dec 18, 2024 · b1afad6 · b1afad6
1 parent 8f8be97
commit b1afad6
Show file tree

Hide file tree

Showing 21 changed files with 111 additions and 146 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -4,6 +4,10 @@ module.exports = {
     {
       env: { mocha: true },
       files: ['test/**/*.js'],
+      parserOptions: { sourceType: 'module' },
+      rules: {
+        'n/no-extraneous-import': 'off',
+      },
     },
   ],
   parser: '@babel/eslint-parser',

diff --git a/test/commands/try-each-test.js b/test/commands/try-each-test.js
@@ -1,7 +1,5 @@
-'use strict';
-
-const expect = require('chai').expect;
-const TryEachCommand = require('../../lib/commands/try-each');
+import { expect } from 'chai';
+import TryEachCommand from '../../lib/commands/try-each.js';
 
 const origTryEachTask = TryEachCommand._TryEachTask;
 const origGetConfig = TryEachCommand._getConfig;

diff --git a/test/commands/try-ember-test.js b/test/commands/try-ember-test.js
@@ -1,7 +1,5 @@
-'use strict';
-
-const expect = require('chai').expect;
-const TryEmberCommand = require('../../lib/commands/try-ember');
+import { expect } from 'chai';
+import TryEmberCommand from '../../lib/commands/try-ember.js';
 
 const origTryEachTask = TryEmberCommand._TryEachTask;
 const origGetConfig = TryEmberCommand._getConfig;

diff --git a/test/commands/try-one-test.js b/test/commands/try-one-test.js
@@ -1,7 +1,5 @@
-'use strict';
-
-const expect = require('chai').expect;
-const TryOneCommand = require('../../lib/commands/try-one');
+import { expect } from 'chai';
+import TryOneCommand from '../../lib/commands/try-one.js';
 
 const origTryEachTask = TryOneCommand._TryEachTask;
 const origGetConfig = TryOneCommand._getConfig;

diff --git a/test/dependency-manager-adapters/npm-adapter-test.js b/test/dependency-manager-adapters/npm-adapter-test.js
@@ -1,14 +1,13 @@
-'use strict';
-
-let expect = require('chai').expect;
-let fs = require('fs-extra');
-let path = require('path');
-let tmp = require('tmp-sync');
-let fixturePackage = require('../fixtures/package.json');
-let NpmAdapter = require('../../lib/dependency-manager-adapters/npm');
-let writeJSONFile = require('../helpers/write-json-file');
-let assertFileContainsJSON = require('../helpers/assert-file-contains-json');
-let generateMockRun = require('../helpers/generate-mock-run');
+import { expect } from 'chai';
+import fs from 'fs-extra';
+import path from 'path';
+import tmp from 'tmp-sync';
+import NpmAdapter from '../../lib/dependency-manager-adapters/npm.js';
+import writeJSONFile from '../helpers/write-json-file.js';
+import assertFileContainsJSON from '../helpers/assert-file-contains-json.js';
+import generateMockRun from '../helpers/generate-mock-run.js';
+
+const fixturePackage = fs.readJsonSync('./test/fixtures/package.json');
 
 let root = process.cwd();
 let tmproot = path.join(root, 'tmp');

diff --git a/test/dependency-manager-adapters/pnpm-adapter-test.js b/test/dependency-manager-adapters/pnpm-adapter-test.js
@@ -1,15 +1,13 @@
-'use strict';
+import chai, { expect } from 'chai';
+import chaiAsPromised from 'chai-as-promised';
+import fs from 'fs-extra';
+import path from 'path';
+import tmp from 'tmp-sync';
+import sinon from 'sinon';
+import PnpmAdapter from '../../lib/dependency-manager-adapters/pnpm.js';
+import generateMockRun from '../helpers/generate-mock-run.js';
 
-let chai = require('chai');
-let chaiAsPromised = require('chai-as-promised');
 chai.use(chaiAsPromised);
-let { expect } = chai;
-let fs = require('fs-extra');
-let path = require('path');
-let tmp = require('tmp-sync');
-const sinon = require('sinon');
-let PnpmAdapter = require('../../lib/dependency-manager-adapters/pnpm');
-let generateMockRun = require('../helpers/generate-mock-run');
 
 let root = process.cwd();
 let tmproot = path.join(root, 'tmp');

diff --git a/test/dependency-manager-adapters/workspace-adapter-test.js b/test/dependency-manager-adapters/workspace-adapter-test.js
@@ -1,14 +1,13 @@
-'use strict';
-
-let expect = require('chai').expect;
-let fs = require('fs-extra');
-let path = require('path');
-let tmp = require('tmp-sync');
-let fixtureWorkspaces = require('../fixtures/package-with-workspaces.json');
-let WorkspaceAdapter = require('../../lib/dependency-manager-adapters/workspace');
-let writeJSONFile = require('../helpers/write-json-file');
-let assertFileContainsJSON = require('../helpers/assert-file-contains-json');
-let generateMockRun = require('../helpers/generate-mock-run');
+import { expect } from 'chai';
+import fs from 'fs-extra';
+import path from 'path';
+import tmp from 'tmp-sync';
+import WorkspaceAdapter from '../../lib/dependency-manager-adapters/workspace.js';
+import writeJSONFile from '../helpers/write-json-file.js';
+import assertFileContainsJSON from '../helpers/assert-file-contains-json.js';
+import generateMockRun from '../helpers/generate-mock-run.js';
+
+const fixtureWorkspaces = fs.readJsonSync('./test/fixtures/package-with-workspaces.json');
 
 let root = process.cwd();
 let tmproot = path.join(root, 'tmp');

diff --git a/test/dependency-manager-adapters/yarn-adapter-test.js b/test/dependency-manager-adapters/yarn-adapter-test.js
@@ -1,14 +1,13 @@
-'use strict';
-
-let expect = require('chai').expect;
-let fs = require('fs-extra');
-let path = require('path');
-let tmp = require('tmp-sync');
-let fixturePackage = require('../fixtures/package.json');
-let YarnAdapter = require('../../lib/dependency-manager-adapters/yarn');
-let writeJSONFile = require('../helpers/write-json-file');
-let assertFileContainsJSON = require('../helpers/assert-file-contains-json');
-let generateMockRun = require('../helpers/generate-mock-run');
+import { expect } from 'chai';
+import fs from 'fs-extra';
+import path from 'path';
+import tmp from 'tmp-sync';
+import YarnAdapter from '../../lib/dependency-manager-adapters/yarn.js';
+import writeJSONFile from '../helpers/write-json-file.js';
+import assertFileContainsJSON from '../helpers/assert-file-contains-json.js';
+import generateMockRun from '../helpers/generate-mock-run.js';
+
+const fixturePackage = fs.readJsonSync('./test/fixtures/package.json');
 
 let root = process.cwd();
 let tmproot = path.join(root, 'tmp');

diff --git a/test/helpers/assert-file-contains-json.js b/test/helpers/assert-file-contains-json.js
@@ -1,12 +1,10 @@
-'use strict';
+import { expect } from 'chai';
+import fs from 'fs-extra';
+import path from 'path';
 
-let expect = require('chai').expect;
-let fs = require('fs-extra');
-let path = require('path');
-
-module.exports = function assertFileContainsJSON(filePath, expectedObj) {
+export default function assertFileContainsJSON(filePath, expectedObj) {
   return assertFileContains(filePath, JSON.stringify(expectedObj, null, 2));
-};
+}
 
 function assertFileContains(filePath, expectedContents) {
   let regex = new RegExp(`${escapeForRegex(expectedContents)}($|\\W)`, 'gm');

diff --git a/test/helpers/generate-mock-run.js b/test/helpers/generate-mock-run.js
@@ -1,8 +1,6 @@
-'use strict';
+import { _originalRunFunction } from '../../lib/utils/run.js';
 
-const { _originalRunFunction } = require('../../lib/utils/run');
-
-module.exports = function generateMockRun() {
+export default function generateMockRun() {
   let mockedRuns = [];
   let options = { allowPassthrough: true };
   if (typeof arguments[0] === 'string') {
@@ -28,7 +26,7 @@ module.exports = function generateMockRun() {
       );
     }
   };
-};
+}
 
 function isCommandMocked(mockedRun, actualCommand, actualArgs) {
   let mockedRunParts = mockedRun.command.split(' ');

diff --git a/test/helpers/stub-dependency-manager-adapter.js b/test/helpers/stub-dependency-manager-adapter.js
@@ -1,6 +1,4 @@
-'use strict';
-
-module.exports = class {
+export default class {
   setup() {
     return Promise.resolve();
   }
@@ -18,4 +16,4 @@ module.exports = class {
   cleanup() {
     return Promise.resolve();
   }
-};
+}
diff --git a/test/helpers/write-json-file.js b/test/helpers/write-json-file.js
@@ -1,7 +1,5 @@
-'use strict';
+import fs from 'fs-extra';
 
-const fs = require('fs-extra');
-
-module.exports = function writeJSONFile(filename, contents) {
+export default function writeJSONFile(filename, contents) {
   fs.writeFileSync(filename, JSON.stringify(contents, null, 2));
-};
+}
diff --git a/test/package.json b/test/package.json
@@ -0,0 +1,6 @@
+{
+  "description": "This `package.json` file solely exists to use ES modules in the test suite.",
+  "name": "test",
+  "private": true,
+  "type": "module"
+}
diff --git a/test/tasks/reset-test.js b/test/tasks/reset-test.js
@@ -1,10 +1,10 @@
-'use strict';
+import tmp from 'tmp-sync';
+import path from 'path';
+import fs from 'fs-extra';
+import writeJSONFile from '../helpers/write-json-file.js';
+import ResetTask from '../../lib/tasks/reset.js';
 
-const tmp = require('tmp-sync');
-const path = require('path');
-const fs = require('fs-extra');
-const fixturePackageJson = require('../fixtures/package.json');
-const writeJSONFile = require('../helpers/write-json-file');
+const fixturePackageJson = fs.readJsonSync('./test/fixtures/package.json');
 
 const root = process.cwd();
 const tmproot = path.join(root, 'tmp');
@@ -36,7 +36,6 @@ describe('reset', () => {
       ],
     };
 
-    let ResetTask = require('../../lib/tasks/reset');
     let resetTask = new ResetTask({
       project: { root: tmpdir },
       config,

diff --git a/test/tasks/try-each-test.js b/test/tasks/try-each-test.js
@@ -1,17 +1,18 @@
-'use strict';
-
-const expect = require('chai').expect;
-const tmp = require('tmp-sync');
-const path = require('path');
-const fs = require('fs-extra');
-const fixturePackage = require('../fixtures/package.json');
-const writeJSONFile = require('../helpers/write-json-file');
-const { _mockLog, _restoreLog } = require('../../lib/utils/console');
-const { _mockRun, _restoreRun } = require('../../lib/utils/run');
+import { expect } from 'chai';
+import chalk from 'chalk';
+import tmp from 'tmp-sync';
+import path from 'path';
+import fs from 'fs-extra';
+import writeJSONFile from '../helpers/write-json-file.js';
+import TryEachTask from '../../lib/tasks/try-each.js';
+import { _mockLog, _restoreLog } from '../../lib/utils/console.js';
+import { _mockRun, _restoreRun } from '../../lib/utils/run.js';
 
 /* Some of the tests in this file intentionally DO NOT stub dependency manager adapter*/
-const StubDependencyAdapter = require('../helpers/stub-dependency-manager-adapter');
-const generateMockRun = require('../helpers/generate-mock-run');
+import StubDependencyAdapter from '../helpers/stub-dependency-manager-adapter.js';
+import generateMockRun from '../helpers/generate-mock-run.js';
+
+const fixturePackage = fs.readJsonSync('./test/fixtures/package.json');
 
 const root = process.cwd();
 const tmproot = path.join(root, 'tmp');
@@ -54,7 +55,7 @@ describe('tryEach', () => {
   beforeEach(() => {
     tmpdir = tmp.in(tmproot);
     process.chdir(tmpdir);
-    require('chalk').level = 0;
+    chalk.level = 0;
   });
 
   afterEach(() => {
@@ -81,7 +82,6 @@ describe('tryEach', () => {
 
       _mockLog(outputFn);
 
-      let TryEachTask = require('../../lib/tasks/try-each');
       let tryEachTask = new TryEachTask({
         project: { root: tmpdir },
         config,
@@ -137,7 +137,6 @@ describe('tryEach', () => {
 
       _mockLog(outputFn);
 
-      let TryEachTask = require('../../lib/tasks/try-each');
       let tryEachTask = new TryEachTask({
         project: { root: tmpdir },
         config,
@@ -203,7 +202,6 @@ describe('tryEach', () => {
 
       _mockLog(outputFn);
 
-      let TryEachTask = require('../../lib/tasks/try-each');
       let tryEachTask = new TryEachTask({
         project: { root: tmpdir },
         config,
@@ -252,7 +250,6 @@ describe('tryEach', () => {
 
       _mockLog(outputFn);
 
-      let TryEachTask = require('../../lib/tasks/try-each');
       let tryEachTask = new TryEachTask({
         project: { root: tmpdir },
         config,
@@ -307,7 +304,6 @@ describe('tryEach', () => {
 
         _mockLog(outputFn);
 
-        let TryEachTask = require('../../lib/tasks/try-each');
         let tryEachTask = new TryEachTask({
           project: { root: tmpdir },
           config,
@@ -359,7 +355,6 @@ describe('tryEach', () => {
 
         _mockLog(outputFn);
 
-        let TryEachTask = require('../../lib/tasks/try-each');
         let tryEachTask = new TryEachTask({
           project: { root: tmpdir },
           config,
@@ -412,7 +407,6 @@ describe('tryEach', () => {
 
         _mockLog(outputFn);
 
-        let TryEachTask = require('../../lib/tasks/try-each');
         let tryEachTask = new TryEachTask({
           project: { root: tmpdir },
           config,
@@ -468,7 +462,6 @@ describe('tryEach', () => {
 
         _mockLog(outputFn);
 
-        let TryEachTask = require('../../lib/tasks/try-each');
         let tryEachTask = new TryEachTask({
           project: { root: tmpdir },
           config,
@@ -517,7 +510,6 @@ describe('tryEach', () => {
 
         _mockLog(outputFn);
 
-        let TryEachTask = require('../../lib/tasks/try-each');
         let tryEachTask = new TryEachTask({
           project: { root: tmpdir },
           config,
@@ -591,7 +583,6 @@ describe('tryEach', () => {
 
         _mockLog(outputFn);
 
-        let TryEachTask = require('../../lib/tasks/try-each');
         let tryEachTask = new TryEachTask({
           project: { root: tmpdir },
           config,
@@ -640,7 +631,6 @@ describe('tryEach', () => {
 
         _mockLog(outputFn);
 
-        let TryEachTask = require('../../lib/tasks/try-each');
         let tryEachTask = new TryEachTask({
           project: { root: tmpdir },
           config,
@@ -697,7 +687,6 @@ describe('tryEach', () => {
 
         _mockLog(outputFn);
 
-        let TryEachTask = require('../../lib/tasks/try-each');
         let tryEachTask = new TryEachTask({
           project: { root: tmpdir },
           config,
@@ -752,7 +741,6 @@ describe('tryEach', () => {
         return Promise.resolve(true);
       };
 
-      let TryEachTask = require('../../lib/tasks/try-each');
       let tryEachTask = new TryEachTask({
         project: { root: tmpdir },
         config,

diff --git a/test/utils/config-test.js b/test/utils/config-test.js
@@ -1,12 +1,11 @@
-'use strict';
-
-const expect = require('chai').expect;
-const fs = require('fs-extra');
-const path = require('path');
-const tmp = require('tmp-sync');
-const fixturePackage = require('../fixtures/package.json');
-const writeJSONFile = require('../helpers/write-json-file');
-const getConfig = require('../../lib/utils/config');
+import { expect } from 'chai';
+import fs from 'fs-extra';
+import path from 'path';
+import tmp from 'tmp-sync';
+import writeJSONFile from '../helpers/write-json-file.js';
+import getConfig from '../../lib/utils/config.js';
+
+const fixturePackage = fs.readJsonSync('./test/fixtures/package.json');
 
 const root = process.cwd();
 const tmproot = path.join(root, 'tmp');