suitest-js-api 3.6.0 → 3.7.0

package/lib/constants/keys.js

@@ -58,6 +58,11 @@ const KEY = {
 	UP_ARROW: '[[Up arrow]]',
 	SEARCH: '[[Search]]',
 	DONE: '[[Done]]',
+	UP: '[[Up]]',
+	DOWN: '[[Down]]',
+	LEFT: '[[Left]]',
+	RIGHT: '[[Right]]',
+	OK: '[[Ok]]',
 };
 
 Object.freeze(KEY);

package/lib/testLauncher/commands/run.js

@@ -43,10 +43,21 @@ const builder = yargs => {
 			describe: 'Will launch user command with --inspect-brk execArgv, used for debugging',
 			global: false,
 		})
+		.option('override-config-file', {
+			describe: 'Specifies an additional config file which properties have precedence over properties in a standard configuration file.',
+			global: false,
+			type: 'string',
+		})
+		.option('base-config-file', {
+			describe: 'Path to a config file to override standard configuration files. Standard configuration files are ignored.',
+			global: false,
+			type: 'string',
+		})
 		.option('config-file', {
 			describe: texts.cliConfig(),
 			global: false,
 			type: 'string',
+			deprecate: 'Can have unexpected behaviour. Use --base-config-file or --override-config-file.',
 		})
 		.option('default-timeout', {
 			describe: texts.defaultTimeout(),

package/lib/testLauncher/composeConfig.js

@@ -58,9 +58,17 @@ const DEFAULT_PATHS = [
  * @param {String} filePath path to file
  */
 function readConfigFile(filePath) {
+	const extension = path.extname(filePath);
+	if (extension === '.js') {
+		if (!path.isAbsolute(filePath)) {
+			// ensure correct handling of relative paths, we want to prevent searching in __dirname
+			filePath = path.join(process.cwd(), filePath);
+		}
+		return require(filePath);
+	}
 	const fileContent = fs.readFileSync(filePath, 'utf8');
 
-	switch (path.extname(filePath)) {
+	switch (extension) {
 		case '.yaml':
 		case '.yml':
 			return yaml.load(fileContent);
@@ -68,8 +76,8 @@ function readConfigFile(filePath) {
 			return JSON5.parse(fileContent);
 		case '.ini':
 			return ini.parse(fileContent);
-		case '.js':
-			return require(filePath);
+		case '.json':
+			return JSON.parse(fileContent);
 		default:
 			try {
 				return JSON.parse(fileContent);
@@ -158,6 +166,7 @@ function findConfigUpToRoot(pathToSearch, filename) {
  * Searches for 'extends' property for other config file and if presents merge them.
  * cli arguments are not parsed.
  * If file found, but json invalid, throw error.
+ * @param {string} [pathToConfig] expicit path to configuration file
  * @returns {Object}
  */
 function readRcConfig(pathToConfig) {
@@ -170,9 +179,6 @@ function readRcConfig(pathToConfig) {
 			.filter(defaultConfig => IS_WINDOWS ? defaultConfig.isGeneral : true);
 
 		for (const defaultConfig of defaultConfigurations) {
-			if (mainConfigFilePath) {
-				break;
-			}
 			if (
 				fs.existsSync(defaultConfig.path) &&
 				fs.lstatSync(defaultConfig.path).isDirectory()
@@ -181,6 +187,9 @@ function readRcConfig(pathToConfig) {
 					defaultConfig.deepSearch ?
 						findConfigUpToRoot :
 						findConfig)(defaultConfig.path, defaultConfig.filename);
+				if (mainConfigFilePath) {
+					break;
+				}
 			}
 		}
 	}
@@ -210,14 +219,14 @@ function readRcConfig(pathToConfig) {
 }
 
 /**
- * Read json config file provided by user.
+ * Read config file provided by user.
  * @param {string} path - path to config file
  * @throws {SuitestError}
- * @returns {Object} - parsed json
+ * @returns {Object} - parsed config file
  */
 function readUserConfig(path) {
 	try {
-		return JSON.parse(fs.readFileSync(path));
+		return readConfigFile(path);
 	} catch (error) {
 		throw new SuitestError(invalidUserConfig(path, error.message), error.code);
 	}
@@ -229,8 +238,20 @@ function readUserConfig(path) {
  * @returns {{ownArgs: Object, userCommandArgs: string[]}}
  */
 const composeConfig = (argv) => {
-	const rcConfig = readRcConfig(argv.configFile);
-	const configFilePath = argv.configFile || rcConfig.configFile;
+	if (argv.configFile) {
+		console.warn('Warning: You are using deprecated argument --config-file. Please use --override-config-file or --base-config-file instead.');
+		if (argv.baseConfigFile || argv.overrideConfigFile) {
+			throw new SuitestError('Combination of deprecated --config-file with either --base-config-file or --override-config-file is not allowed');
+		}
+	}
+	const rcConfig = readRcConfig(argv.baseConfigFile || argv.configFile);
+	if (rcConfig.configFile) {
+		console.warn('Warning: You are using deprecated option configFile. Please use overrideConfigFile instead.');
+	}
+	if ((argv.configFile || rcConfig.configFile) && (argv.baseConfigFile || argv.overrideConfigFile || rcConfig.overrideConfigFile)) {
+		throw new SuitestError('Combination of deprecated configFile with --base-config-file or --override-config-file or overrideConfigFile is not allowed');
+	}
+	const configFilePath = argv.overrideConfigFile || rcConfig.overrideConfigFile || argv.configFile || rcConfig.configFile;
 	const userConfig = configFilePath ? readUserConfig(configFilePath) : {};
 
 	const ownArgs = {

package/lib/texts.js

@@ -41,7 +41,7 @@ module.exports = {
 	invalidInputMessage: (methodName, field) =>
 		`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.`,
+	invalidUserConfig: template`Failed to process config file '${0}'.\n\t${1}.\n\tMake sure path is correct and file is in valid format.`,
 	circularDependencyError: (path) => `Circular dependency found on ${path} path.`,
 
 	// WebSockets errors

package/lib/validation/jsonSchemas.js

@@ -362,6 +362,7 @@ schemas[validationKeys.CONFIGURE] = {
 	'properties': {
 		'appConfigId': {'type': 'string'},
 		'concurrency': {'type': 'number'},
+		'overrideConfigFile': {'type': 'string'},
 		'configFile': {'type': 'string'},
 		'deviceId': {'type': 'string'},
 		'disallowCrashReports': {'type': 'boolean'},

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "suitest-js-api",
-  "version": "3.6.0",
+  "version": "3.7.0",
   "main": "index.js",
   "repository": "git@github.com:SuitestAutomation/suitest-js-api.git",
   "author": "Suitest <hello@suite.st>",

package/typeDefinition/ApplicationChain.d.ts

@@ -56,4 +56,4 @@ interface ApplicationAbandonedChain extends
 {}
 
 type ApplicationQueryResult = string;
-type ApplicationEvalResult = boolean | void;
+type ApplicationEvalResult = boolean | undefined;

package/typeDefinition/BrightScriptExpression.d.ts

@@ -75,4 +75,4 @@ interface BrightScriptExpressionAbandonedChain extends
 {}
 
 type BrightScriptExpressionQueryResult = string;
-type BrightScriptExpressionEvalResult = boolean | void;
+type BrightScriptExpressionEvalResult = boolean | undefined;

package/typeDefinition/ClearAppData.d.ts

@@ -10,4 +10,4 @@ export interface ClearAppDataChain extends
 
 interface ClearAppDataAbandonedChain extends AbstractChain {}
 
-type ClearAppDataEvalResult = void | boolean;
+type ClearAppDataEvalResult = undefined | boolean;

package/typeDefinition/CloseAppChain.d.ts

@@ -9,4 +9,4 @@ export interface CloseAppChain extends
 
 interface CloseAppAbandonedChain extends AbstractChain {}
 
-type CloseAppEvalResult = void | boolean;
+type CloseAppEvalResult = undefined | boolean;

package/typeDefinition/CookieChain.d.ts

@@ -71,5 +71,5 @@ interface CookieEvalModifiers<T> extends
 
 interface CookieAbandonedChain extends AbstractChain {}
 
-type CookieQueryResult = string | void;
-type CookieEvalResult = boolean | void;
+type CookieQueryResult = string | undefined;
+type CookieEvalResult = boolean | undefined;

package/typeDefinition/ElementChain.d.ts

@@ -151,5 +151,5 @@ interface ElementBaseEvalChain<TSelf> extends
 
 interface ElementAbandonedChain extends AbstractChain {}
 
-type ElementQueryResult = ElementProps | void;
-type ElementEvalResult = boolean | void;
+type ElementQueryResult = ElementProps | undefined;
+type ElementEvalResult = boolean | undefined;

package/typeDefinition/ExecuteBrightScriptChain.d.ts

@@ -9,4 +9,4 @@ export interface ExecuteBrightScriptChain extends
 
 interface ExecuteBrightScriptAbandonedChain extends AbstractChain {}
 
-type ExecuteBrightScriptEvalResult = boolean | void;
+type ExecuteBrightScriptEvalResult = boolean | undefined;

package/typeDefinition/ExecuteCommandChain.d.ts

@@ -9,4 +9,4 @@ export interface ExecuteCommandChain extends
 
 interface ExecuteCommandAbandonedChain extends AbstractChain {}
 
-type ExecuteCommandEvalResult = boolean | void;
+type ExecuteCommandEvalResult = boolean | undefined;

package/typeDefinition/JavascriptExpression.d.ts

@@ -75,4 +75,4 @@ interface JsExpressionAbandonedChain extends
 {}
 
 type JsExpressionQueryResult = string;
-type JsExpressionEvalResult = boolean | void;
+type JsExpressionEvalResult = boolean | undefined;

package/typeDefinition/LocationChain.d.ts

@@ -77,4 +77,4 @@ interface LocationAbandonedChain extends
 {}
 
 type LocationQueryResult = string;
-type LocationEvalResult = boolean | void;
+type LocationEvalResult = boolean | undefined;

package/typeDefinition/NetworkRequest.d.ts

@@ -35,4 +35,4 @@ interface NetworkRequestEvalChain<T> extends
 
 interface NetworkRequestAbandonedChain extends AbstractChain {}
 
-type NetworkRequestEvalResult = boolean | void;
+type NetworkRequestEvalResult = boolean | undefined;

package/typeDefinition/OpenAppChain.d.ts

@@ -13,4 +13,4 @@ export interface OpenAppChain extends
 
 interface OpenAppAbandonedChain extends AbstractChain {}
 
-type OpenAppEvalResult = void | boolean;
+type OpenAppEvalResult = undefined | boolean;

package/typeDefinition/OpenUrl.d.ts

@@ -9,4 +9,4 @@ export interface OpenUrlChain extends
 
 interface OpenUrlAbandonedChain extends AbstractChain {}
 
-type OpenUrlEvalResult = void | boolean;
+type OpenUrlEvalResult = undefined | boolean;

package/typeDefinition/PlayStationVideoChain.d.ts

@@ -47,5 +47,5 @@ interface PlayStationVideoBaseEvalChain<TSelf> extends
 
 interface PlayStationVideoAbandonedChain extends AbstractChain {}
 
-type PlayStationVideoQueryResult = PlayStationVideoProps | void;
-type PlayStationVideoEvalResult = boolean | void;
+type PlayStationVideoQueryResult = PlayStationVideoProps | undefined;
+type PlayStationVideoEvalResult = boolean | undefined;

package/typeDefinition/PollUrl.d.ts

@@ -9,4 +9,4 @@ export interface PollUrlChain extends
 
 interface PollUrlAbandonedChain extends AbstractChain {}
 
-type PollUrlEvalResult = void | boolean;
+type PollUrlEvalResult = undefined | boolean;

package/typeDefinition/PositionChain.d.ts

@@ -52,4 +52,4 @@ interface PositionEmptyChain extends PositionBaseEvalChain<PositionEmptyChain> {
 interface PositionAbandonedChain extends AbstractChain {}
 
 type PositionQueryResult = string;
-type PositionEvalResult = boolean | void;
+type PositionEvalResult = boolean | undefined;

package/typeDefinition/PressButton.d.ts

@@ -38,4 +38,4 @@ interface PressButtonEmptyChain extends PressButtonBaseEvalChain<PressButtonEmpt
 interface PressButtonAbandonedChain extends AbstractChain {}
 
 type PressButtonQueryResult = string;
-type PressButtonEvalResult = boolean | void;
+type PressButtonEvalResult = boolean | undefined;

package/typeDefinition/RelativePositionChain.d.ts

@@ -45,4 +45,4 @@ interface RelativePositionEmptyChain extends RelativePositionBaseEvalChain<Relat
 interface RelativePositionAbandonedChain extends AbstractChain {}
 
 type RelativePositionQueryResult = string;
-type RelativePositionEvalResult = boolean | void;
+type RelativePositionEvalResult = boolean | undefined;

package/typeDefinition/SleepChain.d.ts

@@ -9,4 +9,4 @@ export interface SleepChain extends
 
 interface SleepAbandonedChain extends AbstractChain {}
 
-type SleepEvalResult = void | boolean;
+type SleepEvalResult = undefined | boolean;

package/typeDefinition/SuspendAppChain.d.ts

@@ -9,4 +9,4 @@ export interface SuspendAppChain extends
 
 interface SuspendAppAbandonedChain extends AbstractChain {}
 
-type SuspendAppEvalResult = void | boolean;
+type SuspendAppEvalResult = undefined | boolean;

package/typeDefinition/VideoChain.d.ts

@@ -88,5 +88,5 @@ interface VideoBaseEvalChain<TSelf> extends
 
 interface VideoAbandonedChain extends AbstractChain {}
 
-type VideoQueryResult = ElementProps | void;
-type VideoEvalResult = boolean | void;
+type VideoQueryResult = ElementProps | undefined;
+type VideoEvalResult = boolean | undefined;

package/typeDefinition/WindowChain.d.ts

@@ -54,4 +54,4 @@ interface WindowEmptyChain extends WindowBaseEvalChain<WindowEmptyChain> {}
 interface WindowAbandonedChain extends AbstractChain {}
 
 type WindowQueryResult = string;
-type WindowEvalResult = boolean | void;
+type WindowEvalResult = boolean | undefined;

package/typeDefinition/constants/Keys.d.ts

@@ -57,4 +57,9 @@ export type Keys = {
 	UP_ARROW:    '[[Up arrow]]',
 	SEARCH:      '[[Search]]',
 	DONE:        '[[Done]]',
+	UP:          '[[Up]]',
+	DOWN:        '[[Down]]',
+	LEFT:        '[[Left]]',
+	RIGHT:       '[[Right]]',
+	OK:          '[[Ok]]',
 }