improve config handling

Author: delabiejochen

.gitignore

@@ -105,3 +105,5 @@ dist
 
 # typescript output
 lib/
+
+testingbot.json

package.json

@@ -18,6 +18,7 @@
   "devDependencies": {
     "@types/archiver": "^3.1.0",
     "@types/node": "^14.0.26",
+    "@types/request": "^2.48.5",
     "@types/yargs": "^15.0.5",
     "@typescript-eslint/eslint-plugin": "^3.8.0",
     "@typescript-eslint/parser": "^3.8.0",
@@ -27,6 +28,7 @@
   },
   "dependencies": {
     "archiver": "^5.0.0",
+    "request": "^2.88.2",
     "tracer": "^1.1.3",
     "yargs": "^15.4.1"
   }

src/commands/run.ts

@@ -1,29 +1,38 @@
 import log from '../log';
 import Archiver from '../utils/archiver';
 import Uploader from '../utils/uploader';
+import Config from '../utils/config';
 
 interface Arguments {
 	[x: string]: unknown;
-	p: string | boolean;
+	cf: string | boolean;
 }
 
 export default class RunProject {
-	private path = '.';
-	private archiver: Archiver;
-	private uploader: Uploader;
+	private archiver: Archiver | undefined = undefined;
+	private uploader: Uploader | undefined = undefined;
 
 	constructor(argv: Arguments) {
-		this.archiver = new Archiver({
-			cypress_path: '.',
-		});
-
-		this.uploader = new Uploader({
-			cypress_path: '',
-		});
+		this.start();
 	}
 
 	public async start(): Promise<void> {
-		let zipFile: string | undefined;
+		const config = await Config.getConfig();
+		const configValidationError = Config.validate(config);
+		if (configValidationError) {
+			throw new Error(
+				`Configuration error: ${configValidationError.join('\n')}`,
+			);
+		}
+
+		this.archiver = new Archiver(config);
+		this.uploader = new Uploader(config);
+
+		let zipFile: string;
+
+		if (!this.archiver || !this.uploader) {
+			throw new Error(`Invalid state, please try again`);
+		}
 
 		try {
 			zipFile = await this.archiver.start();
@@ -32,6 +41,12 @@ export default class RunProject {
 			return;
 		}
 
-		const success = await this.uploader.start();
+		try {
+			const success = await this.uploader.start(zipFile);
+			log.info('got success', success);
+		} catch (err) {
+			log.error(err);
+			return;
+		}
 	}
 }

src/index.ts

@@ -1,5 +1,6 @@
 import * as yargs from 'yargs';
 import InitProject from './commands/init';
+import RunProject from './commands/run';
 
 process.removeAllListeners('warning');
 
@@ -24,6 +25,22 @@ yargs
 
 		return new InitProject(initArgv);
 	})
+	.command('run', 'more info', function (yargs) {
+		const initArgv = yargs
+			.usage('usage: $0 run [options]')
+			.options({
+				cf: {
+					alias: 'config-file',
+					default: 'testingbot.json',
+					description: 'The path to the testingbot.json config file',
+					type: 'string',
+					demand: true,
+				},
+			})
+			.help('help')
+			.wrap(null).argv;
+		return new RunProject(initArgv);
+	})
 	.alias('h', 'help')
 	.help('help')
 	.wrap(null).argv;

src/utils/archiver.ts

@@ -3,17 +3,15 @@ import fs from 'fs';
 import path from 'path';
 import os from 'os';
 import log from './../log';
+import { IConfig } from './config';
 
 const fsPromises = fs.promises;
-interface ArchiveSettings {
-	cypress_path: string;
-}
 
 export default class Archiver {
-	private settings: ArchiveSettings;
+	private config: IConfig;
 
-	constructor(settings: ArchiveSettings) {
-		this.settings = settings;
+	constructor(config: IConfig) {
+		this.config = config;
 	}
 
 	public async start(): Promise<string> {
@@ -57,7 +55,7 @@ export default class Archiver {
 				];
 				allowedFileTypes.forEach((fileType) => {
 					archive.glob(`**/*.${fileType}`, {
-						cwd: this.settings.cypress_path,
+						cwd: this.config.run_settings.cypress_project_dir,
 						matchBase: true,
 						ignore: [
 							'node_modules/**',
@@ -71,10 +69,6 @@ export default class Archiver {
 				archive.finalize();
 			} catch (e) {
 				reject(e);
-			} finally {
-				if (tempZipFile) {
-					fsPromises.unlink(tempZipFile);
-				}
 			}
 		});
 	}

src/utils/config.ts

@@ -0,0 +1,57 @@
+import fs from 'fs';
+
+const fsPromises = fs.promises;
+
+interface IAuth {
+	key: string;
+	secret: string;
+}
+
+interface IBrowser {
+	browserName: string;
+	platform: string;
+	versions: string[];
+}
+
+interface IRunSettings {
+	cypress_project_dir: string;
+	project_name: string;
+	build_name: string;
+	parallel_count: number;
+	npm_dependencies: any;
+	package_config_options: any;
+}
+
+export interface IConfig {
+	auth: IAuth;
+	browsers: IBrowser[];
+	run_settings: IRunSettings;
+}
+
+export default {
+	async getConfig(): Promise<IConfig> {
+		const configString = await fsPromises.readFile(`testingbot.json`);
+		const configObject = JSON.parse(configString.toString());
+
+		return configObject as IConfig;
+	},
+
+	validate(config: IConfig): string[] {
+		const errors: string[] = [];
+		if (config.auth.key === '' || config.auth.key === '<Your TestingBot key>') {
+			errors.push(
+				`Please add a valid TestingBot key in the testingbot.json file`,
+			);
+		}
+		if (
+			config.auth.secret === '' ||
+			config.auth.secret === '<Your TestingBot secret>'
+		) {
+			errors.push(
+				`Please add a valid TestingBot scret in the testingbot.json file`,
+			);
+		}
+
+		return errors;
+	},
+};

src/utils/uploader.ts

@@ -1,81 +1,48 @@
-import archiver, { ArchiverError } from 'archiver';
 import fs from 'fs';
-import path from 'path';
-import os from 'os';
+import request from 'request';
 import log from './../log';
-
-const fsPromises = fs.promises;
-interface UploadSettings {
-	cypress_path: string;
-}
+import { IConfig } from './config';
 
 export default class Uploader {
-	private settings: UploadSettings;
+	private config: IConfig;
 
-	constructor(settings: UploadSettings) {
-		this.settings = settings;
+	constructor(config: IConfig) {
+		this.config = config;
 	}
 
-	public async start(): Promise<string> {
+	public async start(zipFile: string): Promise<string> {
 		return new Promise((resolve, reject) => {
-			let tempZipFile: string | undefined;
-
-			try {
-				tempZipFile = path.join(os.tmpdir(), 'upload.zip');
-				const output = fs.createWriteStream(tempZipFile);
-				const archive = archiver('zip', {
-					zlib: { level: 9 },
-				});
-
-				archive.on('warning', (err: ArchiverError) => {
-					if (err.code === 'ENOENT') {
-						log.warn(err);
+			const requestOptions = {
+				method: 'POST',
+				uri: 'https://api.testingbot.com/v1/storage',
+				auth: {
+					user: this.config.auth.key,
+					pass: this.config.auth.secret,
+					sendImmediately: true,
+				},
+				formData: {
+					file: fs.createReadStream(zipFile),
+				},
+			};
+
+			request(requestOptions, function (error, response) {
+				if (error) {
+					return reject(error);
+				}
+				let responseBody = null;
+				if (response) {
+					if (response.body && typeof response.body === 'string') {
+						response.body = JSON.parse(response.body);
+					}
+					if (response.statusCode.toString().substring(0, 1) === '2') {
+						responseBody = response.body;
 					} else {
-						reject(err);
+						return reject(response.body);
 					}
-				});
-
-				// listen for all archive data to be written
-				// 'close' event is fired only when a file descriptor is involved
-				output.on('close', () => {
-					resolve(tempZipFile);
-				});
-
-				archive.on('error', (err: ArchiverError) => {
-					reject(err);
-				});
-
-				archive.pipe(output);
-
-				const allowedFileTypes = [
-					'js',
-					'json',
-					'txt',
-					'ts',
-					'feature',
-					'features',
-				];
-				allowedFileTypes.forEach((fileType) => {
-					archive.glob(`**/*.${fileType}`, {
-						cwd: this.settings.cypress_path,
-						matchBase: true,
-						ignore: [
-							'node_modules/**',
-							'package-lock.json',
-							'package.json',
-							'testingbot-package.json',
-						],
-					});
-				});
-
-				archive.finalize();
-			} catch (e) {
-				reject(e);
-			} finally {
-				if (tempZipFile) {
-					fsPromises.unlink(tempZipFile);
 				}
-			}
+
+				resolve(responseBody);
+			});
 		});
 	}
 }