suitest-js-api 2.5.2 → 3.0.3

package/lib/testLauncher/commands/run.js

@@ -0,0 +1,111 @@
+const {once} = require('ramda');
+const {composeConfig} = require('../composeConfig');
+const texts = require('../../texts');
+const logLevels = require('../../constants/logLevels');
+const SuitestLauncher = require('../SuitestLauncher');
+const suitest = require('../../../index');
+
+const command = 'run';
+const describe = 'Command for start testing';
+
+const builder = yargs => {
+	yargs
+		.option('token-id', {
+			alias: 'k',
+			describe: 'Suitest Token Key, can be generated on the profile page',
+			global: false,
+		})
+		.option('token-password', {
+			alias: 'p',
+			describe: 'Suitest Token Password, can be generated on the profile page',
+			global: false,
+		})
+		.option('device-id', {
+			alias: 'd',
+			describe: 'Device you want to connect to',
+			global: false,
+		})
+		.option('app-config-id', {
+			alias: 'c',
+			describe: 'Application configuration id to launch the app with',
+			global: false,
+		})
+		.option('preset', {
+			describe: 'Preset for configuration and device.',
+			array: true,
+			global: false,
+		})
+		.option('inspect', {
+			describe: 'Will launch user command with --inspect execArgv, used for debugging',
+			global: false,
+		})
+		.option('inspect-brk', {
+			describe: 'Will launch user command with --inspect-brk execArgv, used for debugging',
+			global: false,
+		})
+		.option('config-file', {
+			describe: texts.cliConfig(),
+			global: false,
+			type: 'string',
+		})
+		.option('default-timeout', {
+			describe: texts.defaultTimeout(),
+			global: false,
+			type: 'number',
+		})
+		.option('disallow-crash-reports', {
+			describe: texts.cliDisallowCrashReports(),
+			global: false,
+			type: 'boolean',
+		})
+		.option('log-dir', {
+			describe: texts['tl.logDirDescription'](),
+			global: false,
+		})
+		.option('log-level', {
+			describe: texts.cliLogLevel(),
+			global: false,
+			choices: Object.values(logLevels),
+		})
+		.option('timestamp', {
+			describe: texts.cliTimestamp(),
+			global: false,
+			type: 'string',
+		})
+		.option('screenshot-dir', {
+			describe: 'Directory for saving screenshots.',
+			global: false,
+			type: 'string',
+		})
+		.option('concurrency', {
+			describe: 'How many parallel sessions of the test runner should be spawned. '
+				+ 'I.e. on how many devices will it run in parallel. 0 = unlimited',
+			default: 0,
+			global: false,
+		})
+		.option('include-changelist', {
+			describe: 'If unapplied changes should be tested with runSnippet command.',
+			boolean: true,
+			default: false,
+			global: false,
+		});
+};
+
+const handler = async(argv) => {
+	const {ownArgs, userCommandArgs} = composeConfig(argv);
+
+	suitest.configuration.override(ownArgs);
+
+	const suitestLauncher = new SuitestLauncher(ownArgs, userCommandArgs);
+
+	await suitestLauncher.runTokenSession();
+};
+
+/* istanbul ignore next */
+module.exports = {
+	command,
+	describe,
+	builder,
+	// Make sure async handler is called only once (yargs bug)
+	handler: global._suitestTesting ? handler : once(handler),
+};

package/lib/testLauncher/composeConfig.js

@@ -1,11 +1,113 @@
-const {promptPassword} = require('../utils/testLauncherHelper');
+// TODO: add test coverage for file
+
 const {pickNonNil} = require('../utils/common');
 const {hideOwnArgs} = require('./processArgs');
 const suitest = require('../../index');
 const fs = require('fs');
-const rc = require('rc');
 const SuitestError = require('../utils/SuitestError');
-const {invalidUserConfig} = require('../texts');
+const {
+	invalidUserConfig,
+	circularDependencyError,
+} = require('../texts');
+const yaml = require('js-yaml');
+const JSON5 = require('json5');
+const ini = require('ini');
+const path = require('path');
+
+const PRESETS = 'presets';
+const APP_NAME = 'suitest';
+const ETC_DIR = '/etc';
+const IS_WIN = process.platform === 'win32';
+const HOME_DIR = IS_WIN
+	? process.env.USERPROFILE
+	: process.env.HOME;
+
+const CONFIG_FILES = [
+	`.${APP_NAME}rc.js`,
+	`.${APP_NAME}rc.json`,
+	`.${APP_NAME}rc.yaml`,
+	`.${APP_NAME}rc.yml`,
+	`.${APP_NAME}rc.json5`,
+	`.${APP_NAME}rc.ini`,
+	`.${APP_NAME}rc`,
+];
+
+/**
+ * @description should repeat lookup logic from rc library
+ * @type {string[]}
+ */
+const LOOKUP_DIRS = [
+	path.join(HOME_DIR, `.${APP_NAME}rc`),
+	path.join(HOME_DIR, `.${APP_NAME}`, 'config'),
+	path.join(HOME_DIR, '.config', APP_NAME),
+	path.join(HOME_DIR, '.config', APP_NAME, 'config'),
+	path.join(ETC_DIR, `.${APP_NAME}rc`),
+	path.join(ETC_DIR, APP_NAME, 'config'),
+	process.cwd(),
+];
+
+/**
+ * @description Reads file from path and returns file as an object. Supports json, yaml, json5 and ini formats.
+ * @param {String} filePath path to file
+ */
+function readConfigFile(filePath) {
+	const fileContent = fs.readFileSync(filePath, 'utf8');
+
+	switch (path.extname(filePath)) {
+		case '.yaml':
+		case '.yml':
+			return yaml.load(fileContent);
+		case '.json5':
+			return JSON5.parse(fileContent);
+		case '.ini':
+			return ini.parse(fileContent);
+		case '.js':
+			return require(filePath);
+		default:
+			try {
+				return JSON.parse(fileContent);
+			} catch (error) {
+				return ini.parse(fileContent);
+			}
+	}
+}
+
+/**
+ * @description Recursive search and merging for Extends configs
+ * @param {object} defaultConfigObject main configuration file object
+ * @param {String} extendPath extend path of other configuration file to merge with
+ * @param {String} filePath currently in read configuration file path
+ * @param {Array} foundPaths array of extends paths. Used to verify circular dependency
+ */
+function findExtendConfigs(defaultConfigObject, extendPath, filePath, foundPaths) {
+	const pathToConfig = path.join(path.dirname(filePath), extendPath);
+
+	if (foundPaths.includes(pathToConfig)) {
+		throw new SuitestError(circularDependencyError(pathToConfig));
+	}
+
+	const additionalConfigFile = readConfigFile(pathToConfig);
+	const mainConfigFile = {...additionalConfigFile};
+
+	Object.keys(defaultConfigObject).forEach((objKey) => {
+		if (objKey === PRESETS) {
+			mainConfigFile.presets = {...mainConfigFile[objKey], ...defaultConfigObject[objKey]};
+		} else {
+			mainConfigFile[objKey] = defaultConfigObject[objKey];
+		}
+	});
+
+	if ('extends' in additionalConfigFile) {
+		return findExtendConfigs(
+			mainConfigFile,
+			additionalConfigFile.extends,
+			pathToConfig,
+			[...foundPaths, pathToConfig],
+		);
+	}
+
+	return mainConfigFile;
+}
 
 /**
  * Read `.suitestrc` launcher config file.
@@ -15,16 +117,56 @@ const {invalidUserConfig} = require('../texts');
  * If file found, but json invalid, throw error.
  * @returns {Object}
  */
-function readRcConfig() {
-	// ignore .suitestrc files when running unit tests
-	if (global._suitestTesting)
+function readRcConfig(pathToConfig) {
+	let mainConfigFilePath = '';
+	const foundFiles = [];
+
+	if (pathToConfig) {
+		foundFiles.push(pathToConfig);
+		mainConfigFilePath = pathToConfig;
+	} else {
+		LOOKUP_DIRS.forEach((projectDir) => {
+			if (!mainConfigFilePath && fs.existsSync(projectDir)) {
+				const files = fs.readdirSync(projectDir)
+					.filter(fileName => CONFIG_FILES.includes(fileName))
+					.map(file => path.join(projectDir, file));
+
+				if (files.length > 0) {
+					mainConfigFilePath = files[0];
+					foundFiles.push(files[0]);
+				}
+			}
+		});
+	}
+
+	if (!mainConfigFilePath) {
 		return {};
+	}
+
+	const configFile = readConfigFile(mainConfigFilePath);
+
+	if ('extends' in configFile) {
+		return {
+			...findExtendConfigs(
+				configFile,
+				configFile.extends,
+				mainConfigFilePath,
+				[foundFiles[0]],
+			),
+			configs: foundFiles,
+			config: foundFiles[0],
+		};
+	}
 
-	return rc('suitest', {}, () => ({}));
+	return {
+		...configFile,
+		configs: foundFiles,
+		config: foundFiles[0],
+	};
 }
 
 /**
- * Read josn config file provided by user.
+ * Read json config file provided by user.
  * @param {string} path - path to config file
  * @throws {SuitestError}
  * @returns {Object} - parsed json
@@ -40,11 +182,10 @@ function readUserConfig(path) {
 /**
  * Compose config from rc file, user config file and cli args
  * @param {Object} argv - yargs cli args object
- * @param {boolean} askPassword - ask for password or not
  * @returns {{ownArgs: Object, userCommandArgs: string[]}}
  */
-const composeConfig = async(argv, askPassword) => {
-	const rcConfig = readRcConfig();
+const composeConfig = (argv) => {
+	const rcConfig = readRcConfig(argv.configFile);
 	const configFilePath = argv.configFile || rcConfig.configFile;
 	const userConfig = configFilePath ? readUserConfig(configFilePath) : {};
 
@@ -55,10 +196,6 @@ const composeConfig = async(argv, askPassword) => {
 	};
 	const userCommandArgs = hideOwnArgs();
 
-	if (askPassword) {
-		ownArgs.password = ownArgs.password || await promptPassword();
-	}
-
 	return {
 		ownArgs,
 		userCommandArgs,
@@ -66,6 +203,8 @@ const composeConfig = async(argv, askPassword) => {
 };
 
 module.exports = {
+	readConfigFile,
+	findExtendConfigs,
 	composeConfig,
 	readRcConfig,
 	readUserConfig,

package/lib/testLauncher/launcherLogger.js

@@ -6,26 +6,16 @@
 const {stColors} = require('../utils/logger');
 const {logger} = require('../../index');
 
-/**
- * Log snipepts
- */
-function deviceLines(devicesLines, deviceId, deviceName) {
-	logger.log('');
-	logger.log(`Test started on ${deviceName ? stColors.bold(deviceName) : deviceId}`);
-	devicesLines.forEach(log => logger.log(log.msg, deviceId));
-	logger.log(`Test finished on ${deviceName ? stColors.bold(deviceName) : deviceId}`);
-}
-
 function argsValidationError(error) {
 	logger.error(error);
 	logger.log('');
 	logger.log(
-		'Try running `suitest --help` to see usage information or consult our docs at https://suite.st/docs'
+		'Try running `suitest --help` to see usage information or consult our docs at https://suite.st/docs',
 	);
 	logger.log('');
 }
 
-function finalAutomated(failedCount, succeededCount) {
+function final(failedCount, succeededCount) {
 	logger.log('');
 	logger.log(
 		stColors.mild('Test ')
@@ -35,20 +25,10 @@ function finalAutomated(failedCount, succeededCount) {
 	logger.log('');
 }
 
-function finalInteractive(finishedWithErrors) {
-	logger.log('');
-	finishedWithErrors
-		? logger.error('Test finished with errors')
-		: logger.success('Test run completed successfully. Bye!');
-	logger.log('');
-}
-
 module.exports = {
 	stColors,
 	snippets: {
 		argsValidationError,
-		deviceLines,
-		finalAutomated,
-		finalInteractive,
+		final,
 	},
 };

package/lib/testLauncher/processArgs.js

@@ -3,7 +3,7 @@ const parser = require('yargs-parser');
 // Specify which options should be treated as boolen.
 // This will enable setting boolean option value to true if not defined explicitly,
 // eg: '--disallow-crash-reports' will be parsed as '--disallow-crash-reports=true'
-const booleanOpts = ['disallow-crash-reports'];
+const booleanOpts = ['disallow-crash-reports', 'include-changelist'];
 const inspectOpts = ['inspect', 'inspect-brk'];
 
 const parseOptions = argv => {

package/lib/testLauncher/repl.js

@@ -59,7 +59,7 @@ function setupRepl(opts, isTTY) {
 
 	const watcher = chokidar.watch(watch, {ignored, cwd}).on(
 		'change',
-		file => setTimeout(() => onFileChange(file, cwd, callFile, repeater), 50)
+		file => setTimeout(() => onFileChange(file, cwd, callFile, repeater), 50),
 	);
 
 	const prompt = 'Suitest $ ';
@@ -89,7 +89,7 @@ function setupRepl(opts, isTTY) {
  * Module resolution is relative to cwd.
  * @param {String} repeater - string representation of repeater
  * @param {String} cwd - current working directory
- * @param {string} callFilename - name of the file where "interactive" was called.
+ * @param {string} callFilename - name of the file where "startREPL" was called.
  * @returns {*}
  */
 function repeaterFromString(repeater, cwd, callFilename) {
@@ -137,7 +137,7 @@ async function onFileChange(file, cwd, callFile, repeater) {
 	const funcBody = colors.white(getShortFunctionBody(func));
 
 	console.log(colors.magenta(
-		replFilesChanged(funcBody)
+		replFilesChanged(funcBody),
 	));
 
 	// Run the repeater without allowing the process to exit with an error

package/lib/texts.js

@@ -33,7 +33,6 @@ module.exports = {
 	// Auth errors
 	authNotAllowed: commandName => `You're not allowed to execute .${commandName} function. Make sure you're logged in with the correct credentials.`,
 	authFailed: () => 'Authentication failed. Make sure you\'re trying to login with correct credentials.',
-	authFailedAutomated: () => 'Authentication failed. Make sure your token is valid and exists.',
 	notWhitelistedIp: () => 'Unauthorized access - your IP address is not whitelisted. Please contact your Suitest administrator for more information.',
 	connectionNotEstablished: () => 'A session with the Suitest server was not established or was already closed. You need to open a session before you can execute test commands',
 
@@ -43,6 +42,7 @@ module.exports = {
 		`provided for .${methodName} function.` + (field ? ` ${field}` : ''),
 	invalidConfigObj: () => 'provided for configuration object.',
 	invalidUserConfig: template`Failed to process config file '${0}'.\n\t${1}.\n\tMake sure path is correct and file is in valid json format.`,
+	circularDependencyError: (path) => `Circular dependency found on ${path} path.`,
 
 	// WebSockets errors
 	wsNotConnected: () => 'Connection to Suitest has been interrupted. Please make sure you are online and double check your login credentials.',
@@ -53,7 +53,6 @@ module.exports = {
 	chainExpected: () => 'Until condition expects a chain as an input parameter',
 	invalidInheredProps: template`Matching properties against repo values works only for elements stored in repo.\nEither select the element by it's API-ID or specify property values to match against.\nAffected properties: ${0}`,
 	invalidVideoInheredProps: template`Matching properties against repo values works only for elements stored in repo. \nEither select the element by it's API-ID or specify property values to match against.\nAffected properties: ${0}`,
-	testPackNotFound: template`Test pack ${0} not found. If it is a new test pack, make sure version changes are applied.\nCheck https://suite.st/docs/versions/#changed-assets for more info.`,
 
 	/**
 	 * @description SuitestError.SERVER_ERROR message
@@ -81,41 +80,31 @@ Put an "await" in front of those chains or call .abandon() to suppress these war
 ${leaves}`,
 
 	// test launcher
-	launcherGreeting: (version, runMode) => {
+	launcherGreeting: (version) => {
 		const offsetInHours = (new Date()).getTimezoneOffset() / 60;
 
 		return '' +
 		`Hi there! This is Suitest test launcher v${version}.\n` +
-		`Preparing to start execution in ${runMode.toLowerCase()} mode ...\n` +
+		'Preparing to start execution ...\n' +
 		`← Time logs are provided in local time zone (UTC${offsetInHours > 0 ? '-' : '+'}${Math.abs(offsetInHours)})\n\n`;
 	},
 
-	launcherSummaryInteractive: (testCommand, executionLog, device) => {
+	launcherSummary: (testCommand, executionLog, ...devices) => {
 		return '' +
-		`Test command: ${testCommand}\n` +
-		`Log directory: ${executionLog}\n` +
-		`Device: ${device}\n\n` +
-
-		'TIP: Assertions are marked with "A", chain evaluations are marked with "E", application console logs are marked as "AL".\n';
-	},
-
-	launcherSummaryAutomated: (testPackId, testCommand, executionLog, ...devices) => {
-		return '' +
-			`Test pack id: ${testPackId}\n` +
 			`Test command: ${testCommand}\n` +
-			`Log directory: ${executionLog}\n` +
+			(executionLog ? `Log directory: ${executionLog}\n` : '') +
 			'Devices: \n' +
-			`  - ${devices.join('\n  - ')}`;
+			`  - ${devices.join('\n  - ')}\n` +
+			'TIP: Assertions are marked with "A", chain evaluations are marked with "E", application console logs are marked as "AL".\n';
 	},
 
-	fileLogSummary: (testCommand, orgId, appConfigId, testPackId, startTime) => {
+	fileLogSummary: (testCommand, orgId, appConfigId, startTime) => {
 		return '' +
 			'Suitest test execution log\n' +
 			'--------------------------\n\n' +
 			`- Date ${startTime}.\n` +
 			`- Organization ID: ${orgId}\n` +
 			`- App config ID: ${appConfigId}\n` +
-			(testPackId? `- Test pack ID: ${testPackId}\n` : '') +
 			`- Test command: ${testCommand}\n\n\n`;
 	},
 
@@ -134,16 +123,15 @@ ${leaves}`,
 	launcherWrongDeviceId: template`The deviceId ${0} is unknown. Device may have been deleted.`,
 
 	'tl.noArguments': () => 'Command was not specified',
-	'tl.seeMoreCommandsOptions': template`Run ${0} or ${1} to see those commands options`,
+	'tl.seeMoreCommandsOptions': template`Run ${0} to see those commands options`,
 	'tl.finishedWithErrors': () => 'Some executions finished with errors',
 	'tl.finishedWithSuccess': () => 'All executions finished successfully',
-	'tl.promptPassword': () => 'Please enter your password: ',
 	'tl.failedToCreateDir': (code, path) => `${code} error occurred while creating a new directory "${path}"`,
 	'tl.createDirPermissionDenied': (path) => `Cannot create log file (${path}) Permission denied`,
 	'tl.executionMode': template`Execution mode: `,
 	'tl.cmdAttributionTip': template`\nTIP: Assertions are marked with "A", chain evaluations are marked with "E".`,
 	'tl.logDirDescription': () => 'If defined, additional logging to specified folder will be performed.',
-	'tl.inspectOnlyForInteractiveMode': () => 'Please use interactive mode to enable debugging.',
+	'tl.inspectOnlyForSingleDevice': () => 'Please connect to single device to enable debugging.',
 	'tl.differentLauncherAndLibVersions': template`The version of suitest library (${0}) provided from your script is different from suitest launcher (${1})`,
 	'tl.newVersionAvailable': template`New version (${0}) of Suitest JavaScript API is out, please upgrade: \`npm i suitest-js-api\``,
 
@@ -151,8 +139,10 @@ ${leaves}`,
 	'errorType.syntaxError.modifierMissing': template`${0} chain missing modifier.`,
 	'errorType.suitestCommand': template`provided for 'suitest ${0}' command. It`,
 	'errorType.suitestTestCommand': `Seems you forgot to provide a test command${EOL}check https://suite.st/docs/suitest-api/test-launcher/#usage for more info`,
-	'errorType.testPackNoDevices': () => 'There are no devices associated with this test pack.',
 	'errorType.testCannotBeFetched': (testId, mainTest) => `Test cannot be fetched test id: ${mainTest ? mainTest + ' > ... > ' + testId : testId}`,
+	'errorType.noDevices': () => 'There are no devices associated with current configuration',
+	'errorType.specifyRunningDevices': () => 'Please specify Configuration id and device id, or presets',
+	'errorType.notFoundPresets': (notFoundPresets) => `Presets ${notFoundPresets.join(', ')} were not found in your configuration`,
 
 	'commandError.notSupportedPlatform': () => 'Screenshots are not supported on this device.',
 	'commandError.timeout': () => 'Failed to take a screenshot due to timeout.',
@@ -167,15 +157,13 @@ ${leaves}`,
 	ipcFailedToCreateServer: template`Failed to create IPC server. Port ${0} is busy.`,
 
 	// suffixes
-	'suffix.sessionWillClose': () => 'Test session will now close and all remaining Suitest commands will fail. To allow execution of remaining Suitest commands call suitest.startTest() or fix this error.',
+	'suffix.sessionWillClose': () => 'Test session will now close and all remaining Suitest commands will fail.',
 
 	// logger msg
-	commandExecuted: (name) => `command "${name}" was executed`,
 	sessionOpen: () => 'Connecting to Suitest ...',
 	sessionOpened: () => 'Connected to Suitest',
 	sessionClosing: () => 'Disconnecting from Suitest',
 	sessionClosed: () => 'Disconnected from Suitest',
-	commandWillBeExecuted: (name) => `command "${name}" will be executed`,
 
 	connectingToDevice: (name, id) => `Connecting to "${name}" (${id})`,
 	connectedToDevice: (name, id) => `Connected to "${name}" (${id})`,
@@ -186,17 +174,8 @@ ${leaves}`,
 
 	disconnectedFromDevice: () => 'Disconnected from device',
 	disconnectingFromDevice: () => 'Disconnecting from device',
-	testWillBeStarted: (name) => name ? `Test ${name} will be started` : 'New test will be started',
-	testWasStarted: (name) => name ? `Test ${name} was started` : 'New test was started',
-	testPackWillBeStarted: (name) => `Test pack ${name} will be started`,
-	testPackWasStarted: (name) => `Test pack ${name} was started`,
-	startTestDeprecate: () => '.startTest with arguments is deprecated',
-
-	// Warnings
-	warnConfigureDeprecation: () => '.configure() command is deprecated and will be removed soon. Use separete commands for each field or .suitestrc file or cli args for configuration.',
-	warnVideoAsElementDeprecation: () => '.element({video: true}) is deprecated and will be removed soon, use .video() instead.',
 
-	replWarnInteractive: () => 'Ignored the "interactive" command. This command works only in the interactive mode.',
+	replWarn: () => 'Ignored the "startREPL" command. This command works only for single device.',
 	replWelcomeMessage: (vars, cwd, watch, repeater, varColor) => {
 		return '' +
 		'Test execution has been paused for the interactive session\n' +
@@ -219,11 +198,11 @@ ${leaves}`,
 	replFailedToRequire: template`Failed to require file ${0}. (You may need to update your "watch" parameter)`,
 	replIpcErrorInChildProcess: template`IPC error in child process `,
 	replIpcNotImplemented: template`IPC protocol not implemented for message: ${0}`,
-	replIpcNotAvailable: template`suitest.interactive() command only works when used together with Suitest launcher.`,
+	replIpcNotAvailable: template`suitest.startREPL() command only works when used together with Suitest launcher.`,
 	replFailedToFindRepeater: template`Error: Failed to find the repeater "${0}".`,
 	replRepeaterNotAFunc: template`Error: Repeater "${0}" is not a function. Value: ${1}`,
-	replNotATty: template`You seem to be using suitest from a CLI that is not a TTY. Some features of suitest.interactive command may not work as expected. In case of problems try switching to the default system's CLI program, like bash on Linux or cmd on Windows. Sometimes replacing "suitest" command with "node node_modules/suitest-js-api/lib/testLauncher/" could help as well`,
-	replWrongNodeVersion: template`Error: To use "suitest.interactive" you need NodeJS version v9.4 or newer. You are using ${0}. Please update.`,
+	replNotATty: template`You seem to be using suitest from a CLI that is not a TTY. Some features of suitest.startREPL command may not work as expected. In case of problems try switching to the default system's CLI program, like bash on Linux or cmd on Windows. Sometimes replacing "suitest" command with "node node_modules/suitest-js-api/lib/testLauncher/" could help as well`,
+	replWrongNodeVersion: template`Error: To use "suitest.startREPL" you need NodeJS version v9.4 or newer. You are using ${0}. Please update.`,
 
 	// Cli args
 	cliLogLevel: () => `Logger verbosity level [default: "${logLevels.normal}"]`,