many improvements

Author: delabiejochen

README.md

@@ -21,6 +21,9 @@ You can easily install the CLI via `npm` or `yarn`:
 $ npm install -g testinbot-cypress-cli
 ```
 
+To use the CLI in combination with [TestingBot Tunnel](https://testingbot.com/support/other/tunnel), you will need to have JDK8 (or higher) installed.
+TestingBot Tunnel is used to connect TestingBot's browser grid with your local computer or network.
+
 ### Configure
 
 Once the CLI is installed, you'll need to point it to a configuration file.
@@ -50,6 +53,14 @@ Once you've started this command, the tests will start to appear in the [Testing
 
 ## Documentation
 
+### Environment variables
+
+If you prefer to keep your TestingBot credentials in environment variables, you can use `TESTINGBOT_KEY` and `TESTINGBOT_SECRET` environment variables.
+
+If you are running this CLI in a CI/CD like Jenkins or TeamCity, you can set the
+environment variable `TESTINGBOT_CI=1`. The CLI will output the `TestingBotSessionID`, in combination
+with a TestingBot CI plugin you will be able to view the test's details from inside your CI.
+
 ## Getting Help
 
 If you need help, please reach out to us via [email protected] or our public Slack: https://testingbot.com/support

src/commands/run.ts

@@ -1,4 +1,5 @@
 import log from '../log';
+import request from 'request';
 import Archiver from '../utils/archiver';
 import Uploader from '../utils/uploader';
 import Poller, { IRun, ITest } from '../utils/poller';
@@ -7,20 +8,25 @@ import Tunnel from '../utils/tunnel';
 import ora from 'ora';
 import chalk from 'chalk';
 import io from 'socket.io-client';
-import { runInThisContext } from 'vm';
 
 interface Arguments {
 	[x: string]: unknown;
 	cf: string | boolean;
 }
 
+interface ISocketData {
+	id: number
+	payload: string
+}
+
 export default class RunProject {
 	private archiver: Archiver | undefined = undefined;
 	private uploader: Uploader | undefined = undefined;
 	private poller: Poller | undefined = undefined;
 	private tunnel: Tunnel | undefined = undefined;
 	private configFilePath: string | undefined = undefined;
 	private config: IConfig | undefined = undefined;
+	private projectId: number | undefined = undefined;
 
 	constructor(argv: Arguments) {
 		if (typeof(argv.cf) === 'string') {
@@ -29,20 +35,52 @@ export default class RunProject {
 	}
 
 	public exitHandler(): void {
+		this.stopJob();
 		if (this.config && this.config.run_settings.start_tunnel) {
 			if (this.tunnel) {
 				this.tunnel.stop().then(() => {
 					process.exit();
-				}).catch(console.error);
+				}).catch(log.error);
 				this.tunnel = undefined;
 			}
 		} else {
 			process.exit()
 		}
 	}
 
-	public errorHandler(): void {
-		console.error(chalk.white.bgRed.bold(`A fatal error occurred, please report this to testingbot.com`));
+	private async stopJob(): Promise<boolean> {
+		if (!this.config) {
+			return false;
+		}
+
+		if (!this.projectId) {
+			return false;
+		}
+
+		return new Promise((resolve, reject) => {
+			const requestOptions = {
+				method: 'POST',
+				uri: `https://api.testingbot.com/v1/cypress/${this.projectId}/stop_project`,
+				auth: {
+					user: this.config ? this.config.auth.key : '',
+					pass: this.config ? this.config.auth.secret : '', 
+					sendImmediately: true,
+				}
+			};
+
+			request(requestOptions, (error) => {
+				if (error) {
+					return reject(error);
+				}
+
+				resolve(true);
+			});
+		});
+	}
+
+	public errorHandler(err: Error): void {
+		log.error(chalk.white.bgRed.bold(`A fatal error occurred, please report this to testingbot.com`));
+		log.error(err);
 		this.exitHandler();
 	}
 
@@ -52,30 +90,30 @@ export default class RunProject {
 		process.on('SIGINT', this.exitHandler.bind(this, {exit:true}));
 		process.on('SIGUSR1', this.exitHandler.bind(this, {exit:true}));
 		process.on('SIGUSR2', this.exitHandler.bind(this, {exit:true}));
-		process.on('uncaughtException', this.errorHandler.bind(this, {exit:true}));
+		process.on('uncaughtException', this.errorHandler.bind(this));
 	}
 
 	private realTimeMessage(message: string): void {
-		console.log(message);
+		const data: ISocketData = JSON.parse(message);
+		log.info(data.payload);
 	}
 
 	private realTimeError(message: string): void {
-		console.error(message);
+		const data: ISocketData = JSON.parse(message);
+		log.error(data.payload);
 	}
 
-	private parseErrors(runs: IRun[]): string[] {
-		let errors: string[] = []
+	private parseSuccess(runs: IRun[]): boolean {
+		let success = true;
 		for (let i = 0; i < runs.length; i++) {
-			if (runs[i].errors.length > 0) {
-				errors = errors.concat(runs[i].errors);
-			}
+			success = success && runs[i].success;
 		}
 
-		return errors;
+		return success;
 	}
 
 	private parseTestCases(runs: IRun[]): ITest[] {
-		let testCases: ITest[] = []
+		const testCases: ITest[] = []
 		for (let i = 0; i < runs.length; i++) {
 			const testCase = runs[i].test;
 			if (testCase) {
@@ -91,14 +129,14 @@ export default class RunProject {
 		try {
 			config = await Config.getConfig(this.configFilePath || `testingbot.json`);
 		} catch (e) {
-			console.error(chalk.white.bgRed.bold(`Configuration file problem: ${e.message} for Config File: ${this.configFilePath || `testingbot.json`}`));
+			log.error(chalk.white.bgRed.bold(`Configuration file problem: ${e.message} for Config File: ${this.configFilePath || `testingbot.json`}`));
 			return;
 		}
 
 		const configValidationErrors = Config.validate(config);
 
 		if (configValidationErrors.length > 0) {
-			console.error(chalk.white.bgRed.bold(`Configuration errors: ${configValidationErrors.join('\n')}`));
+			log.error(chalk.white.bgRed.bold(`Configuration errors: ${configValidationErrors.join('\n')}`));
 			return;
 		}
 
@@ -112,7 +150,7 @@ export default class RunProject {
 		let zipFile: string;
 
 		if (!this.archiver || !this.uploader) {
-			console.error(chalk.white.bgRed.bold(`Invalid state, please try again`));
+			log.error(chalk.white.bgRed.bold(`Invalid state, please try again`));
 			return;
 		}
 
@@ -122,31 +160,31 @@ export default class RunProject {
 			tunnelSpinner.succeed('TestingBot Tunnel Ready');
 		}
 
-		const uploadSpinner = ora('Starting Project on TestingBot').start();
+		const uploadSpinner = ora('Starting Cypress Project on TestingBot').start();
 		try {
 			zipFile = await this.archiver.start();
 		} catch (err) {
-			console.error(err);
+			log.error(err);
 			return;
 		}
 
 		this.registerCloseHandlers();
 
 		try {
 			const response = await this.uploader.start(zipFile);
-			uploadSpinner.succeed('Cypress is now running on TestingBot')
-			const realTime = io.connect('https://hub.testingbot.com:3031');
-			realTime.emit('join', `cypress_${response.id}`)
-			realTime.on('cypress_data', (msg: string) => this.realTimeMessage.bind(this, msg));
-			realTime.on('cypress_error', (msg: string) => this.realTimeError.bind(this, msg));
+			this.projectId = response.id;
+			uploadSpinner.succeed('Cypress Project is now running on TestingBot');
+
+			if (config.run_settings.realTimeLogs) {
+				const realTime = io.connect('https://hub.testingbot.com:3031');
+				realTime.emit('join', `cypress_${response.id}`)
+				realTime.on('cypress_data', this.realTimeMessage.bind(this));
+				realTime.on('cypress_error', this.realTimeError.bind(this));
+			}
 
 			const poller = await this.poller.check(response.id, uploadSpinner);
 			const testCases = this.parseTestCases(poller.runs);
-			const errors = this.parseErrors(poller.runs);
-			
-			if (errors.length > 0) {
-				console.error(chalk.white.bgRed.bold(`Errors occurred:` + errors.join(`\n`)));
-			}
+			const success = this.parseSuccess(poller.runs);
 
 			if (process.env.TESTINGBOT_CI && testCases.length > 0) {
 				for (let i = 0; i < testCases.length; i++) {
@@ -155,10 +193,10 @@ export default class RunProject {
 				}
 			}
 
-			process.exit(errors.length === 0 ? 0 : 1);
+			process.exit(success === true ? 0 : 1);
 
 		} catch (err) {
-			console.error(chalk.white.bgRed.bold(err));
+			log.error(chalk.white.bgRed.bold(err));
 			if (config.run_settings.start_tunnel) {
 				await this.tunnel.stop();
 			}

src/log.ts

@@ -1,9 +1,8 @@
 import tracer from 'tracer';
 
-const logger = tracer.colorConsole({
+const logger = tracer.console({
 	level: 'info',
-	format: '{{timestamp}} {{file}}:{{line}} {{title}}: {{message}}',
-	dateformat: 'HH:MM:ss.L',
+	format: '{{message}}',
 });
 
 export default logger;

src/templates/config.ts

@@ -18,7 +18,8 @@ export default (): string => {
 			npm_dependencies: {},
 			package_config_options: {},
 			start_tunnel: true,
-			local_ports: []
+			local_ports: [],
+			realTimeLogs: true
 		},
 		tunnel_settings: {
 			verbose: false

src/utils/archiver.ts

@@ -56,17 +56,23 @@ export default class Archiver {
 					'png',
 					'zip' 
 				];
+
+				let ignoredPaths = [
+					'**/node_modules/**',
+					'./node_modules/**',
+					'package-lock.json',
+					'package.json',
+					'testingbot-package.json',
+				];
+
+				if (this.config.run_settings.exclude && this.config.run_settings.exclude.length > 0) {
+					ignoredPaths = ignoredPaths.concat(this.config.run_settings.exclude)
+				}
 				allowedFileTypes.forEach((fileType) => {
 					archive.glob(`**/*.${fileType}`, {
 						cwd: this.config.run_settings.cypress_project_dir,
 						matchBase: true,
-						ignore: [
-							'**/node_modules/**',
-							'./node_modules/**',
-							'package-lock.json',
-							'package.json',
-							'testingbot-package.json',
-						],
+						ignore: ignoredPaths,
 					});
 				});
 

src/utils/config.ts

@@ -22,6 +22,8 @@ interface IRunSettings {
 	package_config_options: any
 	start_tunnel: boolean
 	local_ports: number[]
+	exclude: string[]
+	realTimeLogs: boolean
 }
 
 export interface IConfig {

src/utils/poller.ts

@@ -1,6 +1,6 @@
 import request from 'request';
-import log from './../log';
 import { IConfig } from './config';
+import log from '../log';
 import ora from 'ora';
 
 export interface ITest {
@@ -19,6 +19,7 @@ export interface IRun {
 	capabilities: any
 	errors: string[]
 	test?: ITest
+	success: boolean
 }
 
 interface IPollResponse {
@@ -33,6 +34,7 @@ export default class Poller {
 	private intervalId: NodeJS.Timeout | undefined;
 	private static readonly MAX_RETRIES_WAITING = 60;
 	private static readonly MAX_RETRIES_READY = 600;
+	private initSuccess = false;
 
 	constructor(config: IConfig) {
 		this.config = config;
@@ -75,6 +77,14 @@ export default class Poller {
 						this.intervalId = undefined;
 					}
 					return reject(new Error(`This project has been running for over 20 minutes, stopping now.`));
+				} else if (status === IStatus.READY && !this.initSuccess) {
+					this.initSuccess = true;
+					for (let i = 0; i < response.runs.length; i++) {
+						const testCase = response.runs[i].test;
+						if (testCase) {
+							log.info(`Testcase started, view live stream https://testingbot.com/members/tests/${testCase.sessionId}`);
+						}
+					}
 				}
 
 				this.retryNumber += 1;