@brightspace-ui/testing 1.18.0 → 1.20.0

package/README.md

@@ -4,7 +4,7 @@
 
 Testing utilities which are specifically designed and configured for Brightspace UI components and applications.
 
-> **Migrating from `@open-wc/testing` and/or `@brightspace-ui/visual-diff`?**
+> **Migrating from `@open-wc/testing`/`@web/test-runner`?**
 > Refer to the [Migration Guide](docs/migration-guide.md) for help migrating a repo to `@brightspace-ui/testing`.
 
 Install from NPM:
@@ -479,6 +479,7 @@ Vdiff tests are written [just like other tests](#writing-tests), and the same ut
 Use the asynchronous `.to.be.golden()` Chai assertion to take a vdiff snapshot and [compare it against its golden](#generating-the-goldens).
 
 ```javascript
+import './my-elem.js';
 import { fixture, html } from '@brightspace-ui/testing';
 
 describe('my-elem', () => {

package/bin/d2l-test-runner.js

@@ -1,6 +1,5 @@
 #!/usr/bin/env node
 import commandLineArgs from 'command-line-args';
-import { execSync } from 'node:child_process';
 import process from 'node:process';
 import { runner } from '../src/server/cli/test-runner.js';
 
@@ -19,21 +18,6 @@ if (cli.subcommand === 'vdiff') {
 	} else if (vdiff.subcommand === 'report') {
 		const { report } = await import('../src/server/cli/vdiff/report.js');
 		await report.start();
-	} else if (vdiff.subcommand === 'migrate') {
-		const { migrate } = await import('../src/server/cli/vdiff/migrate.js');
-		await migrate.start(vdiff._unknown);
-	} else if (vdiff.subcommand === 'migrate-local') {
-
-		const { pattern = './**' } = commandLineArgs({ name: 'pattern', type: String, defaultOption: true }, { partial: true, argv: vdiff._unknown || [] });
-
-		stdout.write('\nInstalling @brightspace-ui/visual-diff\n');
-		execSync('npm install @brightspace-ui/visual-diff@14  --no-save');
-		stdout.write(`\nRunning existing tests for pattern '${pattern}/*.visual-diff.js'\n`);
-		execSync(`npx mocha '${pattern}/*.visual-diff.js' -t 10000 --golden`);
-		stdout.write('\nTest run complete.\n');
-
-		const { migrate } = await import('../src/server/cli/vdiff/migrate.js');
-		await migrate.start(vdiff._unknown, true);
 	} else {
 		stdout.write(`\nfatal: unknown subcommand: ${vdiff.subcommand}\n`);
 	}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@brightspace-ui/testing",
   "description": "Utilities for testing front-end components and applications",
   "type": "module",
-  "version": "1.18.0",
+  "version": "1.20.0",
   "repository": "https://github.com/BrightspaceUI/testing.git",
   "scripts": {
     "lint": "npm run lint:eslint && npm run lint:style",

package/src/server/cli/test-runner.js

@@ -120,13 +120,6 @@ async function getTestRunnerOptions(argv = []) {
 			type: Boolean,
 			description: 'Run tests in Webkit',
 			order: 4
-		},
-		{
-			name: 'test-reporting',
-			type: Boolean,
-			defaultOption: false,
-			description: 'Enables generating a D2L Test Reporting format JSON file',
-			order: 14
 		}
 	];
 
@@ -166,14 +159,6 @@ async function getTestRunnerOptions(argv = []) {
 				{
 					example: 'vdiff golden',
 					desc: 'Generate new golden screenshots'
-				},
-				{
-					example: 'vdiff migrate [directory]',
-					desc: 'Migrate from @brightspace-ui/visual-diff. Restrict which goldens are migrated with a directory glob.'
-				},
-				{
-					example: 'vdiff migrate-local [directory]',
-					desc: 'Generate goldens with @brightspace-ui/visual-diff for local comparison while migrating tests. Restrict which goldens are generated with a directory glob.'
 				}]
 			}
 		]);

package/src/server/wtr-config.js

@@ -1,4 +1,5 @@
 import { defaultReporter } from '@web/test-runner';
+import { env } from 'node:process';
 import { headedMode } from './headed-mode-plugin.js';
 import { playwrightLauncher } from '@web/test-runner-playwright';
 import { reporter as testReportingReporter } from 'd2l-test-reporting/reporters/web-test-runner.js';
@@ -6,6 +7,7 @@ import { visualDiff } from './visual-diff-plugin.js';
 import { visualDiffReporter } from './visual-diff-reporter.js';
 
 const DEFAULT_PATTERN = type => `./test/**/*.${type}.js`;
+const DEFAULT_TEST_REPORTING = !!env['CI'];
 const BROWSER_MAP = {
 	chrome: 'chromium',
 	chromium: 'chromium',
@@ -182,7 +184,7 @@ export class WTRConfig {
 		pattern = DEFAULT_PATTERN,
 		slow,
 		timeout,
-		testReporting,
+		testReporting = DEFAULT_TEST_REPORTING,
 		...passthroughConfig
 	} = {}) {
 
@@ -215,8 +217,6 @@ export class WTRConfig {
 			});
 		}
 
-		testReporting = !!testReporting || this.#cliArgs['test-reporting'];
-
 		if (group === 'vdiff' || testReporting) {
 			config.reporters ??= [ defaultReporter() ];
 		}

package/src/server/cli/vdiff/migrate.js

@@ -1,53 +0,0 @@
-#!/usr/bin/env node
-import { appendFile, mkdir, readFile, rename, rm } from 'node:fs/promises';
-import { join, normalize, parse } from 'node:path';
-import commandLineArgs from 'command-line-args';
-import { glob } from 'glob';
-import { PATHS } from '../../paths.js';
-import { stdout } from 'node:process';
-
-async function start(argv = [], local = false) {
-	const { pattern = './**' } = commandLineArgs({ name: 'pattern', type: String, defaultOption: true }, { partial: true, argv });
-	const oldSuffix = local ? 'screenshots/golden' : 'screenshots/ci/golden';
-
-	stdout.write(`\nMigrating goldens for pattern '${pattern}/${oldSuffix}'\n`);
-	const dirs = await glob(`${pattern}/${oldSuffix}`, { ignore: 'node_modules/**', posix: true });
-	let fileCount = 0;
-
-	const gitignore = await readFile('.gitignore', { encoding: 'UTF8' }).catch(() => '');
-	if (!new RegExp(`${PATHS.VDIFF_ROOT}/(\n|$)`).test(gitignore)) {
-		const newline = gitignore.endsWith('\n') ? '' : '\n';
-		await appendFile('.gitignore', `${newline}${PATHS.VDIFF_ROOT}/\n`);
-	}
-
-	await Promise.all(dirs.map(async dir => {
-		const files = await glob(`${dir}/*/*.png`, { posix: true });
-
-		await Promise.all(files.map(async file => {
-			fileCount += 1;
-			const { base: name, dir } = parse(file);
-			const dirName = parse(dir).name;
-
-			const newName = name
-				.replace(/^d2l-/, '')
-				.replace(new RegExp(`^${dirName}-`), '');
-
-			const newDir = local ?
-				`${PATHS.VDIFF_ROOT}/${dir.replace(`${oldSuffix}/${dirName}`, `${dirName}/${PATHS.GOLDEN}/chromium`)}` :
-				dir.replace(`${oldSuffix}/${dirName}`, `${PATHS.GOLDEN}/${dirName}/chromium`);
-
-			await mkdir(newDir, { recursive: true });
-			return rename(file, join(newDir, newName));
-		}));
-
-		if (!local) {
-			return rm(normalize(join(dir, '..', '..')), { recursive: true });
-		}
-	}));
-
-	stdout.write(`\nMigrated ${fileCount} ${fileCount === 1 ? 'golden' : 'goldens'} found in ${dirs.length} test ${dirs.length === 1 ? 'directory' : 'directories'}\n`);
-}
-
-export const migrate = {
-	start
-};