cypress cli initial commit

Author: delabiejochen

.eslintrc.js

@@ -0,0 +1,14 @@
+module.exports = {
+  parser: "@typescript-eslint/parser", // Specifies the ESLint parser
+  parserOptions: {
+    ecmaVersion: 2020, // Allows for the parsing of modern ECMAScript features
+    sourceType: "module" // Allows for the use of imports
+  },
+  extends: [
+    "plugin:@typescript-eslint/recommended" // Uses the recommended rules from the @typescript-eslint/eslint-plugin
+  ],
+  rules: {
+    // 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",
+  }
+};

.gitignore

@@ -0,0 +1,107 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and *not* Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# typescript output
+lib/

.prettierrc

@@ -0,0 +1,7 @@
+{
+  "semi": true,
+  "trailingComma": "all",
+  "singleQuote": true,
+  "printWidth": 80,
+  "useTabs": true
+}

README.md

@@ -0,0 +1 @@
+## This will soon host the Cypress CLI for running tests on TestingBot

package.json

@@ -0,0 +1,33 @@
+{
+  "name": "testingbot-cypress-cli",
+  "version": "1.0.0",
+  "description": "Run Cypress tests on TestingBot.com's Browser Grid",
+  "main": "lib/index.js",
+  "scripts": {
+    "lint": "eslint --ext ts src/",
+    "make": "tsc",
+    "start": "node lib/index.js",
+    "prettier-format": "prettier --config .prettierrc 'src/**/*.ts' --write"
+  },
+  "keywords": [
+    "cypress",
+    "testingbot"
+  ],
+  "author": "Jochen Delabie <[email protected]>",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/archiver": "^3.1.0",
+    "@types/node": "^14.0.26",
+    "@types/yargs": "^15.0.5",
+    "@typescript-eslint/eslint-plugin": "^3.8.0",
+    "@typescript-eslint/parser": "^3.8.0",
+    "eslint": "^7.6.0",
+    "prettier": "^2.0.5",
+    "typescript": "^3.9.7"
+  },
+  "dependencies": {
+    "archiver": "^5.0.0",
+    "tracer": "^1.1.3",
+    "yargs": "^15.4.1"
+  }
+}

src/commands/init.ts

@@ -0,0 +1,42 @@
+import fs from 'fs';
+import log from './../log';
+import path from 'path';
+import config from './../templates/config';
+
+const fsPromises = fs.promises;
+
+interface Arguments {
+	[x: string]: unknown;
+	p: string | boolean;
+}
+
+export default class InitProject {
+	private path = '.';
+
+	constructor(argv: Arguments) {
+		if (argv.p) {
+			this.path = argv.p as string;
+		}
+
+		this.generate();
+	}
+
+	private async generate(): Promise<void> {
+		let dirExists = false;
+
+		try {
+			const dirStat = await fsPromises.stat(this.path);
+			dirExists = dirStat.isDirectory();
+		} catch (e) {}
+
+		if (!dirExists) {
+			log.error(`Directory ${this.path} does not exist`);
+			return;
+		}
+
+		await fsPromises.writeFile(
+			path.join(this.path, `testingbot.json`),
+			config(),
+		);
+	}
+}

src/commands/run.ts

@@ -0,0 +1,37 @@
+import log from '../log';
+import Archiver from '../utils/archiver';
+import Uploader from '../utils/uploader';
+
+interface Arguments {
+	[x: string]: unknown;
+	p: string | boolean;
+}
+
+export default class RunProject {
+	private path = '.';
+	private archiver: Archiver;
+	private uploader: Uploader;
+
+	constructor(argv: Arguments) {
+		this.archiver = new Archiver({
+			cypress_path: '.',
+		});
+
+		this.uploader = new Uploader({
+			cypress_path: '',
+		});
+	}
+
+	public async start(): Promise<void> {
+		let zipFile: string | undefined;
+
+		try {
+			zipFile = await this.archiver.start();
+		} catch (err) {
+			log.error(err);
+			return;
+		}
+
+		const success = await this.uploader.start();
+	}
+}

src/index.ts

@@ -0,0 +1,29 @@
+import * as yargs from 'yargs';
+import InitProject from './commands/init';
+
+process.removeAllListeners('warning');
+
+yargs
+	.usage('usage: $0 <command>')
+	.alias('v', 'version')
+	.describe('v', '1.0')
+	.command('init', 'more info', function (yargs) {
+		const initArgv = yargs
+			.usage('usage: $0 init [options]')
+			.options({
+				p: {
+					alias: 'path',
+					default: false,
+					description:
+						'The path where we need to initialize the Cypress+TestingBot config file',
+					type: 'string',
+				},
+			})
+			.help('help')
+			.wrap(null).argv;
+
+		return new InitProject(initArgv);
+	})
+	.alias('h', 'help')
+	.help('help')
+	.wrap(null).argv;

src/log.ts

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

src/templates/config.ts

@@ -0,0 +1,31 @@
+export default (): string => {
+	const config = {
+		auth: {
+			key: '<Your TestingBot key>',
+			secret: '<Your TestingBot secret>',
+		},
+		browsers: [
+			{
+				browserName: 'chrome',
+				platform: 'Windows 10',
+				versions: ['78', '77'],
+			},
+			{
+				browserName: 'firefox',
+				os: 'Mojave',
+				versions: ['74', '75'],
+			},
+		],
+		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: {},
+		},
+	};
+
+	return JSON.stringify(config, null, 4);
+};