Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Rewrite JUnit hook failures so Trunk attributes them to the original test (#74344)

Oleh Kd96b9900191b
diff --git a/.github/workflows/e2e-test.yml b/.github/workflows/e2e-test.yml
index 6069af39630..8b111d98698 100644
--- a/.github/workflows/e2e-test.yml
+++ b/.github/workflows/e2e-test.yml
@@ -158,6 +158,17 @@ jobs:
# whether to fail or to pass the whole job, based on the quarantine list.
continue-on-error: true
+ - name: Rewrite JUnit hook failures (dry-run)
+ if: always()
+ continue-on-error: true
+ shell: bash
+ run: |
+ if [ -d ./target/junit ]; then
+ bun e2e/support/fix-junit-hooks.ts --dry-run ./target/junit
+ else
+ echo "No ./target/junit directory; nothing to process."
+ fi
+
- name: Upload Test Results
uses: ./.github/actions/upload-test-results
if: always()
diff --git a/.github/workflows/embedding-sdk-component-tests.yml b/.github/workflows/embedding-sdk-component-tests.yml
index 7847a8c862b..a7597ae1170 100644
--- a/.github/workflows/embedding-sdk-component-tests.yml
+++ b/.github/workflows/embedding-sdk-component-tests.yml
@@ -87,6 +87,17 @@ jobs:
CYPRESS_BROWSER: ${{ steps.cypress-prep.outputs.chrome-path }}
run: node e2e/runner/run_cypress_ci.js component
+ - name: Rewrite JUnit hook failures (dry-run)
+ if: always()
+ continue-on-error: true
+ shell: bash
+ run: |
+ if [ -d ./target/junit ]; then
+ bun e2e/support/fix-junit-hooks.ts --dry-run ./target/junit
+ else
+ echo "No ./target/junit directory; nothing to process."
+ fi
+
- name: Upload Test Results
uses: ./.github/actions/upload-test-results
if: always()
@@ -240,6 +251,17 @@ jobs:
node e2e/runner/run_cypress_ci.js component \
--expose grepTags="-@skip-backward-compatibility"
+ - name: Rewrite JUnit hook failures (dry-run)
+ if: always()
+ continue-on-error: true
+ shell: bash
+ run: |
+ if [ -d ./target/junit ]; then
+ bun e2e/support/fix-junit-hooks.ts --dry-run ./target/junit
+ else
+ echo "No ./target/junit directory; nothing to process."
+ fi
+
- name: Upload Test Results
uses: ./.github/actions/upload-test-results
if: always()
diff --git a/bun.lock b/bun.lock
index 025af55c8c1..2cdff9e1148 100644
--- a/bun.lock
+++ b/bun.lock
@@ -319,6 +319,8 @@
"eslint-plugin-storybook": "9.1.17",
"eslint-plugin-testing-library": "7.15.4",
"eslint-plugin-ttag": "^1.1.0",
+ "fast-xml-builder": "^1.2.0",
+ "fast-xml-parser": "^5.8.0",
"fetch-mock": "^12.0.0",
"get-nonce": "^1.0.1",
"glob": "^7.1.1",
@@ -1208,6 +1210,8 @@
"@noble/hashes": ["@noble/[email protected]", "", {}, "sha512-jCs9ldd7NwzpgXDIf6P3+NrHh9/sD6CQdxHyjQI+h/6rDNo88ypBxxz45UDuZHz9r3tNz7N/VInSVoVdtXEI4A=="],
+ "@nodable/entities": ["@nodable/[email protected]", "", {}, "sha512-nyT7T3nbMyBI/lvr6L5TyWbFJAI9FTgVRakNoBqCD+PmID8DzFrrNdLLtHMwMszOtqZa8PAOV24ZqDnQrhQINA=="],
+
"@nodelib/fs.scandir": ["@nodelib/[email protected]", "", { "dependencies": { "@nodelib/fs.stat": "2.0.5", "run-parallel": "^1.1.9" } }, "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g=="],
"@nodelib/fs.stat": ["@nodelib/[email protected]", "", {}, "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A=="],
@@ -3102,7 +3106,9 @@
"fast-uri": ["[email protected]", "", {}, "sha512-MWipKbbYiYI0UC7cl8m/i/IWTqfC8YXsqjzybjddLsFjStroQzsHXkc73JutMvBiXmOvapk+axIl79ig5t55Bw=="],
- "fast-xml-parser": ["[email protected]", "", { "dependencies": { "strnum": "^2.1.2" }, "bin": { "fxparser": "src/cli/cli.js" } }, "sha512-QNI3sAvSvaOiaMl8FYU4trnEzCwiRr8XMWgAHzlrWpTSj+QaCSvOf1h82OEP1s4hiAXhnbXSyFWCf4ldZzZRVA=="],
+ "fast-xml-builder": ["[email protected]", "", { "dependencies": { "path-expression-matcher": "^1.5.0", "xml-naming": "^0.1.0" } }, "sha512-00aAWieqff+ZJhsXA4g1g7M8k+7AYoMUUHF+/zFb5U6Uv/P0Vl4QZo84/IcufzYalLuEj9928bXN9PbbFzMF0Q=="],
+
+ "fast-xml-parser": ["[email protected]", "", { "dependencies": { "@nodable/entities": "^2.1.0", "fast-xml-builder": "^1.2.0", "path-expression-matcher": "^1.5.0", "strnum": "^2.3.0", "xml-naming": "^0.1.0" }, "bin": { "fxparser": "src/cli/cli.js" } }, "sha512-6bIM7fsJxeo3uXv7OncQYsBAMPJ7V16Slahl/6M98C/i2q+vB1+4a0MtrvYwDFEUrwDSbAmeLDRXsOBwrL7yAg=="],
"fastest-levenshtein": ["[email protected]", "", {}, "sha512-eRnCtTTtGZFpQCwhJiUOuxPQWRXVKYDn0b2PeHfXL6/Zi53SLAzAHfVhVWK2AryC/WH05kGfxhFIPvTF0SXQzg=="],
@@ -4260,6 +4266,8 @@
"path-exists": ["[email protected]", "", {}, "sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w=="],
+ "path-expression-matcher": ["[email protected]", "", {}, "sha512-cbrerZV+6rvdQrrD+iGMcZFEiiSrbv9Tfdkvnusy6y0x0GKBXREFg/Y65GhIfm0tnLntThhzCnfKwp1WRjeCyQ=="],
+
"path-is-absolute": ["[email protected]", "", {}, "sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg=="],
"path-key": ["[email protected]", "", {}, "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q=="],
@@ -5022,7 +5030,7 @@
"strip-json-comments": ["[email protected]", "", {}, "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig=="],
- "strnum": ["[email protected]", "", {}, "sha512-l63NF9y/cLROq/yqKXSLtcMeeyOfnSQlfMSlzFt/K73oIaD8DGaQWd7Z34X9GPiKqP5rbSh84Hl4bOlLcjiSrQ=="],
+ "strnum": ["[email protected]", "", {}, "sha512-ums3KNd42PGyx5xaoVTO1mjU1bH3NpY4vsrVlnv9PNGqQj8wd7rJ6nEypLrJ7z5vxK5RP0yMLo6J/Gsm62DI5Q=="],
"strtok3": ["[email protected]", "", { "dependencies": { "@tokenizer/token": "^0.3.0", "peek-readable": "^5.0.0" } }, "sha512-pQ+V+nYQdC5H3Q7qBZAz/MO6lwGhoC2gOAjuouGf/VO0m7vQRh8QNMl2Uf6SwAtzZ9bOw3UIeBukEGNJl5dtXQ=="],
@@ -5448,6 +5456,8 @@
"xml-name-validator": ["[email protected]", "", {}, "sha512-EvGK8EJ3DhaHfbRlETOWAS5pO9MZITeauHKJyb8wyajUfQUenkIg2MvLDTZ4T/TgIcm3HU0TFBgWWboAZ30UHg=="],
+ "xml-naming": ["[email protected]", "", {}, "sha512-k8KO9hrMyNk6tUWqUfkTEZbezRRpONVOzUTnc97VnCvyj6Tf9lyUR9EDAIeiVLv56jsMcoXEwjW8Kv5yPY52lw=="],
+
"xml2js": ["[email protected]", "", { "dependencies": { "sax": ">=0.6.0", "xmlbuilder": "~11.0.0" } }, "sha512-T4rieHaC1EXcES0Kxxj4JWgaUQHDk+qwHcYOCFHfiwKz7tOVPLq7Hjq9dM1WCMhylqMEfP7hMcOIChvotiZegA=="],
"xmlbuilder": ["[email protected]", "", {}, "sha512-fDlsI/kFEx7gLvbecc0/ohLG50fugQp8ryHzMTuW9vSa1GJ0XYWKnhsUx7oie3G98+r56aTQIUB4kht42R3JvA=="],
@@ -6666,6 +6676,8 @@
"openapi-sampler/@types/json-schema": ["@types/[email protected]", "", {}, "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA=="],
+ "openapi-sampler/fast-xml-parser": ["[email protected]", "", { "dependencies": { "strnum": "^2.1.2" }, "bin": { "fxparser": "src/cli/cli.js" } }, "sha512-QNI3sAvSvaOiaMl8FYU4trnEzCwiRr8XMWgAHzlrWpTSj+QaCSvOf1h82OEP1s4hiAXhnbXSyFWCf4ldZzZRVA=="],
+
"openapi-typescript/@redocly/openapi-core": ["@redocly/[email protected]", "", { "dependencies": { "@redocly/ajv": "^8.11.2", "@redocly/config": "^0.22.0", "colorette": "^1.2.0", "https-proxy-agent": "^7.0.5", "js-levenshtein": "^1.1.6", "js-yaml": "^4.1.0", "minimatch": "^5.0.1", "pluralize": "^8.0.0", "yaml-ast-parser": "0.0.43" } }, "sha512-0EbE8LRbkogtcCXU7liAyC00n9uNG9hJ+eMyHFdUsy9lB/WGqnEBgwjA9q2cyzAVcdTkQqTBBU1XePNnN3OijA=="],
"openapi-typescript/supports-color": ["[email protected]", "", {}, "sha512-SS+jx45GF1QjgEXQx4NJZV9ImqmO2NPz5FNsIHrsDjh2YsHnawpan7SNQ1o8NuhrbHZy9AZhIoCUiCeaW/C80g=="],
@@ -7982,6 +7994,8 @@
"object.getownpropertydescriptors/es-abstract/which-typed-array": ["[email protected]", "", { "dependencies": { "available-typed-arrays": "^1.0.6", "call-bind": "^1.0.5", "for-each": "^0.3.3", "gopd": "^1.0.1", "has-tostringtag": "^1.0.1" } }, "sha512-VnXFiIW8yNn9kIHN88xvZ4yOWchftKDsRJ8fEPacX/wl1lOvBrhsJ/OeJCXq7B0AaijRuqgzSKalJoPk+D8MPg=="],
+ "openapi-sampler/fast-xml-parser/strnum": ["[email protected]", "", {}, "sha512-l63NF9y/cLROq/yqKXSLtcMeeyOfnSQlfMSlzFt/K73oIaD8DGaQWd7Z34X9GPiKqP5rbSh84Hl4bOlLcjiSrQ=="],
+
"openapi-typescript/@redocly/openapi-core/@redocly/ajv": ["@redocly/[email protected]", "", { "dependencies": { "fast-deep-equal": "^3.1.1", "json-schema-traverse": "^1.0.0", "require-from-string": "^2.0.2", "uri-js-replace": "^1.0.1" } }, "sha512-4P3iZse91TkBiY+Dx5DUgxQ9GXkVJf++cmI0MOyLDxV9b5MUBI4II6ES8zA5JCbO72nKAJxWrw4PUPW+YP3ZDQ=="],
"openapi-typescript/@redocly/openapi-core/@redocly/config": ["@redocly/[email protected]", "", {}, "sha512-roRDai8/zr2S9YfmzUfNhKjOF0NdcOIqF7bhf4MVC5UxpjIysDjyudvlAiVbpPHp3eDRWbdzUgtkK1a7YiDNyQ=="],
diff --git a/e2e/support/fix-junit-hooks.ts b/e2e/support/fix-junit-hooks.ts
new file mode 100755
index 00000000000..f198572c523
--- /dev/null
+++ b/e2e/support/fix-junit-hooks.ts
@@ -0,0 +1,241 @@
+#!/usr/bin/env bun
+
+// Rewrite Cypress JUnit XML so hook failures are attributed to the
+// underlying test. When a `before each` / `before all` / `after each` /
+// `after all` hook throws, mocha-junit-reporter records the failing testcase
+// as `<suite> "before each" hook for "<test name>"`. That breaks downstream
+// Trunk that keys on the test name. This script parses the
+// XML and strips the hook label from `name` and `classname`, leaving the
+// failure body intact so the error is still preserved.
+
+import {
+ copyFileSync,
+ readFileSync,
+ readdirSync,
+ statSync,
+ writeFileSync,
+} from "node:fs";
+import { join } from "node:path";
+
+import { Command } from "commander";
+import XMLBuilder from "fast-xml-builder";
+import { XMLParser } from "fast-xml-parser";
+
+type Options = {
+ dryRun?: boolean;
+ include: string[];
+};
+
+type Testcase = {
+ "@_name"?: string;
+ "@_classname"?: string;
+ [k: string]: unknown;
+};
+
+type Action =
+ | "rewrote"
+ | "dry-run"
+ | "no-hooks"
+ | "skipped-include"
+ | "skipped-no-spec";
+
+type Rewrite = { before: string; after: string };
+
+type Result = {
+ action: Action;
+ scanned: number;
+ rewritten: number;
+ specFile: string | null;
+ rewrites: Rewrite[];
+};
+
+const program = new Command();
+program
+ .name("fix-junit-hooks")
+ .description(
+ "Rewrite Mocha/Cypress JUnit XML to attribute hook failures to the underlying test.",
+ )
+ .argument("<input-dir>", "directory of JUnit XML files to process")
+ .argument(
+ "[output-dir]",
+ "directory to write results to (defaults to input-dir, in place)",
+ )
+ .option("--dry-run", "log intended changes without writing rewritten XML")
+ .option(
+ "--include <substring>",
+ "only rewrite when the Root Suite's spec file path contains this substring (repeatable)",
+ (value: string, previous: string[]) => previous.concat([value]),
+ [] as string[],
+ )
+ .parse();
+
+const [inDir, outDir = inDir] = program.processedArgs as [string, string?];
+const { dryRun = false, include: includes } = program.opts<Options>();
+
+if (!statSync(inDir).isDirectory()) {
+ console.error(`error: <input-dir> must be a directory, got ${inDir}`);
+ process.exit(1);
+}
+if (inDir !== outDir) {
+ let outStat: ReturnType<typeof statSync> | null = null;
+ try {
+ outStat = statSync(outDir);
+ } catch {}
+ if (outStat && !outStat.isDirectory()) {
+ console.error(`error: <output-dir> must be a directory, got ${outDir}`);
+ process.exit(1);
+ }
+}
+
+const xmlOpts = {
+ ignoreAttributes: false,
+ attributeNamePrefix: "@_",
+ cdataPropName: "__cdata",
+ preserveOrder: false,
+};
+const parser = new XMLParser(xmlOpts);
+const builder = new XMLBuilder({ ...xmlOpts, format: true });
+
+const HOOK_RE = /"(?:before|after) (?:each|all)" hook for "([^"]+)"/g;
+const fix = (s: string | undefined): string | undefined =>
+ typeof s === "string" ? s.replace(HOOK_RE, "$1") : s;
+
+function visitTestcases(node: unknown, fn: (tc: Testcase) => void): void {
+ if (Array.isArray(node)) {
+ node.forEach((n) => visitTestcases(n, fn));
+ return;
+ }
+ if (!node || typeof node !== "object") {
+ return;
+ }
+ for (const [k, v] of Object.entries(node)) {
+ if (k === "testcase") {
+ (Array.isArray(v) ? v : [v]).forEach((tc: Testcase) => fn(tc));
+ } else {
+ visitTestcases(v, fn);
+ }
+ }
+}
+
+// mocha-junit-reporter records the spec path as `file=` on the Root Suite
+// testsuite; that's the only place it appears in the document.
+function findSpecFile(node: unknown): string | null {
+ if (Array.isArray(node)) {
+ for (const n of node) {
+ const f = findSpecFile(n);
+ if (f) {
+ return f;
+ }
+ }
+ return null;
+ }
+ if (!node || typeof node !== "object") {
+ return null;
+ }
+ const file = (node as Record<string, unknown>)["@_file"];
+ if (typeof file === "string") {
+ return file;
+ }
+ for (const v of Object.values(node)) {
+ const f = findSpecFile(v);
+ if (f) {
+ return f;
+ }
+ }
+ return null;
+}
+
+function passthrough(input: string, output: string): void {
+ if (input !== output) {
+ copyFileSync(input, output);
+ }
+}
+
+function processFile(input: string, output: string): Result {
+ const tree = parser.parse(readFileSync(input, "utf8"));
+ const specFile = findSpecFile(tree);
+
+ if (includes.length) {
+ const matched = specFile && includes.some((s) => specFile.includes(s));
+ if (!matched) {
+ passthrough(input, output);
+ return {
+ action: specFile ? "skipped-include" : "skipped-no-spec",
+ scanned: 0,
+ rewritten: 0,
+ specFile,
+ rewrites: [],
+ };
+ }
+ }
+
+ let scanned = 0;
+ const rewrites: Rewrite[] = [];
+ visitTestcases(tree, (tc) => {
+ scanned++;
+ const before = tc["@_name"];
+ tc["@_name"] = fix(tc["@_name"]);
+ tc["@_classname"] = fix(tc["@_classname"]);
+ if (
+ tc["@_name"] !== before &&
+ before !== undefined &&
+ tc["@_name"] !== undefined
+ ) {
+ rewrites.push({ before, after: tc["@_name"] });
+ }
+ });
+ const rewritten = rewrites.length;
+
+ if (dryRun) {
+ passthrough(input, output);
+ return { action: "dry-run", scanned, rewritten, specFile, rewrites };
+ }
+ if (rewritten === 0) {
+ passthrough(input, output);
+ return { action: "no-hooks", scanned, rewritten, specFile, rewrites };
+ }
+ writeFileSync(output, builder.build(tree));
+ return { action: "rewrote", scanned, rewritten, specFile, rewrites };
+}
+
+function summarize(path: string, r: Result): string {
+ const head = (() => {
+ switch (r.action) {
+ case "rewrote":
+ return `${path}: rewrote ${r.rewritten}/${r.scanned}`;
+ case "dry-run":
+ return `${path}: dry-run would rewrite ${r.rewritten}/${r.scanned}`;
+ case "no-hooks":
+ return `${path}: no hooks (0/${r.scanned})`;
+ case "skipped-include":
+ return `${path}: skipped (${r.specFile} did not match --include)`;
+ case "skipped-no-spec":
+ return `${path}: skipped (no Root Suite file= attribute)`;
+ }
+ })();
+ if (r.rewrites.length === 0) {
+ return head;
+ }
+ const detail = r.rewrites
+ .map(({ before, after }) => ` ${before} -> ${after}`)
+ .join("\n");
+ return `${head}\n${detail}`;
+}
+
+const files = readdirSync(inDir)
+ .filter((f) => f.endsWith(".xml"))
+ .sort();
+
+let totalScanned = 0;
+let totalRewritten = 0;
+for (const f of files) {
+ const inP = join(inDir, f);
+ const outP = inDir === outDir ? inP : join(outDir, f);
+ const r = processFile(inP, outP);
+ console.error(summarize(inP, r));
+ totalScanned += r.scanned;
+ totalRewritten += r.rewritten;
+}
+console.error(
+ `total: ${totalRewritten}/${totalScanned} rewritten across ${files.length} files`,
+);
diff --git a/frontend/CLAUDE.md b/frontend/CLAUDE.md
index 34a0ed2b000..616f66972c3 100644
--- a/frontend/CLAUDE.md
+++ b/frontend/CLAUDE.md
@@ -18,6 +18,7 @@ frontend/test/ # Jest unit tests
- **State**: Redux Toolkit
- **Styling**: CSS Modules (preferred) > Emotion styled-components
- **UI**: `metabase/ui` components built with Mantine v8
+- **Package manager**: Bun
- **Build**: Rspack (primary), Webpack (legacy)
- **Testing**: Jest + React Testing Library, Cypress
diff --git a/package.json b/package.json
index 40c1f204792..af3144523b9 100644
--- a/package.json
+++ b/package.json
@@ -328,6 +328,8 @@
"eslint-plugin-storybook": "9.1.17",
"eslint-plugin-testing-library": "7.15.4",
"eslint-plugin-ttag": "^1.1.0",
+ "fast-xml-builder": "^1.2.0",
+ "fast-xml-parser": "^5.8.0",
"fetch-mock": "^12.0.0",
"get-nonce": "^1.0.1",
"glob": "^7.1.1",