Merge branch 'master' of https://github.com/SuitestAutomation/suitest…

…-js-api into hotfix/SUIT-16525-log-level-v3

.circleci/config.yml

@@ -2,25 +2,36 @@
 #
 # Check https://circleci.com/docs/2.0/language-javascript/ for more details
 #
-version: 2
+version: 2.1
+
+executors:
+  node-14:
+    docker:
+      - image: cimg/node:14.21
+  node-16:
+    docker:
+      - image: cimg/node:16.18
+  node-18:
+    docker:
+      - image: cimg/node:18.12
+
 jobs:
   build:
     environment:
       CC_TEST_REPORTER_ID: b8382b02e5d130520012123a7fcc97b478a6294991078cdabb721315bd2a9dd9
-    docker:
-      # specify the version you desire here
-      - image: circleci/node:14
 
-      # Specify service dependencies here if necessary
-      # CircleCI maintains a library of pre-built images
-      # documented at https://circleci.com/docs/2.0/circleci-images/
-      # - image: circleci/mongo:3.4.4
+    working_directory: ~/suitest-js-api
 
-    working_directory: ~/repo
+    parameters:
+      version:
+        type: string
+    executor: node-<< parameters.version >>
 
     steps:
       - checkout
 
+      - run: node --version
+
       - run:
           name: Install dependencies
           command: |
@@ -46,3 +57,10 @@ jobs:
           name: Check TypeScript definitions
           command: |
             npm run test-definitions
+workflows:
+  workflow:
+    jobs:
+      - build:
+          matrix:
+            parameters:
+              version: ["14", "16", "18"]

README.md

@@ -45,18 +45,20 @@ etc.
 - Locally installed Chrome, Firefox, Safari and Edge
 - Apple tvOS, iOS and iPadOS devices, including simulators 
 - Roku
+- Vizio
 
 Suitest supports automating end-to-end testing of:
 
 - HbbTV / Freeview Play apps
 - Samsung Orsay and Tizen apps
 - LG NetCast and webOS apps 
 - HTML apps for other TV's or set-top boxes
-- Android TV apps (including FireTV)
-- tvOS apps
+- Android TV and mobile apps (including FireTV)
+- Apple TV (tvOS), iOS and iPadOS apps
 - Xbox One and Xbox Series S and X apps
 - PlayStation 4 / 5 apps
 - Roku apps
+- Vizio SmartCast
 - Traditional websites and web apps for desktop browsers.
 
 ## Contributing

config/index.js

@@ -11,7 +11,7 @@ const timestamp = require('../lib/constants/timestamp');
 const {validate, validators} = require('../lib/validation');
 const {invalidConfigObj} = require('../lib/texts');
 const {pickNonNil} = require('../lib/utils/common');
-const envVars = require('../lib/constants/enviroment');
+const envVars = require('../lib/constants/environment');
 
 const sentryDsn = 'https://1f74b885d0c44549b57f307733d60351:[email protected]/288812';
 const DEFAULT_TIMEOUT = 2000;

lib/composers/acceptModalComposer.js

@@ -8,14 +8,17 @@ const {invalidInputMessage} = require('../texts');
  * Accept modal dialog, optionally sending message
  * @param {String} [message] - text to be send to modal dialog
  */
-const acceptModalComposer = makeModifierComposer(composers.ACCEPT_MODAL, ['acceptModal'], (_, meta, message = null) => ({
-	...meta,
-	isAcceptModal: true,
-	acceptModalMessage: validate(
-		validators.NON_EMPTY_STRING_OR_NUll,
-		message,
-		invalidInputMessage('acceptModal', 'Message value'),
-	),
-}));
+const acceptModalComposer = makeModifierComposer(
+	composers.ACCEPT_MODAL,
+	['acceptModal'],
+	(_, meta, message = null) => ({
+		...meta,
+		isAcceptModal: true,
+		acceptModalMessage: validate(
+			validators.NON_EMPTY_STRING_OR_NUll,
+			message,
+			invalidInputMessage('acceptModal', 'Message value'),
+		),
+	}));
 
 module.exports = acceptModalComposer;

lib/composers/cloneComposer.js

@@ -8,7 +8,7 @@ const cloneComposer = makeModifierComposer(
 	composers.CLONE,
 	['clone'],
 	(_, meta) => ({...meta}),
-	{unregisterParent: false}
+	{unregisterParent: false},
 );
 
 module.exports = cloneComposer;

lib/composers/matchBrightScriptComposer.js

@@ -22,7 +22,7 @@ const matchBrightScriptComposer = makeModifierComposer(
 				val: res,
 			},
 		};
-	}
+	},
 );
 
 module.exports = matchBrightScriptComposer;

lib/composers/matchRepoComposer.js

@@ -38,16 +38,19 @@ const processMatchRepoArgs = makeArgumentsProcessor(
 	}),
 );
 
-const matchRepoComposer = makeModifierComposer(composers.MATCH_REPO, ['matchRepo', 'matchesRepo'], (_, data, ...args) => ({
-	...data,
-	comparator: {
-		type: SUBJ_COMPARATOR.MATCH,
-		props: validation.validate(
-			validation.validators.ELEMENT_REPO_PROPS,
-			processMatchRepoArgs(args),
-			invalidInputMessage('matchRepo', 'Property')
-		),
-	},
-}));
+const matchRepoComposer = makeModifierComposer(
+	composers.MATCH_REPO,
+	['matchRepo', 'matchesRepo'],
+	(_, data, ...args) => ({
+		...data,
+		comparator: {
+			type: SUBJ_COMPARATOR.MATCH,
+			props: validation.validate(
+				validation.validators.ELEMENT_REPO_PROPS,
+				processMatchRepoArgs(args),
+				invalidInputMessage('matchRepo', 'Property'),
+			),
+		},
+	}));
 
 module.exports = matchRepoComposer;

lib/composers/repeatComposer.js

@@ -8,7 +8,7 @@ const {invalidInputMessage} = require('../texts');
  */
 const repeatComposer = makeModifierComposer(composers.REPEAT, ['repeat'], (_, meta, value) => ({
 	...meta,
-	repeat: validate(validators.ST_VAR_OR_POSITIVE_NUMBER, value, invalidInputMessage('repeat', 'Repeat')),
+	repeat: validate(validators.ST_VAR_OR_POSITIVE_NUMBER_NOT_ZERO, value, invalidInputMessage('repeat', 'Repeat')),
 }));
 
 module.exports = repeatComposer;

lib/composers/requestMatchesComposer.js

@@ -31,7 +31,7 @@ const processRequestArgs = makeArgumentsProcessor(
 	 */
 	({name, val, type = PROP_COMPARATOR.EQUAL}) => getRequestMatchItem(name, val, type),
 	objArg => 'name' in objArg && 'val' in objArg,
-	getRequestMatchItem
+	getRequestMatchItem,
 );
 
 const requestMatchesComposer = makeModifierComposer(
@@ -47,7 +47,7 @@ const requestMatchesComposer = makeModifierComposer(
 				invalidInputMessage('requestMatch', 'Header'),
 			),
 		},
-	})
+	}),
 );
 
 module.exports = requestMatchesComposer;

lib/composers/responseMatchesComposer.js

@@ -32,7 +32,7 @@ const processResponseArgs = makeArgumentsProcessor(
 	 */
 	({name, val, type = PROP_COMPARATOR.EQUAL}) => getResponseMatchComposers(name, val, type),
 	objArg => 'name' in objArg && 'val' in objArg,
-	getResponseMatchComposers
+	getResponseMatchComposers,
 );
 
 const responseMatchesComposer = makeModifierComposer(
@@ -45,10 +45,10 @@ const responseMatchesComposer = makeModifierComposer(
 			props: validation.validate(
 				validation.validators.RESPONSE_MATCHES,
 				processResponseArgs(args),
-				invalidInputMessage('responseMatch', 'Header')
+				invalidInputMessage('responseMatch', 'Header'),
 			),
 		},
-	})
+	}),
 );
 
 module.exports = responseMatchesComposer;

lib/composers/swipeComposer.js

@@ -6,12 +6,21 @@ const {invalidInputMessage} = require('../texts');
 /**
  * Defines click method
  */
-const swipeComposer = makeModifierComposer(composers.TAP, ['swipe', 'flick'], (_, meta, direction, distance, duration) => ({
-	...meta,
-	isSwipe: true,
-	direction: validate(validators.DIRECTIONS, direction, invalidInputMessage('swipe/flick', 'direction')),
-	distance: validate(validators.ST_VAR_OR_POSITIVE_NUMBER, distance, invalidInputMessage('swipe/flick', 'distance')),
-	duration: validate(validators.ST_VAR_OR_POSITIVE_NUMBER, duration, invalidInputMessage('swipe/flick', 'duration')),
-}));
+const swipeComposer = makeModifierComposer(
+	composers.TAP,
+	['swipe', 'flick'],
+	(_, meta, direction, distance, duration) => ({
+		...meta,
+		isSwipe: true,
+		direction: validate(validators.DIRECTIONS, direction, invalidInputMessage('swipe/flick', 'direction')),
+		distance: validate(
+			validators.ST_VAR_OR_POSITIVE_NUMBER, distance,
+			invalidInputMessage('swipe/flick', 'distance'),
+		),
+		duration: validate(
+			validators.ST_VAR_OR_POSITIVE_NUMBER, duration,
+			invalidInputMessage('swipe/flick', 'duration'),
+		),
+	}));
 
 module.exports = swipeComposer;

lib/constants/enviroment.js → lib/constants/environment.js

@@ -1,4 +1,4 @@
-const ENVIROMENT_VARS = Object.freeze({
+const ENVIRONMENT_VARS = Object.freeze({
 	/**
 	 * @description indicates that session is running as launcher child process, contains deviceId|configId|ipcPortNumber
 	 */
@@ -7,4 +7,4 @@ const ENVIROMENT_VARS = Object.freeze({
 	SUITEST_BE_SERVER: 'SUITEST_BE_SERVER',
 });
 
-module.exports = ENVIROMENT_VARS;
+module.exports = ENVIRONMENT_VARS;

lib/constants/keys.js

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

lib/constants/screenOrientation.js

@@ -1,3 +1,5 @@
+/* eslint-disable key-spacing */
+
 const screenOrientation = {
 	PORTRAIT:             'portrait',
 	PORTRAIT_REVERSED:    'portraitReversed',

lib/constants/validationKeys.js

@@ -4,6 +4,7 @@ const validationKeys = {
 	NON_EMPTY_STRING: Symbol('nonEmptyString'),
 	POSITIVE_NUMBER: Symbol('positiveNumber'),
 	ST_VAR_OR_POSITIVE_NUMBER: Symbol('stVarOrPositiveNumber'),
+	ST_VAR_OR_POSITIVE_NUMBER_NOT_ZERO: Symbol('stVarOrPositiveNumberNotZero'),
 	ST_VAR_OR_NUMBER: Symbol('stVarOrNumber'),
 	NON_EMPTY_STRING_OR_UNDEFINED: Symbol('nonEmptyStringOrUndefined'),
 	NON_EMPTY_STRING_OR_NUll: Symbol('nonEmptyStringOrNull'),

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(),