ember-exam 8.0.0 → 9.1.0

package/.release-plan.json

@@ -0,0 +1,21 @@
+{
+  "solution": {
+    "ember-exam": {
+      "impact": "minor",
+      "oldVersion": "9.0.0",
+      "newVersion": "9.1.0",
+      "constraints": [
+        {
+          "impact": "minor",
+          "reason": "Appears in changelog section :rocket: Enhancement"
+        },
+        {
+          "impact": "patch",
+          "reason": "Appears in changelog section :house: Internal"
+        }
+      ],
+      "pkgJSONPath": "./package.json"
+    }
+  },
+  "description": "## Release (2025-03-05)\n\nember-exam 9.1.0 (minor)\n\n#### :rocket: Enhancement\n* `ember-exam`\n  * [#1313](https://github.com/ember-cli/ember-exam/pull/1313) Use ember-exam with vite ([@NullVoxPopuli](https://github.com/NullVoxPopuli))\n\n#### :house: Internal\n* `ember-exam`\n  * [#1336](https://github.com/ember-cli/ember-exam/pull/1336) Update release-plan ([@NullVoxPopuli](https://github.com/NullVoxPopuli))\n  * [#1333](https://github.com/ember-cli/ember-exam/pull/1333) Fix lints since eslint-plugin-ember was upgraded ([@NullVoxPopuli](https://github.com/NullVoxPopuli))\n  * [#1332](https://github.com/ember-cli/ember-exam/pull/1332) Revert #1188 ([@NullVoxPopuli](https://github.com/NullVoxPopuli))\n  * [#1330](https://github.com/ember-cli/ember-exam/pull/1330) Revert \"Update dependency ember-qunit to v9\" ([@NullVoxPopuli](https://github.com/NullVoxPopuli))\n  * [#1329](https://github.com/ember-cli/ember-exam/pull/1329) Revert \"Update pnpm to v10.5.2\" ([@NullVoxPopuli](https://github.com/NullVoxPopuli))\n  * [#1322](https://github.com/ember-cli/ember-exam/pull/1322) Setup Release plan ([@NullVoxPopuli](https://github.com/NullVoxPopuli))\n  * [#1314](https://github.com/ember-cli/ember-exam/pull/1314) Convert to pnpm ([@NullVoxPopuli](https://github.com/NullVoxPopuli))\n  * [#1289](https://github.com/ember-cli/ember-exam/pull/1289) Add .codeclimate.yml to .npmignore ([@SergeAstapov](https://github.com/SergeAstapov))\n\n#### Committers: 2\n- Sergey Astapov ([@SergeAstapov](https://github.com/SergeAstapov))\n- [@NullVoxPopuli](https://github.com/NullVoxPopuli)\n"
+}

package/README.md

@@ -1,11 +1,9 @@
 # Ember Exam
-[![Build Status](https://travis-ci.org/ember-cli/ember-exam.svg?branch=master)](https://travis-ci.org/ember-cli/ember-exam)
+![Build Status](https://github.com/ember-cli/ember-exam/actions/workflows/ci.yml/badge.svg?event=push)
 [![NPM Version](https://badge.fury.io/js/ember-exam.svg)](https://badge.fury.io/js/ember-exam)
 [![Ember Observer Score](https://emberobserver.com/badges/ember-exam.svg)](https://emberobserver.com/addons/ember-exam)
-[![Code Climate](https://codeclimate.com/github/trentmwillis/ember-exam/badges/gpa.svg)](https://codeclimate.com/github/trentmwillis/ember-exam)
-[![Node Test Coverage](https://codeclimate.com/github/trentmwillis/ember-exam/badges/coverage.svg)](https://codeclimate.com/github/trentmwillis/ember-exam/coverage)
 
-Ember Exam is an addon to allow you more control over how you run your tests when used in conjunction with [Ember QUnit](https://github.com/emberjs/ember-qunit) or [Ember Mocha](https://github.com/emberjs/ember-mocha). It provides the ability to randomize, split, parallelize, and load-balance your test suite by adding a more robust CLI command.
+Ember Exam is an addon to allow you more control over how you run your tests when used in conjunction with [ember-qunit](https://github.com/emberjs/ember-qunit). It provides the ability to randomize, split, parallelize, and load-balance your test suite by adding a more robust CLI command.
 
 It started as a way to help reduce flaky tests and encourage healthy test driven development. It's like [Head & Shoulders](http://www.headandshoulders.com/) for your tests!
 
@@ -15,6 +13,7 @@ The [documentation website](https://ember-cli.github.io/ember-exam/) contains ex
 
 ## Table of Contents
 
+- [Compatibility](#compatibility)
 - [Installation](#installation)
 - [How To Use](#how-to-use)
   * [Version < `3.0.0`](#version--300)
@@ -24,17 +23,23 @@ The [documentation website](https://ember-cli.github.io/ember-exam/) contains ex
     + [Split Test Parallelization](#split-test-parallelization)
   * [Test Load Balancing](#test-load-balancing)
       - [Test Failure Reproduction](#test-failure-reproduction)
+  * [Preserve Test Name](#preserve-test-name)
 - [Advanced Configuration](#advanced-configuration)
   * [Ember Try & CI Integration](#ember-try--ci-integration)
   * [Test Suite Segmentation](#test-suite-segmentation)
 
+## Compatibility
+
+* Ember.js v4.8 or above
+* Ember CLI v4.8 or above
+* Node.js v18 or above
 
 ## Installation
 
 Installation is as easy as running:
 
 ```bash
-$ ember install ember-exam
+$ npm install --save-dev ember-exam
 ```
 
 ## How To Use
@@ -63,16 +68,53 @@ $ ember exam --load-balance --parallel --server
 
 The idea is that you can replace `ember test` with `ember exam` and never look back.
 
-To get the unique features of Ember Exam (described in-depth below), you will need to **replace** the use of `start()` from `Ember-Qunit` or `Ember-Mocha` in `test-helper.js` with `start()` from `ember-exam`:
+To get the unique features of Ember Exam (described in-depth below), you will need to **replace** the use of `start()` from `ember-qunit` in `test-helper.js` with `start()` from `ember-exam`:
 
 ```js
 // test-helper.js
-import start from 'ember-exam/test-support/start';
+import { start } from 'ember-exam/test-support';
 
-// Options passed to `start` will be passed-through to ember-qunit or ember-mocha
+// Options passed to `start` will be passed-through to ember-qunit
 start();
 ```
 
+## How to use with Vite
+
+All of the above applies, but we need to tell vite to build the app before telling ember/exam to run tests on that output.
+
+Update your test-helper.js or test-helper.ts, to have add the ember-exam `start` function:
+```diff
+  // ...
+  import { setApplication } from '@ember/test-helpers';
+  import { setup } from 'qunit-dom';
+- import { start as qunitStart, setupEmberOnerrorValidation } from 'ember-qunit';
++ import { setupEmberOnerrorValidation } from 'ember-qunit';
++ import { start as startEmberExam } from 'ember-exam/test-support';
+
+  export function start() {
+    setApplication(Application.create(config.APP));
+
+    setup(QUnit.assert);
+    setupEmberOnerrorValidation();
+
+-   qunitStart();
++   // Options passed to `start` will be passed-through to ember-qunit
++   startEmberExam();
+  }
+```
+
+Testing development:
+```bash 
+NODE_ENV=development vite build --mode test
+ember exam --path dist
+```
+
+Testing production:
+```bash
+vite build --mode test
+ember exam --path dist
+```
+
 ### Version < `3.0.0`
 
 
@@ -114,7 +156,7 @@ ember exam --split=2 --random
 Randomizing tests with seed: hwr74nkk55vzpvi
 ```
 
-_Note: You must be using QUnit version `1.23.0` or greater for this feature to work properly. This feature is not currently supported by Mocha._
+_Note: You must be using QUnit version `1.23.0` or greater for this feature to work properly.
 
 #### Randomization Iterator
 
@@ -138,8 +180,6 @@ $ ember exam:iterate <num> --options <options>
 
 The `options` should be a string matching what you would use via the CLI.
 
-_Note: This feature is not currently supported by Mocha._
-
 ### Generating Module Metadata File For Test Execution
 
 ```bash
@@ -188,8 +228,6 @@ and it looks something like below:
 ]
 ```
 
-_Note: This feature is not currently supported by Mocha._
-
 
 ### Splitting
 
@@ -209,7 +247,7 @@ The `partition` option allows you to specify which test group to run after using
 $ ember exam --split=4 --partition=1 --partition=2
 ```
 
-_Note: Ember Exam splits tests by modifying the Ember-QUnit/Ember-Mocha's `TestLoader` to bucket each test file into a partition, where each partition has an even number of test files. This makes it possible to have unbalanced partitions. To run your tests with balanced partitions, consider using `--load-balance`. For more info, see [_Test Load Balancing_](#test-load-balancing).
+_Note: Ember Exam splits tests by modifying the ember-qunit's `TestLoader` to bucket each test file into a partition, where each partition has an even number of test files. This makes it possible to have unbalanced partitions. To run your tests with balanced partitions, consider using `--load-balance`. For more info, see [_Test Load Balancing_](#test-load-balancing).
 
 #### Split Test Parallelization
 
@@ -281,7 +319,7 @@ $ ember exam --file-path='/my-application/tests/unit/*.js'
 $ ember exam --parallel=<num> --load-balance
 ```
 
-The `load-balance` option allows you to load balance test files against multiple browsers. It will order the test files by test types, e.g. acceptance | integration | unit | eslint, and load balance the ordered test files between the browsers dynamically rather than statically.
+The `load-balance` option allows you to load balance test files against multiple browsers. It will order the test files by test types, e.g. acceptance | integration | unit, and load balance the ordered test files between the browsers dynamically rather than statically.
 **Note:** parallel must be used along with load-balance to specify a number of browser(s)
 
 The `load-balance` option was added to version 1.1 to address execution performance when running against a large test suite.
@@ -318,7 +356,6 @@ ok 3 Chrome 66.0 - Exam Partition 1 - browser Id 3 - some the other test
 2. You must be using `ember-cli` version 3.2.0 or greater for load balancing and test failure reproduction features to work properly.
 3. You must be using `ember-qunit` version 4.1.1 or greater for this feature to work properly.
 4. You must be using `qunit` version 2.13.0 or greater for this feature to work properly.
-5. This feature is not currently supported by Mocha.
 
 ##### Test Failure Reproduction
 
@@ -373,7 +410,33 @@ $ ember exam --replay-execution=test-execution-000000.json
 1. You must be using `ember-cli` version 3.2.0 or greater for load-balnce and test failure reproduction features to work properly.
 2. You must be using `ember-qunit` version 4.1.1 or greater for this feature to work properly.
 3. You must be using `qunit` version 2.8.0 or greater for this feature to work properly.
-4. This feature is not currently supported by Mocha.
+
+#### Preserve Test Name
+
+When using `--split` and/or `--load-balance` the output will look something like:
+
+```bash
+# ember exam --split=2 --partition=1 --parallel=3 --load-balance
+ok 1 Chrome 66.0 - Exam Partition 1 - browser Id 1 - some test
+ok 2 Chrome 66.0 - Exam Partition 1 - browser Id 2 - another test
+ok 3 Chrome 66.0 - Exam Partition 1 - browser Id 3 - some the other test
+```
+However, if you change the amount of parallelization, or randomize across partitions, the output will change for the same test, which may be an issue if you are tracking test insights over time.
+
+```bash
+# ember exam --split=2 --partition=1 --parallel=2 --load-balance
+ok 1 Chrome 66.0 - Exam Partition 1 - browser Id 2 - some test
+ok 2 Chrome 66.0 - Exam Partition 1 - browser Id 1 - another test
+ok 3 Chrome 66.0 - Exam Partition 1 - browser Id 2 - some the other test
+```
+You can add `--preserve-test-name` to remove the dynamic segments of the output (partition and browser) to ensure the output test names are always the same.
+
+```bash
+# ember exam --split=2 --partition=1 --parallel=3 --load-balance --preserve-test-name
+ok 1 Chrome 66.0 - some test
+ok 2 Chrome 66.0 - another test
+ok 3 Chrome 66.0 - some the other test
+```
 
 ## Advanced Configuration
 

package/addon-test-support/-private/async-iterator.js

@@ -51,7 +51,7 @@ export default class AsyncIterator {
   handleResponse(response) {
     if (this._waiting === false) {
       throw new Error(
-        `${this.toString()} Was not expecting a response, but got a response`
+        `${this.toString()} Was not expecting a response, but got a response`,
       );
     } else {
       this._waiting = false;
@@ -82,7 +82,7 @@ export default class AsyncIterator {
     this._done = true;
     this._testem.removeEventCallbacks(
       this._response,
-      this._boundHandleResponse
+      this._boundHandleResponse,
     );
   }
 
@@ -111,13 +111,13 @@ export default class AsyncIterator {
 
       if (this._emberExamExitOnError) {
         let err = new Error(
-          `EmberExam: Promise timed out after ${this._timeout} s while waiting for response for ${this._request}`
+          `EmberExam: Promise timed out after ${this._timeout} s while waiting for response for ${this._request}`,
         );
         reject(err);
       } else {
         // eslint-disable-next-line no-console
         console.error(
-          `EmberExam: Promise timed out after ${this._timeout} s while waiting for response for ${this._request}. Closing browser to exit gracefully.`
+          `EmberExam: Promise timed out after ${this._timeout} s while waiting for response for ${this._request}. Closing browser to exit gracefully.`,
         );
         resolve(iteratorCompleteResponse);
       }

package/addon-test-support/-private/{ember-exam-qunit-test-loader.js → ember-exam-test-loader.js}

@@ -13,7 +13,7 @@ import QUnit from 'qunit';
  * @class EmberExamQUnitTestLoader
  * @extends {TestLoader}
  */
-export default class EmberExamQUnitTestLoader extends TestLoader {
+export default class EmberExamTestLoader extends TestLoader {
   constructor(testem, urlParams, qunit = QUnit) {
     super();
     this._testModules = [];
@@ -82,7 +82,7 @@ export default class EmberExamQUnitTestLoader extends TestLoader {
       this._testModules = filterTestModules(
         this._testModules,
         modulePath,
-        filePath
+        filePath,
       );
     }
 
@@ -91,18 +91,18 @@ export default class EmberExamQUnitTestLoader extends TestLoader {
       this._testModules = splitTestModules(
         weightTestModules(this._testModules),
         split,
-        partitions
+        partitions,
       );
       this._testem.emit(
         'testem:set-modules-queue',
         this._testModules,
-        browserId
+        browserId,
       );
     } else {
       this._testModules = splitTestModules(
         this._testModules,
         split,
-        partitions
+        partitions,
       );
       this._testModules.forEach((moduleName) => {
         super.require(moduleName);
@@ -120,7 +120,7 @@ export default class EmberExamQUnitTestLoader extends TestLoader {
   loadIndividualModule(moduleName) {
     if (moduleName === undefined) {
       throw new Error(
-        'Failed to load a test module. `moduleName` is undefined in `loadIndividualModule`.'
+        'Failed to load a test module. `moduleName` is undefined in `loadIndividualModule`.',
       );
     }
     super.require(moduleName);

package/addon-test-support/-private/filter-test-modules.js

@@ -41,7 +41,7 @@ function wildcardFilter(module, moduleFilter) {
 function stringFilter(modules, moduleFilter) {
   return modules.filter(
     (module) =>
-      module.includes(moduleFilter) || wildcardFilter(module, moduleFilter)
+      module.includes(moduleFilter) || wildcardFilter(module, moduleFilter),
   );
 }
 
@@ -57,7 +57,7 @@ function regexFilter(modules, modulePathRegexFilter) {
   const exclude = modulePathRegexFilter[1];
 
   return modules.filter(
-    (module) => (!exclude && re.test(module)) || (exclude && !re.test(module))
+    (module) => (!exclude && re.test(module)) || (exclude && !re.test(module)),
   );
 }
 
@@ -98,21 +98,21 @@ function filterTestModules(modules, modulePath, filePath) {
     if (modulePathRegex) {
       return result.concat(
         regexFilter(modules, modulePathRegex).filter(
-          (module) => result.indexOf(module) === -1
-        )
+          (module) => result.indexOf(module) === -1,
+        ),
       );
     } else {
       return result.concat(
         stringFilter(modules, modulePath).filter(
-          (module) => result.indexOf(module) === -1
-        )
+          (module) => result.indexOf(module) === -1,
+        ),
       );
     }
   }, []);
 
   if (filteredTestModules.length === 0) {
     throw new Error(
-      `No tests matched with the filter: ${modulePath || filePath}.`
+      `No tests matched with the filter: ${modulePath || filePath}.`,
     );
   }
   return filteredTestModules;

package/addon-test-support/-private/patch-testem-output.js

@@ -15,7 +15,11 @@ export function updateTestName(urlParams, testName) {
   const partition = urlParams.get('partition') || 1;
   const browser = urlParams.get('browser') || 1;
 
-  if (split && loadBalance) {
+  const preserveTestName = !!urlParams.get('preserveTestName');
+
+  if (preserveTestName) {
+    return testName;
+  } else if (split && loadBalance) {
     testName = `Exam Partition ${partition} - Browser Id ${browser} - ${testName}`;
   } else if (split) {
     testName = `Exam Partition ${partition} - ${testName}`;

package/addon-test-support/-private/split-test-modules.js

@@ -8,25 +8,16 @@ function createGroups(num) {
   return groups;
 }
 
-function filterIntoGroups(arr, filter, numGroups) {
-  const filtered = arr.filter(filter);
+function splitIntoGroups(arr, numGroups) {
   const groups = createGroups(numGroups);
 
-  for (let i = 0; i < filtered.length; i++) {
-    groups[i % numGroups].push(filtered[i]);
+  for (let i = 0; i < arr.length; i++) {
+    groups[i % numGroups].push(arr[i]);
   }
 
   return groups;
 }
 
-function isLintTest(name) {
-  return name.match(/\.(jshint|(es)?lint-test)$/);
-}
-
-function isNotLintTest(name) {
-  return !isLintTest(name);
-}
-
 /**
  * Splits the list of modules into unique subset of modules
  * return the subset indexed by the partition
@@ -43,8 +34,7 @@ export default function splitTestModules(modules, split, partitions) {
     throw new Error('You must specify a split greater than 0');
   }
 
-  const lintTestGroups = filterIntoGroups(modules, isLintTest, split);
-  const otherTestGroups = filterIntoGroups(modules, isNotLintTest, split);
+  const testGroups = splitIntoGroups(modules, split);
   const tests = [];
 
   for (let i = 0; i < partitions.length; i++) {
@@ -53,21 +43,21 @@ export default function splitTestModules(modules, split, partitions) {
       throw new Error(
         "You must specify numbers for partition (you specified '" +
           partitions +
-          "')"
+          "')",
       );
     }
 
     if (split < partition) {
       throw new Error(
         'You must specify partitions numbered less than or equal to your split value of ' +
-          split
+          split,
       );
     } else if (partition < 1) {
       throw new Error('You must specify partitions numbered greater than 0');
     }
 
     const group = partition - 1;
-    tests.push(...lintTestGroups[group], ...otherTestGroups[group]);
+    tests.push(...testGroups[group]);
   }
 
   return tests;

package/addon-test-support/-private/weight-test-modules.js

@@ -1,15 +1,14 @@
 const TEST_TYPE_WEIGHT = {
-  eslint: 1,
   unit: 10,
   integration: 20,
   acceptance: 150,
 };
-const WEIGHT_REGEX = /\/(eslint|unit|integration|acceptance)\//;
+const WEIGHT_REGEX = /\/(unit|integration|acceptance)\//;
 const DEFAULT_WEIGHT = 50;
 
 /**
  * Return the weight for a given module name, a file path to the module
- * Ember tests consist of Acceptance, Integration, Unit, and lint tests. In general, acceptance takes
+ * Ember tests consist of Acceptance, Integration, and Unit tests. In general, acceptance takes
  * longest time to execute, followed by integration and unit.
  * The weight assigned to a module corresponds to its test type execution speed, with slowest being the highest in weight.
  * If the test type is not identifiable from the modulePath, weight default to 50 (ordered after acceptance, but before integration)

package/addon-test-support/.eslintrc

@@ -0,0 +1,6 @@
+{
+  "env": {
+    "browser": true,
+    "node": false
+  }
+}

package/addon-test-support/index.js

@@ -0,0 +1 @@
+export { default as start } from './start';

package/addon-test-support/load.js

@@ -1,5 +1,5 @@
+import EmberExamTestLoader from './-private/ember-exam-test-loader';
 import { patchTestemOutput } from './-private/patch-testem-output';
-import getTestLoader from './-private/get-test-loader';
 
 let loaded = false;
 
@@ -17,7 +17,7 @@ export default function loadEmberExam() {
   }
 
   loaded = true;
-  const EmberExamTestLoader = getTestLoader();
+
   const testLoader = new EmberExamTestLoader(window.Testem);
 
   if (window.Testem) {

package/addon-test-support/start.js

@@ -1,12 +1,8 @@
 import loadEmberExam from 'ember-exam/test-support/load';
-import {
-  dependencySatisfies,
-  macroCondition,
-  importSync,
-} from '@embroider/macros';
+import { start as qunitStart } from 'ember-qunit';
 
 /**
- * Equivalent to ember-qunit or ember-mocha's loadTest() except this does not create a new TestLoader instance
+ * Equivalent to ember-qunit's loadTest() except this does not create a new TestLoader instance
  *
  * @function loadTests
  * @param {*} testLoader
@@ -14,7 +10,7 @@ import {
 function loadTests(testLoader) {
   if (testLoader === undefined) {
     throw new Error(
-      'A testLoader instance has not been created. You must call `loadEmberExam()` before calling `loadTest()`.'
+      'A testLoader instance has not been created. You must call `loadEmberExam()` before calling `loadTest()`.',
     );
   }
 
@@ -23,7 +19,7 @@ function loadTests(testLoader) {
 
 /**
  * Ember-exam's own start function to set up EmberExamTestLoader, load tests and calls start() from
- * ember-qunit or ember-mocha
+ * ember-qunit
  *
  * @function start
  * @param {*} qunitOptions
@@ -34,15 +30,5 @@ export default function start(qunitOptions) {
 
   const testLoader = loadEmberExam();
   loadTests(testLoader);
-
-  let emberTestFramework;
-  if (macroCondition(dependencySatisfies('ember-qunit', '*'))) {
-    emberTestFramework = importSync('ember-qunit');
-  } else if (macroCondition(dependencySatisfies('ember-mocha', '*'))) {
-    emberTestFramework = importSync('ember-mocha');
-  }
-
-  if (emberTestFramework.start) {
-    emberTestFramework.start(modifiedOptions);
-  }
+  qunitStart(modifiedOptions);
 }

package/index.js

@@ -2,41 +2,10 @@
 
 'use strict';
 
-const VersionChecker = require('ember-cli-version-checker');
-
 module.exports = {
   name: require('./package').name,
 
   includedCommands() {
     return require('./lib/commands');
   },
-
-  init() {
-    this._super.init.apply(this, arguments);
-    let versionChecker = new VersionChecker(this.project);
-
-    const hasMagicallyProvidedQUnit = versionChecker
-      .for('ember-qunit')
-      .lt('5.0.0-beta.1');
-
-    let options = {
-      exclude: ['ember-mocha', 'mocha'],
-    };
-
-    // Ember-qunit < 5 provides an AMD shim for qunit but newer versions now use
-    // ember-auto-import to include qunit. This means that qunit is no
-    // longer available for addons (if the parent app is using ember-qunit > 5) to
-    // directly import under embroider unless they are using ember-auto-import
-    // themselves. This condidionally falls back to not using ember-auto-import
-    // when the parent app is providing qunit because without this we would double
-    // include qunit resulting in a runtime error (qunit detects if it as
-    // already be added to the window object and errors if so).
-    if (hasMagicallyProvidedQUnit) {
-      this.options = this.options || {};
-      options.exclude.push('qunit');
-      this.options.autoImport = options;
-    } else {
-      this.options.autoImport = options;
-    }
-  },
 };

package/lib/.eslintrc

@@ -0,0 +1,5 @@
+{
+  "rules": {
+    "no-var": 0
+  }
+}