@fluid-internal/mocha-test-setup 2.60.0 → 2.61.0-355516

package/README.md

@@ -40,8 +40,7 @@ Then put this in a `.mocharc.cjs` file at the root of your package:
 
 const getFluidTestMochaConfig = require("@fluid-internal/mocha-test-setup/mocharc-common");
 
-const packageDir = __dirname;
-const config = getFluidTestMochaConfig(packageDir);
+const config = getFluidTestMochaConfig(__dirname);
 module.exports = config;
 ```
 
@@ -53,13 +52,24 @@ The default configuration generated by `getFluidTestMochaConfig()` looks like th
 
 ```jsonc
 {
-  "exit": true,
   "recursive": true,
-  "require": ["path1", "path2"], // Mapped paths for packages/modules indicated as required when calling getFluidTestMochaConfig()
+  "require": ["@fluid-internal/mocha-test-setup", "source-map-support/register"], // can be extended by providing additionalRequiredModules to getFluidTestMochaConfig()
   "unhandled-rejections": "strict",
+  "node-option": ["conditions=allow-ff-test-exports", "expose-gc"],
+  "ignore": [ "**/*.tool.{js,cjs,mjs}" ], // Ignore "tools" which are scripts intended to be run, not part of the test suite.
+  "spec": "lib/test" // Defaults to "lib/test" where esm tests typically are. Can be overridden via MOCHA_SPEC.
 };
 ```
 
+It is recommended that the source for tests files use a file name ending in ".spec.ts", but this is not enforced:
+no file named based filtering of test files is done by default, except for the ignoring of `"**/*.tool.{js,cjs,mjs}"` noted above.
+
+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 mocha".
+
 The configuration will have additional settings if the following environment variables are present:
 
 ### FLUID_TEST_TIMEOUT
@@ -91,6 +101,20 @@ 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.
+
+### 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
@@ -128,7 +152,7 @@ might behave differently locally and in CI builds, so that's another factor to k
 
 ## Special behavior
 
-### Supress console output by default
+### 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.

package/dist/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 = "2.60.0";
+export declare const pkgVersion = "2.61.0-355516";
 //# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,qCAAqC,CAAC;AAC1D,eAAO,MAAM,UAAU,WAAW,CAAC"}
+{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,qCAAqC,CAAC;AAC1D,eAAO,MAAM,UAAU,kBAAkB,CAAC"}

package/dist/packageVersion.js

@@ -8,5 +8,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pkgVersion = exports.pkgName = void 0;
 exports.pkgName = "@fluid-internal/mocha-test-setup";
-exports.pkgVersion = "2.60.0";
+exports.pkgVersion = "2.61.0-355516";
 //# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,kCAAkC,CAAC;AAC7C,QAAA,UAAU,GAAG,QAAQ,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 = \"2.60.0\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,kCAAkC,CAAC;AAC7C,QAAA,UAAU,GAAG,eAAe,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 = \"2.61.0-355516\";\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 = "2.60.0";
+export declare const pkgVersion = "2.61.0-355516";
 //# sourceMappingURL=packageVersion.d.ts.map

package/lib/packageVersion.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,qCAAqC,CAAC;AAC1D,eAAO,MAAM,UAAU,WAAW,CAAC"}
+{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,qCAAqC,CAAC;AAC1D,eAAO,MAAM,UAAU,kBAAkB,CAAC"}

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 = "2.60.0";
+export const pkgVersion = "2.61.0-355516";
 //# 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,QAAQ,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 = \"2.60.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,eAAe,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 = \"2.61.0-355516\";\n"]}

package/lib/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.52.8"
+      "packageVersion": "7.52.11"
     }
   ]
 }

package/mocharc-common.cjs

@@ -8,6 +8,17 @@
 const { existsSync } = require("fs");
 const path = require("path");
 
+/**
+ * Get the mocha configuration for running tests using the conventions followed in the Fluid Framework repository.
+ *
+ * @param {string} packageDir - the directory of the package, typically set using `__dirname`
+ * @param {string[]} additionalRequiredModules - modules to require in addition to the standard set.
+ * @param {string} testReportPrefix - prefix for the test output report file names.
+ * @remarks
+ * Additional configuration can be provided via environment variables: see {@link file://./README.md}.
+ *
+ * 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.
+ */
 function getFluidTestMochaConfig(packageDir, additionalRequiredModules, testReportPrefix) {
 	const moduleDir = `${packageDir}/node_modules`;
 
@@ -53,6 +64,10 @@ function getFluidTestMochaConfig(packageDir, additionalRequiredModules, testRepo
 		"recursive": true,
 		"require": requiredModulePaths,
 		"unhandled-rejections": "strict",
+		ignore: [
+			// Ignore "tools" which are scripts intended to be run, not part of the test suite.
+			"**/*.tool.{js,cjs,mjs}",
+		],
 		"node-option": [
 			// Allow test-only indexes to be imported. Search the FF repo for package.json files with this condition to see example usage.
 			"conditions=allow-ff-test-exports",
@@ -62,6 +77,7 @@ function getFluidTestMochaConfig(packageDir, additionalRequiredModules, testRepo
 			// these must be provided here and not via mocha's --v8-expose-gc.
 			"expose-gc",
 		],
+		spec: process.env.MOCHA_SPEC ?? "lib/test",
 	};
 
 	if (process.env.FLUID_TEST_TIMEOUT !== undefined) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluid-internal/mocha-test-setup",
-  "version": "2.60.0",
+  "version": "2.61.0-355516",
   "description": "Utilities for Fluid tests",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -30,19 +30,19 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "dependencies": {
-    "@fluid-internal/test-driver-definitions": "~2.60.0",
-    "@fluidframework/core-interfaces": "~2.60.0",
+    "@fluid-internal/test-driver-definitions": "2.61.0-355516",
+    "@fluidframework/core-interfaces": "2.61.0-355516",
     "mocha": "^10.8.2",
     "source-map-support": "^0.5.21"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.1",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-tools/build-cli": "^0.57.0",
+    "@fluid-tools/build-cli": "^0.58.1",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.57.0",
+    "@fluidframework/build-tools": "^0.58.1",
     "@fluidframework/eslint-config-fluid": "^6.0.0",
-    "@microsoft/api-extractor": "7.52.8",
+    "@microsoft/api-extractor": "7.52.11",
     "@types/mocha": "^10.0.10",
     "@types/node": "^18.19.0",
     "concurrently": "^8.2.1",

package/src/packageVersion.ts

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