add more config/cli options

Author: delabiejochen

src/commands/run.ts

@@ -12,6 +12,11 @@ import io from 'socket.io-client';
 interface Arguments {
 	[x: string]: unknown;
 	cf: string | boolean;
+	group?: string;
+	headless?: boolean;
+	parallel?: number;
+	e?: string;
+	s?: string;
 }
 
 interface ISocketData {
@@ -27,11 +32,13 @@ export default class RunProject {
 	private configFilePath: string | undefined = undefined;
 	private config: IConfig | undefined = undefined;
 	private projectId: number | undefined = undefined;
+	private argv: Arguments;
 
 	constructor(argv: Arguments) {
 		if (typeof argv.cf === 'string') {
 			this.configFilePath = argv.cf;
 		}
+		this.argv = argv;
 	}
 
 	public exitHandler(): void {
@@ -140,6 +147,26 @@ export default class RunProject {
 		return testCases;
 	}
 
+	private applyArgsToConfig(): void {
+		if (this.config) {
+			if (this.argv.group) {
+				this.config.run_settings.build_name = this.argv.group;
+			}
+			if (this.argv.headless) {
+				this.config.run_settings.headless = this.argv.headless;
+			}
+			if (this.argv.parallel) {
+				this.config.run_settings.parallel = this.argv.parallel;
+			}
+			if (this.argv.e) {
+				this.config.run_settings.cypressEnv = this.argv.e.split(',');
+			}
+			if (this.argv.s) {
+				this.config.run_settings.cypressSpecs = this.argv.s;
+			}
+		}
+	}
+
 	public async start(): Promise<void> {
 		let config: IConfig;
 		try {
@@ -168,10 +195,12 @@ export default class RunProject {
 
 		this.config = config;
 
-		this.archiver = new Archiver(config);
-		this.uploader = new Uploader(config);
-		this.poller = new Poller(config, this);
-		this.tunnel = new Tunnel(config);
+		this.applyArgsToConfig();
+
+		this.archiver = new Archiver(this.config);
+		this.uploader = new Uploader(this.config);
+		this.poller = new Poller(this.config, this);
+		this.tunnel = new Tunnel(this.config);
 
 		let zipFile: string;
 
@@ -180,7 +209,7 @@ export default class RunProject {
 			return;
 		}
 
-		if (config.run_settings.start_tunnel) {
+		if (this.config.run_settings.start_tunnel) {
 			const tunnelSpinner = ora('Starting TestingBot Tunnel').start();
 			await this.tunnel.start();
 			tunnelSpinner.succeed('TestingBot Tunnel Ready');

src/index.ts

@@ -38,6 +38,35 @@ yargs
 					type: 'string',
 					demand: true,
 				},
+				group: {
+					default: undefined,
+					description: 'Group the specs under this name',
+					type: 'string',
+					nargs: 1,
+				},
+				headless: {
+					default: false,
+					description: 'Run tests in headless mode on TestingBot (no UI)',
+					type: 'boolean',
+				},
+				parallel: {
+					default: 1,
+					description: 'Run tests in parallel on TestingBot',
+					type: 'number',
+				},
+				s: {
+					alias: ['specs', 'spec'],
+					default: undefined,
+					description: 'Runs specific spec file(s). defaults to "all"',
+					type: 'string',
+				},
+				e: {
+					alias: 'env',
+					describe:
+						'Sets environment variables. separate multiple values with a comma',
+					type: 'string',
+					default: undefined,
+				},
 			})
 			.help('help')
 			.wrap(null).argv;

src/templates/config.ts

@@ -20,6 +20,8 @@ export default (): string => {
 			start_tunnel: true,
 			local_ports: [],
 			realTimeLogs: true,
+			headless: false,
+			parallel: 1,
 		},
 		tunnel_settings: {
 			verbose: false,

src/utils/archiver.ts

@@ -69,13 +69,22 @@ export default class Archiver {
 				) {
 					ignoredPaths = ignoredPaths.concat(this.config.run_settings.exclude);
 				}
-				allowedFileTypes.forEach((fileType) => {
-					archive.glob(`**/*.${fileType}`, {
+
+				if (!this.config.run_settings.cypressSpecs) {
+					allowedFileTypes.forEach((fileType) => {
+						archive.glob(`**/*.${fileType}`, {
+							cwd: this.config.run_settings.cypress_project_dir,
+							matchBase: true,
+							ignore: ignoredPaths,
+						});
+					});
+				} else {
+					archive.glob(this.config.run_settings.cypressSpecs, {
 						cwd: this.config.run_settings.cypress_project_dir,
 						matchBase: true,
 						ignore: ignoredPaths,
 					});
-				});
+				}
 
 				const packageJSON = {};
 

src/utils/config.ts

@@ -13,6 +13,9 @@ export interface ICapability {
 	version: string | number;
 	localHttpPorts?: number[];
 	build?: string;
+	headless?: boolean;
+	cypressEnv?: string[];
+	cypressVersion?: string;
 }
 
 interface IRunSettings {
@@ -24,6 +27,11 @@ interface IRunSettings {
 	local_ports: number[];
 	exclude: string[];
 	realTimeLogs: boolean;
+	parallel: number;
+	headless: boolean;
+	cypressEnv: string[];
+	cypressSpecs: string;
+	cypressVersion: string;
 }
 
 export interface IConfig {

src/utils/poller.ts

@@ -113,7 +113,7 @@ View live stream https://testingbot.com/members/tests/${testCase.sessionId}`);
 						}
 					}
 
-					this.runner.onReady()
+					this.runner.onReady();
 				}
 
 				this.retryNumber += 1;

src/utils/uploader.ts

@@ -1,5 +1,6 @@
 import fs from 'fs';
 import request from 'request';
+import os from 'os';
 import { IConfig, ICapability } from './config';
 
 interface IResponse {
@@ -31,6 +32,33 @@ export default class Uploader {
 					capability.build = this.config.run_settings.build_name;
 				});
 			}
+
+			if (this.config.run_settings.headless) {
+				capabilities.map((capability: ICapability) => {
+					capability.headless = this.config.run_settings.headless;
+				});
+			}
+
+			if (this.config.run_settings.cypressEnv) {
+				capabilities.map((capability: ICapability) => {
+					capability.cypressEnv = this.config.run_settings.cypressEnv;
+				});
+			}
+
+			if (this.config.run_settings.cypressVersion) {
+				capabilities.map((capability: ICapability) => {
+					capability.cypressVersion = this.config.run_settings.cypressVersion;
+				});
+			}
+
+			const runSettings = {
+				parallel: 1,
+			};
+
+			if (this.config.run_settings.parallel) {
+				runSettings.parallel = this.config.run_settings.parallel;
+			}
+
 			const requestOptions = {
 				method: 'POST',
 				uri: `https://api.testingbot.com/v1/cypress`,
@@ -42,6 +70,10 @@ export default class Uploader {
 				formData: {
 					file: fs.createReadStream(zipFile),
 					capabilities: JSON.stringify(capabilities),
+					settings: JSON.stringify(runSettings),
+				},
+				headers: {
+					'User-Agent': `TB-Cypress-CLI (${os.arch()}/${os.platform()}/${os.release()})`,
 				},
 			};