@fluid-internal/mocha-test-setup 3.0.2 → 3.2.0

package/.mocharc.cjs

@@ -0,0 +1,19 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+"use strict";
+
+// This package's own self-tests don't use its own `getFluidTestMochaConfig()` (unlike its consumers):
+// that helper wires up `mocha-multi-reporters` and `FluidXunitReporter`'s JUnit-compatible XML output,
+// which these straightforward unit tests don't need, and using it here would mean this package
+// `require`-ing itself as a dependency of its own test run.
+module.exports = {
+	require: ["source-map-support/register"],
+	recursive: true,
+	spec: "lib/test/**/*.spec.js",
+	"unhandled-rejections": "strict",
+	// Fail the test run if no tests are found/run, consistent with `getFluidTestMochaConfig`'s consumers.
+	"fail-zero": true,
+};

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @fluid-internal/mocha-test-setup
 
+## 3.2.0
+
+Dependency updates only.
+
+## 3.1.0
+
+Dependency updates only.
+
 ## 3.0.0
 
 Dependency updates only.

package/README.md

@@ -1,7 +1,6 @@
 # @fluid-internal/mocha-test-setup
 
-<!-- AUTO-GENERATED-CONTENT:START (LIBRARY_README_HEADER) -->
-
+<!-- markdown-magic:begin {"transform":"library-readme-header","headingLevel":2} -->
 <!-- prettier-ignore-start -->
 <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
 
@@ -10,8 +9,7 @@
 **We do not guarantee the stability of this package or its APIs.**
 
 <!-- prettier-ignore-end -->
-
-<!-- AUTO-GENERATED-CONTENT:END -->
+<!-- markdown-magic:end -->
 
 This package has a few main purposes:
 
@@ -187,8 +185,7 @@ to the module with that implementation should **not** be specified with the `--r
 This package has logic that needs the custom logger to be imported/executed at a particular time, and we ensure that
 by requiring that the path be provided through that environment variable.
 
-<!-- AUTO-GENERATED-CONTENT:START (README_FOOTER) -->
-
+<!-- markdown-magic:begin {"transform":"readme-footer","headingLevel":2} -->
 <!-- prettier-ignore-start -->
 <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
 
@@ -196,16 +193,16 @@ by requiring that the path be provided through that environment variable.
 
 You can [contribute](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid Framework in these ways:
 
--   Answer questions in [GitHub Discussions](https://github.com/microsoft/FluidFramework/discussions).
--   [Submit bug reports](https://github.com/microsoft/FluidFramework/issues) and help verify fixes.
--   Review [source code changes](https://github.com/microsoft/FluidFramework/pulls).
--   [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md).
+- Answer questions in [GitHub Discussions](https://github.com/microsoft/FluidFramework/discussions).
+- [Submit bug reports](https://github.com/microsoft/FluidFramework/issues) and help verify fixes.
+- Review [source code changes](https://github.com/microsoft/FluidFramework/pulls).
+- [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md).
 
 For detailed instructions, read the [repo documentation](https://github.com/microsoft/FluidFramework/blob/main/docs/content/Home.md).
 
 This project follows the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
 For more information, read the [Code of Conduct frequently asked questions](https://opensource.microsoft.com/codeofconduct/faq/).
-For questions or comments, contact [opencode@microsoft.com](mailto:opencode@microsoft.com).
+For questions or comments, contact <opencode@microsoft.com>.
 
 This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
 Use of these trademarks or logos must follow Microsoft’s [Trademark & Brand Guidelines](https://www.microsoft.com/trademarks).
@@ -226,5 +223,4 @@ Use of these trademarks or logos must follow Microsoft's [Trademark & Brand Guid
 Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
 
 <!-- prettier-ignore-end -->
-
-<!-- AUTO-GENERATED-CONTENT:END -->
+<!-- markdown-magic:end -->

package/lib/mocharcCommon.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mocharcCommon.d.ts","sourceRoot":"","sources":["../src/mocharcCommon.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACpC,SAAS,EAAE,OAAO,CAAC;IACnB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,WAAW,EAAE,OAAO,CAAC;IACrB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,uBAAuB,CACtC,UAAU,EAAE,MAAM,EAClB,yBAAyB,CAAC,EAAE,MAAM,EAAE,EACpC,gBAAgB,CAAC,EAAE,MAAM,GACvB,oBAAoB,CAyGtB"}
+{"version":3,"file":"mocharcCommon.d.ts","sourceRoot":"","sources":["../src/mocharcCommon.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACpC,SAAS,EAAE,OAAO,CAAC;IACnB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,WAAW,EAAE,OAAO,CAAC;IACrB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,uBAAuB,CACtC,UAAU,EAAE,MAAM,EAClB,yBAAyB,CAAC,EAAE,MAAM,EAAE,EACpC,gBAAgB,CAAC,EAAE,MAAM,GACvB,oBAAoB,CAgHtB"}

package/lib/mocharcCommon.js

@@ -91,8 +91,14 @@ export function getFluidTestMochaConfig(packageDir, additionalRequiredModules, t
             console.log(`Writing test results relative to package to nyc/${outputFilePrefix}junit-report.xml`);
         }
         const suiteName = reportPrefix !== undefined ? `${packageJson.name} - ${reportPrefix}` : packageJson.name;
+        // This must be the exact module specifier mocha-multi-reporters will `require(...)` to load the reporter
+        // (see its source: https://github.com/stevemao/mocha-multi-reporters/blob/master/lib/MultiReporters.js),
+        // i.e. it can't be shortened to some arbitrary friendly name. It also determines the reporter-specific
+        // option key mocha-multi-reporters expects below (and in test-config.json): it camelCases this exact
+        // string and appends "ReporterOptions" (e.g. "@foo/bar/baz" -> "fooBarBazReporterOptions").
+        const xunitReporterName = "@fluid-internal/mocha-test-setup/xunit-reporter";
         config["reporter-options"] = [
-            `configFile=${path.join(import.meta.dirname, "..", "test-config.json")},cmrOutput=xunit+output+${outputFilePrefix}:xunit+suiteName+${suiteName}`,
+            `configFile=${path.join(import.meta.dirname, "..", "test-config.json")},cmrOutput=${xunitReporterName}+output+${outputFilePrefix}:${xunitReporterName}+suiteName+${suiteName}`,
         ];
     }
     if (process.env.FLUID_TEST_TIMEOUT !== undefined) {

package/lib/mocharcCommon.js.map

@@ -1 +1 @@
-{"version":3,"file":"mocharcCommon.js","sourceRoot":"","sources":["../src/mocharcCommon.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,IAAI,MAAM,WAAW,CAAC;AAsB7B;;;;;;;;;;GAUG;AACH,MAAM,UAAU,uBAAuB,CACtC,UAAkB,EAClB,yBAAoC,EACpC,gBAAyB;IAEzB,MAAM,eAAe,GAAG;QACvB,mDAAmD;QACnD,kGAAkG;QAClG,kCAAkC;QAClC,6BAA6B;QAC7B,GAAG,CAAC,yBAAyB,IAAI,EAAE,CAAC;KACpC,CAAC;IAEF,IAAI,OAAO,CAAC,GAAG,CAAC,+BAA+B,KAAK,SAAS,EAAE,CAAC;QAC/D,kFAAkF;QAClF,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAC;IACtE,CAAC;IAED,IAAI,YAAY,GAAG,gBAAgB,CAAC;IACpC,IAAI,WAAW,GAAG,UAAU,CAAC;IAC7B,IAAI,OAAO,CAAC,GAAG,CAAC,wBAAwB,KAAK,KAAK,EAAE,CAAC;QACpD,WAAW,GAAG,WAAW,CAAC;QAC1B,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC;QACnD,OAAO,CAAC,GAAG,CAAC,kBAAkB,GAAG,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,WAAW,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;QAC1F,YAAY,GAAG,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,YAAY,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC;IAC3E,CAAC;IAED,MAAM,MAAM,GAAyB;QACpC,WAAW,EAAE,IAAI;QACjB,SAAS,EAAE,eAAe;QAC1B,sBAAsB,EAAE,QAAQ;QAChC,2FAA2F;QAC3F,gGAAgG;QAChG,2BAA2B;QAC3B,WAAW,EAAE,IAAI;QACjB,MAAM,EAAE;YACP,mFAAmF;YACnF,wBAAwB;SACxB;QACD,aAAa,EAAE;YACd,8HAA8H;YAC9H,kCAAkC;YAClC,mFAAmF;YACnF,uFAAuF;YACvF,mDAAmD;YACnD,kEAAkE;YAClE,WAAW;SACX;QACD,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,UAAU,IAAI,WAAW;KAC3C,CAAC;IAEF,qGAAqG;IACrG,qDAAqD;IACrD,gIAAgI;IAChI,mDAAmD;IACnD,IAAI,OAAO,CAAC,GAAG,CAAC,oBAAoB,KAAK,SAAS,EAAE,CAAC;QACpD,IAAI,OAAO,CAAC,GAAG,CAAC,kBAAkB,KAAK,SAAS,EAAE,CAAC;YAClD,OAAO,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAC;QAC7C,CAAC;QAED,iGAAiG;QACjG,wCAAwC;QACxC,wFAAwF;QACxF,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;QAE3B,wDAAwD;QACxD,mHAAmH;QACnH,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;YAC5E,MAAM,CAAC,KAAK,GAAG,CAAC,YAAY,CAAC,CAAC;QAC/B,CAAC;QAED,MAAM,CAAC,QAAQ,GAAG,+CAA+C,CAAC;QAClE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,CAAC;YACjD,oDAAoD;YACpD,MAAM,CAAC,eAAe,GAAG,CAAC,mCAAmC,CAAC,CAAC;QAChE,CAAC;IACF,CAAC;SAAM,CAAC;QACP,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;QAC9D,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,eAAe,EAAE,MAAM,CAAC,CAEnE,CAAC;QACF,MAAM,CAAC,QAAQ,GAAG,uBAAuB,CAAC;QAC1C,2EAA2E;QAC3E,MAAM,gBAAgB,GAAG,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,YAAY,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9E,IAAI,OAAO,CAAC,GAAG,CAAC,kBAAkB,KAAK,SAAS,EAAE,CAAC;YAClD,OAAO,CAAC,GAAG,CACV,mDAAmD,gBAAgB,kBAAkB,CACrF,CAAC;QACH,CAAC;QACD,MAAM,SAAS,GACd,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,IAAI,MAAM,YAAY,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC;QACzF,MAAM,CAAC,kBAAkB,CAAC,GAAG;YAC5B,cAAc,IAAI,CAAC,IAAI,CACtB,MAAM,CAAC,IAAI,CAAC,OAAO,EACnB,IAAI,EACJ,kBAAkB,CAClB,2BAA2B,gBAAgB,oBAAoB,SAAS,EAAE;SAC3E,CAAC;IACH,CAAC;IAED,IAAI,OAAO,CAAC,GAAG,CAAC,kBAAkB,KAAK,SAAS,EAAE,CAAC;QAClD,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC;IACjD,CAAC;IAED,IAAI,OAAO,CAAC,GAAG,CAAC,sBAAsB,KAAK,SAAS,EAAE,CAAC;QACtD,MAAM,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC;IAC9B,CAAC;IAED,OAAO,MAAM,CAAC;AACf,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { readFileSync } from \"node:fs\";\nimport path from \"node:path\";\n\n/**\n * Mocha configuration object returned by {@link getFluidTestMochaConfig}.\n */\nexport interface FluidTestMochaConfig {\n\trecursive: boolean;\n\trequire: string[];\n\t\"unhandled-rejections\": string;\n\t\"fail-zero\": boolean;\n\tignore: string[];\n\t\"node-option\": string[];\n\tspec: string;\n\texit?: boolean;\n\ttimeout?: number | string;\n\tfgrep?: string[];\n\treporter?: string;\n\treporterOptions?: string[];\n\t\"reporter-options\"?: string[];\n\t\"forbid-only\"?: boolean;\n}\n\n/**\n * Get the mocha configuration for running tests using the conventions followed in the Fluid Framework repository.\n *\n * @param packageDir - the directory of the package, typically set using `__dirname`\n * @param additionalRequiredModules - modules to require in addition to the standard set.\n * @param testReportPrefix - prefix for the test output report file names.\n * @remarks\n * Additional configuration can be provided via environment variables: see {@link file://./README.md}.\n *\n * Users desiring exact control over the `spec` from the CLI should delete or replace the spec from the returned config, since mocha's behavior is to extend it, not override it.\n */\nexport function getFluidTestMochaConfig(\n\tpackageDir: string,\n\tadditionalRequiredModules?: string[],\n\ttestReportPrefix?: string,\n): FluidTestMochaConfig {\n\tconst requiredModules = [\n\t\t// General mocha setup e.g. suppresses console.log,\n\t\t// This has to be before others (except logger) so that registerMochaTestWrapperFuncs is available\n\t\t\"@fluid-internal/mocha-test-setup\",\n\t\t\"source-map-support/register\",\n\t\t...(additionalRequiredModules ?? []),\n\t];\n\n\tif (process.env.FLUID_TEST_LOGGER_PKG_SPECIFIER !== undefined) {\n\t\t// Inject implementation of createTestLogger, put it first before mocha-test-setup\n\t\trequiredModules.unshift(process.env.FLUID_TEST_LOGGER_PKG_SPECIFIER);\n\t}\n\n\tlet reportPrefix = testReportPrefix;\n\tlet defaultSpec = \"lib/test\";\n\tif (process.env.FLUID_TEST_MODULE_SYSTEM === \"CJS\") {\n\t\tdefaultSpec = \"dist/test\";\n\t\tconst testVariant = process.env.FLUID_TEST_VARIANT;\n\t\tprocess.env.FLUID_TEST_VARIANT = testVariant !== undefined ? `CJS,${testVariant}` : \"CJS\";\n\t\treportPrefix = reportPrefix !== undefined ? `${reportPrefix}-CJS` : \"CJS\";\n\t}\n\n\tconst config: FluidTestMochaConfig = {\n\t\t\"recursive\": true,\n\t\t\"require\": requiredModules,\n\t\t\"unhandled-rejections\": \"strict\",\n\t\t// Fail the test run if no tests are found/run. This catches cases where test files fail to\n\t\t// load silently (e.g. due to broken imports), which would otherwise produce a green \"0 passing\"\n\t\t// result with exit code 0.\n\t\t\"fail-zero\": true,\n\t\tignore: [\n\t\t\t// Ignore \"tools\" which are scripts intended to be run, not part of the test suite.\n\t\t\t\"**/*.tool.{js,cjs,mjs}\",\n\t\t],\n\t\t\"node-option\": [\n\t\t\t// Allow test-only indexes to be imported. Search the FF repo for package.json files with this condition to see example usage.\n\t\t\t\"conditions=allow-ff-test-exports\",\n\t\t\t// Performance tests benefit from having access to GC, and memory tests require it.\n\t\t\t// Exposing it here avoids all packages which do perf testing from having to expose it.\n\t\t\t// Note that since \"node-option\" is explicitly set,\n\t\t\t// these must be provided here and not via mocha's --v8-expose-gc.\n\t\t\t\"expose-gc\",\n\t\t],\n\t\tspec: process.env.MOCHA_SPEC ?? defaultSpec,\n\t};\n\n\t// This approach to checking for this flag is consistent with some (but not all) others in this file,\n\t// but not with tools/benchmark/src/Configuration.ts.\n\t// For now, undefined, \"1\" and \"true\" should work consistently across all known use, and \"1\" is the main form we explicitly use.\n\t// All these should be made to match, see AB#69054.\n\tif (process.env.FLUID_TEST_PERF_MODE !== undefined) {\n\t\tif (process.env.SILENT_TEST_OUTPUT === undefined) {\n\t\t\tconsole.log(`Running performance tests...`);\n\t\t}\n\n\t\t// Some perf tests are often quite slow, and we don't want to lose the data by hitting a timeout.\n\t\t// This is 1000 seconds, so ~16 minutes.\n\t\t// This can be overridden by setting FLUID_TEST_TIMEOUT to a different value if desired.\n\t\tconfig.timeout = 1_000_000;\n\n\t\t// If there is no filter specified, limit to benchmarks.\n\t\t// If mocha allowed multiple filters to all be applied to further narrow results, we would do this unconditionally.\n\t\tif (!(process.argv.includes(\"--fgrep\") || process.argv.includes(\"--grep\"))) {\n\t\t\tconfig.fgrep = [\"@Benchmark\"];\n\t\t}\n\n\t\tconfig.reporter = \"@fluid-tools/benchmark/dist/mocha/Reporter.js\";\n\t\tif (!process.argv.includes(\"--reporterOptions\")) {\n\t\t\t// If report options were not specified, default to:\n\t\t\tconfig.reporterOptions = [\"reportFile=./benchmarkOutput.json\"];\n\t\t}\n\t} else {\n\t\tconst packageJsonPath = path.join(packageDir, \"package.json\");\n\t\tconst packageJson = JSON.parse(readFileSync(packageJsonPath, \"utf8\")) as {\n\t\t\tname: string;\n\t\t};\n\t\tconfig.reporter = `mocha-multi-reporters`;\n\t\t// See https://www.npmjs.com/package/mocha-multi-reporters#cmroutput-option\n\t\tconst outputFilePrefix = reportPrefix !== undefined ? `${reportPrefix}-` : \"\";\n\t\tif (process.env.SILENT_TEST_OUTPUT === undefined) {\n\t\t\tconsole.log(\n\t\t\t\t`Writing test results relative to package to nyc/${outputFilePrefix}junit-report.xml`,\n\t\t\t);\n\t\t}\n\t\tconst suiteName =\n\t\t\treportPrefix !== undefined ? `${packageJson.name} - ${reportPrefix}` : packageJson.name;\n\t\tconfig[\"reporter-options\"] = [\n\t\t\t`configFile=${path.join(\n\t\t\t\timport.meta.dirname,\n\t\t\t\t\"..\",\n\t\t\t\t\"test-config.json\",\n\t\t\t)},cmrOutput=xunit+output+${outputFilePrefix}:xunit+suiteName+${suiteName}`,\n\t\t];\n\t}\n\n\tif (process.env.FLUID_TEST_TIMEOUT !== undefined) {\n\t\tconfig.timeout = process.env.FLUID_TEST_TIMEOUT;\n\t}\n\n\tif (process.env.FLUID_TEST_FORBID_ONLY !== undefined) {\n\t\tconfig[\"forbid-only\"] = true;\n\t}\n\n\treturn config;\n}\n"]}
+{"version":3,"file":"mocharcCommon.js","sourceRoot":"","sources":["../src/mocharcCommon.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,IAAI,MAAM,WAAW,CAAC;AAsB7B;;;;;;;;;;GAUG;AACH,MAAM,UAAU,uBAAuB,CACtC,UAAkB,EAClB,yBAAoC,EACpC,gBAAyB;IAEzB,MAAM,eAAe,GAAG;QACvB,mDAAmD;QACnD,kGAAkG;QAClG,kCAAkC;QAClC,6BAA6B;QAC7B,GAAG,CAAC,yBAAyB,IAAI,EAAE,CAAC;KACpC,CAAC;IAEF,IAAI,OAAO,CAAC,GAAG,CAAC,+BAA+B,KAAK,SAAS,EAAE,CAAC;QAC/D,kFAAkF;QAClF,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAC;IACtE,CAAC;IAED,IAAI,YAAY,GAAG,gBAAgB,CAAC;IACpC,IAAI,WAAW,GAAG,UAAU,CAAC;IAC7B,IAAI,OAAO,CAAC,GAAG,CAAC,wBAAwB,KAAK,KAAK,EAAE,CAAC;QACpD,WAAW,GAAG,WAAW,CAAC;QAC1B,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC;QACnD,OAAO,CAAC,GAAG,CAAC,kBAAkB,GAAG,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,WAAW,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;QAC1F,YAAY,GAAG,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,YAAY,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC;IAC3E,CAAC;IAED,MAAM,MAAM,GAAyB;QACpC,WAAW,EAAE,IAAI;QACjB,SAAS,EAAE,eAAe;QAC1B,sBAAsB,EAAE,QAAQ;QAChC,2FAA2F;QAC3F,gGAAgG;QAChG,2BAA2B;QAC3B,WAAW,EAAE,IAAI;QACjB,MAAM,EAAE;YACP,mFAAmF;YACnF,wBAAwB;SACxB;QACD,aAAa,EAAE;YACd,8HAA8H;YAC9H,kCAAkC;YAClC,mFAAmF;YACnF,uFAAuF;YACvF,mDAAmD;YACnD,kEAAkE;YAClE,WAAW;SACX;QACD,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,UAAU,IAAI,WAAW;KAC3C,CAAC;IAEF,qGAAqG;IACrG,qDAAqD;IACrD,gIAAgI;IAChI,mDAAmD;IACnD,IAAI,OAAO,CAAC,GAAG,CAAC,oBAAoB,KAAK,SAAS,EAAE,CAAC;QACpD,IAAI,OAAO,CAAC,GAAG,CAAC,kBAAkB,KAAK,SAAS,EAAE,CAAC;YAClD,OAAO,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAC;QAC7C,CAAC;QAED,iGAAiG;QACjG,wCAAwC;QACxC,wFAAwF;QACxF,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;QAE3B,wDAAwD;QACxD,mHAAmH;QACnH,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;YAC5E,MAAM,CAAC,KAAK,GAAG,CAAC,YAAY,CAAC,CAAC;QAC/B,CAAC;QAED,MAAM,CAAC,QAAQ,GAAG,+CAA+C,CAAC;QAClE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,CAAC;YACjD,oDAAoD;YACpD,MAAM,CAAC,eAAe,GAAG,CAAC,mCAAmC,CAAC,CAAC;QAChE,CAAC;IACF,CAAC;SAAM,CAAC;QACP,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;QAC9D,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,eAAe,EAAE,MAAM,CAAC,CAEnE,CAAC;QACF,MAAM,CAAC,QAAQ,GAAG,uBAAuB,CAAC;QAC1C,2EAA2E;QAE3E,MAAM,gBAAgB,GAAG,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,YAAY,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9E,IAAI,OAAO,CAAC,GAAG,CAAC,kBAAkB,KAAK,SAAS,EAAE,CAAC;YAClD,OAAO,CAAC,GAAG,CACV,mDAAmD,gBAAgB,kBAAkB,CACrF,CAAC;QACH,CAAC;QACD,MAAM,SAAS,GACd,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,IAAI,MAAM,YAAY,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC;QACzF,yGAAyG;QACzG,yGAAyG;QACzG,uGAAuG;QACvG,qGAAqG;QACrG,4FAA4F;QAC5F,MAAM,iBAAiB,GAAG,iDAAiD,CAAC;QAC5E,MAAM,CAAC,kBAAkB,CAAC,GAAG;YAC5B,cAAc,IAAI,CAAC,IAAI,CACtB,MAAM,CAAC,IAAI,CAAC,OAAO,EACnB,IAAI,EACJ,kBAAkB,CAClB,cAAc,iBAAiB,WAAW,gBAAgB,IAAI,iBAAiB,cAAc,SAAS,EAAE;SACzG,CAAC;IACH,CAAC;IAED,IAAI,OAAO,CAAC,GAAG,CAAC,kBAAkB,KAAK,SAAS,EAAE,CAAC;QAClD,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC;IACjD,CAAC;IAED,IAAI,OAAO,CAAC,GAAG,CAAC,sBAAsB,KAAK,SAAS,EAAE,CAAC;QACtD,MAAM,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC;IAC9B,CAAC;IAED,OAAO,MAAM,CAAC;AACf,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { readFileSync } from \"node:fs\";\nimport path from \"node:path\";\n\n/**\n * Mocha configuration object returned by {@link getFluidTestMochaConfig}.\n */\nexport interface FluidTestMochaConfig {\n\trecursive: boolean;\n\trequire: string[];\n\t\"unhandled-rejections\": string;\n\t\"fail-zero\": boolean;\n\tignore: string[];\n\t\"node-option\": string[];\n\tspec: string;\n\texit?: boolean;\n\ttimeout?: number | string;\n\tfgrep?: string[];\n\treporter?: string;\n\treporterOptions?: string[];\n\t\"reporter-options\"?: string[];\n\t\"forbid-only\"?: boolean;\n}\n\n/**\n * Get the mocha configuration for running tests using the conventions followed in the Fluid Framework repository.\n *\n * @param packageDir - the directory of the package, typically set using `__dirname`\n * @param additionalRequiredModules - modules to require in addition to the standard set.\n * @param testReportPrefix - prefix for the test output report file names.\n * @remarks\n * Additional configuration can be provided via environment variables: see {@link file://./README.md}.\n *\n * Users desiring exact control over the `spec` from the CLI should delete or replace the spec from the returned config, since mocha's behavior is to extend it, not override it.\n */\nexport function getFluidTestMochaConfig(\n\tpackageDir: string,\n\tadditionalRequiredModules?: string[],\n\ttestReportPrefix?: string,\n): FluidTestMochaConfig {\n\tconst requiredModules = [\n\t\t// General mocha setup e.g. suppresses console.log,\n\t\t// This has to be before others (except logger) so that registerMochaTestWrapperFuncs is available\n\t\t\"@fluid-internal/mocha-test-setup\",\n\t\t\"source-map-support/register\",\n\t\t...(additionalRequiredModules ?? []),\n\t];\n\n\tif (process.env.FLUID_TEST_LOGGER_PKG_SPECIFIER !== undefined) {\n\t\t// Inject implementation of createTestLogger, put it first before mocha-test-setup\n\t\trequiredModules.unshift(process.env.FLUID_TEST_LOGGER_PKG_SPECIFIER);\n\t}\n\n\tlet reportPrefix = testReportPrefix;\n\tlet defaultSpec = \"lib/test\";\n\tif (process.env.FLUID_TEST_MODULE_SYSTEM === \"CJS\") {\n\t\tdefaultSpec = \"dist/test\";\n\t\tconst testVariant = process.env.FLUID_TEST_VARIANT;\n\t\tprocess.env.FLUID_TEST_VARIANT = testVariant !== undefined ? `CJS,${testVariant}` : \"CJS\";\n\t\treportPrefix = reportPrefix !== undefined ? `${reportPrefix}-CJS` : \"CJS\";\n\t}\n\n\tconst config: FluidTestMochaConfig = {\n\t\t\"recursive\": true,\n\t\t\"require\": requiredModules,\n\t\t\"unhandled-rejections\": \"strict\",\n\t\t// Fail the test run if no tests are found/run. This catches cases where test files fail to\n\t\t// load silently (e.g. due to broken imports), which would otherwise produce a green \"0 passing\"\n\t\t// result with exit code 0.\n\t\t\"fail-zero\": true,\n\t\tignore: [\n\t\t\t// Ignore \"tools\" which are scripts intended to be run, not part of the test suite.\n\t\t\t\"**/*.tool.{js,cjs,mjs}\",\n\t\t],\n\t\t\"node-option\": [\n\t\t\t// Allow test-only indexes to be imported. Search the FF repo for package.json files with this condition to see example usage.\n\t\t\t\"conditions=allow-ff-test-exports\",\n\t\t\t// Performance tests benefit from having access to GC, and memory tests require it.\n\t\t\t// Exposing it here avoids all packages which do perf testing from having to expose it.\n\t\t\t// Note that since \"node-option\" is explicitly set,\n\t\t\t// these must be provided here and not via mocha's --v8-expose-gc.\n\t\t\t\"expose-gc\",\n\t\t],\n\t\tspec: process.env.MOCHA_SPEC ?? defaultSpec,\n\t};\n\n\t// This approach to checking for this flag is consistent with some (but not all) others in this file,\n\t// but not with tools/benchmark/src/Configuration.ts.\n\t// For now, undefined, \"1\" and \"true\" should work consistently across all known use, and \"1\" is the main form we explicitly use.\n\t// All these should be made to match, see AB#69054.\n\tif (process.env.FLUID_TEST_PERF_MODE !== undefined) {\n\t\tif (process.env.SILENT_TEST_OUTPUT === undefined) {\n\t\t\tconsole.log(`Running performance tests...`);\n\t\t}\n\n\t\t// Some perf tests are often quite slow, and we don't want to lose the data by hitting a timeout.\n\t\t// This is 1000 seconds, so ~16 minutes.\n\t\t// This can be overridden by setting FLUID_TEST_TIMEOUT to a different value if desired.\n\t\tconfig.timeout = 1_000_000;\n\n\t\t// If there is no filter specified, limit to benchmarks.\n\t\t// If mocha allowed multiple filters to all be applied to further narrow results, we would do this unconditionally.\n\t\tif (!(process.argv.includes(\"--fgrep\") || process.argv.includes(\"--grep\"))) {\n\t\t\tconfig.fgrep = [\"@Benchmark\"];\n\t\t}\n\n\t\tconfig.reporter = \"@fluid-tools/benchmark/dist/mocha/Reporter.js\";\n\t\tif (!process.argv.includes(\"--reporterOptions\")) {\n\t\t\t// If report options were not specified, default to:\n\t\t\tconfig.reporterOptions = [\"reportFile=./benchmarkOutput.json\"];\n\t\t}\n\t} else {\n\t\tconst packageJsonPath = path.join(packageDir, \"package.json\");\n\t\tconst packageJson = JSON.parse(readFileSync(packageJsonPath, \"utf8\")) as {\n\t\t\tname: string;\n\t\t};\n\t\tconfig.reporter = `mocha-multi-reporters`;\n\t\t// See https://www.npmjs.com/package/mocha-multi-reporters#cmroutput-option\n\n\t\tconst outputFilePrefix = reportPrefix !== undefined ? `${reportPrefix}-` : \"\";\n\t\tif (process.env.SILENT_TEST_OUTPUT === undefined) {\n\t\t\tconsole.log(\n\t\t\t\t`Writing test results relative to package to nyc/${outputFilePrefix}junit-report.xml`,\n\t\t\t);\n\t\t}\n\t\tconst suiteName =\n\t\t\treportPrefix !== undefined ? `${packageJson.name} - ${reportPrefix}` : packageJson.name;\n\t\t// This must be the exact module specifier mocha-multi-reporters will `require(...)` to load the reporter\n\t\t// (see its source: https://github.com/stevemao/mocha-multi-reporters/blob/master/lib/MultiReporters.js),\n\t\t// i.e. it can't be shortened to some arbitrary friendly name. It also determines the reporter-specific\n\t\t// option key mocha-multi-reporters expects below (and in test-config.json): it camelCases this exact\n\t\t// string and appends \"ReporterOptions\" (e.g. \"@foo/bar/baz\" -> \"fooBarBazReporterOptions\").\n\t\tconst xunitReporterName = \"@fluid-internal/mocha-test-setup/xunit-reporter\";\n\t\tconfig[\"reporter-options\"] = [\n\t\t\t`configFile=${path.join(\n\t\t\t\timport.meta.dirname,\n\t\t\t\t\"..\",\n\t\t\t\t\"test-config.json\",\n\t\t\t)},cmrOutput=${xunitReporterName}+output+${outputFilePrefix}:${xunitReporterName}+suiteName+${suiteName}`,\n\t\t];\n\t}\n\n\tif (process.env.FLUID_TEST_TIMEOUT !== undefined) {\n\t\tconfig.timeout = process.env.FLUID_TEST_TIMEOUT;\n\t}\n\n\tif (process.env.FLUID_TEST_FORBID_ONLY !== undefined) {\n\t\tconfig[\"forbid-only\"] = true;\n\t}\n\n\treturn config;\n}\n"]}

package/lib/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluid-internal/mocha-test-setup";
-export declare const pkgVersion = "3.0.2";
+export declare const pkgVersion = "3.2.0";
 //# sourceMappingURL=packageVersion.d.ts.map

package/lib/packageVersion.js

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export const pkgName = "@fluid-internal/mocha-test-setup";
-export const pkgVersion = "3.0.2";
+export const pkgVersion = "3.2.0";
 //# sourceMappingURL=packageVersion.js.map

package/lib/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,kCAAkC,CAAC;AAC1D,MAAM,CAAC,MAAM,UAAU,GAAG,OAAO,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluid-internal/mocha-test-setup\";\nexport const pkgVersion = \"3.0.2\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,kCAAkC,CAAC;AAC1D,MAAM,CAAC,MAAM,UAAU,GAAG,OAAO,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluid-internal/mocha-test-setup\";\nexport const pkgVersion = \"3.2.0\";\n"]}

package/lib/xunitReporter.d.ts

@@ -0,0 +1,67 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Walks up from `startDir` looking for the repo root, identified by the presence of
+ * `pnpm-workspace.yaml`. Falls back to `startDir` if no such ancestor is found (e.g. if the workspace
+ * layout ever changes).
+ *
+ * @remarks Exported (in addition to being used internally) so tests can independently compute the
+ * expected `classname` for a given file without duplicating this logic.
+ */
+export declare function findRepoRoot(startDir: string): string;
+/**
+ * The subset of a Mocha `Test` that {@link FluidXunitReporter} cares about.
+ */
+interface JUnitTestLike {
+    /**
+     * Absolute path of the file the test is defined in, as set by Mocha.
+     */
+    file?: string;
+    /**
+     * The `Suite` (or nested `Suite`s) the test is defined in. `xunit`'s `test` method relies on
+     * `parent.fullTitle()`, and mocha's own `isPending()` implementation recurses into `parent.isPending()`,
+     * so the whole object (not just `fullTitle`) needs to be preserved when overriding it below.
+     */
+    parent: object;
+    /**
+     * The test's fully qualified title: its own title, prefixed by its ancestor `describe` blocks' titles.
+     */
+    fullTitle(): string;
+}
+/**
+ * Minimal typing for mocha's built-in `xunit` reporter constructor and the `test` instance method
+ * {@link FluidXunitReporter} overrides.
+ */
+interface XUnitReporterInstance {
+    test(test: JUnitTestLike, options?: unknown): void;
+}
+declare const XUnitReporterCtor: new (runner: unknown, options: unknown) => XUnitReporterInstance;
+/**
+ * A JUnit reporter for Mocha, based on mocha's built-in `xunit` reporter, that fixes two issues with the
+ * default `xunit` output when many packages' reports are viewed together in Azure DevOps's Tests tab.
+ *
+ * `name` (the `<testcase>`'s display title in Azure DevOps): `xunit` sets this to the test's own,
+ * non-fully-qualified title (e.g. `"increments"`), which frequently collides with other tests of the same
+ * name defined under different `describe` blocks or files. This override sets it to the fully qualified
+ * title instead (the full `describe`/`it` chain), which is unique.
+ *
+ * `classname` (used by Azure DevOps's JUnit importer to populate the "Test file" grouping — see
+ * `AutomatedTestStorage` in
+ * {@link https://github.com/microsoft/azure-pipelines-agent/blob/master/src/Agent.Worker/TestResults/Legacy/JunitResultReader.cs | JunitResultReader.cs}):
+ * `xunit` sets this to the fully qualified title as well, so that grouping showed test titles instead of
+ * file names. This override sets it to the path (relative to the repo root) of the file containing the
+ * test.
+ *
+ * All other behavior — notably, `xunit`'s single flat `<testsuite>` per report file — is unchanged, so
+ * this reporter is not subject to the Azure DevOps "Test Run" naming regression that `mocha-junit-reporter`
+ * (which emits one `<testsuite>` per `describe` block, rather than one per file) causes: Azure DevOps's
+ * JUnit importer falls back to a generic `JUnit_<file name>` run title whenever a report file contains more
+ * than one `<testsuite>` element, unconditionally, regardless of file or suite naming.
+ */
+export declare class FluidXunitReporter extends XUnitReporterCtor {
+    test(test: JUnitTestLike, options?: unknown): void;
+}
+export {};
+//# sourceMappingURL=xunitReporter.d.ts.map

package/lib/xunitReporter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"xunitReporter.d.ts","sourceRoot":"","sources":["../src/xunitReporter.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAOH;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAcrD;AAID;;GAEG;AACH,UAAU,aAAa;IACtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,IAAI,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,UAAU,qBAAqB;IAC9B,IAAI,CAAC,IAAI,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACnD;AAED,QAAA,MAAM,iBAAiB,EAAuC,KAC7D,MAAM,EAAE,OAAO,EACf,OAAO,EAAE,OAAO,KACZ,qBAAqB,CAAC;AAE3B;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,kBAAmB,SAAQ,iBAAiB;IACjD,IAAI,CAAC,IAAI,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI;CAkBzD"}

package/lib/xunitReporter.js

@@ -0,0 +1,74 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { existsSync } from "node:fs";
+import path from "node:path";
+import Mocha from "mocha";
+/**
+ * Walks up from `startDir` looking for the repo root, identified by the presence of
+ * `pnpm-workspace.yaml`. Falls back to `startDir` if no such ancestor is found (e.g. if the workspace
+ * layout ever changes).
+ *
+ * @remarks Exported (in addition to being used internally) so tests can independently compute the
+ * expected `classname` for a given file without duplicating this logic.
+ */
+export function findRepoRoot(startDir) {
+    let dir = startDir;
+    // eslint-disable-next-line no-constant-condition -- terminates via the `parent === dir` root check below
+    while (true) {
+        if (existsSync(path.join(dir, "pnpm-workspace.yaml"))) {
+            return dir;
+        }
+        const parent = path.dirname(dir);
+        if (parent === dir) {
+            // Reached the filesystem root without finding a workspace marker.
+            return startDir;
+        }
+        dir = parent;
+    }
+}
+const repoRoot = findRepoRoot(process.cwd());
+const XUnitReporterCtor = Mocha.reporters.XUnit;
+/**
+ * A JUnit reporter for Mocha, based on mocha's built-in `xunit` reporter, that fixes two issues with the
+ * default `xunit` output when many packages' reports are viewed together in Azure DevOps's Tests tab.
+ *
+ * `name` (the `<testcase>`'s display title in Azure DevOps): `xunit` sets this to the test's own,
+ * non-fully-qualified title (e.g. `"increments"`), which frequently collides with other tests of the same
+ * name defined under different `describe` blocks or files. This override sets it to the fully qualified
+ * title instead (the full `describe`/`it` chain), which is unique.
+ *
+ * `classname` (used by Azure DevOps's JUnit importer to populate the "Test file" grouping — see
+ * `AutomatedTestStorage` in
+ * {@link https://github.com/microsoft/azure-pipelines-agent/blob/master/src/Agent.Worker/TestResults/Legacy/JunitResultReader.cs | JunitResultReader.cs}):
+ * `xunit` sets this to the fully qualified title as well, so that grouping showed test titles instead of
+ * file names. This override sets it to the path (relative to the repo root) of the file containing the
+ * test.
+ *
+ * All other behavior — notably, `xunit`'s single flat `<testsuite>` per report file — is unchanged, so
+ * this reporter is not subject to the Azure DevOps "Test Run" naming regression that `mocha-junit-reporter`
+ * (which emits one `<testsuite>` per `describe` block, rather than one per file) causes: Azure DevOps's
+ * JUnit importer falls back to a generic `JUnit_<file name>` run title whenever a report file contains more
+ * than one `<testsuite>` element, unconditionally, regardless of file or suite naming.
+ */
+export class FluidXunitReporter extends XUnitReporterCtor {
+    test(test, options) {
+        const classname = test.file === undefined ? test.fullTitle() : path.relative(repoRoot, test.file);
+        // `xunit`'s `test` method reads `test.title` for `name` and `test.parent.fullTitle()` for
+        // `classname`. Wrap `test` and `test.parent` (via prototypal inheritance, so unrelated
+        // properties/methods they're relied on for — `file`, `duration`, `state`, `err`, `isPending()`
+        // (which recurses into `parent.isPending()`) — still resolve correctly) to present the values
+        // wanted here, without mutating the shared `test`/`test.parent` objects that other reporters
+        // running in the same `mocha-multi-reporters` process also read.
+        const wrappedParent = Object.create(test.parent, {
+            fullTitle: { value: () => classname, enumerable: true },
+        });
+        const wrapped = Object.create(test, {
+            title: { value: test.fullTitle(), enumerable: true },
+            parent: { value: wrappedParent, enumerable: true },
+        });
+        super.test(wrapped, options);
+    }
+}
+//# sourceMappingURL=xunitReporter.js.map

package/lib/xunitReporter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"xunitReporter.js","sourceRoot":"","sources":["../src/xunitReporter.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAAC,QAAgB;IAC5C,IAAI,GAAG,GAAG,QAAQ,CAAC;IACnB,yGAAyG;IACzG,OAAO,IAAI,EAAE,CAAC;QACb,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,qBAAqB,CAAC,CAAC,EAAE,CAAC;YACvD,OAAO,GAAG,CAAC;QACZ,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACjC,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YACpB,kEAAkE;YAClE,OAAO,QAAQ,CAAC;QACjB,CAAC;QACD,GAAG,GAAG,MAAM,CAAC;IACd,CAAC;AACF,CAAC;AAED,MAAM,QAAQ,GAAG,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;AAgC7C,MAAM,iBAAiB,GAAG,KAAK,CAAC,SAAS,CAAC,KAGhB,CAAC;AAE3B;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,OAAO,kBAAmB,SAAQ,iBAAiB;IACjD,IAAI,CAAC,IAAmB,EAAE,OAAiB;QACjD,MAAM,SAAS,GACd,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACjF,0FAA0F;QAC1F,uFAAuF;QACvF,+FAA+F;QAC/F,8FAA8F;QAC9F,6FAA6F;QAC7F,iEAAiE;QACjE,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE;YAChD,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,SAAS,EAAE,UAAU,EAAE,IAAI,EAAE;SACvD,CAA4B,CAAC;QAC9B,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE;YACnC,KAAK,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,SAAS,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE;YACpD,MAAM,EAAE,EAAE,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,IAAI,EAAE;SAClD,CAAkB,CAAC;QACpB,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC9B,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { existsSync } from \"node:fs\";\nimport path from \"node:path\";\n\nimport Mocha from \"mocha\";\n\n/**\n * Walks up from `startDir` looking for the repo root, identified by the presence of\n * `pnpm-workspace.yaml`. Falls back to `startDir` if no such ancestor is found (e.g. if the workspace\n * layout ever changes).\n *\n * @remarks Exported (in addition to being used internally) so tests can independently compute the\n * expected `classname` for a given file without duplicating this logic.\n */\nexport function findRepoRoot(startDir: string): string {\n\tlet dir = startDir;\n\t// eslint-disable-next-line no-constant-condition -- terminates via the `parent === dir` root check below\n\twhile (true) {\n\t\tif (existsSync(path.join(dir, \"pnpm-workspace.yaml\"))) {\n\t\t\treturn dir;\n\t\t}\n\t\tconst parent = path.dirname(dir);\n\t\tif (parent === dir) {\n\t\t\t// Reached the filesystem root without finding a workspace marker.\n\t\t\treturn startDir;\n\t\t}\n\t\tdir = parent;\n\t}\n}\n\nconst repoRoot = findRepoRoot(process.cwd());\n\n/**\n * The subset of a Mocha `Test` that {@link FluidXunitReporter} cares about.\n */\ninterface JUnitTestLike {\n\t/**\n\t * Absolute path of the file the test is defined in, as set by Mocha.\n\t */\n\tfile?: string;\n\n\t/**\n\t * The `Suite` (or nested `Suite`s) the test is defined in. `xunit`'s `test` method relies on\n\t * `parent.fullTitle()`, and mocha's own `isPending()` implementation recurses into `parent.isPending()`,\n\t * so the whole object (not just `fullTitle`) needs to be preserved when overriding it below.\n\t */\n\tparent: object;\n\n\t/**\n\t * The test's fully qualified title: its own title, prefixed by its ancestor `describe` blocks' titles.\n\t */\n\tfullTitle(): string;\n}\n\n/**\n * Minimal typing for mocha's built-in `xunit` reporter constructor and the `test` instance method\n * {@link FluidXunitReporter} overrides.\n */\ninterface XUnitReporterInstance {\n\ttest(test: JUnitTestLike, options?: unknown): void;\n}\n\nconst XUnitReporterCtor = Mocha.reporters.XUnit as unknown as new (\n\trunner: unknown,\n\toptions: unknown,\n) => XUnitReporterInstance;\n\n/**\n * A JUnit reporter for Mocha, based on mocha's built-in `xunit` reporter, that fixes two issues with the\n * default `xunit` output when many packages' reports are viewed together in Azure DevOps's Tests tab.\n *\n * `name` (the `<testcase>`'s display title in Azure DevOps): `xunit` sets this to the test's own,\n * non-fully-qualified title (e.g. `\"increments\"`), which frequently collides with other tests of the same\n * name defined under different `describe` blocks or files. This override sets it to the fully qualified\n * title instead (the full `describe`/`it` chain), which is unique.\n *\n * `classname` (used by Azure DevOps's JUnit importer to populate the \"Test file\" grouping — see\n * `AutomatedTestStorage` in\n * {@link https://github.com/microsoft/azure-pipelines-agent/blob/master/src/Agent.Worker/TestResults/Legacy/JunitResultReader.cs | JunitResultReader.cs}):\n * `xunit` sets this to the fully qualified title as well, so that grouping showed test titles instead of\n * file names. This override sets it to the path (relative to the repo root) of the file containing the\n * test.\n *\n * All other behavior — notably, `xunit`'s single flat `<testsuite>` per report file — is unchanged, so\n * this reporter is not subject to the Azure DevOps \"Test Run\" naming regression that `mocha-junit-reporter`\n * (which emits one `<testsuite>` per `describe` block, rather than one per file) causes: Azure DevOps's\n * JUnit importer falls back to a generic `JUnit_<file name>` run title whenever a report file contains more\n * than one `<testsuite>` element, unconditionally, regardless of file or suite naming.\n */\nexport class FluidXunitReporter extends XUnitReporterCtor {\n\tpublic test(test: JUnitTestLike, options?: unknown): void {\n\t\tconst classname =\n\t\t\ttest.file === undefined ? test.fullTitle() : path.relative(repoRoot, test.file);\n\t\t// `xunit`'s `test` method reads `test.title` for `name` and `test.parent.fullTitle()` for\n\t\t// `classname`. Wrap `test` and `test.parent` (via prototypal inheritance, so unrelated\n\t\t// properties/methods they're relied on for — `file`, `duration`, `state`, `err`, `isPending()`\n\t\t// (which recurses into `parent.isPending()`) — still resolve correctly) to present the values\n\t\t// wanted here, without mutating the shared `test`/`test.parent` objects that other reporters\n\t\t// running in the same `mocha-multi-reporters` process also read.\n\t\tconst wrappedParent = Object.create(test.parent, {\n\t\t\tfullTitle: { value: () => classname, enumerable: true },\n\t\t}) as JUnitTestLike[\"parent\"];\n\t\tconst wrapped = Object.create(test, {\n\t\t\ttitle: { value: test.fullTitle(), enumerable: true },\n\t\t\tparent: { value: wrappedParent, enumerable: true },\n\t\t}) as JUnitTestLike;\n\t\tsuper.test(wrapped, options);\n\t}\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluid-internal/mocha-test-setup",
-  "version": "3.0.2",
+  "version": "3.2.0",
   "description": "Utilities for Fluid tests",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -19,11 +19,15 @@
     "./mocharc-common": {
       "require": "./mocharc-common-cjswrapper.cjs",
       "default": "./lib/mocharcCommon.js"
+    },
+    "./xunit-reporter": {
+      "require": "./xunit-reporter-cjswrapper.cjs",
+      "default": "./lib/xunitReporter.js"
     }
   },
   "dependencies": {
-    "@fluid-internal/test-driver-definitions": "~3.0.2",
-    "@fluidframework/core-interfaces": "~3.0.2",
+    "@fluid-internal/test-driver-definitions": "~3.2.0",
+    "@fluidframework/core-interfaces": "~3.2.0",
     "mocha": "^11.7.5",
     "source-map-support": "^0.5.21"
   },
@@ -37,12 +41,14 @@
     "@microsoft/api-extractor": "7.58.1",
     "@types/mocha": "^10.0.10",
     "@types/node": "~22.19.17",
+    "@types/xml2js": "^0.4.14",
     "concurrently": "^10.0.3",
     "copyfiles": "^2.4.1",
     "eslint": "~9.39.1",
     "jiti": "^2.6.1",
     "rimraf": "^6.1.3",
-    "typescript": "~6.0.3"
+    "typescript": "~6.0.3",
+    "xml2js": "^0.6.2"
   },
   "fluidBuild": {
     "_tasks_comment": "build:cjs is configured to depend on build:esm task as all CommonJS consumers expect mocha support which is implemented in ESM. Building ESM when CommonJS is requested ensures the implementation expectation is satisfied.",
@@ -67,7 +73,7 @@
     "build:docs": "api-extractor run --local --config api-extractor/api-extractor-model.json",
     "build:esm": "tsc --project ./tsconfig.json",
     "build:genver": "gen-version",
-    "check:are-the-types-wrong": "attw --pack . --profile esm-only --exclude-entrypoints ./mocharc-common",
+    "check:are-the-types-wrong": "attw --pack . --profile esm-only --exclude-entrypoints ./mocharc-common ./xunit-reporter",
     "check:biome": "biome check .",
     "check:exports": "concurrently \"npm:check:exports:*\"",
     "check:exports:bundle-release-tags": "api-extractor run --config api-extractor/api-extractor-lint-bundle.json",
@@ -76,12 +82,15 @@
     "check:types:inexactOptionalPropertyTypes": "tsc --project ./tsconfig.json --noEmit --exactOptionalPropertyTypes false --skipLibCheck --emitDeclarationOnly false --tsBuildInfoFile ./tsconfig.inexactOptionalPropertyTypes.tsbuildinfo",
     "ci:build:api-reports": "api-extractor run --config api-extractor/api-extractor-report.json",
     "ci:build:docs": "api-extractor run --config api-extractor/api-extractor-model.json",
-    "clean": "rimraf --glob dist lib \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp",
+    "clean": "rimraf --glob dist lib \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
     "eslint": "eslint --quiet --format stylish src",
     "eslint:fix": "eslint --quiet --format stylish src --fix --fix-type problem,suggestion,layout",
     "format": "npm run format:biome",
     "format:biome": "biome check . --write",
     "lint": "fluid-build . --task lint",
-    "lint:fix": "fluid-build . --task eslint:fix --task format"
+    "lint:fix": "fluid-build . --task eslint:fix --task format",
+    "test": "npm run test:mocha",
+    "test:mocha": "npm run test:mocha:esm",
+    "test:mocha:esm": "mocha"
   }
 }

package/src/mocharcCommon.ts

@@ -120,6 +120,7 @@ export function getFluidTestMochaConfig(
 		};
 		config.reporter = `mocha-multi-reporters`;
 		// See https://www.npmjs.com/package/mocha-multi-reporters#cmroutput-option
+
 		const outputFilePrefix = reportPrefix !== undefined ? `${reportPrefix}-` : "";
 		if (process.env.SILENT_TEST_OUTPUT === undefined) {
 			console.log(
@@ -128,12 +129,18 @@ export function getFluidTestMochaConfig(
 		}
 		const suiteName =
 			reportPrefix !== undefined ? `${packageJson.name} - ${reportPrefix}` : packageJson.name;
+		// This must be the exact module specifier mocha-multi-reporters will `require(...)` to load the reporter
+		// (see its source: https://github.com/stevemao/mocha-multi-reporters/blob/master/lib/MultiReporters.js),
+		// i.e. it can't be shortened to some arbitrary friendly name. It also determines the reporter-specific
+		// option key mocha-multi-reporters expects below (and in test-config.json): it camelCases this exact
+		// string and appends "ReporterOptions" (e.g. "@foo/bar/baz" -> "fooBarBazReporterOptions").
+		const xunitReporterName = "@fluid-internal/mocha-test-setup/xunit-reporter";
 		config["reporter-options"] = [
 			`configFile=${path.join(
 				import.meta.dirname,
 				"..",
 				"test-config.json",
-			)},cmrOutput=xunit+output+${outputFilePrefix}:xunit+suiteName+${suiteName}`,
+			)},cmrOutput=${xunitReporterName}+output+${outputFilePrefix}:${xunitReporterName}+suiteName+${suiteName}`,
 		];
 	}
 

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluid-internal/mocha-test-setup";
-export const pkgVersion = "3.0.2";
+export const pkgVersion = "3.2.0";

package/src/xunitReporter.ts

@@ -0,0 +1,113 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { existsSync } from "node:fs";
+import path from "node:path";
+
+import Mocha from "mocha";
+
+/**
+ * Walks up from `startDir` looking for the repo root, identified by the presence of
+ * `pnpm-workspace.yaml`. Falls back to `startDir` if no such ancestor is found (e.g. if the workspace
+ * layout ever changes).
+ *
+ * @remarks Exported (in addition to being used internally) so tests can independently compute the
+ * expected `classname` for a given file without duplicating this logic.
+ */
+export function findRepoRoot(startDir: string): string {
+	let dir = startDir;
+	// eslint-disable-next-line no-constant-condition -- terminates via the `parent === dir` root check below
+	while (true) {
+		if (existsSync(path.join(dir, "pnpm-workspace.yaml"))) {
+			return dir;
+		}
+		const parent = path.dirname(dir);
+		if (parent === dir) {
+			// Reached the filesystem root without finding a workspace marker.
+			return startDir;
+		}
+		dir = parent;
+	}
+}
+
+const repoRoot = findRepoRoot(process.cwd());
+
+/**
+ * The subset of a Mocha `Test` that {@link FluidXunitReporter} cares about.
+ */
+interface JUnitTestLike {
+	/**
+	 * Absolute path of the file the test is defined in, as set by Mocha.
+	 */
+	file?: string;
+
+	/**
+	 * The `Suite` (or nested `Suite`s) the test is defined in. `xunit`'s `test` method relies on
+	 * `parent.fullTitle()`, and mocha's own `isPending()` implementation recurses into `parent.isPending()`,
+	 * so the whole object (not just `fullTitle`) needs to be preserved when overriding it below.
+	 */
+	parent: object;
+
+	/**
+	 * The test's fully qualified title: its own title, prefixed by its ancestor `describe` blocks' titles.
+	 */
+	fullTitle(): string;
+}
+
+/**
+ * Minimal typing for mocha's built-in `xunit` reporter constructor and the `test` instance method
+ * {@link FluidXunitReporter} overrides.
+ */
+interface XUnitReporterInstance {
+	test(test: JUnitTestLike, options?: unknown): void;
+}
+
+const XUnitReporterCtor = Mocha.reporters.XUnit as unknown as new (
+	runner: unknown,
+	options: unknown,
+) => XUnitReporterInstance;
+
+/**
+ * A JUnit reporter for Mocha, based on mocha's built-in `xunit` reporter, that fixes two issues with the
+ * default `xunit` output when many packages' reports are viewed together in Azure DevOps's Tests tab.
+ *
+ * `name` (the `<testcase>`'s display title in Azure DevOps): `xunit` sets this to the test's own,
+ * non-fully-qualified title (e.g. `"increments"`), which frequently collides with other tests of the same
+ * name defined under different `describe` blocks or files. This override sets it to the fully qualified
+ * title instead (the full `describe`/`it` chain), which is unique.
+ *
+ * `classname` (used by Azure DevOps's JUnit importer to populate the "Test file" grouping — see
+ * `AutomatedTestStorage` in
+ * {@link https://github.com/microsoft/azure-pipelines-agent/blob/master/src/Agent.Worker/TestResults/Legacy/JunitResultReader.cs | JunitResultReader.cs}):
+ * `xunit` sets this to the fully qualified title as well, so that grouping showed test titles instead of
+ * file names. This override sets it to the path (relative to the repo root) of the file containing the
+ * test.
+ *
+ * All other behavior — notably, `xunit`'s single flat `<testsuite>` per report file — is unchanged, so
+ * this reporter is not subject to the Azure DevOps "Test Run" naming regression that `mocha-junit-reporter`
+ * (which emits one `<testsuite>` per `describe` block, rather than one per file) causes: Azure DevOps's
+ * JUnit importer falls back to a generic `JUnit_<file name>` run title whenever a report file contains more
+ * than one `<testsuite>` element, unconditionally, regardless of file or suite naming.
+ */
+export class FluidXunitReporter extends XUnitReporterCtor {
+	public test(test: JUnitTestLike, options?: unknown): void {
+		const classname =
+			test.file === undefined ? test.fullTitle() : path.relative(repoRoot, test.file);
+		// `xunit`'s `test` method reads `test.title` for `name` and `test.parent.fullTitle()` for
+		// `classname`. Wrap `test` and `test.parent` (via prototypal inheritance, so unrelated
+		// properties/methods they're relied on for — `file`, `duration`, `state`, `err`, `isPending()`
+		// (which recurses into `parent.isPending()`) — still resolve correctly) to present the values
+		// wanted here, without mutating the shared `test`/`test.parent` objects that other reporters
+		// running in the same `mocha-multi-reporters` process also read.
+		const wrappedParent = Object.create(test.parent, {
+			fullTitle: { value: () => classname, enumerable: true },
+		}) as JUnitTestLike["parent"];
+		const wrapped = Object.create(test, {
+			title: { value: test.fullTitle(), enumerable: true },
+			parent: { value: wrappedParent, enumerable: true },
+		}) as JUnitTestLike;
+		super.test(wrapped, options);
+	}
+}

package/test-config.json

@@ -1,6 +1,6 @@
 {
-	"reporterEnabled": "spec,xunit",
-	"xunitReporterOptions": {
+	"reporterEnabled": "spec,@fluid-internal/mocha-test-setup/xunit-reporter",
+	"fluidInternalMochaTestSetupXunitReporterReporterOptions": {
 		"output": "nyc/{id}junit-report.xml",
 		"suiteName": "{id}"
 	}

package/xunit-reporter-cjswrapper.cjs

@@ -0,0 +1,15 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+// This file exists to preserve CommonJS default export compatibility for the xunit-reporter entrypoint,
+// since `mocha-multi-reporters` loads reporters via a plain CommonJS `require()`.
+// Once all consumers are using named imports, this file can be removed and all conditions can point
+// directly to the ESM file. attw xunit-reporter exclusion can also be removed at that time.
+
+"use strict";
+
+const { FluidXunitReporter } = require("./lib/xunitReporter.js");
+
+module.exports = FluidXunitReporter;