@fluid-internal/mocha-test-setup 3.4.0 → 3.6.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @fluid-internal/mocha-test-setup
 
+## 3.6.0
+
+Dependency updates only.
+
+## 3.5.0
+
+Dependency updates only.
+
 ## 3.4.0
 
 Dependency updates only.

package/README.md

@@ -15,10 +15,72 @@ This package has a few main purposes:
 
 -   Expose/generate a default `.mocharc.cjs` configuration for running [mocha](https://mochajs.org) tests, which other
     packages can extend.
--   Map paths for required packages/modules to account for [Lerna](https://lerna.js.org/)'s dependency hoisting.
 -   Add mocha `beforeAll`, `beforeEach` and `afterEach` [root hook plugins](https://mochajs.org/#root-hook-plugins) to add
     some special behavior when we run tests.
 
+## Running tests
+
+For packages using this configuration, build the package and its tests, then run `pnpm exec mocha` from the package directory.
+
+- [Select test files with `MOCHA_SPEC`](#mocha_spec).
+- [Filter test names with Mocha's `--fgrep` or `--grep`](https://mochajs.org/running/cli/#--fgrep-string--f-string).
+- [Enable performance measurements with `FLUID_TEST_PERF_MODE`](#fluid_test_perf_mode).
+
+## Environment Variables
+
+Set environment variables before running Mocha.
+For cross-platform scripts, use `cross-env`, for example `pnpm exec cross-env MOCHA_SPEC=lib/test/example.spec.js mocha`.
+
+### MOCHA_SPEC
+
+Sets the compiled test file, directory, or glob to load, relative to the package directory.
+It replaces the default selection of `lib/test` (or `dist/test` with [`FLUID_TEST_MODULE_SYSTEM=CJS`](#fluid_test_module_system)).
+Unlike `MOCHA_SPEC`, positional file arguments and `--spec` add to the configured selection because of [Mocha's configuration merging](https://mochajs.org/next/running/configuring/#merging).
+Name filtering alone still loads all configured test files; use `MOCHA_SPEC` to avoid loading unrelated files.
+
+### FLUID_TEST_PERF_MODE
+
+Set to `1` to measure benchmarks instead of running them as correctness tests.
+Leave unset for correctness testing; do not use `0` to disable it.
+
+This selects the benchmark reporter, sets a 1,000-second timeout per test, and writes results to `./benchmarkOutput.json`.
+Override the timeout with [`FLUID_TEST_TIMEOUT`](#fluid_test_timeout) and the report path with `--reporterOptions reportFile=<path>`.
+
+The default `@Benchmark` filter is omitted when you supply `--fgrep <text>` or `--grep <pattern>` (use these long options with separate arguments).
+Your filter replaces, rather than intersects with, the default.
+See [benchmark filtering](../../../tools/benchmark/README.md#--fgrep-benchmark) for tags and combining constraints.
+
+### FLUID_TEST_TIMEOUT
+
+Overrides Mocha's per-test timeout in milliseconds, including the performance-mode default.
+
+### FLUID_TEST_FORBID_ONLY
+
+When present, enables Mocha's `forbid-only` option to reject exclusive tests.
+
+### FLUID_TEST_MODULE_SYSTEM
+
+When set to "CJS", current run is setup to be for CommonJS coverage:
+- "CJS" is noted as a variant and shown as prefix to test case names.
+- The JUnit test-results file will be prefixed with "CJS-".
+- Default spec is changed from `lib/test` to `dist/test`.
+
+### FLUID_LOGGER_PROPS
+
+Sets a JSON object serialized into the `testEnvProps` telemetry field.
+Its `hostName` property also overrides the event's `hostName`:
+
+```
+FLUID_LOGGER_PROPS='{ "hostName": "Benchmark" }'
+```
+
+### FLUID_TEST_LOGGER_PKG_SPECIFIER
+
+Specifies a module exporting `createTestLogger`, which returns an `ITelemetryBufferedLogger`.
+The setup calls this factory, wraps the logger with test context, and installs the global `getTestLogger` function.
+Use this variable rather than `--require` to configure a custom logger.
+Pipelines use it to send telemetry to internal engineering systems.
+
 ## Base `mocharc.cjs` configuration
 
 To leverage the base mocha configuration exposed by this package, first add it as a `devDependency` to your `package.json`
@@ -47,7 +109,7 @@ If you need extra configuration, make changes to the `config` object before assi
 
 Mocha will use this file by default if no path to a configuration file is provided explicitly.
 
-The default configuration generated by `getFluidTestMochaConfig()` looks like this:
+The following excerpt shows some of the settings generated by `getFluidTestMochaConfig()`:
 
 ```jsonc
 {
@@ -65,104 +127,11 @@ no file named based filtering of test files is done by default, except for the i
 
 Note: some packages do explicitly filter test files to `*.spec.js`: in such packages test files with other names will be silently ignored.
 
-## Environment Variables
-
-In package.json scripts, environment variables can be set using cross-env, like "cross-env MOCHA_SPEC=lib/mocha/test/**/*.spec.*js mocha".
-
-The configuration will have additional settings if the following environment variables are present:
-
-### FLUID_TEST_TIMEOUT
-
-If it exists, the default configuration will also include this:
-
-```json
-{
-	"timeout": "<value-of-FLUID_TEST_TIMEOUT>"
-}
-```
-
-### FLUID_TEST_FORBID_ONLY
-
-If it exists, the default configuration will also include this:
-
-```json
-{
-	"forbid-only": "true"
-}
-```
-
-### FLUID_LOGGER_PROPS
-
-In case there is a need to override telemetry metrics, one can make use of an environment variable `FLUID_LOGGER_PROPS`,
-that to override them during execution time:
-
-```
-FLUID_LOGGER_PROPS='{ "hostName": "Benchmark" }'
-```
-
-### FLUID_TEST_LOGGER_PKG_SPECIFIER
-
-Injects implementation of `createTestLogger`.
-We use it in our pipelines to submit telemetry to internal engineering systems.
-Probably not useful outside of that scenario, except when using it locally to test something related to its use in the pipelines.
-
-### FLUID_TEST_MODULE_SYSTEM
-
-When set to "CJS", current run is setup to be for CommonJS coverage:
-- "CJS" is noted as a variant and shown as prefix to test case names.
-- Coverage file will be prefixed with "CJS-".
-- Default spec is changed from `lib/test` to `dist/test`; see more below.
-
-### MOCHA_SPEC
-
-Select the "spec".
-Note that unlike Mocha's built in MOCHA_OPTIONS environment variable,
-this will replace our default spec instead of adding to the spec (See https://mochajs.org/next/running/configuring/#merging).
-Also unlike Mocha's default behavior (see https://mochajs.org/next/running/cli/),
-this configuration defaults spec to `lib/test` (where we place our esm tests) instead of `test`.
-
-## Mapping of package paths to account for Lerna hoisting
-
-The way we use Lerna to manage our monorepo, package dependencies are sometimes moved out of the `node_modules` folder
-of the package that declares them, and into a `node_modules` folder at the root of the release group.
-This applies to external dependencies (i.e. not between packages in our repo) that are present in more than one of our
-packages, including `mocha` itself as well as other test runners, which means that their path when they execute
-might not be the one you'd normally expect.
-This can cause issues when test scripts point to other dependencies of the package being tested (e.g. with the `-r/--require`
-flag) when running tests.
-This utility maps the paths of packages/modules passed to the `getFluidTestMochaConfig()` function, to ensure they are
-imported from whichever location they end up at.
-
-**NOTE**: once we move to `pnpm` this functionality might become irrelevant because `pnpm` keeps all dependencies in the
-expected paths and creates the necessary symlinks, instead of changing where dependency folders are located.
-
-### Considerations for non-package/module arguments
-
-Sometimes you'll want to provide a package/module/path as an argument when executing your tests but outside of the
-required packages that you can pass to `getFluidTestMochaConfig()`.
-For example, the path to a reporter file:
-
-```console
-mocha --require @fluid-internal/mocha-test-setup --reporter @fluid-tools/benchmark/dist/mocha/Reporter.js
-```
-
-Depending on where that file is coming from, you'll need to be careful with how that path is specified.
-E.g. `@fluid-tools/benchmark`, while being part of the repository, is not part of any release group, so it will always
-be downloaded from the public npm feed and treated as an external dependency.
-Since several packages declare it as a dependency, Lerna will hoist it to `node_modules` at the root of the release group.
-In general, the safest solution is to specify it starting with the package name (including scope if applicable).
-This might break in a few edge cases as long as we use Lerna with hoisting, so we'll have to deal with them individually.
-
-A particular way of specifying a package/module/path (e.g. starting with the package name vs starting with `node_modules/`)
-might behave differently locally and in CI builds, so that's another factor to keep in mind.
-
 ## Special behavior
 
 ### Suppress console output by default
 
-`console.log()`, `console.warn()` and `console.error()` are disabled by default when using this package.
-They can be re-enabled by setting the `FLUID_TEST_VERBOSE` environment variable to any non-empty value, e.g.
-`FLUID_TEST_VERBOSE=1`.
+`console.log()`, `console.warn()` and `console.error()` are suppressed during tests unless `FLUID_TEST_VERBOSE` is set, for example `FLUID_TEST_VERBOSE=1`.
 
 ### Telemetry events
 
@@ -170,21 +139,6 @@ A couple of telemetry events `fluid:telemetry:Test_start` and `fluid:telemetry:T
 The `Test_end` event includes fields with the test's state (passing/failed), its duration, if it timed out.
 If a `FLUID_TEST_VARIANT` environment variable exists, the `testVariant` field in the events will have its value.
 
-### Support for a custom logger
-
-This utility supports using a custom logger implementation.
-This can be useful to send the operational telemetry generated by the FluidFramework while the tests are running, to a
-particular log sink.
-
-It is expected that the package with the custom logger implementation adds a `getTestLogger() => ITelemetryBufferedLogger`
-function to the `global` object, which this package will call in order to obtain an instance of the custom logger.
-
-If a custom logger implementation will be used when executing tests in a package that leverages this utility, the path
-to the module with that implementation should **not** be specified with the `--require/-r` flag, but through the
-`FLUID_TEST_LOGGER_PKG_PATH` environment variable.
-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.
-
 <!-- 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. -->

package/lib/mocharcCommon.d.ts

@@ -28,9 +28,11 @@ export interface FluidTestMochaConfig {
  * @param additionalRequiredModules - modules to require in addition to the standard set.
  * @param testReportPrefix - prefix for the test output report file names.
  * @remarks
- * Additional configuration can be provided via environment variables: see {@link file://./README.md}.
+ * See the "Running tests" section in [README.md](../README.md)
+ * for test selection, performance measurements, and environment variable configuration.
  *
- * 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.
+ * Mocha’s CLI `spec` arguments add to the configured selection rather than replacing it.
+ * For exact control over `spec` (including via the CLI), replace or delete the `spec` property in the returned configuration.
  */
 export declare function getFluidTestMochaConfig(packageDir: string, additionalRequiredModules?: string[], testReportPrefix?: string): FluidTestMochaConfig;
 //# sourceMappingURL=mocharcCommon.d.ts.map

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,CAgHtB"}
+{"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;AAYD;;;;;;;;;;;;GAYG;AAEH,wBAAgB,uBAAuB,CACtC,UAAU,EAAE,MAAM,EAClB,yBAAyB,CAAC,EAAE,MAAM,EAAE,EACpC,gBAAgB,CAAC,EAAE,MAAM,GACvB,oBAAoB,CAgHtB"}

package/lib/mocharcCommon.js

@@ -4,6 +4,16 @@
  */
 import { readFileSync } from "node:fs";
 import path from "node:path";
+/* eslint-disable @fluid-internal/fluid/no-markdown-links-in-jsdoc --
+This configuration helper is not published in API docs so we can keep its README link source-relative.
+Sadly there seems to be no way to link the readme file with {@link} tags nor raw file urls that can actually be clicked in VS-Code
+(directly or via intellisense) without giving errors due to needing to navigate up via `..` which is blocked.
+There also seems to be no way to make this link go to the relevant anchor in the README file as vscode interprets it as part of the file name,
+rather than recognizing it as an anchor within the file.
+I still think using this non anchored markdown link is better than linking to a URL on github which points either to this branch,
+or main where these docs don't even exist yet.
+Thus I feel this lint suppression allows for a better link, and thus is justified.
+*/
 /**
  * Get the mocha configuration for running tests using the conventions followed in the Fluid Framework repository.
  *
@@ -11,10 +21,13 @@ import path from "node:path";
  * @param additionalRequiredModules - modules to require in addition to the standard set.
  * @param testReportPrefix - prefix for the test output report file names.
  * @remarks
- * Additional configuration can be provided via environment variables: see {@link file://./README.md}.
+ * See the "Running tests" section in [README.md](../README.md)
+ * for test selection, performance measurements, and environment variable configuration.
  *
- * 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.
+ * Mocha’s CLI `spec` arguments add to the configured selection rather than replacing it.
+ * For exact control over `spec` (including via the CLI), replace or delete the `spec` property in the returned configuration.
  */
+/* eslint-enable @fluid-internal/fluid/no-markdown-links-in-jsdoc -- see the disable for details */
 export function getFluidTestMochaConfig(packageDir, additionalRequiredModules, testReportPrefix) {
     const requiredModules = [
         // General mocha setup e.g. suppresses console.log,

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;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"]}
+{"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;;;;;;;;;EASE;AACF;;;;;;;;;;;;GAYG;AACH,mGAAmG;AACnG,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/* eslint-disable @fluid-internal/fluid/no-markdown-links-in-jsdoc --\nThis configuration helper is not published in API docs so we can keep its README link source-relative.\nSadly there seems to be no way to link the readme file with {@link} tags nor raw file urls that can actually be clicked in VS-Code\n(directly or via intellisense) without giving errors due to needing to navigate up via `..` which is blocked.\nThere also seems to be no way to make this link go to the relevant anchor in the README file as vscode interprets it as part of the file name,\nrather than recognizing it as an anchor within the file.\nI still think using this non anchored markdown link is better than linking to a URL on github which points either to this branch,\nor main where these docs don't even exist yet.\nThus I feel this lint suppression allows for a better link, and thus is justified.\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 * See the \"Running tests\" section in [README.md](../README.md)\n * for test selection, performance measurements, and environment variable configuration.\n *\n * Mocha’s CLI `spec` arguments add to the configured selection rather than replacing it.\n * For exact control over `spec` (including via the CLI), replace or delete the `spec` property in the returned configuration.\n */\n/* eslint-enable @fluid-internal/fluid/no-markdown-links-in-jsdoc -- see the disable for details */\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.4.0";
+export declare const pkgVersion = "3.6.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.4.0";
+export const pkgVersion = "3.6.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.4.0\";\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.6.0\";\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluid-internal/mocha-test-setup",
-  "version": "3.4.0",
+  "version": "3.6.0",
   "description": "Utilities for Fluid tests",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -26,17 +26,17 @@
     }
   },
   "dependencies": {
-    "@fluid-internal/test-driver-definitions": "~3.4.0",
-    "@fluidframework/core-interfaces": "~3.4.0",
+    "@fluid-internal/test-driver-definitions": "~3.6.0",
+    "@fluidframework/core-interfaces": "~3.6.0",
     "mocha": "^11.7.5",
     "source-map-support": "^0.5.21"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.18.5",
     "@biomejs/biome": "~2.4.5",
-    "@fluid-tools/build-cli": "^0.67.0",
+    "@fluid-tools/build-cli": "^0.68.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.67.0",
+    "@fluidframework/build-tools": "^0.68.0",
     "@fluidframework/eslint-config-fluid": "^14.0.0",
     "@microsoft/api-extractor": "7.58.1",
     "@types/mocha": "^10.0.10",

package/src/mocharcCommon.ts

@@ -26,6 +26,16 @@ export interface FluidTestMochaConfig {
 	"forbid-only"?: boolean;
 }
 
+/* eslint-disable @fluid-internal/fluid/no-markdown-links-in-jsdoc --
+This configuration helper is not published in API docs so we can keep its README link source-relative.
+Sadly there seems to be no way to link the readme file with {@link} tags nor raw file urls that can actually be clicked in VS-Code
+(directly or via intellisense) without giving errors due to needing to navigate up via `..` which is blocked.
+There also seems to be no way to make this link go to the relevant anchor in the README file as vscode interprets it as part of the file name,
+rather than recognizing it as an anchor within the file.
+I still think using this non anchored markdown link is better than linking to a URL on github which points either to this branch,
+or main where these docs don't even exist yet.
+Thus I feel this lint suppression allows for a better link, and thus is justified.
+*/
 /**
  * Get the mocha configuration for running tests using the conventions followed in the Fluid Framework repository.
  *
@@ -33,10 +43,13 @@ export interface FluidTestMochaConfig {
  * @param additionalRequiredModules - modules to require in addition to the standard set.
  * @param testReportPrefix - prefix for the test output report file names.
  * @remarks
- * Additional configuration can be provided via environment variables: see {@link file://./README.md}.
+ * See the "Running tests" section in [README.md](../README.md)
+ * for test selection, performance measurements, and environment variable configuration.
  *
- * 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.
+ * Mocha’s CLI `spec` arguments add to the configured selection rather than replacing it.
+ * For exact control over `spec` (including via the CLI), replace or delete the `spec` property in the returned configuration.
  */
+/* eslint-enable @fluid-internal/fluid/no-markdown-links-in-jsdoc -- see the disable for details */
 export function getFluidTestMochaConfig(
 	packageDir: string,
 	additionalRequiredModules?: string[],

package/src/packageVersion.ts

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