ember-testem 0.4.0 → 0.5.0

package/README.md

@@ -3,6 +3,17 @@
 _Backward- and forward-compatible testing for Ember projects_
 
 
+## Why?
+
+Until now, testing Ember apps and addons required `ember-cli`, a monolith package that is written in JavaScript and has little relevance in v2 apps and v2 addons. Ember's test ecosystem (e.g. `ember-exam`, `@percy/ember`) is at risk because it is built on `ember-cli`.
+
+`ember-testem` aims to show that:
+
+- The fix is minimal, backward-, and forward-compatible (apps with strict resolver, apps without `ember-cli`).
+- We can keep using `qunit` and `testem`. No need to switch to another test framework and rewrite tests.
+- We can keep using battle-tested packages like `@percy/ember`, `ember-a11y-testing`, `ember-qunit`, `ember-test-selectors`, `miragejs`, and `qunit-dom`.
+
+
 ## Quickstart
 
 1\. Install `ember-testem` as a development dependency. The package provides an executable named `ember-test`.
@@ -37,7 +48,7 @@ export default {
 };
 ```
 
-3\. Update the `test` script in `package.json` so that it separates concerns. Build the test app, then run it.
+3\. Update the `test` script in `package.json` so that it builds the test app, then runs the app (the tests).
 
 ```diff
 {
@@ -55,7 +66,7 @@ export default {
 }
 ```
 
-Note, `test:watch` can encounter race conditions. Once the test build is complete, refresh the test browser to see the latest results.
+Note, `test:watch` may encounter race conditions. Once the build is complete, refresh the test browser to see the latest results.
 
 <details>
 
@@ -214,6 +225,24 @@ ember-test --port 0
 
 </details>
 
+<details>
+
+<summary>Optional: Randomize tests</summary>
+
+Pass `--random` to randomize the order of tests. This helps you guarantee that your tests are independent of one another.
+
+```sh
+ember-test --random
+```
+
+You can also pass a seed to run tests in a particular random order.
+
+```sh
+ember-test --random gflqlwrm59j
+```
+
+</details>
+
 > [!NOTE]
 >
 > `ember-testem` provides a limited API on purpose.

package/dist/bin/ember-test.js

@@ -25,6 +25,10 @@ const argv = yargs(hideBin(process.argv))
     .option('port', {
     describe: 'Port for running tests. Pass 0 to automatically pick an available port.',
     type: 'number',
+})
+    .option('random', {
+    describe: 'Randomize the order of tests (with a seed)',
+    type: 'string',
 })
     .option('root', {
     describe: 'Project root',
@@ -47,7 +51,8 @@ const codemodOptions = {
     projectRoot: argv['root'] ?? process.cwd(),
     qunit: {
         filter: argv['filter'],
-        testModule: argv['module'],
+        module: argv['module'],
+        random: argv['random'],
     },
     server: argv['server'],
 };

package/dist/src/steps/create-options.js

@@ -1,3 +1,4 @@
+import { createSeed } from '../utils/create-options/create-seed.js';
 export function createOptions(codemodOptions) {
     const { buildPath, port, projectRoot, qunit, server } = codemodOptions;
     return {
@@ -5,6 +6,10 @@ export function createOptions(codemodOptions) {
         launchBrowser: Boolean(server),
         port,
         projectRoot,
-        qunit,
+        qunit: {
+            filter: qunit.filter,
+            module: qunit.module,
+            seed: createSeed(qunit.random),
+        },
     };
 }

package/dist/src/utils/create-options/create-seed.js

@@ -0,0 +1,15 @@
+export function createSeed(seed) {
+    switch (seed) {
+        case undefined: {
+            return undefined;
+        }
+        case '': {
+            const seedNew = Math.random().toString(36).slice(2);
+            console.log(`Randomizing tests with seed: ${seedNew}`);
+            return seedNew;
+        }
+        default: {
+            return seed;
+        }
+    }
+}

package/dist/src/utils/run-tests/get-query-params.js

@@ -1,11 +1,14 @@
 export function getQueryParams(options) {
     const { qunit } = options;
     const params = [];
-    if (qunit.testModule) {
-        params.push(`module=${qunit.testModule}`);
+    if (qunit.module) {
+        params.push(`module=${qunit.module}`);
     }
     if (qunit.filter) {
         params.push(`filter=${qunit.filter}`);
     }
+    if (qunit.seed) {
+        params.push(`seed=${qunit.seed}`);
+    }
     return params.join('&');
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ember-testem",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Backward- and forward-compatible testing for Ember projects",
   "keywords": [
     "ci",
@@ -11,7 +11,7 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/ijlee2/ember-test.git",
+    "url": "https://github.com/ijlee2/ember-testem.git",
     "directory": "packages/ember-testem"
   },
   "license": "MIT",