chore(test): run doclint tests with mocha, delete utils/testrunner

.github/workflows/tests.yml

@@ -38,7 +38,7 @@ jobs:
     # XVFB-RUN merges both STDOUT and STDERR, whereas we need only STDERR
     # Wrap `npm run` in a subshell to redirect STDERR to file.
     # Enable core dumps in the subshell.
-    - run: xvfb-run --auto-servernum  --server-args="-screen 0 1280x960x24" -- bash -c "ulimit -c unlimited && node test/runner --jobs=1 --forbid-only --timeout=30000 && npm run coverage"
+    - run: xvfb-run --auto-servernum  --server-args="-screen 0 1280x960x24" -- bash -c "ulimit -c unlimited && node test/runner test/ --jobs=1 --forbid-only --timeout=30000 && npm run coverage"
       env:
         BROWSER: ${{ matrix.browser }}
         DEBUG: "pw:*,-pw:wrapped*,-pw:test*"
@@ -69,7 +69,7 @@ jobs:
     - uses: microsoft/playwright-github-action@v1
     - run: npm ci
     - run: npm run build
-    - run: node test/runner --jobs=1 --forbid-only --timeout=30000
+    - run: node test/runner test/ --jobs=1 --forbid-only --timeout=30000
       env:
         BROWSER: ${{ matrix.browser }}
         DEBUG: "pw:*,-pw:wrapped*,-pw:test*"
@@ -103,7 +103,7 @@ jobs:
     - uses: microsoft/playwright-github-action@v1
     - run: npm ci
     - run: npm run build
-    - run: node test/runner --jobs=1 --forbid-only --timeout=30000
+    - run: node test/runner test/ --jobs=1 --forbid-only --timeout=30000
       shell: bash
       env:
         BROWSER: ${{ matrix.browser }}
@@ -160,7 +160,7 @@ jobs:
     # XVFB-RUN merges both STDOUT and STDERR, whereas we need only STDERR
     # Wrap `npm run` in a subshell to redirect STDERR to file.
     # Enable core dumps in the subshell.
-    - run: xvfb-run --auto-servernum  --server-args="-screen 0 1280x960x24" -- bash -c "ulimit -c unlimited && node test/runner --jobs=1 --forbid-only --timeout=30000"
+    - run: xvfb-run --auto-servernum  --server-args="-screen 0 1280x960x24" -- bash -c "ulimit -c unlimited && node test/runner test/ --jobs=1 --forbid-only --timeout=30000"
       if: ${{ always() }}
       env:
         BROWSER: ${{ matrix.browser }}
@@ -194,7 +194,7 @@ jobs:
     # XVFB-RUN merges both STDOUT and STDERR, whereas we need only STDERR
     # Wrap `npm run` in a subshell to redirect STDERR to file.
     # Enable core dumps in the subshell.
-    - run: xvfb-run --auto-servernum  --server-args="-screen 0 1280x960x24" -- bash -c "ulimit -c unlimited && node test/runner --jobs=1 --forbid-only --timeout=30000"
+    - run: xvfb-run --auto-servernum  --server-args="-screen 0 1280x960x24" -- bash -c "ulimit -c unlimited && node test/runner test/ --jobs=1 --forbid-only --timeout=30000"
       env:
         BROWSER: ${{ matrix.browser }}
         DEBUG: "pw:*,-pw:wrapped*,-pw:test*"

package.json

@@ -9,18 +9,17 @@
     "node": ">=10.15.0"
   },
   "scripts": {
-    "ctest": "cross-env BROWSER=chromium node test/runner",
-    "ftest": "cross-env BROWSER=firefox node test/runner",
-    "wtest": "cross-env BROWSER=webkit node test/runner",
+    "ctest": "cross-env BROWSER=chromium node test/runner test/",
+    "ftest": "cross-env BROWSER=firefox node test/runner test/",
+    "wtest": "cross-env BROWSER=webkit node test/runner test/",
     "test": "npm run ctest && npm run ftest && npm run wtest",
     "eslint": "[ \"$CI\" = true ] && eslint --quiet -f codeframe --ext js,ts ./src || eslint --ext js,ts ./src",
     "tsc": "tsc -p .",
     "tsc-installer": "tsc -p ./src/install/tsconfig.json",
     "doc": "node utils/doclint/cli.js",
     "doc-no-channel": "node utils/doclint/cli.js --no-channel",
-    "test-infra": "node utils/doclint/check_public_api/test/test.js && node utils/doclint/preprocessor/test.js",
+    "test-infra": "node test/runner utils/doclint/check_public_api/test/test.js && node test/runner utils/doclint/preprocessor/test.js",
     "lint": "npm run eslint && npm run tsc && npm run doc && npm run doc-no-channel && npm run check-deps && npm run generate-channels && npm run test-types && npm run test-infra",
-    "debug-test": "node --inspect-brk test/test.js",
     "clean": "rimraf lib && rimraf types",
     "prepare": "node install-from-github.js",
     "build": "node utils/runWebpack.js --mode='development' && tsc -p . && npm run generate-types",

test/runner/index.js

@@ -34,8 +34,7 @@ program
   .option('--timeout <timeout>', 'Specify test timeout threshold (in milliseconds), default: 10000', 10000)
   .action(async (command) => {
     // Collect files
-    const files = [];
-    collectFiles(path.join(process.cwd(), 'test'), command.args, files);
+    const files = collectFiles(path.join(process.cwd(), command.args[0]), command.args.slice(1));
     const rootSuite = new Mocha.Suite('', new Mocha.Context(), true);
 
     console.log(`Parsing ${files.length} test files`);
@@ -84,10 +83,13 @@ program
 
 program.parse(process.argv);
 
-function collectFiles(dir, filters, files) {
+function collectFiles(dir, filters) {
+  if (fs.statSync(dir).isFile())
+    return [dir];
+  const files = [];
   for (const name of fs.readdirSync(dir)) {
     if (fs.lstatSync(path.join(dir, name)).isDirectory()) {
-      collectFiles(path.join(dir, name), filters, files);
+      files.push(...collectFiles(path.join(dir, name), filters));
       continue;
     }
     if (!name.includes('spec'))
@@ -103,4 +105,5 @@ function collectFiles(dir, filters, files) {
       }
     }
   }
+  return files;
 }

test/runner/worker.js

@@ -18,7 +18,7 @@ const path = require('path');
 const Mocha = require('mocha');
 const { fixturesUI, fixturePool } = require('./fixturesUI');
 const { gracefullyCloseAll } = require('../../lib/server/processLauncher');
-const GoldenUtils = require('../../utils/testrunner/GoldenUtils');
+const GoldenUtils = require('./GoldenUtils');
 
 const browserName = process.env.BROWSER || 'chromium';
 const goldenPath = path.join(__dirname, '..', 'golden-' + browserName);

utils/doclint/check_public_api/test/test.js

@@ -21,70 +21,58 @@ const Source = require('../../Source');
 const mdBuilder = require('../MDBuilder');
 const jsBuilder = require('../JSBuilder');
 
-const TestRunner  = require('../../../testrunner/');
-const runner = new TestRunner({
-  goldenPath: __dirname,
-  outputPath: __dirname
-});
-
-const {describe, xdescribe, fdescribe} = runner.api();
-const {it, fit, xit} = runner.api();
-const {beforeAll, beforeEach, afterAll, afterEach} = runner.api();
-const {expect} = runner.api();
-
-let browser;
-let page;
-
-beforeAll(async function() {
-  browser = await playwright.chromium.launch();
-  page = await browser.newPage();
-});
-
-afterAll(async function() {
+registerWorkerFixture('page', async({}, test) => {
+  const browser = await playwright.chromium.launch();
+  const page = await browser.newPage();
+  await test(page);
   await browser.close();
 });
 
 describe('checkPublicAPI', function() {
-  it('diff-classes', testLint);
-  it('diff-methods', testLint);
-  it('diff-properties', testLint);
-  it('diff-arguments', testLint);
-  it('diff-events', testLint);
-  it('check-duplicates', testLint);
-  it('check-sorting', testLint);
-  it('check-returns', testLint);
-  it('check-nullish', testLint);
-  it('js-builder-common', testJSBuilder);
-  it('js-builder-inheritance', testJSBuilder);
-  it('md-builder-common', testMDBuilder);
-  it('md-builder-comments', testMDBuilder);
+  testLint('diff-classes');
+  testLint('diff-methods');
+  testLint('diff-properties');
+  testLint('diff-arguments');
+  testLint('diff-events');
+  testLint('check-duplicates');
+  testLint('check-sorting');
+  testLint('check-returns');
+  testLint('check-nullish');
+  testJSBuilder('js-builder-common');
+  testJSBuilder('js-builder-inheritance');
+  testMDBuilder('md-builder-common');
+  testMDBuilder('md-builder-comments');
 });
 
-runner.run();
-
-async function testLint(state, testRun) {
-  const dirPath = path.join(__dirname, testRun.test().name());
-  const mdSources = await Source.readdir(dirPath, '.md');
-  const tsSources = await Source.readdir(dirPath, '.ts');
-  const jsSources = await Source.readdir(dirPath, '.js');
-  const messages = await checkPublicAPI(page, mdSources, jsSources.concat(tsSources));
-  const errors = messages.map(message => message.text);
-  expect(errors.join('\n')).toBeGolden(path.join(testRun.test().name(), 'result.txt'));
+async function testLint(name) {
+  it(name, async({page}) => {
+    const dirPath = path.join(__dirname, name);
+    const mdSources = await Source.readdir(dirPath, '.md');
+    const tsSources = await Source.readdir(dirPath, '.ts');
+    const jsSources = await Source.readdir(dirPath, '.js');
+    const messages = await checkPublicAPI(page, mdSources, jsSources.concat(tsSources));
+    const errors = messages.map(message => message.text);
+    expect(errors.join('\n')).toBeGolden(path.join(dirPath, 'result.txt'));
+  });
 }
 
-async function testMDBuilder(state, testRun) {
-  const dirPath = path.join(__dirname, testRun.test().name());
-  const sources = await Source.readdir(dirPath, '.md');
-  const {documentation} = await mdBuilder(page, sources);
-  expect(serialize(documentation)).toBeGolden(path.join(testRun.test().name(), 'result.txt'));
+async function testMDBuilder(name) {
+  it(name, async({page}) => {
+    const dirPath = path.join(__dirname, name);
+    const sources = await Source.readdir(dirPath, '.md');
+    const {documentation} = await mdBuilder(page, sources);
+    expect(serialize(documentation)).toBeGolden(path.join(dirPath, 'result.txt'));
+  });
 }
 
-async function testJSBuilder(state, testRun) {
-  const dirPath = path.join(__dirname, testRun.test().name());
-  const jsSources = await Source.readdir(dirPath, '.js');
-  const tsSources = await Source.readdir(dirPath, '.ts');
-  const {documentation} = await jsBuilder.checkSources(jsSources.concat(tsSources));
-  expect(serialize(documentation)).toBeGolden(path.join(testRun.test().name(), 'result.txt'));
+async function testJSBuilder(name) {
+  it(name, async() => {
+    const dirPath = path.join(__dirname, name);
+    const jsSources = await Source.readdir(dirPath, '.js');
+    const tsSources = await Source.readdir(dirPath, '.ts');
+    const {documentation} = await jsBuilder.checkSources(jsSources.concat(tsSources));
+    expect(serialize(documentation)).toBeGolden(path.join(dirPath, 'result.txt'));
+  });
 }
 
 /**

utils/doclint/preprocessor/test.js

@@ -14,15 +14,8 @@
  * limitations under the License.
  */
 
-const {runCommands, ensureTipOfTreeAPILinks} = require('.');
+const {runCommands} = require('.');
 const Source = require('../Source');
-const TestRunner  = require('../../testrunner/');
-const runner = new TestRunner();
-
-const {describe, xdescribe, fdescribe} = runner.api();
-const {it, fit, xit} = runner.api();
-const {beforeAll, beforeEach, afterAll, afterEach} = runner.api();
-const {expect} = runner.api();
 
 describe('runCommands', function() {
   const OPTIONS_REL = {
@@ -202,5 +195,3 @@ describe('runCommands', function() {
   });
 });
 
-runner.run();
-