Add policy for test scripts to split property for the client pipeline (#17161)

Also fix driver-web-cache test to run in the CI.

Author: curtisman

azure/packages/azure-client/package.json

@@ -32,6 +32,7 @@
 		"prettier": "prettier --check . --ignore-path ../../../.prettierignore",
 		"prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
 		"start:tinylicious:test": "npx @fluidframework/azure-local-service > tinylicious.log 2>&1",
+		"test": "npm run test:realsvc",
 		"test:realsvc": "npm run test:realsvc:tinylicious",
 		"test:realsvc:local:run": "mocha --recursive 'dist/test/**/*.spec.js' --exit --timeout 10000",
 		"test:realsvc:tinylicious": "start-server-and-test start:tinylicious:test 7070 test:realsvc:local:run",

azure/packages/test/scenario-runner/package.json

@@ -29,7 +29,7 @@
 		"start": "node ./dist/orchestratorRunner.js --config v1",
 		"start:scenario": "node ./dist/orchestratorRunner.js --config",
 		"start:server": "node ./dist/server.js",
-		"test": "echo \"Error: no test specified\" && exit 1",
+		"test": "npm run test:realsvc",
 		"test:realsvc": "npm run test:realsvc:tinylicious",
 		"test:realsvc:azure": "cross-env FLUID_CLIENT=azure npm run test:realsvc:azure:run",
 		"test:realsvc:azure:run": "mocha --recursive 'dist/test/**/*.spec.js' --exit --timeout 10000",

build-tools/packages/build-tools/src/repoPolicyCheck/handlers/npmPackages.ts

@@ -789,6 +789,51 @@ export const handlers: Handler[] = [
 			}
 		},
 	},
+	{
+		name: "npm-package-json-test-scripts-split",
+		match,
+		handler: (file, root) => {
+			let json;
+
+			try {
+				json = JSON.parse(readFile(file));
+			} catch (err) {
+				return "Error parsing JSON file: " + file;
+			}
+
+			const scripts = json.scripts;
+			if (scripts === undefined) {
+				return undefined;
+			}
+			const testScript = scripts["test"];
+
+			const splitTestScriptNames = ["test:mocha", "test:jest", "test:realsvc"];
+
+			if (testScript === undefined) {
+				if (splitTestScriptNames.some((name) => scripts[name] !== undefined)) {
+					return "Missing 'test' scripts";
+				}
+				return undefined;
+			}
+
+			const actualSplitTestScriptNames = splitTestScriptNames.filter(
+				(name) => scripts[name] !== undefined,
+			);
+
+			if (actualSplitTestScriptNames.length === 0) {
+				if (!testScript.startsWith("echo ")) {
+					return "Missing split test scripts. The 'test' script must call one or more \"split\" scripts like 'test:mocha', 'test:jest', or 'test:realsvc'.";
+				}
+				return undefined;
+			}
+			const expectedTestScript = actualSplitTestScriptNames
+				.map((name) => `npm run ${name}`)
+				.join(" && ");
+			if (testScript !== expectedTestScript) {
+				return `Unexpected test script:\n\tactual: ${testScript}\n\texpected: ${expectedTestScript}`;
+			}
+		},
+	},
 	{
 		name: "npm-package-json-script-mocha-config",
 		match,

experimental/dds/tree/package.json

@@ -31,8 +31,9 @@
 		"perf:measure": "npm run perf -- --fgrep @Measurement",
 		"prettier": "prettier --check . --ignore-path ../../../.prettierignore",
 		"prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
-		"test": "nyc npm run test:mocha",
+		"test": "npm run test:mocha",
 		"test:benchmark:report": "mocha \"dist/**/*.tests.js\" --node-option unhandled-rejections=strict,expose-gc --exit --perfMode --fgrep @Benchmark -r node_modules/@fluidframework/mocha-test-setup --reporter @fluid-tools/benchmark/dist/MochaReporter.js --timeout 60000",
+		"test:coverage": "nyc npm run test",
 		"test:mocha": "mocha \"dist/**/*.tests.js\" --exit -r node_modules/@fluidframework/mocha-test-setup",
 		"test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
 		"test:stress": "cross-env FUZZ_TEST_COUNT=10 FUZZ_STRESS_RUN=true mocha \"dist/**/*.fuzz.tests.js\" --exit -r @fluidframework/mocha-test-setup",

fluidBuild.config.cjs

@@ -143,6 +143,12 @@ module.exports = {
 				"packages/test/mocha-test-setup/package.json",
 				"examples/apps/attributable-map/package.json",
 			],
+			"npm-package-json-test-scripts-split": [
+				"server/",
+				"tools/",
+				"package.json",
+				"packages/test/test-service-load/package.json",
+			],
 		},
 		packageNames: {
 			// The allowed package scopes for the repo.

packages/common/client-utils/package.json

@@ -28,10 +28,7 @@
 		"build:test:jest": "tsc --project ./src/test/jest/tsconfig.json",
 		"build:test:mocha": "tsc --project ./src/test/mocha/tsconfig.json",
 		"build:test:types": "tsc --project ./src/test/types/tsconfig.json",
-		"ci:build": "npm run build:compile",
 		"ci:build:docs": "api-extractor run --typescript-compiler-folder ./node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
-		"ci:test": "npm run test:report",
-		"ci:test:coverage": "npm run test:coverage",
 		"clean": "rimraf --glob _api-extractor-temp dist lib *.tsbuildinfo *.build.log",
 		"eslint": "eslint --format stylish src",
 		"eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
@@ -41,11 +38,8 @@
 		"prettier": "prettier --check . --ignore-path ../../../.prettierignore",
 		"prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
 		"test": "npm run test:mocha && npm run test:jest",
-		"test:coverage": "npm run test:report",
 		"test:jest": "jest",
-		"test:jest:report": "npm run test:jest -- --ci --coverage --reporters=default --reporters=jest-junit",
 		"test:mocha": "mocha  --recursive dist/test/mocha/**/*.spec.js --exit --project test/tsconfig.json",
-		"test:report": "nyc npm run test:mocha && npm run test:jest:report",
 		"tsc": "tsc",
 		"typetests:gen": "fluid-type-test-generator",
 		"typetests:prepare": "flub typetests --dir . --reset --previous --normalize"

packages/drivers/driver-web-cache/package.json

@@ -31,7 +31,8 @@
 		"lint:fix": "npm run prettier:fix && npm run eslint:fix",
 		"prettier": "prettier --check . --ignore-path ../../../.prettierignore",
 		"prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
-		"test": "jest",
+		"test": "npm run test:jest",
+		"test:jest": "jest",
 		"tsc": "tsc",
 		"typetests:gen": "fluid-type-test-generator",
 		"typetests:prepare": "flub typetests --dir . --reset --previous --normalize"
@@ -60,6 +61,10 @@
 		"rimraf": "^4.4.0",
 		"typescript": "~4.5.5"
 	},
+	"jest-junit": {
+		"outputDirectory": "nyc",
+		"outputName": "jest-junit-report.xml"
+	},
 	"typeValidation": {
 		"broken": {}
 	}

packages/framework/tinylicious-client/package.json

@@ -31,6 +31,7 @@
 		"prettier": "prettier --check . --ignore-path ../../../.prettierignore",
 		"prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
 		"start:tinylicious:test": "tinylicious > tinylicious.log 2>&1",
+		"test": "npm run test:realsvc",
 		"test:realsvc": "npm run test:realsvc:tinylicious",
 		"test:realsvc:tinylicious": "start-server-and-test start:tinylicious:test 7070 test:realsvc:tinylicious:run",
 		"test:realsvc:tinylicious:run": "mocha --recursive 'dist/test/**/*.spec.js' --exit",