suitest-js-api 2.5.1 → 3.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "suitest-js-api",
-  "version": "2.5.1",
+  "version": "3.0.2",
   "main": "index.js",
   "repository": "git@github.com:SuitestAutomation/suitest-js-api.git",
   "author": "Suitest <hello@suite.st>",
@@ -24,7 +24,7 @@
   "homepage": "https://suite.st/",
   "license": "MIT",
   "engines": {
-    "node": ">=8.0.0"
+    "node": ">=14.0.0"
   },
   "bin": {
     "suitest": "bin/suitest"
@@ -74,6 +74,7 @@
     "express": "^4.17.1",
     "husky": "^4.2.5",
     "mocha": "^7.2.0",
+    "mock-fs": "^5.1.0",
     "mock-require": "^3.0.3",
     "mock-socket": "^7.1.0",
     "mock-spawn": "^0.2.6",
@@ -84,7 +85,7 @@
   },
   "dependencies": {
     "@suitest/smst-to-text": "^4.2.2",
-    "@suitest/translate": "^4.3.3",
+    "@suitest/translate": "^4.4.0",
     "@types/node": "^14.0.10",
     "ajv": "^6.12.2",
     "ansi-regex": "^5.0.0",
@@ -92,6 +93,9 @@
     "colors": "^1.4.0",
     "compare-versions": "^3.6.0",
     "escape-string-regexp": "4.0.0",
+    "ini": "^2.0.0",
+    "js-yaml": "^4.1.0",
+    "json5": "^2.2.0",
     "keypress": "^0.2.1",
     "moment": "^2.26.0",
     "node-fetch": "^2.6.0",
@@ -99,8 +103,6 @@
     "prettyjson": "^1.2.1",
     "ramda": "^0.27.0",
     "raven": "^2.6.2",
-    "rc": "^1.2.8",
-    "read": "^1.0.7",
     "semver": "^7.3.2",
     "stack-trace": "^0.0.10",
     "uuid": "8.1.0",

package/suitest.js

@@ -1,16 +1,12 @@
 require('./lib/utils/sentry/Raven');
-const util = require('util');
-const texts = require('./lib/texts');
+const {clone} = require('ramda');
 
 // Commands
 const {openSession} = require('./lib/commands/openSession');
 const {closeSession} = require('./lib/commands/closeSession');
-const {startTestPack} = require('./lib/commands/startTestPack');
 const {pairDevice} = require('./lib/commands/pairDevice');
 const releaseDevice = require('./lib/commands/releaseDevice');
 const {setAppConfig} = require('./lib/commands/setAppConfig');
-const startTest = require('./lib/commands/startTest');
-const endTest = require('./lib/commands/endTest');
 
 // Chains
 const openAppFactory = require('./lib/chains/openAppChain');
@@ -84,13 +80,12 @@ class SUITEST_API extends EventEmitter {
 		this.appContext = new Context();
 		this.pairedDeviceContext = new Context();
 		this.getPairedDevice = () => this.pairedDeviceContext.context;
-		this.testContext = new Context();
 		this.configuration = configFactory();
 		this.config = this.configuration.config;
-		this.configure = util.deprecate(this.configuration.override, texts.warnConfigureDeprecation());
-		this.configuration.configurableFields.map(fieldName => {
-			this[`set${fieldName[0].toUpperCase()}${fieldName.slice(1)}`] = (val) => this.configuration.override({[fieldName]: val});
-		});
+		this.setDefaultTimeout = (defaultTimeout) => this.configuration.override({defaultTimeout});
+		this.setContinueOnFatalError = (continueOnFatalError) => this.configuration.override({continueOnFatalError});
+		this.setDisallowCrashReports = (disallowCrashReports) => this.configuration.override({disallowCrashReports});
+		this.setLogLevel = (logLevel) => this.configuration.override({logLevel});
 
 		// creating methods based on instance dependencies
 		this.logger = createLogger(this.configuration.config, this.pairedDeviceContext);
@@ -102,9 +97,6 @@ class SUITEST_API extends EventEmitter {
 		this.pairDevice = (...args) => pairDevice(this, ...args);
 		this.setAppConfig = (...args) => setAppConfig(this, ...args);
 		this.closeSession = (...args) => closeSession(this, ...args);
-		this.startTestPack = (...args) => startTestPack(this, ...args);
-		this.startTest = (...args) => startTest(this, ...args);
-		this.endTest = (...args) => endTest(this, ...args);
 		this.releaseDevice = (...args) => releaseDevice(this, ...args);
 
 		const {openApp, openAppAssert} = openAppFactory(this);
@@ -123,7 +115,7 @@ class SUITEST_API extends EventEmitter {
 		const {jsExpression, jsExpressionAssert} = jsExpressionFactory(this);
 		const {networkRequest, networkRequestAssert} = networkRequestFactory(this);
 		const {video, videoAssert} = videoFactory(this);
-		const {element, elementAssert} = elementFactory(this, video);
+		const {element, elementAssert} = elementFactory(this);
 		const {playstationVideo, playstationVideoAssert} = playstationVideoFactory(this);
 		const {pollUrl, pollUrlAssert} = pollUrlFactory(this);
 		const {runTestAssert} = runTestFactory(this);
@@ -256,7 +248,7 @@ class SUITEST_API extends EventEmitter {
 	}
 
 	getConfig() {
-		return {...this.configuration.config};
+		return clone(this.configuration.config);
 	}
 }
 

package/typeDefinition/ElementChain.d.ts

@@ -15,10 +15,14 @@ import {
 	MoveToModifier,
 	Repeatable,
 	Intervalable,
+	BaseEmptyChain,
 	BaseChain,
 	UntilModifier,
 	VisibleModifier,
 	VideoStateModifiers,
+	GetCssModifiers,
+	HandleModifier,
+	GetAttributesModifier,
 } from './modifiers';
 import {ElementProps} from "./constants/ElementProps";
 
@@ -34,7 +38,10 @@ export interface ElementChain extends
 	ScrollModifier<ElementRepeatIntervalChain>, // scroll
 	SwipeModifier<ElementRepeatIntervalChain>, // swipe
 	MoveToModifier<ElementEmptyChain>, // moveTo
-	VisibleModifier<ElementWithoutEvalChain>
+	VisibleModifier<ElementWithoutEvalChain>,// visible
+	GetCssModifiers<ElementGetPropertiesChain>, // getCssProperties
+	HandleModifier<ElementHandleChain>, // handle
+	GetAttributesModifier<ElementGetAttributesChain> // getAttributes
 {}
 
 // -matchers +timeout +negation
@@ -107,6 +114,27 @@ interface ElementEvalModifiers<T> extends
 	ElementMatchModifiers<T>
 {}
 
+/*
+ * @description represents return value of calling getCssProperties function.
+ */
+interface ElementGetPropertiesChain extends
+	BaseEmptyChain<ElementGetPropertiesChain, Record<string, string>, ElementAbandonedChain>
+{}
+
+/*
+ * @description represents return value of calling "handle" function.
+ */
+interface ElementHandleChain extends
+	BaseEmptyChain<ElementHandleChain, string[], ElementAbandonedChain>
+{}
+
+/*
+ * @description represents return value of calling "getAttributes" function.
+ */
+interface ElementGetAttributesChain extends
+	BaseEmptyChain<ElementGetAttributesChain, Record<string, string>, ElementAbandonedChain>
+{}
+
 interface ElementEvalModifiersWithNegation<T> extends
 	ExistsModifiers<T>,
 	VisibleModifier<T>

package/typeDefinition/constants/Element.d.ts

@@ -86,6 +86,8 @@ export type ElementPropTypes = {
 	EXTENDS:                   'extends',
 	UI_ELEMENT_ID:             'uiElementId',
 	INDEX:                     'index',
+	OFFSET_TOP:                'offsetTop',
+	OFFSET_LEFT:               'offsetLeft',
 };
 
 // Element properties comparators

package/typeDefinition/constants/Vrc.d.ts

@@ -20,6 +20,8 @@ export type VrcConstants = {
 	NUM_7:                   '7',
 	NUM_8:                   '8',
 	NUM_9:                   '9',
+	NEXT:                    'NEXT',
+	PREVIOUS:                'PREVIOUS',
 	FAST_FWD:                'FAST_FWD',
 	REWIND:                  'REWIND',
 	STOP:                    'STOP',

package/typeDefinition/modifiers.d.ts

@@ -241,3 +241,16 @@ export interface ElementMatchModifiers<T> {
 export interface HasExitedModifiers<T> {
 	hasExited(): T;
 }
+
+export interface GetCssModifiers<T> {
+	getCssProperties(properties: string[]): T;
+}
+
+export interface HandleModifier<T> {
+	handle(multiple?: boolean): T;
+	handle(opts?: {multiple?: boolean}): T;
+}
+
+export interface GetAttributesModifier<T> {
+	getAttributes(attributes?: string[]): T;
+}

package/lib/commands/endTest.js

@@ -1,28 +0,0 @@
-/**
- * End test command.
- * This command explicitly closes current test.
- * Can be omitted, in that case test will be closed implicitly with following startTest call or when session ends.
- */
-
-const wsContentTypes = require('../api/wsContentTypes');
-const chainPromise = require('../utils/chainPromise');
-const {commandExecuted, commandWillBeExecuted} = require('../texts');
-
-/**
- * End automated session test, clear test context.
- * @param {Object} instance of main class
- * @returns {ChainablePromise.<void>}
- */
-async function endTest({webSockets, authContext, testContext, logger}) {
-	logger.delayed(commandWillBeExecuted('endTest'));
-	// authorize
-	const authedContent = await authContext.authorizeWs({type: wsContentTypes.endTest}, endTest.name);
-
-	// make ws request
-	await webSockets.send(authedContent);
-
-	testContext.clear();
-	logger.log(commandExecuted('endTest'));
-}
-
-module.exports = chainPromise(endTest);

package/lib/commands/startTest.js

@@ -1,55 +0,0 @@
-/**
- * Start test command.
- * This command allows user to define that all following commands must be recorded as new test.
- * Only relevant for automated test runs.
- */
-
-const util = require('util');
-const wsContentTypes = require('../api/wsContentTypes');
-const {validate, validators} = require('../validation');
-const chainPromise = require('../utils/chainPromise');
-const {testWasStarted, testWillBeStarted, startTestDeprecate} = require('../texts');
-
-/**
- * Start test
- * @info using .startTest with arguments is deprecated
- * @param {Object} instance of main class
- * @param {string} clientTestId - user-defined id of the test, must be unique per test pack
- * @param {string} [name] - human readable name of the test, optional.
- * @param {string} [description] - arbitrary description of the test
- * @throws {SuitestError} - when context of the test run is wrong
- * @returns {ChainablePromise.<void>}
- */
-async function startTest({webSockets, authContext, testContext, logger}, clientTestId, {name, description} = {}) {
-	logger.info(testWillBeStarted(name || clientTestId));
-
-	const content = {
-		clientTestId,
-		name,
-		description,
-	};
-
-	// authorize
-	const authedContent = await authContext.authorizeWs({
-		type: wsContentTypes.startTest,
-	}, startTest.name);
-
-	// make ws request
-	await webSockets.send(authedContent);
-
-	testContext.clear();
-	testContext.setContext(content);
-	logger.info(testWasStarted(name || clientTestId));
-}
-const deprecateStartTest = util.deprecate(startTest, startTestDeprecate());
-
-function startTestWrapper(...args) {
-	// first argument is instance of SUITEST_API
-	if (args.length > 1) {
-		return deprecateStartTest(...args);
-	}
-
-	return startTest(...args);
-}
-
-module.exports = chainPromise(startTestWrapper);

package/lib/commands/startTestPack.js

@@ -1,93 +0,0 @@
-/**
- * Suitest method to start test pack run and generate session token.
- */
-
-const {omit} = require('ramda');
-
-const sessionConstants = require('../constants/session');
-const request = require('../api/request');
-const endpoints = require('../api/endpoints');
-const {validate, validators} = require('../validation');
-const chainPromise = require('../utils/chainPromise');
-const {
-	invalidInputMessage,
-	authFailedAutomated,
-	notWhitelistedIp,
-	testPackWillBeStarted,
-	testPackWasStarted,
-	testPackNotFound,
-} = require('../texts');
-const SuitestError = require('../utils/SuitestError');
-
-/**
- * Start test pack on suitest server by testPackId.
- * Set automated session context on success.
- *
- * @param {Object} instance of main class
- * @param {schema} testPackData
- * @returns {Promise} response object
- */
-async function startTestPack({authContext, webSockets, logger}, testPackData) {
-	const tpData = {
-		includeChangelist: false,
-		...testPackData,
-	};
-
-	logger.delayed(testPackWillBeStarted(tpData.testPackId));
-	// validate authData json
-	validate(
-		validators.START_TEST_PACK,
-		tpData,
-		invalidInputMessage('startTestPack', 'TestPack data'),
-	);
-
-	// if token key and pass explicitly provided, set corresponding access token
-	if ('accessTokenKey' in tpData && 'accessTokenPassword' in tpData) {
-		authContext.setContext(
-			sessionConstants.ACCESS_TOKEN,
-			tpData.accessTokenKey,
-			tpData.accessTokenPassword
-		);
-	}
-
-	// authorize
-	const authedRequestObject = await authContext.authorizeHttp(endpoints.testPackGenTokens, {
-		method: 'POST',
-		body: omit(
-			['testPackId', 'accessTokenKey', 'accessTokenPassword'],
-			tpData
-		),
-	}, {type: SuitestError.AUTH_FAILED});
-
-	// make api request
-	const response = await request(
-		[endpoints.testPackGenTokens, {id: tpData.testPackId}],
-		authedRequestObject,
-		err => new SuitestError(...(
-			err.status === 404
-				? [testPackNotFound(tpData.testPackId), SuitestError.SERVER_ERROR]
-				: (
-					err.status === 403
-						? [notWhitelistedIp(), SuitestError.AUTH_FAILED]
-						: [authFailedAutomated(), SuitestError.AUTH_FAILED]
-				)
-		)),
-	);
-
-	// if success, set interactive session context
-	authContext.setContext(sessionConstants.AUTOMATED, response.deviceAccessToken);
-
-	// authorize ws connection
-	const authedWsConnection = await authContext.authorizeWsConnection({}, startTestPack.name);
-
-	// connect ws
-	await webSockets.connect(authedWsConnection);
-	logger.delayed(testPackWasStarted(tpData.testPackId));
-
-	return response;
-}
-
-module.exports = {
-	startTestPack: chainPromise(startTestPack),
-	startTestPackUnchained: startTestPack,
-};

package/lib/testLauncher/commands/automated.js

@@ -1,70 +0,0 @@
-/**
- * 'automated' test launcher command
- */
-
-const SuitestLauncher = require('../SuitestLauncher');
-const suitest = require('../../../index');
-const {applyCommonArgs} = require('./common');
-const {once} = require('ramda');
-const {composeConfig} = require('../composeConfig');
-
-const command = 'automated';
-
-const describe = 'Automatically start new test pack run and spawn user '
-	+ 'defined test command for each device from the test pack in parallel.';
-
-const builder = yargs => {
-	applyCommonArgs(yargs);
-
-	yargs
-		.option('token-key', {
-			alias: 'k',
-			describe: 'Suitest Token Id, can be generated on the profile page',
-			global: false,
-		})
-		.option('token-id', {
-			describe: 'Suitest Token Id, 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('test-pack-id', {
-			alias: 't',
-			describe: 'Id of the test pack to launch',
-			global: false,
-		})
-		// --config-override	configOverride	no	a JSON object with config override. Format for JSON is same as we have on FE
-		// --vcs-commit-hash	vcsCommitHash	no	a commit hash in version control system. Will be used on the results page
-		// --vcs-branch	vcsBranch	no	a branch name in version control system. Will be used on the results page
-		// --app-version	appVersion	no	an application version. Will be used on the results page
-		// --metadata	metadata	no	any additional data user might want to include. As plain string. Will be displayed on results page
-		.option('concurrency', {
-			alias: 'c',
-			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,
-		});
-};
-
-const handler = async(argv) => {
-	const {ownArgs, userCommandArgs} = await composeConfig(argv, false);
-
-	suitest.configuration.override(ownArgs);
-
-	const suitestLauncher = new SuitestLauncher(ownArgs, userCommandArgs);
-
-	await suitestLauncher.runAutomatedSession();
-};
-
-/* 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/commands/common.js

@@ -1,43 +0,0 @@
-const texts = require('../../texts');
-const logLevels = require('../../constants/logLevels');
-
-/**
- * Apply cli args common for interactive and automated commands
- * @param {*} yargs
- */
-function applyCommonArgs(yargs) {
-	yargs
-		.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',
-		});
-}
-
-module.exports = {
-	applyCommonArgs,
-};

package/lib/testLauncher/commands/interactive.js

@@ -1,70 +0,0 @@
-/**
- * 'interactive' test launcher command
- */
-const SuitestLauncher = require('../SuitestLauncher');
-const suitest = require('../../../index');
-const {applyCommonArgs} = require('./common');
-const {once} = require('ramda');
-const {composeConfig} = require('../composeConfig');
-
-const command = 'interactive';
-
-const describe = 'Run defined test command a single time in interactive session mode on a single device. '
-	+ 'It\'s intended for test authoring and application debugging.';
-
-const builder = yargs => {
-	applyCommonArgs(yargs);
-
-	yargs
-		.option('username', {
-			alias: 'u',
-			describe: 'E-mail you\'re using to login to Suitest',
-			global: false,
-		})
-		.option('password', {
-			alias: 'p',
-			describe: 'Password for your Suitest account.',
-			global: false,
-		})
-		.option('org-id', {
-			alias: 'o',
-			describe: 'Id of the organisation you want to log in into',
-			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('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,
-		});
-};
-
-const handler = async(argv) => {
-	const {ownArgs, userCommandArgs} = await composeConfig(argv, true);
-
-	suitest.configuration.override(ownArgs);
-	const suitestLauncher = new SuitestLauncher(ownArgs, userCommandArgs);
-
-	await suitestLauncher.runInteractiveSession();
-};
-
-/* istanbul ignore next */
-module.exports = {
-	command,
-	describe,
-	builder,
-	// Make sure async handler is called only once (yargs bug)
-	handler: global._suitestTesting ? handler : once(handler),
-};