add more validations

Author: delabiejochen

src/commands/run.ts

@@ -5,6 +5,7 @@ import Poller from '../utils/poller';
 import Config from '../utils/config';
 import Tunnel from '../utils/tunnel';
 import ora from 'ora';
+import chalk from 'chalk';
 
 interface Arguments {
 	[x: string]: unknown;
@@ -16,24 +17,28 @@ export default class RunProject {
 	private uploader: Uploader | undefined = undefined;
 	private poller: Poller | undefined = undefined;
 	private tunnel: Tunnel | undefined = undefined;
+	private configFilePath: string | undefined = undefined;
 
 	constructor(argv: Arguments) {
-		try {
-			this.start();
-		} catch (e) {
-			console.log('error', e)
-			log.error(e)
+		if (typeof(argv.cf) === 'string') {
+			this.configFilePath = argv.cf;
 		}
 	}
 
 	public async start(): Promise<void> {
-		const config = await Config.getConfig();
+		let config;
+		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`}`));
+			return;
+		}
+		
 		const configValidationErrors = Config.validate(config);
 
 		if (configValidationErrors.length > 0) {
-			throw new Error(
-				`Configuration errors: ${configValidationErrors.join('\n')}`,
-			);
+			console.error(chalk.white.bgRed.bold(`Configuration errors: ${configValidationErrors.join('\n')}`));
+			return;
 		}
 
 		this.archiver = new Archiver(config);
@@ -44,7 +49,8 @@ export default class RunProject {
 		let zipFile: string;
 
 		if (!this.archiver || !this.uploader) {
-			throw new Error(`Invalid state, please try again`);
+			console.error(chalk.white.bgRed.bold(`Invalid state, please try again`));
+			return;
 		}
 
 		if (config.run_settings.start_tunnel) {
@@ -53,24 +59,23 @@ export default class RunProject {
 			tunnelSpinner.succeed('TestingBot Tunnel Ready');
 		}
 
+		const uploadSpinner = ora('Starting Project on TestingBot').start();
 		try {
 			zipFile = await this.archiver.start();
 		} catch (err) {
-			log.error(err);
+			console.error(err);
 			return;
 		}
 
 		try {
-			const uploadSpinner = ora('Starting Project on TestingBot').start();
-
 			const response = await this.uploader.start(zipFile);
 			uploadSpinner.succeed('Cypress is now running on TestingBot')
 
-			const poller = await this.poller.check(response.id)
+			const poller = await this.poller.check(response.id, uploadSpinner)
 			log.info(poller)
 
 		} catch (err) {
-			log.error(err);
+			console.error(chalk.white.bgRed.bold(err));
 			if (config.run_settings.start_tunnel) {
 				await this.tunnel.stop();
 			}

src/index.ts

@@ -23,7 +23,7 @@ yargs
 			.help('help')
 			.wrap(null).argv;
 
-		return new InitProject(initArgv);
+			return new InitProject(initArgv);
 	})
 	.command('run', 'more info', function (yargs) {
 		const initArgv = yargs
@@ -39,7 +39,8 @@ yargs
 			})
 			.help('help')
 			.wrap(null).argv;
-		return new RunProject(initArgv);
+			const runProject = new RunProject(initArgv);
+			runProject.start();
 	})
 	.alias('h', 'help')
 	.help('help')

src/templates/config.ts

@@ -14,14 +14,16 @@ export default (): string => {
 		run_settings: {
 			cypress_project_dir:
 				'/path/to/directory-that-contains-<cypress.json>-file',
-			project_name: 'project-name',
 			build_name: 'build-name',
 			parallel_count: 'How many tests you want to run in parallel',
 			npm_dependencies: {},
 			package_config_options: {},
 			start_tunnel: true,
 			local_ports: []
 		},
+		tunnel_settings: {
+			verbose: false
+		}
 	};
 
 	return JSON.stringify(config, null, 4);

src/utils/archiver.ts

@@ -5,8 +5,6 @@ import os from 'os';
 import log from './../log';
 import { IConfig } from './config';
 
-const fsPromises = fs.promises;
-
 export default class Archiver {
 	private config: IConfig;
 

src/utils/config.ts

@@ -12,11 +12,11 @@ export interface ICapability {
 	platform: string;
 	version: string | number;
 	localHttpPorts?: number[];
+	build?: string;
 }
 
 interface IRunSettings {
 	cypress_project_dir: string
-	project_name: string
 	build_name: string
 	parallel_count: number
 	npm_dependencies: any
@@ -29,11 +29,12 @@ export interface IConfig {
 	auth: IAuth;
 	browsers: ICapability[];
 	run_settings: IRunSettings;
+	tunnel_settings: any;
 }
 
 export default {
-	async getConfig(): Promise<IConfig> {
-		const configString = await fsPromises.readFile(`testingbot.json`);
+	async getConfig(configFilePath: string): Promise<IConfig> {
+		const configString = await fsPromises.readFile(configFilePath);
 		const configObject = JSON.parse(configString.toString());
 
 		return configObject as IConfig;

src/utils/poller.ts

@@ -1,6 +1,7 @@
 import request from 'request';
 import log from './../log';
 import { IConfig } from './config';
+import ora from 'ora';
 
 interface IPollResponse {
 	status: string
@@ -18,14 +19,15 @@ export default class Poller {
 		this.config = config;
 	}
 
-	public async check(id: number): Promise<IPollResponse> {
+	public async check(id: number, spinner: ora.Ora): Promise<IPollResponse> {
 		return new Promise((resolve, reject) => {
 			this.intervalId = setInterval(async () => {
 				const response = await this.getStatus(id);
-				log.info('checking', response);
 
 				if (response.status === 'DONE') {
-					if (response.errors.length === 0) {
+					spinner.succeed('Cypress Project has finished running on TestingBot');
+					log.info(response);
+					if (Object.keys(response.errors).length === 0) {
 						if (this.intervalId) {
 							clearInterval(this.intervalId);
 							this.intervalId = undefined;

src/utils/tunnel.ts

@@ -12,10 +12,12 @@ export default class Tunnel {
 
 	public async start(): Promise<void> {
 		return new Promise((resolve, reject) => {
-			testingbotTunnel({
+			const tunnelOpts = Object.assign({
 				apiKey: this.config.auth.key,
 				apiSecret: this.config.auth.secret,
-			}, (err: any, tunnel: any) => {
+			}, this.config.tunnel_settings);
+
+			testingbotTunnel(tunnelOpts, (err: any, tunnel: any) => {
 				if (err) {
 					reject(err);
 					return;

src/utils/uploader.ts

@@ -18,7 +18,13 @@ export default class Uploader {
 			const capabilities = this.config.browsers;
 			if (this.config.run_settings.local_ports.length > 0) {
 				capabilities.map((capability: ICapability) => {
-					capability.localHttpPorts = this.config.run_settings.local_ports
+					capability.localHttpPorts = this.config.run_settings.local_ports;
+				})
+			}
+
+			if (this.config.run_settings.build_name && this.config.run_settings.build_name.length > 0 && this.config.run_settings.build_name !== 'build-name') {
+				capabilities.map((capability: ICapability) => {
+					capability.build = this.config.run_settings.build_name;
 				})
 			}
 			const requestOptions = {