Parallelize tests (#729)

iTwin · Oct 7, 2024 · 1b51140 · 1b51140
1 parent 79bcbf1
commit 1b51140
Show file tree

Hide file tree

Showing 33 changed files with 256 additions and 197 deletions.
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -81,7 +81,7 @@
         "--config",
         "./.mocharc.json",
         "--no-timeouts",
-        "lib/cjs/test/**/*.test.js"
+        "--parallel=false"
       ],
       "outFiles": [
         "${workspaceFolder}/packages/components/lib/**/*.js"
@@ -101,7 +101,7 @@
         "--config",
         "./.mocharc.json",
         "--no-timeouts",
-        "lib/cjs/test/**/*.test.js"
+        "--parallel=false"
       ],
       "outFiles": [
         "${workspaceFolder}/packages/opentelemetry/lib/**/*.js"
@@ -121,7 +121,7 @@
         "--config",
         "./.mocharc.json",
         "--no-timeouts",
-        "lib/cjs/test/**/*.test.js"
+        "--parallel=false"
       ],
       "outFiles": [
         "${workspaceFolder}/packages/testing/lib/**/*.js"
@@ -141,7 +141,7 @@
         "--config",
         "./.mocharc.json",
         "--no-timeouts",
-        "./lib/**/*.test.js"
+        "--parallel=false"
       ],
       "env": {
         "NODE_ENV": "development",
@@ -158,7 +158,7 @@
         "--config",
         "./.mocharc.json",
         "--no-timeouts",
-        "lib/cjs/test/**/*.test.js"
+        "--parallel=false"
       ],
       "outFiles": [
         "${workspaceFolder}/packages/shared/lib/**/*.js"
@@ -178,7 +178,7 @@
         "--config",
         "./.mocharc.json",
         "--no-timeouts",
-        "lib/cjs/test/**/*.test.js"
+        "--parallel=false"
       ],
       "outFiles": [
         "${workspaceFolder}/packages/hierarchies/lib/**/*.js"
@@ -198,7 +198,7 @@
         "--config",
         "./.mocharc.json",
         "--no-timeouts",
-        "lib/cjs/test/**/*.test.js"
+        "--parallel=false"
       ],
       "outFiles": [
         "${workspaceFolder}/packages/core-interop/lib/**/*.js"
@@ -217,7 +217,8 @@
       "args": [
         "--config",
         "./.mocharc.json",
-        "--no-timeouts"
+        "--no-timeouts",
+        "--parallel=false"
       ],
       "outFiles": [
         "${workspaceFolder}/packages/components/lib/**/*.js",
@@ -244,7 +245,7 @@
         "--config",
         "./.mocharc.json",
         "--no-timeouts",
-        "lib/cjs/test/**/*.test.js"
+        "--parallel=false"
       ],
       "outFiles": [
         "${workspaceFolder}/packages/unified-selection/lib/**/*.js"
@@ -264,7 +265,7 @@
         "--config",
         "./.mocharc.json",
         "--no-timeouts",
-        "lib/cjs/test/**/*.test.js"
+        "--parallel=false"
       ],
       "outFiles": [
         "${workspaceFolder}/packages/hierarchies-react/lib/**/*.js"

diff --git a/apps/full-stack-tests/.mocharc.json b/apps/full-stack-tests/.mocharc.json
@@ -1,11 +1,9 @@
 {
-  "require": ["ignore-styles"],
+  "require": ["ignore-styles", "./lib/setup.js"],
   "checkLeaks": true,
   "globals": ["requestAnimationFrame", "IS_REACT_ACT_ENVIRONMENT"],
   "timeout": 60000,
   "slow": 500,
-  "file": ["./lib/setup.js"],
-  "reporter": ["node_modules/@itwin/build-tools/mocha-reporter"],
-  "reporterOptions": ["mochaFile=lib/test/junit_results.xml"],
+  "parallel": true,
   "spec": ["./lib/**/*.test.js"]
 }
diff --git a/apps/full-stack-tests/package.json b/apps/full-stack-tests/package.json
@@ -4,8 +4,8 @@
   "description": "Presentation integration tests",
   "private": true,
   "scripts": {
-    "build": "tsc",
-    "build:watch": "tsc -w",
+    "build": "node ./scripts/setup-tests.js && tsc",
+    "build:watch": "npm run build -- -w",
     "clean": "rimraf lib build",
     "cover": "npm run -s test",
     "lint": "eslint ./src/**/*.{ts,tsx}",

diff --git a/apps/full-stack-tests/scripts/setup-tests.js b/apps/full-stack-tests/scripts/setup-tests.js
@@ -0,0 +1,35 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+const { execFileSync } = require("child_process");
+const cpx = require("cpx2");
+const fs = require("fs");
+const path = require("path");
+
+cpx.copySync(`assets/**/*`, "lib/assets");
+copyITwinFrontendAssets("lib/public");
+pseudoLocalize("lib/public/locales");
+
+function copyITwinFrontendAssets(outputDir) {
+  const iTwinPackagesPath = "node_modules/@itwin";
+  fs.readdirSync(iTwinPackagesPath)
+    .map((packageName) => {
+      const packagePath = path.resolve(iTwinPackagesPath, packageName);
+      return path.join(packagePath, "lib", "public");
+    })
+    .filter((assetsPath) => fs.existsSync(assetsPath))
+    .forEach((src) => {
+      cpx.copySync(`${src}/**/*`, outputDir);
+    });
+}
+
+function pseudoLocalize(localesDir) {
+  const betoolsPath = path.resolve("node_modules", "@itwin", "build-tools", "bin", "betools.js");
+  const args = [betoolsPath, "pseudolocalize", "--englishDir", `${localesDir}/en`, "--out", `${localesDir}/en-PSEUDO`];
+  try {
+    execFileSync("node", args);
+  } catch {
+    throw new Error("Failed to pseudoLocalize localization files");
+  }
+}
diff --git a/apps/full-stack-tests/src/IntegrationTests.ts b/apps/full-stack-tests/src/IntegrationTests.ts
@@ -66,7 +66,7 @@ export async function initialize(props?: { backendTimeout?: number }) {
   const presentationTestingInitProps: PresentationTestingInitProps = {
     rpcs: [SnapshotIModelRpcInterface, IModelReadRpcInterface, PresentationRpcInterface, ECSchemaRpcInterface],
     backendProps: backendInitProps,
-    backendHostProps: { cacheDir: path.join(__dirname, ".cache") },
+    backendHostProps: { cacheDir: path.join(__dirname, ".cache", `${process.pid}`) },
     frontendProps: frontendInitProps,
     frontendApp: IntegrationTestsApp,
     frontendAppOptions,

diff --git a/apps/full-stack-tests/src/components/tree/Update.test.tsx b/apps/full-stack-tests/src/components/tree/Update.test.tsx
@@ -15,8 +15,9 @@ import {
   TreeModelNode,
   TreeModelRootNode,
   TreeModelSource,
+  UiComponents,
 } from "@itwin/components-react";
-import { IModelConnection, SnapshotConnection } from "@itwin/core-frontend";
+import { IModelApp, IModelConnection, SnapshotConnection } from "@itwin/core-frontend";
 import { ChildNodeSpecificationTypes, Ruleset, RuleTypes } from "@itwin/presentation-common";
 import { IPresentationTreeDataProvider, usePresentationTreeState, UsePresentationTreeStateProps } from "@itwin/presentation-components";
 import { Presentation } from "@itwin/presentation-frontend";
@@ -46,6 +47,14 @@ describe("Tree update", () => {
   describe("detection", () => {
     let defaultProps: Omit<UsePresentationTreeStateProps, "ruleset">;
 
+    before(async () => {
+      await UiComponents.initialize(IModelApp.localization);
+    });
+
+    after(() => {
+      UiComponents.terminate();
+    });
+
     beforeEach(() => {
       defaultProps = {
         imodel,

diff --git a/apps/full-stack-tests/src/setup.ts b/apps/full-stack-tests/src/setup.ts
@@ -2,57 +2,50 @@
  * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
+// WARNING: The order of imports in this file is important!
 
+// setup chai
 import * as chai from "chai";
 import chaiJestSnapshot from "chai-jest-snapshot";
 import chaiSubset from "chai-subset";
-import { execFileSync } from "child_process";
-import * as cpx from "cpx2";
-import * as fs from "fs";
-import globalJsdom from "global-jsdom";
-import * as jsdom from "jsdom";
-import * as path from "path";
-import ResizeObserver from "resize-observer-polyfill";
 import sinonChai from "sinon-chai";
-
-// eslint-disable-next-line no-console
-console.log(`Backend PID: ${process.pid}`);
-
-// get rid of various xhr errors in the console
-globalJsdom(undefined, {
-  virtualConsole: new jsdom.VirtualConsole().sendTo(console, { omitJSDOMErrors: true }),
-});
-global.ResizeObserver = ResizeObserver;
-
-// setup chai
 chai.use(chaiJestSnapshot);
 chai.use(sinonChai);
 chai.use(chaiSubset);
 
-before(function () {
-  chaiJestSnapshot.resetSnapshotRegistry();
-
-  cpx.copySync(`assets/**/*`, "lib/assets");
-  copyITwinFrontendAssets("lib/public");
-  pseudoLocalize("lib/public/locales");
-
-  getGlobalThis().IS_REACT_ACT_ENVIRONMENT = true;
-});
-
-beforeEach(function () {
-  const currentTest = this.currentTest!;
-
-  // set up snapshot name
-  const sourceFilePath = currentTest.file!.replace("lib", "src").replace(/\.(jsx?|tsx?)$/, "");
-  const snapPath = `${sourceFilePath}.snap`;
-  chaiJestSnapshot.setFilename(snapPath);
-  chaiJestSnapshot.setTestName(currentTest.fullTitle());
+// get rid of various xhr errors in the console
+import globalJsdom from "global-jsdom";
+import * as jsdom from "jsdom";
+globalJsdom(undefined, {
+  virtualConsole: new jsdom.VirtualConsole().sendTo(console, { omitJSDOMErrors: true }),
 });
 
-after(function () {
-  delete getGlobalThis().IS_REACT_ACT_ENVIRONMENT;
-});
+// polyfill ResizeObserver
+import ResizeObserver from "resize-observer-polyfill";
+global.ResizeObserver = ResizeObserver;
 
+// supply mocha hooks
+import { cleanup } from "@testing-library/react";
+export const mochaHooks = {
+  beforeAll() {
+    chaiJestSnapshot.resetSnapshotRegistry();
+    getGlobalThis().IS_REACT_ACT_ENVIRONMENT = true;
+  },
+  beforeEach() {
+    // set up snapshot name
+    const currentTest = (this as unknown as Mocha.Context).currentTest!;
+    const sourceFilePath = currentTest.file!.replace("lib", "src").replace(/\.(jsx?|tsx?)$/, "");
+    const snapPath = `${sourceFilePath}.snap`;
+    chaiJestSnapshot.setFilename(snapPath);
+    chaiJestSnapshot.setTestName(currentTest.fullTitle());
+  },
+  afterEach() {
+    cleanup();
+  },
+  afterAll() {
+    delete getGlobalThis().IS_REACT_ACT_ENVIRONMENT;
+  },
+};
 // eslint-disable-next-line @typescript-eslint/naming-convention
 function getGlobalThis(): typeof globalThis & { IS_REACT_ACT_ENVIRONMENT?: boolean } {
   /* istanbul ignore else */
@@ -74,26 +67,3 @@ function getGlobalThis(): typeof globalThis & { IS_REACT_ACT_ENVIRONMENT?: boole
   /* istanbul ignore next */
   throw new Error("unable to locate global object");
 }
-
-function copyITwinFrontendAssets(outputDir: string) {
-  const iTwinPackagesPath = "node_modules/@itwin";
-  fs.readdirSync(iTwinPackagesPath)
-    .map((packageName) => {
-      const packagePath = path.resolve(iTwinPackagesPath, packageName);
-      return path.join(packagePath, "lib", "public");
-    })
-    .filter((assetsPath) => fs.existsSync(assetsPath))
-    .forEach((src) => {
-      cpx.copySync(`${src}/**/*`, outputDir);
-    });
-}
-
-function pseudoLocalize(localesDir: string) {
-  const betoolsPath = path.resolve("node_modules", "@itwin", "build-tools", "bin", "betools.js");
-  const args = [betoolsPath, "pseudolocalize", "--englishDir", `${localesDir}/en`, "--out", `${localesDir}/en-PSEUDO`];
-  try {
-    execFileSync("node", args);
-  } catch {
-    throw new Error("Failed to pseudoLocalize localization files");
-  }
-}
diff --git a/apps/full-stack-tests/src/unified-selection/HiliteSet.test.ts b/apps/full-stack-tests/src/unified-selection/HiliteSet.test.ts
@@ -33,7 +33,11 @@ describe("HiliteSet", () => {
   let iModel: IModelConnection;
 
   before(async () => {
-    await initialize();
+    await initialize({
+      backendHostProps: {
+        cacheDir: path.join(__dirname, ".cache", `${process.pid}`),
+      },
+    });
     // eslint-disable-next-line @itwin/no-internal
     RpcManager.registerImpl(ECSchemaRpcInterface, ECSchemaRpcImpl);
     RpcConfiguration.developmentMode = true;

diff --git a/apps/full-stack-tests/src/unified-selection/SelectionScope.test.ts b/apps/full-stack-tests/src/unified-selection/SelectionScope.test.ts
@@ -29,7 +29,11 @@ describe("SelectionScope", () => {
   let iModel: IModelConnection;
 
   before(async () => {
-    await initialize();
+    await initialize({
+      backendHostProps: {
+        cacheDir: path.join(__dirname, ".cache", `${process.pid}`),
+      },
+    });
     // eslint-disable-next-line @itwin/no-internal
     RpcManager.registerImpl(ECSchemaRpcInterface, ECSchemaRpcImpl);
     RpcConfiguration.developmentMode = true;

diff --git a/packages/components/.mocharc.json b/packages/components/.mocharc.json
@@ -1,10 +1,9 @@
 {
-  "require": ["ignore-styles"],
+  "require": ["ignore-styles", "./lib/cjs/test/setup"],
   "checkLeaks": true,
   "global": ["IS_REACT_ACT_ENVIRONMENT", "__iui"],
   "timeout": 60000,
-  "file": ["./lib/cjs/test/index.js"],
-  "exclude": ["./lib/test/coverage/**/*"],
-  "reporter": ["node_modules/@itwin/build-tools/mocha-reporter"],
-  "reporterOptions": ["mochaFile=lib/test/junit_results.xml"]
+  "parallel": true,
+  "spec": ["./lib/cjs/test/**/*.test.js"],
+  "exclude": ["./lib/test/coverage/**/*"]
 }
diff --git a/packages/components/package.json b/packages/components/package.json
@@ -36,7 +36,7 @@
     "clean": "rimraf lib build",
     "cover": "nyc npm -s test",
     "lint": "eslint ./src/**/*.{ts,tsx}",
-    "test": "mocha --enable-source-maps --config ./.mocharc.json \"./lib/cjs/test/**/*.test.js\"",
+    "test": "mocha --enable-source-maps --config ./.mocharc.json",
     "test:watch": "npm -s test -- --reporter min --watch-extensions ts,tsx --watch",
     "docs": "npm run -s docs:extract && npm run -s docs:reference && npm run -s docs:changelog",
     "docs:changelog": "cpx ./CHANGELOG.md ./build/docs/reference/presentation-components",