Enable JUnit report output during testRunner processing. (#1901)

Reporting support for VSTS primarily.
- Add reporter & reporterOptions to testRunner
- Add support for JUnit output file

Author: d3r3kk

news/3 Code Health/1897.md

@@ -0,0 +1 @@
+Add JUnit file output to enable CI integration with VSTS.

package-lock.json

@@ -1926,8 +1926,8 @@
         "@types/chai-arrays": "^1.0.2",
         "@types/chai-as-promised": "^7.1.0",
         "@types/del": "^3.0.0",
-        "@types/download": "^6.2.2",
         "@types/dotenv": "^4.0.3",
+        "@types/download": "^6.2.2",
         "@types/event-stream": "^3.3.33",
         "@types/fs-extra": "^5.0.1",
         "@types/get-port": "^3.2.0",
@@ -1971,6 +1971,7 @@
         "is-running": "^2.1.0",
         "istanbul": "^0.4.5",
         "mocha": "^5.0.4",
+        "mocha-junit-reporter": "^1.17.0",
         "node-has-native-dependencies": "^1.0.2",
         "relative": "^3.0.2",
         "remap-istanbul": "^0.10.1",

package.json

@@ -8,6 +8,12 @@ export const IS_APPVEYOR = process.env.APPVEYOR === 'true';
 export const IS_TRAVIS = process.env.TRAVIS === 'true';
 export const IS_VSTS = process.env.TF_BUILD !== undefined;
 export const IS_CI_SERVER = IS_TRAVIS || IS_APPVEYOR || IS_VSTS;
+
+// allow the CI server to specify JUnit output...
+export const MOCHA_REPORTER_JUNIT: boolean = IS_CI_SERVER && process.env.MOCHA_REPORTER_JUNIT !== undefined;
+export const MOCHA_CI_REPORTFILE: string = MOCHA_REPORTER_JUNIT && process.env.MOCHA_CI_REPORTFILE !== undefined ? process.env.MOCHA_CI_REPORTFILE.toString() : './junit-out.xml';
+export const MOCHA_CI_PROPERTIES: string = MOCHA_REPORTER_JUNIT && process.env.MOCHA_CI_PROPERTIES !== undefined ? process.env.MOCHA_CI_PROPERTIES.toString() : '';
+
 export const TEST_TIMEOUT = 25000;
 export const IS_MULTI_ROOT_TEST = isMultitrootTest();
 export const IS_CI_SERVER_TEST_DEBUGGER = process.env.IS_CI_SERVER_TEST_DEBUGGER === '1';

src/test/constants.ts

@@ -5,7 +5,8 @@ if ((Reflect as any).metadata === undefined) {
 }
 
 import { IS_CI_SERVER, IS_CI_SERVER_TEST_DEBUGGER,
-         IS_MULTI_ROOT_TEST, IS_VSTS } from './constants';
+         IS_MULTI_ROOT_TEST, IS_VSTS, MOCHA_CI_PROPERTIES,
+         MOCHA_CI_REPORTFILE, MOCHA_REPORTER_JUNIT } from './constants';
 import * as testRunner from './testRunner';
 
 process.env.VSC_PYTHON_CI_TEST = '1';
@@ -22,11 +23,28 @@ const testFilesSuffix = process.env.TEST_FILES_SUFFIX;
 // Hack, as retries is not supported as setting in tsd.
 const options: testRunner.SetupOptions & { retries: number } = {
     ui: 'tdd',
-    useColors: !IS_VSTS,
+    useColors: true,
     timeout: 25000,
     retries: 3,
     grep,
     testFilesSuffix
 };
+
+// VSTS CI doesn't display colours correctly (yet).
+if (IS_VSTS) {
+    options.useColors = false;
+}
+
+// CI can ask for a JUnit reporter if the environment variable
+// 'MOCHA_REPORTER_JUNIT' is defined, further control is afforded
+// by other 'MOCHA_CI_...' variables. See constants.ts for info.
+if (MOCHA_REPORTER_JUNIT) {
+    options.reporter = 'mocha-junit-reporter';
+    options.reporterOptions = {
+        mochaFile: MOCHA_CI_REPORTFILE,
+        properties: MOCHA_CI_PROPERTIES
+    };
+}
+
 testRunner.configure(options, { coverageConfig: '../coverconfig.json' });
 module.exports = testRunner;

src/test/index.ts

@@ -49,7 +49,15 @@ let mocha = new Mocha(<any>{
     useColors: true
 });
 
-export type SetupOptions = MochaSetupOptions & { testFilesSuffix?: string };
+export type SetupOptions = MochaSetupOptions & {
+    testFilesSuffix?: string;
+    reporter?: string;
+    reporterOptions?: {
+        mochaFile?: string;
+        properties?: string;
+    };
+};
+
 let testFilesGlob = 'test';
 let coverageOptions: { coverageConfig: string } | undefined;