suitest-js-api 2.5.2 → 3.0.3

package/config/index.js

@@ -11,26 +11,27 @@ 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 sentryDsn = 'https://1f74b885d0c44549b57f307733d60351:dd736ff3ac994104ab6635da53d9be2e@sentry.io/288812';
 const DEFAULT_TIMEOUT = 2000;
 
 const overridableFields = [
-	'tokenKey', 'tokenId', 'tokenPassword', 'testPackId', 'concurrency', // launcher automated
-	'username', 'password', 'orgId', 'deviceId', 'appConfigId', 'inspect', 'inspectBrk', // launcher intaractive
-	'logLevel', 'logDir', 'timestamp', 'configFile', 'disallowCrashReports', 'defaultTimeout', // launcher common
+	'tokenId', 'tokenPassword', 'concurrency', 'preset', 'presets', 'deviceId', 'appConfigId', 'inspect', 'inspectBrk',
+	'logLevel', 'logDir', 'timestamp', 'configFile', 'disallowCrashReports', 'defaultTimeout', 'screenshotDir',
+	'includeChangelist',
 ];
 
-const configurableFields = ['logLevel', 'disallowCrashReports', 'defaultTimeout'];
+const serverAddress = process.env[envVars.SUITEST_BE_SERVER] || 'the.suite.st';
 
 const main = Object.freeze({
-	apiUrl: 'https://the.suite.st/api/public/v3',
+	apiUrl: `https://${serverAddress}/api/public/v4`,
 	disallowCrashReports: false,
 	logLevel: logLevels.normal,
 	sentryDsn,
 	timestamp: timestamp.default,
 	defaultTimeout: DEFAULT_TIMEOUT,
-	wsUrl: 'wss://the.suite.st/api/public/v3/socket',
+	wsUrl: `wss://${serverAddress}/api/public/v4/socket`,
 });
 
 const test = Object.freeze({
@@ -69,7 +70,6 @@ const configFactory = () => {
 	return {
 		config,
 		overridableFields,
-		configurableFields,
 		extend,
 		override,
 	};

package/index.d.ts

@@ -47,25 +47,15 @@ export = suitest;
 
 declare namespace suitest {
 	export interface ISuitestBase extends NodeJS.EventEmitter {
-		startTestPack(options: StartTestPackOptions): Promise<StartTestPackResult|SuitestError>;
 		openSession(options: OpenSessionOptions): Promise<OpenSessionResult|SuitestError>;
 		closeSession(): Promise<object|SuitestError>;
 		setAppConfig(configId: string, options?: ConfigOverride): Promise<void|SuitestError>;
 		pairDevice(deviceId: string): Promise<DeviceData|SuitestError>;
 		releaseDevice(): Promise<void|SuitestError>;
-		// @deprecated use startTest without arguments
-		startTest(clientTestId: string, options?: StartTestOptions): Promise<void|SuitestError>;
-		startTest(): Promise<void|SuitestError>;
-		endTest(): Promise<void|SuitestError>;
-		interactive(options: ReplOptions): Promise<void>;
+		startREPL(options?: ReplOptions): Promise<void>;
 
 		// config
 		getConfig(): ConfigureOptions;
-
-		/**
-		 * @deprecated use separate methods for changing configuration properties
-		 */
-		configure(config: Partial<ConfigureOptions>): void;
 		setDefaultTimeout(timeout: ConfigureOptions['defaultTimeout']): void;
 		setContinueOnFatalError(continueOnFatalError: ConfigureOptions['continueOnFatalError']): void;
 		setDisallowCrashReports(disallowCrashReports: ConfigureOptions['disallowCrashReports']): void;
@@ -76,7 +66,7 @@ declare namespace suitest {
 		application(): ApplicationChain;
 		clearAppData(): ClearAppDataChain;
 		cookie(cookieName: string): CookieChain;
-		element(elementSelector: ElementSelector | string): ElementChain;
+		element(elementSelector: ElementSelector[] | ElementSelector | string): ElementChain;
 		video(): VideoChain;
 		psVideo(): PlayStationVideoChain;
 		executeCommand(jsCode: string): ExecuteCommandChain;
@@ -110,10 +100,18 @@ declare namespace suitest {
 
 		/**
 		 * @description the complete path to the file name where the screenshot should be saved.
+		 *  Can be defined as string with placeholders, for example default path
+		 *  to screenshots folder looks like {screenshotDir}/{dateTime}-{currentFile}-l{currentLine}.png.
+		 *  Available placeholders:
+		 *  - screenshotDir - default value is "screenshots"
+		 *  - dateTime - time when saving screenshot happens in YYYY-MM-DD-HH-mm-ss-SSS format
+		 *  - currentFile - file where saving screenshot requested
+		 *  - currentLine - line of code where saving screenshot requested
 		 * @example
 		 * suitest.saveScreenshot('/path/to/file.png');
+		 * suitest.saveScreenshot('{screenshotDir}/{dateTime}-{currentFile}-l{currentLine}.png');
 		 */
-		saveScreenshot(fileName: string): TakeScreenshotChain<void>;
+		saveScreenshot(fileName?: string): TakeScreenshotChain<void>;
 
 		getPairedDevice(): null | {
 			deviceId: string,
@@ -128,7 +126,7 @@ declare namespace suitest {
 			inactivityTimeout?: number,
 			status: string,
 			displayName?: string,
-			shortDisplayName?: string
+			shortDisplayName?: string,
 		}
 
 		// constants
@@ -154,7 +152,6 @@ declare namespace suitest {
 		authContext: AuthContext;
 		appContext: Context;
 		pairedDeviceContext: Context;
-		testContext: Context;
 
 		on(eventName: 'consoleLog', listener: (consoleLog: ConsoleLogEvent) => void): this;
 		on(eventName: 'networkLog', listener: (networkLog: NetworkLogEvent) => void): this;
@@ -173,7 +170,7 @@ declare namespace suitest {
 		application(): ApplicationChain;
 		clearAppData(): ClearAppDataChain;
 		cookie(cookieName: string): CookieChain;
-		element(elementSelector: ElementSelector | string): ElementChain;
+		element(elementSelector: ElementSelector[] | ElementSelector | string): Omit<ElementChain, 'getCssProperties' | 'handle' | 'getAttributes'>;
 		video(): VideoChain;
 		psVideo(): PlayStationVideoChain;
 		executeCommand(jsCode: string): ExecuteCommandChain;
@@ -247,7 +244,7 @@ declare namespace suitest {
 		url?: string;
 		suitestify?: boolean;
 		domainList?: string[];
-		freezeRules?: Array<{
+		mapRules?: Array<{
 			methods: string[];
 			url: string;
 			type: string;
@@ -262,56 +259,13 @@ declare namespace suitest {
 		[key: string]: any; // user should have ability to pass any property to config object
 	}
 
-	interface StartTestPackOptions {
-		testPackId: number;
-		accessTokenKey: string;
-		accessTokenPassword: string;
-		config?: ConfigOverride;
-		metadata?: {
-			version?: string;
-			hash?: string;
-			link?: string;
-		},
-		commitHash?: string;
-		appVersion?: string;
-		vcsBranch?: string;
-		allowServiceCalls?: boolean;
-		includeChangelist?: boolean;
-	}
-
-	interface StartTestPackResult {
-		deviceAccessToken: string;
-		tokenValidUntil: string;
-		testPackRunId: string;
-		testPack: {
-			name: string;
-			models: Array<{
-				modelId: string;
-				firmware: string;
-			}>,
-			devices: Array<{deviceId: string}>;
-		}
-	}
-
 	type OpenSessionOptions = {
-		username: string;
-		password: string;
-		orgId: string;
-	} | {
-		sessionToken: string;
-	} | {
-		accessTokenKey: string;
-		accessTokenPassword: string;
+		tokenId: string;
+		tokenPassword: string;
 	}
 
 	interface OpenSessionResult {
-		deviceAccessToken: string;
-		tokenValidUntil: string;
-	}
-
-	interface StartTestOptions {
-		name?: string;
-		description?: string;
+		accessToken: string;
 	}
 
 	interface ConfigureOptions {
@@ -321,13 +275,9 @@ declare namespace suitest {
 		defaultTimeout: number;
 	}
 
-	interface ResponseError {
-		errorType: string;
-	}
-
 	interface Context {
-		context: any;
-		setContext(context: symbol): void;
+		context: unknown;
+		setContext(context: unknown): void;
 		clear(): void;
 	}
 
@@ -354,14 +304,16 @@ declare namespace suitest {
 		apiId?: string;
 		css?: string,
 		xpath?: string,
+		handle?: string,
 		attributes?: string,
 		text?: string,
+		linkText?: string,
+		partialLinkText?: string,
 		position?: string,
 		size?: string,
 		color?: string,
 		index?: number,
-		video?: true,
-		psVideo?: true,
+		active?: true,
 	}
 
 	type ScreenOrientationValues =

package/lib/api/endpoints.js

@@ -5,24 +5,17 @@
  */
 
 const endpoints = {
-	session:               '/get-interactive-device-access-token',
-	sessionClose:          '/invalidate-token',
-	testPackGenTokens:     '/test-packs/:id/get-device-access-token',
 	apps:                  '/apps',
 	appById:               '/apps/:appId',
 	appTags:               '/apps/:appId/tags',
 	appConfigs:            '/apps/:appId/configs',
 	appConfigById:         '/apps/:appId/configs/:configId',
-	appTestPacks:          '/apps/:appId/test-packs',
-	appTestPackById:       '/apps/:appId/test-packs/:testPackId',
 	appTestDefinitions:    '/apps/:appId/test-definitions',
 	appTestDefinitionById: '/apps/:appId/versions/:versionId/tests/:testId',
 	devices:               '/devices',
 	testRun:               '/test-run',
 	testRunById:           '/test-run/:testRunId',
 	testRunOnDevice:       '/test-run/:testRunId/device/:deviceId',
-	testPackRun:           '/test-pack-run',
-	testPackRunById:       '/test-pack-run/:testPackRunId',
 };
 
 Object.freeze(endpoints);

package/lib/api/webSockets.js

@@ -11,7 +11,7 @@ const fetch = require('node-fetch');
 
 const SuitestError = require('../utils/SuitestError');
 const texts = require('../texts');
-const {handleProgress} = require('../utils/interactiveProgressHandler');
+const {handleProgress} = require('../utils/progressHandler');
 const {getInfoErrorMessage} = require('../utils/socketErrorMessages');
 const {translateNotStartedReason} = require('../utils/translateResults');
 const logLevels = require('../../lib/constants/logLevels');

package/lib/api/wsContentTypes.js

@@ -3,10 +3,8 @@
  */
 
 const contentTypes = {
-	endTest: 'endTest',
 	pairDevice: 'connectDevice',
 	releaseDevice: 'releaseDevice',
-	startTest: 'startTest',
 	selectConfiguration: 'selectConfiguration',
 	enableDebugMode: 'enableDebugMode',
 	query: 'query',

package/lib/chains/elementChain.js

@@ -32,10 +32,12 @@ const {
 	makeToJSONComposer,
 	untilComposer,
 	visibleComposer,
+	handleComposer,
+	attributesComposer,
+	cssPropsComposer,
 } = require('../composers');
 const {
 	invalidInputMessage,
-	warnVideoAsElementDeprecation,
 	assertElementMalformed,
 } = require('../texts');
 const {validate, validators} = require('../validation');
@@ -52,6 +54,29 @@ const {
 	applyUntilCondition,
 } = require('../utils/chainUtils');
 
+const replaceIndexByIfMultipleFoundReturn = (selector) => {
+	if (Reflect.has(selector, 'index')) {
+		const result = {...selector};
+
+		result.ifMultipleFoundReturn = result.index;
+		delete result.index;
+
+		return result;
+	}
+
+	return selector;
+};
+
+const processElementSelector = (selector) => {
+	const processObjectSelector = (s) => replaceIndexByIfMultipleFoundReturn(omit(['apiId'], s));
+
+	if (Array.isArray(selector)) {
+		return selector.map(processObjectSelector);
+	}
+
+	return processObjectSelector(selector);
+};
+
 const elementFactory = (classInstance, video) => {
 	const toJSON = data => {
 		const type = getRequestType(data);
@@ -60,15 +85,10 @@ const elementFactory = (classInstance, video) => {
 			type: 'element',
 		};
 		const apiId = data.selector.apiId;
-		const selectors = omit(['apiId'], data.selector);
-
-		if (Reflect.has(selectors, 'index')) {
-			selectors.ifMultipleFoundReturn = selectors.index;
-			delete selectors.index;
-		}
+		const selectors = processElementSelector(data.selector);
 
 		if (apiId) {
-			subject.apiId = apiId; // not yet supported by network api
+			subject.apiId = apiId;
 		} else {
 			subject.val = selectors;
 		}
@@ -76,9 +96,22 @@ const elementFactory = (classInstance, video) => {
 		// query
 		if (type === 'query') {
 			socketMessage.subject = {
-				type: 'elementProps',
-				selector: apiId ? data.selector : selectors,
+				selector: apiId
+					? data.selector
+					: selectors,
 			};
+			if (data.handle) {
+				socketMessage.subject.type = 'elementHandle';
+				socketMessage.subject.multiple = data.handle.multiple;
+			} else if (data.attributes) {
+				socketMessage.subject.type = 'elementAttributes';
+				socketMessage.subject.attributes = data.attributes;
+			} else if (data.cssProps) {
+				socketMessage.subject.type = 'elementCssProps';
+				socketMessage.subject.elementCssProps = data.cssProps;
+			} else {
+				socketMessage.subject.type = 'elementProps';
+			}
 		}
 
 		// click and tap
@@ -178,6 +211,25 @@ const elementFactory = (classInstance, video) => {
 			output.push(assertComposer);
 		}
 
+		// should check that no any composer was applied to current chain (should be empty).
+		if (!data.isNegated
+			&& !data.isAssert
+			&& !data.isClick
+			&& !data.tap
+			&& !data.isSwipe
+			&& !data.isScroll
+			&& !data.isMoveTo
+			&& isNil(data.sendText)
+			&& isNil(data.setText)
+			&& !data.comparator
+			&& !data.timeout
+			&& !data.handle
+			&& !data.attributes
+			&& !data.cssProps
+		) {
+			output.push(cssPropsComposer, handleComposer, attributesComposer);
+		}
+
 		if (!data.isNegated
 			&& !data.isClick
 			&& !data.tap
@@ -188,6 +240,9 @@ const elementFactory = (classInstance, video) => {
 			&& isNil(data.setText)
 			&& !isMatchesComparator
 			&& !isVisibleComparator
+			&& !data.handle
+			&& !data.cssProps
+			&& !data.attributes
 		) {
 			output.push(notComposer);
 		}
@@ -205,6 +260,9 @@ const elementFactory = (classInstance, video) => {
 			&& !data.tap
 			&& isNil(data.sendText)
 			&& isNil(data.setText)
+			&& !data.handle
+			&& !data.cssProps
+			&& !data.attributes
 		) {
 			output.push(timeoutComposer);
 		}
@@ -218,6 +276,9 @@ const elementFactory = (classInstance, video) => {
 			&& !data.isScroll
 			&& isNil(data.sendText)
 			&& isNil(data.setText)
+			&& !data.handle
+			&& !data.cssProps
+			&& !data.attributes
 		) {
 			output.push(existComposer, visibleComposer);
 			if (!data.isNegated) {
@@ -238,6 +299,9 @@ const elementFactory = (classInstance, video) => {
 			&& isNil(data.sendText)
 			&& isNil(data.setText)
 			&& !data.isNegated
+			&& !data.handle
+			&& !data.cssProps
+			&& !data.attributes
 		) {
 			output.push(
 				clickComposer,
@@ -267,27 +331,34 @@ const elementFactory = (classInstance, video) => {
 		return output;
 	};
 
-	const deprecatedVideo = util.deprecate(video, warnVideoAsElementDeprecation());
-
 	const elementChain = elementSelector => {
 		const selector = typeof elementSelector === 'string' ? {apiId: elementSelector} : elementSelector;
 
-		if (selector && selector.video && Object.keys(selector).length === 1) {
-			return deprecatedVideo();
+		if (Array.isArray(selector)) {
+			selector.forEach(selectorItem => {
+				validate(
+					validators.ELEMENT_SELECTOR,
+					selectorItem,
+					invalidInputMessage('element', 'Element selector'),
+				);
+			});
+		} else {
+			validate(
+				validators.ELEMENT_SELECTOR,
+				selector,
+				invalidInputMessage('element', 'Element selector'),
+			);
 		}
 
 		return makeChain(classInstance, getComposers, {
 			type: 'element',
-			selector: validate(
-				validators.ELEMENT_SELECTOR,
-				selector,
-				invalidInputMessage('element', 'Element selector')),
+			selector,
 		});
 	};
 
 	return {
 		element: elementChain,
-		elementAssert: elementSelector => elementChain(elementSelector).toAssert(),
+		elementAssert: (selectors) => elementChain(selectors).toAssert(),
 
 		// For testing
 		getComposers,

package/lib/chains/saveScreenshotChain.js

@@ -1,3 +1,5 @@
+const path = require('path');
+const moment = require('moment');
 const makeChain = require('../utils/makeChain');
 const {
 	makeToStringComposer,
@@ -7,8 +9,55 @@ const {
 } = require('../composers');
 const t = require('../texts');
 const {validate, validators} = require('../validation');
+const {getFirstNotSuitestStackItem} = require('../utils/stackTraceParser');
+const {DEFAULT_SCREENSHOT_DIR} = require('../constants');
+
+const PATH_PLACEHOLDERS = ['screenshotDir', 'dateTime', 'currentFile', 'currentLine'];
+// /{(screenshotDir|dateTime|currentFile|currentLine)}/
+const CONTAINS_PLACEHOLDER_REGEX = new RegExp(
+	'{(' + PATH_PLACEHOLDERS.join('|') + ')}', 'g',
+);
+// '{screenshotDir}/{dateTime}-{currentFile}-l{currentLine}.png'
+const DEFAULT_PATH = path.join('{screenshotDir}', '{dateTime}-{currentFile}-l{currentLine}.png');
+
+/**
+ * @description checks that path contains any of placeholders
+ * @param {string} path
+ * @returns {boolean}
+ */
+function pathContainsPlaceholders(path) {
+	return !!path.match(CONTAINS_PLACEHOLDER_REGEX);
+}
 
 const saveScreenshotFactory = (classInstance) => {
+	function getPlaceholdersValues(date = new Date()) {
+		const userStackItem = getFirstNotSuitestStackItem();
+
+		return {
+			screenshotDir: path.resolve(
+				process.cwd(),
+				classInstance.config.screenshotDir || DEFAULT_SCREENSHOT_DIR,
+			),
+			// example: 2021-09-06-13-40-29-954
+			dateTime: moment(date).format('YYYY-MM-DD-HH-mm-ss-SSS'),
+			currentFile: path.basename(userStackItem.file),
+			currentLine: userStackItem.line,
+		};
+	}
+
+	function processFilePath(filePath) {
+		if (pathContainsPlaceholders(filePath)) {
+			const placeholdersValues = getPlaceholdersValues();
+
+			return filePath.replace(
+				CONTAINS_PLACEHOLDER_REGEX,
+				(_matching, value) => placeholdersValues[value],
+			);
+		}
+
+		return filePath;
+	}
+
 	const toJSON = () => ({type: 'takeScreenshot'});
 
 	const toStringComposer = makeToStringComposer(toJSON);
@@ -32,20 +81,26 @@ const saveScreenshotFactory = (classInstance) => {
 	/**
 	 * @param {string} fileName
 	 */
-	const saveScreenshotChain = (fileName) => makeChain(classInstance, getComposers, {
-		type: 'takeScreenshot',
-		fileName: validate(
+	const saveScreenshotChain = (fileName = DEFAULT_PATH) => {
+		validate(
 			validators.NON_EMPTY_STRING,
 			fileName,
 			t.invalidInputMessage('saveScreenshot', 'File name'),
-		),
-	});
+		);
+
+		return makeChain(classInstance, getComposers, {
+			type: 'takeScreenshot',
+			fileName: processFilePath(fileName),
+		});
+	};
 
 	return {
 		saveScreenshot: saveScreenshotChain,
 		// For Unit Testing
 		getComposers,
 		toJSON,
+		getPlaceholdersValues,
+		processFilePath,
 	};
 };
 

package/lib/commands/closeSession.js

@@ -1,46 +1,21 @@
 /**
- * Close session suitest method allows user to invalidate session token and clear current auth context.
+ * Close session suitest method that clear current auth context.
  */
 
-const request = require('../api/request');
-const endpoints = require('../api/endpoints');
 const ipcClient = require('../testLauncher/ipc/client');
 const ipcServer = require('../testLauncher/ipc/server');
 const chainPromise = require('../utils/chainPromise');
-const SuitestError = require('../utils/SuitestError');
-const {authNotAllowed, sessionClosed, sessionClosing} = require('../texts');
-const envVars = require('../constants/enviroment');
+const {sessionClosed, sessionClosing} = require('../texts');
 
 /**
- * Invalidate session token on server side.
- * Clear current auth context.
+ * @description Clear current auth context.
  * @param {Object} instance of main class
  * @returns {Promise} response object
  */
 async function closeSession({webSockets, authContext, appContext, logger}) {
 	logger.delayed(sessionClosing());
 
-	// don't invalidate tokens in test launcher child processes
-	if (!process.env[envVars.SUITEST_CHILD_PROCESS]) {
-		// authorize and make api request
-		const authedRequestObject = await authContext.authorizeHttp(endpoints.sessionClose, {
-			method: 'POST',
-			body: {
-				token: authContext.getToken(),
-			},
-		}, {commandName: closeSession.name});
-
-		await request(
-			endpoints.sessionClose,
-			authedRequestObject,
-			() => new SuitestError(
-				authNotAllowed(closeSession.name),
-				SuitestError.AUTH_NOT_ALLOWED
-			)
-		);
-	}
-
-	// if success, clear session context, disconnect ws
+	// if success, clear auth context, disconnect ws
 	webSockets.disconnect();
 	ipcClient.disconnect();
 	ipcServer.close();