Change jest to always use jest-junit reporter whether in CI or not (#17173)

To mirror what mocha does so that local run can be more similar to CI
runs

Author: curtisman

azure/packages/external-controller/jest.config.js

@@ -20,4 +20,14 @@ module.exports = {
 	transform: {
 		"^.+\\.ts?$": "ts-jest",
 	},
+	reporters: [
+		"default",
+		[
+			"jest-junit",
+			{
+				outputDirectory: "nyc",
+				outputName: "jest-junit-report.xml",
+			},
+		],
+	],
 };

azure/packages/external-controller/package.json

@@ -101,10 +101,6 @@
 			}
 		}
 	},
-	"jest-junit": {
-		"outputDirectory": "nyc",
-		"outputName": "jest-junit-report.xml"
-	},
 	"typeValidation": {
 		"disabled": true,
 		"broken": {}

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

@@ -853,7 +853,7 @@ export const handlers: Handler[] = [
 			const mochaScriptName = scripts["test:mocha"] !== undefined ? "test:mocha" : "test";
 			const mochaScript = scripts[mochaScriptName];
 
-			if (!mochaScript || !mochaScript.startsWith("mocha")) {
+			if (mochaScript === undefined || !mochaScript.startsWith("mocha")) {
 				// skip irregular test script for now
 				return undefined;
 			}
@@ -871,4 +871,63 @@ export const handlers: Handler[] = [
 			}
 		},
 	},
+
+	{
+		name: "npm-package-json-script-jest-config",
+		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 jestScriptName = scripts["test:jest"] !== undefined ? "test:jest" : "test";
+			const jestScript = scripts[jestScriptName];
+
+			if (jestScript === undefined || !jestScript.startsWith("jest")) {
+				// skip irregular test script for now
+				return undefined;
+			}
+
+			const packageDir = path.dirname(file);
+			const jestFileName = ["jest.config.js", "jest.config.cjs"].find((name) =>
+				fs.existsSync(path.join(packageDir, name)),
+			);
+			if (jestFileName === undefined) {
+				return `Missing jest config file.`;
+			}
+
+			const jestConfigFile = path.join(packageDir, jestFileName);
+			const config = require(path.resolve(jestConfigFile));
+			if (config.reporters === undefined) {
+				return `Missing reporters in '${jestConfigFile}'`;
+			}
+
+			const expectedReporter = [
+				"default",
+				[
+					"jest-junit",
+					{
+						outputDirectory: "nyc",
+						outputName: "jest-junit-report.xml",
+					},
+				],
+			];
+
+			if (JSON.stringify(config.reporters) !== JSON.stringify(expectedReporter)) {
+				return `Unexpected reporters in '${jestConfigFile}'`;
+			}
+
+			if (json["jest-junit"] !== undefined) {
+				return `Extraneous jest-unit config in ${file}`;
+			}
+		},
+	},
 ];

common/lib/common-utils/jest.config.js

@@ -7,4 +7,14 @@ module.exports = {
 	preset: "jest-puppeteer",
 	testMatch: ["**/dist/test/jest/?(*.)+(spec|test).js"],
 	testPathIgnorePatterns: ["/node_modules/"],
+	reporters: [
+		"default",
+		[
+			"jest-junit",
+			{
+				outputDirectory: "nyc",
+				outputName: "jest-junit-report.xml",
+			},
+		],
+	],
 };

common/lib/common-utils/package.json

@@ -45,7 +45,7 @@
 		"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:jest:report": "npm run test:jest -- --ci --coverage",
 		"test:mocha": "mocha --unhandled-rejections=strict  --recursive dist/test/mocha/**/*.spec.js --exit --project test/tsconfig.json",
 		"test:mocha:multireport": "cross-env FLUID_TEST_MULTIREPORT=1 npm run test:mocha",
 		"test:mocha:report": "npm run test:mocha -- -- --reporter xunit --reporter-option output=nyc/mocha-junit-report.xml",
@@ -146,10 +146,6 @@
 			]
 		}
 	},
-	"jest-junit": {
-		"outputDirectory": "nyc",
-		"outputName": "jest-junit-report.xml"
-	},
 	"typeValidation": {
 		"broken": {}
 	}

examples/apps/attributable-map/jest.config.js

@@ -20,4 +20,14 @@ module.exports = {
 	transform: {
 		"^.+\\.ts?$": "ts-jest",
 	},
+	reporters: [
+		"default",
+		[
+			"jest-junit",
+			{
+				outputDirectory: "nyc",
+				outputName: "jest-junit-report.xml",
+			},
+		],
+	],
 };

examples/apps/attributable-map/package.json

@@ -82,10 +82,6 @@
 			}
 		}
 	},
-	"jest-junit": {
-		"outputDirectory": "nyc",
-		"outputName": "jest-junit-report.xml"
-	},
 	"typeValidation": {
 		"disabled": true,
 		"broken": {}

examples/apps/collaborative-textarea/package.json

@@ -92,10 +92,6 @@
 			}
 		}
 	},
-	"jest-junit": {
-		"outputDirectory": "nyc",
-		"outputName": "jest-junit-report.xml"
-	},
 	"typeValidation": {
 		"disabled": true,
 		"broken": {}

examples/apps/contact-collection/jest.config.js

@@ -20,4 +20,14 @@ module.exports = {
 	transform: {
 		"^.+\\.ts?$": "ts-jest",
 	},
+	reporters: [
+		"default",
+		[
+			"jest-junit",
+			{
+				outputDirectory: "nyc",
+				outputName: "jest-junit-report.xml",
+			},
+		],
+	],
 };

examples/apps/contact-collection/package.json

@@ -88,10 +88,6 @@
 			}
 		}
 	},
-	"jest-junit": {
-		"outputDirectory": "nyc",
-		"outputName": "jest-junit-report.xml"
-	},
 	"typeValidation": {
 		"disabled": true,
 		"broken": {}