suitest-js-api 3.1.4 → 3.2.1

package/index.d.ts

@@ -85,8 +85,8 @@ declare namespace suitest {
 		pollUrl(url: string, response: string): PollUrlChain;
 		position(x: number, y: number): PositionChain;
 		relativePosition(x: number, y: number): RelativePosition;
-		press(key: string): PressButtonChain;
-		press(keys: string[]): PressButtonChain;
+		press(key: string, options?: { longPressMs?: string | number }): PressButtonChain;
+		press(keys: string[], options?: { longPressMs?: string | number }): PressButtonChain;
 		sleep(milliseconds: number): SleepChain;
 		window(): WindowChain;
 
@@ -190,8 +190,8 @@ declare namespace suitest {
 		pollUrl(url: string, response: string): PollUrlChain;
 		position(x: number, y: number): PositionChain;
 		relativePosition(x: number, y: number): RelativePosition;
-		press(key: string): PressButtonChain;
-		press(keys: string[]): PressButtonChain;
+		press(key: string, options?: { longPressMs?: string | number }): PressButtonChain;
+		press(keys: string[], options?: { longPressMs?: string | number }): PressButtonChain;
 		runTest(testId: string): RunTestChain;
 		sleep(milliseconds: number): SleepChain;
 		window(): WindowChain;
@@ -232,16 +232,7 @@ declare namespace suitest {
 	interface DeviceData {
 		id: string;
 		firmware: string;
-		deviceMeta: {
-			codeName: string;
-			deviceType: string;
-		};
-		status: {
-			type: string;
-			canPair: boolean;
-		};
-		platforms: string[];
-		workingPlatforms: string[];
+		modelId: string;
 	}
 
 	interface ConfigOverride {

package/lib/chains/pressButtonChain.js

@@ -20,16 +20,24 @@ const {validate, validators} = require('../validation');
 const {getRequestType} = require('../utils/socketChainHelper');
 
 const pressButtonFactory = (classInstance) => {
-	const toJSON = (data) => ({
-		type: getRequestType(data, false),
-		request: compose(
-			msg => applyUntilCondition(msg, data),
-			msg => applyCountAndDelay(msg, data),
-		)({
+	const toJSON = (data) => {
+		const base = {
 			type: 'button',
 			ids: data.ids,
-		}),
-	});
+		};
+
+		if (data.longPressMs !== undefined) {
+			base.longPressMs = data.longPressMs;
+		}
+
+		return {
+			type: getRequestType(data, false),
+			request: compose(
+				msg => applyUntilCondition(msg, data),
+				msg => applyCountAndDelay(msg, data),
+			)(base),
+		};
+	};
 
 	const toStringComposer = makeToStringComposer(toJSON);
 	const thenComposer = makeThenComposer(toJSON);
@@ -67,18 +75,34 @@ const pressButtonFactory = (classInstance) => {
 		return output;
 	};
 
-	const pressButtonChain = buttonOrButtons => {
+	/**
+	 * @param {string | string[]} buttonOrButtons
+	 * @param {{longPressMs?: number}} [options]
+	 * @returns {PressButtonChain}
+	 */
+	const pressButtonChain = (buttonOrButtons, options = {}) => {
 		const ids = Array.isArray(buttonOrButtons) ? buttonOrButtons : [buttonOrButtons];
 
 		return makeChain(classInstance, getComposers, {
 			type: 'press',
-			ids: validate(validators.ARRAY_OF_BUTTONS, ids, invalidInputMessage('pressButton', 'Illegal button ids.')),
+			ids: validate(
+				validators.ARRAY_OF_BUTTONS,
+				ids,
+				invalidInputMessage('pressButton', 'Illegal button ids.'),
+			),
+			longPressMs: options.longPressMs !== undefined
+				? validate(
+					validators.ST_VAR_OR_POSITIVE_NUMBER,
+					options.longPressMs,
+					invalidInputMessage('pressButton', 'Invalid longPressMs'),
+				)
+				: undefined,
 		});
 	};
 
 	return {
 		pressButton: pressButtonChain,
-		pressButtonAssert: buttonOrButtons => pressButtonChain(buttonOrButtons).toAssert(),
+		pressButtonAssert: (...args) => pressButtonChain(...args).toAssert(),
 
 		// For testing
 		toJSON,

package/lib/testLauncher/SuitestLauncher.js

@@ -7,6 +7,7 @@ const {
 	addLauncherIpcListeners,
 	throwDebugForManyDevicesError,
 	increaseMaxListeners,
+	handleChildResult,
 } = require('../utils/testLauncherHelper');
 const {TEST_COMMAND, TOKEN} = require('../constants/modes');
 const sessionConstants = require('../constants/session');
@@ -88,6 +89,8 @@ class SuitestLauncher {
 				throwDebugForManyDevicesError();
 			}
 
+			let finishedWithErrors = false;
+
 			try {
 				const ipcPort = await ipcServer.start({
 					...this.ownArgv,
@@ -101,7 +104,7 @@ class SuitestLauncher {
 				// increase stdout max listeners based on number of child processes to avoid node warning
 				increaseMaxListeners(process.stdout, devices.length, this.ownArgv.concurrency);
 
-				await runAllDevices(
+				finishedWithErrors = await runAllDevices(
 					this.restArgs,
 					this.ownArgv,
 					devicesWithDetails,
@@ -109,6 +112,7 @@ class SuitestLauncher {
 				);
 			} finally {
 				await closeSessionUnchained(suitest);
+				handleChildResult(finishedWithErrors);
 			}
 		} catch (error) {
 			await captureException(error);

package/lib/testLauncher/composeConfig.js

@@ -17,33 +17,40 @@ 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
+const IS_WINDOWS = process.platform === 'win32';
+const HOME_DIR = IS_WINDOWS
 	? 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`,
+const CONFIG_FORMATS = [
+	'.js',
+	'.json',
+	'.yaml',
+	'.yml',
+	'.json5',
+	'.ini',
 ];
 
 /**
- * @description should repeat lookup logic from rc library
- * @type {string[]}
+ * @description default directories to search. Logic the same as in rc
+ * @type {
+	* {
+	* path: string,
+	* filename: string,
+	* deepSearch: boolean,
+	* isGeneral: boolean
+	* } []
+ * }
  */
-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(),
+const DEFAULT_PATHS = [
+	{path: process.cwd(), filename: `.${APP_NAME}rc`, deepSearch: true, isGeneral: true},
+	{path: path.join(HOME_DIR, '.config', APP_NAME), filename: 'config', deepSearch: false, isGeneral: true},
+	{path: path.join(HOME_DIR, '.config'), filename: APP_NAME, deepSearch: false, isGeneral: true},
+	{path: path.join(HOME_DIR, `.${APP_NAME}`), filename: 'config', deepSearch: false, isGeneral: true},
+	{path: HOME_DIR, filename: `.${APP_NAME}rc`, deepSearch: false, isGeneral: true},
+
+	{path: path.join(ETC_DIR, APP_NAME), filename: 'config', deepSearch: false, isGeneral: false},
+	{path: ETC_DIR, filename: `${APP_NAME}rc`, deepSearch: false, isGeneral: false},
 ];
 
 /**
@@ -109,34 +116,73 @@ function findExtendConfigs(defaultConfigObject, extendPath, filePath, foundPaths
 	return mainConfigFile;
 }
 
+/**
+ * @description Search for configuration files.
+ * @param {String} pathToSearch path to directory to search
+ * @param {String} filename base filename without extension
+ */
+function findConfig(pathToSearch, filename) {
+	if (!fs.existsSync(pathToSearch)) {
+		return;
+	}
+	const files = fs.readdirSync(pathToSearch);
+	const file = files.find(file => {
+		const {name, ext} = path.parse(file);
+
+		return name === filename && (CONFIG_FORMATS.includes(ext) || !ext);
+	});
+
+	return file ? path.join(pathToSearch, file) : undefined;
+}
+
+/**
+ * @description Search for configuration files up to the root.
+ * @param {String} pathToSearch path to directory to search
+ * @param {String} filename base filename without extension
+ */
+function findConfigUpToRoot(pathToSearch, filename) {
+	const foundConfigFile = findConfig(pathToSearch, filename);
+
+	if (foundConfigFile || path.parse(pathToSearch).root === pathToSearch) {
+		return foundConfigFile;
+	}
+
+	return findConfigUpToRoot(path.join(pathToSearch, '../'), filename);
+}
+
 /**
  * Read `.suitestrc` launcher config file.
+ * Also, searches for default RC paths.
  * If file not found, return empty object.
- * Supports json and ini formats.
+ * Supports json, json5, js, yaml, yml, ini formats.
+ * 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.
  * @returns {Object}
  */
 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]);
-				}
+		const defaultConfigurations = DEFAULT_PATHS
+			.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()
+			) {
+				mainConfigFilePath = (
+					defaultConfig.deepSearch ?
+						findConfigUpToRoot :
+						findConfig)(defaultConfig.path, defaultConfig.filename);
+			}
+		}
 	}
 
 	if (!mainConfigFilePath) {
@@ -151,17 +197,15 @@ function readRcConfig(pathToConfig) {
 				configFile,
 				configFile.extends,
 				mainConfigFilePath,
-				[foundFiles[0]],
+				[mainConfigFilePath],
 			),
-			configs: foundFiles,
-			config: foundFiles[0],
+			config: mainConfigFilePath,
 		};
 	}
 
 	return {
 		...configFile,
-		configs: foundFiles,
-		config: foundFiles[0],
+		config: mainConfigFilePath,
 	};
 }
 

package/lib/texts.js

@@ -158,9 +158,6 @@ ${leaves}`,
 	// ipc
 	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.',
-
 	// logger msg
 	sessionOpen: () => 'Connecting to Suitest ...',
 	sessionOpened: () => 'Connected to Suitest',

package/lib/utils/socketErrorMessages.js

@@ -133,15 +133,6 @@ function getErrorMessage({response, jsonMessage, verbosity, snippets}) {
 	return chainUtils.translateLineResult(jsonMessage, verbosity, response);
 }
 
-/**
- * @description check if error should be considered as fatal
- * @param {Object} res websocket message
- * @returns {boolean}
- */
-function isErrorFatal(res) {
-	return res.result === 'fatal' || normalizeErrorType(res) === 'testIsNotStarted';
-}
-
 /**
  * @description Normalize errorType
  * @param {*} response webscoket message
@@ -169,8 +160,7 @@ module.exports = {
 	 * @returns {string}
 	 */
 	getInfoErrorMessage: (message, prefix = '', res, stack) => {
-		const suffix = isErrorFatal(res) ? ` ${t['suffix.sessionWillClose']()}` : '';
-		const msg = prefix + stripAnsiChars(message) + suffix;
+		const msg = prefix + stripAnsiChars(message);
 		const firstStackLine = stack && getFirstStackLine(stack);
 		const nl = firstStackLine && msg.endsWith(EOL) ? '' : EOL;
 

package/lib/utils/testLauncherHelper.js

@@ -312,7 +312,7 @@ function getChildOptions(device, port) {
  * @param {Object} ownArgv - implicitly derived parameters
  * @param {Array} devices - array with items containing full device information
  * @param {number} ipcPort - ipc port number
- * @returns {Promise<*>}
+ * @returns {Promise<boolean>} - finished with errors or not.
  */
 function runAllDevices(cmdArgv, ownArgv, devices, ipcPort) {
 	const tests = devices.map(device => () => runTestOnDevice(
@@ -343,7 +343,8 @@ function runAllDevices(cmdArgv, ownArgv, devices, ipcPort) {
 
 		log.final(failedDevices.length, result.length - failedDevices.length);
 		warnNewVersionAvailable(logger, version, suitestVersion);
-		handleChildResult(failedDevices.length !== 0);
+
+		return failedDevices.length !== 0;
 	});
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "suitest-js-api",
-  "version": "3.1.4",
+  "version": "3.2.1",
   "main": "index.js",
   "repository": "git@github.com:SuitestAutomation/suitest-js-api.git",
   "author": "Suitest <hello@suite.st>",
@@ -85,7 +85,7 @@
   },
   "dependencies": {
     "@suitest/smst-to-text": "^4.4.3",
-    "@suitest/translate": "^4.4.3",
+    "@suitest/translate": "^4.4.4",
     "@types/node": "^14.0.10",
     "ajv": "^6.12.2",
     "ansi-regex": "^5.0.0",