add reporter options (json, junit)

Author: delabiejochen

.eslintrc.js

@@ -11,6 +11,7 @@ module.exports = {
     // Place to specify ESLint rules. Can be used to overwrite rules specified from the extended configs
     // e.g. "@typescript-eslint/explicit-function-return-type": "off",
     "@typescript-eslint/no-var-requires": "off",
-    "@typescript-eslint/no-explicit-any": "off"
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/explicit-module-boundary-types": "off"
   }
 };

package-lock.json

@@ -36,7 +36,8 @@
     "@typescript-eslint/parser": "^3.8.0",
     "eslint": "^7.6.0",
     "prettier": "^2.0.5",
-    "typescript": "^3.9.7"
+    "typescript": "^3.9.7",
+    "xmlbuilder2": "^2.4.0"
   },
   "dependencies": {
     "archiver": "^5.2.0",

package.json

@@ -8,6 +8,7 @@ import Tunnel from '../utils/tunnel';
 import ora from 'ora';
 import chalk from 'chalk';
 import io from 'socket.io-client';
+import Reporter, { IFormatType } from '../utils/reporter';
 
 interface Arguments {
 	[x: string]: unknown;
@@ -17,6 +18,8 @@ interface Arguments {
 	parallel?: number;
 	e?: string;
 	s?: string;
+	r?: string;
+	o?: string;
 }
 
 interface ISocketData {
@@ -45,13 +48,18 @@ export default class RunProject {
 		this.stopJob();
 		if (this.config && this.config.run_settings.start_tunnel) {
 			if (this.tunnel) {
-				this.tunnel
-					.stop()
-					.then(() => {
-						process.exit();
-					})
-					.catch(log.error);
-				this.tunnel = undefined;
+				try {
+					this.tunnel
+						.stop()
+						.then(() => {
+							process.exit();
+						})
+						.catch(log.error);
+					this.tunnel = undefined;
+				} catch (err) {
+					log.error(chalk.white.bgRed.bold(err));
+					process.exit();
+				}
 			}
 		} else {
 			process.exit();
@@ -230,6 +238,7 @@ export default class RunProject {
 		}
 
 		this.registerCloseHandlers();
+		let success = false;
 
 		try {
 			const response = await this.uploader.start(zipFile);
@@ -238,22 +247,28 @@ export default class RunProject {
 
 			const poller = await this.poller.check(response.id, uploadSpinner);
 			const testCases = this.parseTestCases(poller.runs);
-			const success = this.parseSuccess(poller.runs);
+			success = this.parseSuccess(poller.runs);
 
 			if (process.env.TESTINGBOT_CI && testCases.length > 0) {
 				for (let i = 0; i < testCases.length; i++) {
 					const testCase = testCases[i];
 					console.log(`TestingBotSessionId=${testCase.sessionId}`);
 				}
 			}
-
-			process.exit(success === true ? 0 : 1);
 		} catch (err) {
-			log.error(chalk.white.bgRed.bold(err));
+			if (err) {
+				log.error(chalk.white.bgRed.bold(err));
+			}
+		} finally {
 			if (config.run_settings.start_tunnel) {
 				await this.tunnel.stop();
 			}
-			process.exit(1);
+			if (this.argv.r && this.projectId) {
+				const reporter = new Reporter(this.config, this.projectId, this.argv.o);
+				await reporter.format(this.argv.r as IFormatType);
+			}
+
+			process.exit(success === true ? 0 : 1);
 		}
 	}
 }

src/commands/run.ts

@@ -67,6 +67,19 @@ yargs
 					type: 'string',
 					default: undefined,
 				},
+				r: {
+					alias: 'reporter',
+					describe:
+						'Runs a specific reporter. valid reporters: "json", "junit"',
+					type: 'string',
+					default: undefined,
+				},
+				o: {
+					alias: 'reporter-options',
+					describe: 'Options for a reporter',
+					type: 'string',
+					default: undefined,
+				},
 			})
 			.help('help')
 			.wrap(null).argv;

src/index.ts

@@ -0,0 +1,68 @@
+import { IReportOptions } from '../reporter';
+import fs from 'fs';
+import { create } from 'xmlbuilder2';
+const fsPromises = fs.promises;
+
+export default class JUnitFormatter {
+	private reportData: any;
+	private reportOptions: IReportOptions;
+
+	constructor(reportData: any, reportOptions: IReportOptions) {
+		this.reportData = JSON.parse(reportData.report);
+		this.reportOptions = reportOptions;
+	}
+
+	public async format(): Promise<any> {
+		const doc = create().ele('testsuites', {
+			name: 'Cypress Tests',
+			tests: this.reportData.results.length,
+		});
+
+		for (let i = 0; i < this.reportData.results.length; i++) {
+			for (let j = 0; j < this.reportData.results[i].suites.length; j++) {
+				const suite = this.reportData.results[i].suites[j];
+				const failureCount = suite.tests.filter((index: number, value: any) => {
+					return value.pass === true;
+				}).length;
+				const suiteElement = doc.root().ele('testsuite', {
+					name: suite.title,
+					timestamp: new Date().toUTCString(),
+					tests: suite.tests.length,
+					failures: failureCount,
+				});
+
+				for (let k = 0; k < suite.tests.length; k++) {
+					const testCase = suite.tests[k];
+					const testElement = suiteElement.ele('testcase', {
+						name: testCase.fullTitle,
+						classname: testCase.fullTitle,
+						time: testCase.duration / 1000,
+					});
+
+					if (testCase.err && testCase.err.message) {
+						testElement.ele('failure', {
+							message: testCase.err.message,
+						});
+					}
+
+					if (testCase.err && testCase.err.message) {
+						testElement.ele('failure', {
+							message: testCase.err.message,
+						});
+					}
+				}
+			}
+		}
+
+		const xml = doc.end({ prettyPrint: true });
+
+		let outputFileName = 'test-results.xml';
+		if (this.reportOptions && this.reportOptions.mochaFile) {
+			outputFileName = this.reportOptions.mochaFile;
+		}
+
+		await fsPromises.writeFile(outputFileName, xml);
+
+		return this.reportData;
+	}
+}

src/utils/formatters/junit.ts

@@ -35,6 +35,7 @@ interface IPollResponse {
 	version: string;
 	build?: string;
 	build_id?: number;
+	success: boolean;
 }
 
 export default class Poller {
@@ -58,25 +59,20 @@ export default class Poller {
 				const status = this.getStatus(response);
 
 				if (status === IStatus.DONE) {
-					const errors = this.getErrors(response);
-					if (errors.length === 0) {
+					response.success = this.isSuccess(response);
+					if (response.success) {
 						spinner.succeed(
 							'Cypress Project has finished running on TestingBot',
 						);
-						if (this.intervalId) {
-							clearInterval(this.intervalId);
-							this.intervalId = undefined;
-						}
-						return resolve(response);
+					} else {
+						spinner.fail('Cypress Project has finished running on TestingBot');
 					}
 
-					spinner.fail('Cypress Project has finished running on TestingBot');
-
 					if (this.intervalId) {
 						clearInterval(this.intervalId);
 						this.intervalId = undefined;
 					}
-					return reject(errors);
+					return resolve(response);
 				}
 
 				if (
@@ -120,16 +116,14 @@ View results on https://testingbot.com/members/builds/${response.build_id}`);
 		});
 	}
 
-	private getErrors(response: IPollResponse): string[] {
-		const errors: string[] = [];
+	private isSuccess(response: IPollResponse): boolean {
+		let success = true;
 		for (let i = 0; i < response.runs.length; i++) {
 			const testRun = response.runs[i];
-			if (testRun.errors.length > 0) {
-				errors.concat(testRun.errors);
-			}
+			success = success && testRun.success;
 		}
 
-		return errors;
+		return success;
 	}
 
 	private getStatus(response: IPollResponse): IStatus {