tests: sequester mocks to -test.mocks.js files

flow-report/test/run-flow-report-tests.sh

@@ -8,13 +8,13 @@
 
 set -eux
 
+SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+LH_ROOT="$SCRIPT_DIR/../.."
+
 ARGS=(
   --testMatch='{flow-report/**/*-test.ts,flow-report/**/*-test.tsx}'
-  --require=flow-report/test/setup/env-setup.ts
-  --loader=@esbuild-kit/esm-loader
-  # util-test.tsx won't finish on its own because of an open MessagePort, so help it out.
-  # See https://github.com/jsdom/jsdom/issues/2448#issuecomment-802288244
-  --exit
+  --require="$LH_ROOT/flow-report/test/setup/env-setup.ts"
 )
 
-yarn mocha ${ARGS[*]} "$@"
+cd "$LH_ROOT"
+node --loader=@esbuild-kit/esm-loader lighthouse-core/test/scripts/run-mocha-tests.js ${ARGS[*]} "$@"

flow-report/test/setup/env-setup.ts

@@ -21,32 +21,35 @@ fs.writeFileSync(`${LH_ROOT}/node_modules/@testing-library/preact/dist/esm/packa
 fs.writeFileSync(`${LH_ROOT}/node_modules/@testing-library/preact-hooks/src/package.json`,
   '{"type": "module"}');
 
-// @ts-expect-error
-global.React = preact;
-
-export default {
-  mochaHooks: {
-    beforeEach() {
-      const {window} = new JSDOM(undefined, {
-        url: 'file:///Users/example/report.html/',
-      });
-      global.window = window as any;
-      global.document = window.document;
-      global.location = window.location;
-      global.self = global.window;
-
-      // Use JSDOM types as necessary.
-      global.Blob = window.Blob;
-      global.HTMLInputElement = window.HTMLInputElement;
-
-      // Functions not implemented in JSDOM.
-      window.Element.prototype.scrollIntoView = jestMock.fn();
-      global.self.matchMedia = jestMock.fn<any, any>(() => ({
-        addListener: jestMock.fn(),
-      }));
-
-      // @ts-expect-error: for @testing-library/preact-hooks
-      global.MessageChannel = MessageChannel;
-    },
+const rootHooks = {
+  beforeAll() {
+    // @ts-expect-error
+    global.React = preact;
   },
+  beforeEach() {
+    const {window} = new JSDOM(undefined, {
+      url: 'file:///Users/example/report.html/',
+    });
+    global.window = window as any;
+    global.document = window.document;
+    global.location = window.location;
+    global.self = global.window;
+
+    // Use JSDOM types as necessary.
+    global.Blob = window.Blob;
+    global.HTMLInputElement = window.HTMLInputElement;
+
+    // Functions not implemented in JSDOM.
+    window.Element.prototype.scrollIntoView = jestMock.fn();
+    global.self.matchMedia = jestMock.fn<any, any>(() => ({
+      addListener: jestMock.fn(),
+    }));
+
+    // @ts-expect-error: for @testing-library/preact-hooks
+    global.MessageChannel = MessageChannel;
+  },
+};
+
+export {
+  rootHooks,
 };

lighthouse-core/test/fraggle-rock/gather/navigation-runner-test.js

@@ -9,8 +9,6 @@ import jestMock from 'jest-mock';
 import {
   createMockDriver,
   createMockBaseArtifacts,
-  mockDriverSubmodules,
-  mockRunnerModule,
 } from './mock-driver.js';
 import {initializeConfig} from '../../../fraggle-rock/config/config.js';
 import {defaultNavigationConfig} from '../../../config/constants.js';
@@ -19,21 +17,17 @@ import DevtoolsLogGatherer from '../../../gather/gatherers/devtools-log.js';
 import TraceGatherer from '../../../gather/gatherers/trace.js';
 import {fnAny} from '../../test-utils.js';
 import {networkRecordsToDevtoolsLog} from '../../network-records-to-devtools-log.js';
-import {Runner as runnerActual} from '../../../runner.js';
+import * as runner from '../../../fraggle-rock/gather/navigation-runner.js';
 
-// Some imports needs to be done dynamically, so that their dependencies will be mocked.
-// See: https://jestjs.io/docs/ecmascript-modules#differences-between-esm-and-commonjs
-//      https://github.com/facebook/jest/issues/10025
-/** @type {import('../../../fraggle-rock/gather/navigation-runner.js')} */
-let runner;
+/** @type {import('./navigation-runner-test.mocks.js').testContext} */
+// @ts-expect-error
+const testContext = global.lighthouseTestContext;
+const {mocks, mockRunner, runnerActual} = testContext;
 
-const mocks = await mockDriverSubmodules();
-const mockRunner = await mockRunnerModule();
 beforeEach(async () => {
   mockRunner.reset();
   mockRunner.getGathererList.mockImplementation(runnerActual.getGathererList);
   mockRunner.getAuditList.mockImplementation(runnerActual.getAuditList);
-  runner = (await import('../../../fraggle-rock/gather/navigation-runner.js'));
 });
 
 /** @typedef {{meta: LH.Gatherer.GathererMeta<'Accessibility'>, getArtifact: Mock<any, any>, startInstrumentation: Mock<any, any>, stopInstrumentation: Mock<any, any>, startSensitiveInstrumentation: Mock<any, any>, stopSensitiveInstrumentation:  Mock<any, any>}} MockGatherer */

lighthouse-core/test/fraggle-rock/gather/navigation-runner-test.mocks.js

@@ -0,0 +1,25 @@
+/**
+ * @license Copyright 2022 The Lighthouse Authors. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ */
+
+import {Runner} from '../../../runner.js';
+import {
+  mockDriverSubmodules,
+  mockRunnerModule,
+} from './mock-driver.js';
+
+const mocks = await mockDriverSubmodules();
+const mockRunner = await mockRunnerModule();
+
+mockRunner.getGathererList.mockImplementation(Runner.getGathererList);
+mockRunner.getAuditList.mockImplementation(Runner.getAuditList);
+
+/** @typedef {typeof testContext} testContext */
+const testContext = {
+  mocks,
+  mockRunner,
+  runnerActual: Runner,
+};
+export {testContext};

lighthouse-core/test/gather/fetcher-test.js

@@ -4,26 +4,13 @@
  * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
  */
 
+import {Fetcher} from '../../gather/fetcher.js';
+import {Driver} from '../../gather/driver.js';
 import {Connection} from '../../gather/connections/connection.js';
 import {fnAny, mockCommands} from '../test-utils.js';
 
 const {createMockSendCommandFn} = mockCommands;
 
-// Some imports needs to be done dynamically, so that their dependencies will be mocked.
-// See: https://jestjs.io/docs/ecmascript-modules#differences-between-esm-and-commonjs
-//      https://github.com/facebook/jest/issues/10025
-/** @typedef {import('../../gather/driver.js').Driver} Driver */
-/** @type {typeof import('../../gather/driver.js').Driver} */
-let Driver;
-/** @typedef {import('../../gather/fetcher.js').Fetcher} Fetcher */
-/** @type {typeof import('../../gather/fetcher.js').Fetcher} */
-let Fetcher;
-
-before(async () => {
-  Driver = (await import('../../gather/driver.js')).Driver;
-  Fetcher = (await import('../../gather/fetcher.js')).Fetcher;
-});
-
 /** @type {Connection} */
 let connectionStub;
 /** @type {Driver} */

lighthouse-core/test/gather/gather-runner-test.js

@@ -9,15 +9,14 @@ import {strict as assert} from 'assert';
 import jestMock from 'jest-mock';
 
 import {Gatherer} from '../../gather/gatherers/gatherer.js';
-// import GathererRunner_ from '../../gather/gather-runner.js';
-// import {Config} from '../../config/config.js';
+import {GatherRunner as GatherRunner_} from '../../gather/gather-runner.js';
+import {Config} from '../../config/config.js';
 import {LighthouseError} from '../../lib/lh-error.js';
 import {networkRecordsToDevtoolsLog} from '../network-records-to-devtools-log.js';
-// import {Driver} from '../../gather/driver.js';
+import {Driver} from '../../gather/driver.js';
 import {Connection} from '../../gather/connections/connection.js';
 import {createMockSendCommandFn, createMockOnceFn} from './mock-commands.js';
 import {
-  makeMocksForGatherRunner,
   makeParamsOptional,
   makePromiseInspectable,
   flushAllTimersAndMicrotasks,
@@ -30,8 +29,6 @@ import {fakeDriver} from './fake-driver.js';
 
 const unresolvedPerfLog = readJson('./../fixtures/unresolved-perflog.json', import.meta);
 
-await makeMocksForGatherRunner();
-
 /** @type {jestMock.SpyInstance<Promise<void>, [session: any, pageUrl: string]>} */
 let assertNoSameOriginServiceWorkerClientsMock;
 
@@ -49,24 +46,9 @@ function createTypeHackedGatherRunner() {
   };
 }
 
-// Some imports needs to be done dynamically, so that their dependencies will be mocked.
-// See: https://jestjs.io/docs/ecmascript-modules#differences-between-esm-and-commonjs
-//      https://github.com/facebook/jest/issues/10025
-/** @typedef {import('../../gather/driver.js').Driver} Driver */
-/** @type {typeof import('../../gather/driver.js').Driver} */
-let Driver;
-/** @type {typeof import('../../gather/gather-runner.js').GatherRunner} */
-let GatherRunner_;
-/** @typedef {import('../../config/config.js').Config} Config */
-/** @type {typeof import('../../config/config.js').Config} */
-let Config;
-
 /** @type {ReturnType<createTypeHackedGatherRunner>} */
 let GatherRunner;
 before(async () => {
-  Driver = (await import('../../gather/driver.js')).Driver;
-  GatherRunner_ = (await import('../../gather/gather-runner.js')).GatherRunner;
-  Config = (await import('../../config/config.js')).Config;
   assertNoSameOriginServiceWorkerClientsMock =
     jestMock.spyOn(GatherRunner_, 'assertNoSameOriginServiceWorkerClients');
   GatherRunner = createTypeHackedGatherRunner();

lighthouse-core/test/gather/gather-runner-test.mocks.js

@@ -0,0 +1,9 @@
+/**
+ * @license Copyright 2022 The Lighthouse Authors. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ */
+
+import {makeMocksForGatherRunner} from '../test-utils.js';
+
+await makeMocksForGatherRunner();

lighthouse-core/test/runner-test.js

@@ -9,62 +9,31 @@ import {strict as assert} from 'assert';
 import path from 'path';
 
 import jestMock from 'jest-mock';
-import * as td from 'testdouble';
 
-// import Runner from '../runner.js';
-// import {GatherRunner} from '../gather/gather-runner.js';
+import {Runner} from '../runner.js';
+import {GatherRunner} from '../gather/gather-runner.js';
 import {fakeDriver as driverMock} from './gather/fake-driver.js';
-// import {Config} from '../config/config.js';
+import {Config} from '../config/config.js';
 import {Audit} from '../audits/audit.js';
 import {Gatherer} from '../gather/gatherers/gatherer.js';
 import * as assetSaver from '../lib/asset-saver.js';
 import {LighthouseError} from '../lib/lh-error.js';
 import * as i18n from '../lib/i18n/i18n.js';
-import {importMock, makeMocksForGatherRunner} from './test-utils.js';
+import {importMock} from './test-utils.js';
 import {getModuleDirectory} from '../../esm-utils.js';
 
 const moduleDir = getModuleDirectory(import.meta);
 
-await makeMocksForGatherRunner();
+/** @type {import('./runner-test.mocks.js').testContext} */
+// @ts-expect-error
+const testContext = global.lighthouseTestContext;
+const {saveArtifactsSpy, saveLhrSpy, loadArtifactsSpy} = testContext;
 
-// Some imports needs to be done dynamically, so that their dependencies will be mocked.
-// See: https://jestjs.io/docs/ecmascript-modules#differences-between-esm-and-commonjs
-//      https://github.com/facebook/jest/issues/10025
-/** @type {typeof import('../runner.js').Runner} */
-let Runner;
-/** @type {typeof import('../gather/gather-runner.js').GatherRunner} */
-let GatherRunner;
-/** @type {typeof import('../config/config.js').Config} */
-let Config;
-
-/** @type {jestMock.Mock} */
-let saveArtifactsSpy;
-/** @type {jestMock.Mock} */
-let saveLhrSpy;
-/** @type {jestMock.Mock} */
-let loadArtifactsSpy;
 /** @type {jestMock.Mock} */
 let gatherRunnerRunSpy;
 /** @type {jestMock.Mock} */
 let runAuditSpy;
 
-await td.replaceEsm('../lib/asset-saver.js', {
-  saveArtifacts: saveArtifactsSpy = jestMock.fn(assetSaver.saveArtifacts),
-  saveLhr: saveLhrSpy = jestMock.fn(),
-  loadArtifacts: loadArtifactsSpy = jestMock.fn(assetSaver.loadArtifacts),
-});
-
-await td.replaceEsm('../gather/driver/service-workers.js', {
-  getServiceWorkerVersions: jestMock.fn().mockResolvedValue({versions: []}),
-  getServiceWorkerRegistrations: jestMock.fn().mockResolvedValue({registrations: []}),
-});
-
-before(async () => {
-  Runner = (await import('../runner.js')).Runner;
-  GatherRunner = (await import('../gather/gather-runner.js')).GatherRunner;
-  Config = (await import('../config/config.js')).Config;
-});
-
 beforeEach(() => {
   gatherRunnerRunSpy = jestMock.spyOn(GatherRunner, 'run');
   runAuditSpy = jestMock.spyOn(Runner, '_runAudit');

lighthouse-core/test/runner-test.mocks.js

@@ -0,0 +1,39 @@
+/**
+ * @license Copyright 2022 The Lighthouse Authors. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ */
+
+import jestMock from 'jest-mock';
+import * as td from 'testdouble';
+
+import {makeMocksForGatherRunner} from './test-utils.js';
+import * as assetSaver from '../lib/asset-saver.js';
+
+await makeMocksForGatherRunner();
+
+/** @type {jestMock.Mock} */
+let saveArtifactsSpy;
+/** @type {jestMock.Mock} */
+let saveLhrSpy;
+/** @type {jestMock.Mock} */
+let loadArtifactsSpy;
+
+await td.replaceEsm('../lib/asset-saver.js', {
+  saveArtifacts: saveArtifactsSpy = jestMock.fn(assetSaver.saveArtifacts),
+  saveLhr: saveLhrSpy = jestMock.fn(),
+  loadArtifacts: loadArtifactsSpy = jestMock.fn(assetSaver.loadArtifacts),
+});
+
+await td.replaceEsm('../gather/driver/service-workers.js', {
+  getServiceWorkerVersions: jestMock.fn().mockResolvedValue({versions: []}),
+  getServiceWorkerRegistrations: jestMock.fn().mockResolvedValue({registrations: []}),
+});
+
+/** @typedef {typeof testContext} testContext */
+const testContext = {
+  saveArtifactsSpy,
+  saveLhrSpy,
+  loadArtifactsSpy,
+};
+export {testContext};