Wrap @web/test-runner binary

bin/d2l-test-runner.js

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+import { argv } from 'node:process';
+import { runner } from '../src/server/cli/test-runner.js';
+
+const options = await runner.getOptions(argv);
+
+await runner.start(options);

package.json

@@ -7,12 +7,16 @@
   "scripts": {
     "lint": "eslint . --ext .js",
     "start": "web-dev-server --root-dir ./.vdiff --open ./.report/",
-    "test": "npm run lint && npm run test:server && npm run test:browser",
-    "test:browser": "web-test-runner --files \"./test/browser/**/*.test.js\" --node-resolve --playwright",
-    "test:server": "mocha ./test/server/**/*.test.js",
-    "test:vdiff": "web-test-runner --config ./test/browser/wtr-vdiff.config.js --group vdiff",
+    "test": "npm run lint && npm run test:bin && npm run test:server && npm run test:browser",
+    "test:bin": "mocha './test/bin/**/*.test.js'",
+    "test:browser": "web-test-runner --files './test/browser/**/*.test.js' --node-resolve --playwright",
+    "test:server": "mocha './test/server/**/*.test.js'",
+    "test:vdiff": "npx d2l-test-runner --config ./test/browser/vdiff.config.js --group vdiff",
     "test:vdiff:golden": "npm run test:vdiff -- --golden"
   },
+  "bin": {
+    "d2l-test-runner": "./bin/d2l-test-runner.js"
+  },
   "author": "D2L Corporation",
   "license": "Apache-2.0",
   "devDependencies": {
@@ -24,8 +28,7 @@
     "sinon": "^15"
   },
   "exports": {
-    ".": "./src/browser/index.js",
-    "./wtr-config.js": "./src/server/index.js"
+    ".": "./src/browser/index.js"
   },
   "files": [
     "/src"
@@ -36,11 +39,13 @@
   "dependencies": {
     "@rollup/plugin-node-resolve": "^15",
     "@open-wc/testing": "^3",
+    "@web/config-loader": "^0.2",
     "@web/rollup-plugin-html": "^2",
     "@web/test-runner": "^0.16",
     "@web/test-runner-commands": "^0.7",
     "@web/test-runner-playwright": "^0.10",
     "command-line-args": "^5",
+    "command-line-usage": "^7",
     "glob": "^10",
     "lit": "^2",
     "page": "^1",

src/server/cli/test-runner.js

@@ -0,0 +1,159 @@
+import { ConfigLoaderError, readConfig } from '@web/config-loader';
+import commandLineArgs from 'command-line-args';
+import commandLineUsage from 'command-line-usage';
+import process from 'node:process';
+import { startTestRunner } from '@web/test-runner';
+import { WTRConfig } from '../wtr-config.js';
+
+async function getTestRunnerOptions(argv = []) {
+
+	const DISALLOWED_OPTIONS = ['--browsers', '--playwright', '--puppeteer', '--groups'];
+
+	const optionDefinitions = [
+		// web-test-runner options
+		{
+			name: 'files',
+			type: String,
+			multiple: true,
+			description: 'Test files to run. Path or glob.\n[Default: ./test/**/*.<group>.js]',
+			order: 8
+		},
+		{
+			name: 'group',
+			type: String,
+			required: true,
+			defaultOption: true,
+			description: 'Name of the group to run tests for\n[Default: test]',
+			order: 1
+		},
+		{
+			name: 'manual',
+			type: Boolean,
+			description: 'Starts test runner in manual testing mode. Ignores browser options and prints manual testing URL.\n{underline Not compatible with automated browser interactions}\nConsider using --watch to debug in the browser instead.',
+			order: 11
+		},
+		{
+			name: 'watch',
+			type: Boolean,
+			description: 'Reload tests on file changes. Allows debugging in all browsers.',
+			order: 9
+		},
+
+		// d2l-test-runner options
+		{
+			name: 'chrome',
+			type: Boolean,
+			description: 'Run tests in Chromium',
+			order: 2
+		},
+		{
+			name: 'config',
+			alias: 'c',
+			type: String,
+			description: 'Location to read config file from\n[Default: ./d2l-test-runner.config.js]',
+			order: 9
+		},
+		{
+			name: 'filter',
+			alias: 'f',
+			type: String,
+			multiple: true,
+			description: 'Filter test files by replacing wildcards with this glob',
+			order: 6
+		},
+		{
+			name: 'firefox',
+			type: Boolean,
+			description: 'Run tests in Firefox',
+			order: 3
+		},
+		{
+			name: 'golden',
+			type: Boolean,
+			description: 'Generate new golden screenshots. Ignored unless group is "vdiff".',
+			order: 10
+		},
+		{
+			name: 'grep',
+			alias: 'g',
+			type: String,
+			description: 'Only run tests matching this string or regexp',
+			order: 7
+		},
+		{
+			name: 'help',
+			type: Boolean,
+			description: 'Print usage information and exit',
+			order: 12
+		},
+		{
+			name: 'safari',
+			type: Boolean,
+			description: 'Run tests in Webkit',
+			order: 4
+		},
+		{
+			name: 'timeout',
+			alias: 't',
+			type: Number,
+			description: 'Test timeout threshold in ms\n[Default: 2000]',
+			order: 5
+		},
+	];
+
+	const cliArgs = commandLineArgs(optionDefinitions, { partial: true, argv });
+
+	if (cliArgs.help) {
+		const help = commandLineUsage([
+			{
+				header: 'D2L Test',
+				content: 'Test runner for D2L components and applications'
+			},
+			{
+				header: 'Usage',
+				content: 'd2l-test-runner [options]',
+			},
+			{
+				header: 'Options',
+				optionList: optionDefinitions
+					.map(o => (o.description += '\n') && o)
+					.filter(o => 'order' in o)
+					.sort((a, b) => (a.order > b.order ? 1 : -1))
+			}
+		]);
+		process.stdout.write(help);
+		process.exit();
+	}
+
+	cliArgs._unknown = cliArgs._unknown?.filter(o => !DISALLOWED_OPTIONS.includes(o));
+
+	const testConfig = await readConfig('d2l-test-runner.config', cliArgs.config).catch(err => {
+		if (err instanceof ConfigLoaderError) {
+			throw new Error(err.message);
+		} else {
+			throw err;
+		}
+	}) || {};
+
+	const wtrConfig = new WTRConfig(cliArgs);
+	const config = wtrConfig.create(testConfig);
+
+	argv = [
+		'--group', cliArgs.group,
+		...(cliArgs._unknown || [])
+	];
+	// copy cli-only wtr options back to argv to be processed
+	cliArgs.watch && argv.push('--watch');
+	cliArgs.manual && argv.push('--manual');
+
+	return {
+		argv,
+		config,
+		readFileConfig: false
+	};
+}
+
+export const runner = {
+	getOptions: getTestRunnerOptions,
+	start: startTestRunner
+};

src/server/headed-mode-plugin.js

@@ -8,6 +8,7 @@ export function headedMode({ manual, watch, pattern }) {
 		name: 'brightspace-headed-mode',
 		async transform(context) {
 			if ((watch || manual) && files.includes(context.path.slice(1))) {
+				// allow time to open devtools in firefox and webkit
 				watch && await new Promise(r => setTimeout(r, 2000));
 				return `debugger;\n${context.body}`;
 			}

src/server/visual-diff-reporter.js

@@ -1,8 +1,8 @@
-import { cpSync, mkdirSync, rmSync, writeFileSync } from 'fs';
-import { dirname, join } from 'path';
+import { cpSync, mkdirSync, rmSync, writeFileSync } from 'node:fs';
+import { dirname, join } from 'node:path';
 import { getTestInfo, PATHS } from './visual-diff-plugin.js';
-import { execSync } from 'child_process';
-import { fileURLToPath } from 'url';
+import { execSync } from 'node:child_process';
+import { fileURLToPath } from 'node:url';
 
 const __dirname = dirname(fileURLToPath(import.meta.url));
 
@@ -112,7 +112,7 @@ export function visualDiffReporter({ reportResults = true } = {}) {
 			cpSync(inputDir, tempDir, { force: true, recursive: true });
 			writeFileSync(join(tempDir, 'data.js'), `export default ${json};`);
 
-			execSync(`rollup -c ${join(__dirname, './rollup.config.js')}`);
+			execSync(`npx rollup -c ${join(__dirname, './rollup.config.js')}`, { stdio: 'pipe' });
 
 			rmSync(tempDir, { recursive: true });