appium-xcuitest-driver
Version:
Appium driver for iOS using XCUITest for backend
340 lines (322 loc) • 13 kB
JavaScript
import _ from 'lodash';
import {fs, util} from 'appium/support';
import {errors} from 'appium/driver';
import {services} from 'appium-ios-device';
import path from 'node:path';
import B from 'bluebird';
import {
SUPPORTED_EXTENSIONS,
onPostConfigureApp,
onDownloadApp,
} from '../app-utils';
export default {
/**
* Installs the given application to the device under test.
*
* Please ensure the app is built for a correct architecture and is signed with a proper developer signature (for real devices) prior to calling this.
* @param {string} app - See docs for `appium:app` capability
* @param {number} [timeoutMs] - The maximum time to wait until app install is finished (in ms) on real devices.
* If not provided, then the value of `appium:appPushTimeout` capability is used. If the capability is not provided then the default is 240000ms (4 minutes).
* @param {boolean} [checkVersion] - If the application installation follows currently installed application's version status if provided.
* No checking occurs if no this option.
* @privateRemarks Link to capability docs
* @returns {Promise<void>}
* @this {XCUITestDriver}
*/
async mobileInstallApp(app, timeoutMs, checkVersion) {
const srcAppPath = await this.helpers.configureApp(app, {
onPostProcess: onPostConfigureApp.bind(this),
onDownload: onDownloadApp.bind(this),
supportedExtensions: SUPPORTED_EXTENSIONS,
});
this.log.info(
`Installing '${srcAppPath}' to the ${this.isRealDevice() ? 'real device' : 'Simulator'} ` +
`with UDID '${this.device.udid}'`,
);
if (!(await fs.exists(srcAppPath))) {
throw this.log.errorWithException(
`The application at '${srcAppPath}' does not exist or is not accessible`,
);
}
const bundleId = await this.appInfosCache.extractBundleId(srcAppPath);
if (checkVersion) {
const {install} = await this.checkAutInstallationState({
enforceAppInstall: false,
fullReset: false,
noReset: false,
bundleId,
app: srcAppPath,
});
if (!install) {
this.log.info(`Skipping the installation of '${bundleId}'`);
return;
}
}
await this.device.installApp(
srcAppPath,
bundleId,
{
timeoutMs: timeoutMs ?? this.opts.appPushTimeout
},
);
this.log.info(`Installation of '${srcAppPath}' succeeded`);
},
/**
* Checks whether the given application is installed on the device under test.
* Offload app is handled as not installed.
*
* @param {string} bundleId - The bundle identifier of the application to be checked
* @returns {Promise<boolean>} `true` if the application is installed; `false` otherwise
* @this {XCUITestDriver}
*/
async mobileIsAppInstalled(bundleId) {
const installed = await this.device.isAppInstalled(bundleId);
this.log.info(`App '${bundleId}' is${installed ? '' : ' not'} installed`);
return installed;
},
/**
* Removes/uninstalls the given application from the device under test.
* Offload app data could also be removed.
*
* @param {string} bundleId - The bundle identifier of the application to be removed
* @returns {Promise<boolean>} `true` if the application has been removed successfully; `false` otherwise
* @this {XCUITestDriver}
*/
async mobileRemoveApp(bundleId) {
this.log.info(
`Uninstalling the application with bundle identifier '${bundleId}' ` +
`from the ${this.isRealDevice() ? 'real device' : 'Simulator'} with UDID '${this.device.udid}'`,
);
try {
await this.device.removeApp(bundleId);
this.log.info(`Removal of '${bundleId}' succeeded`);
return true;
} catch (err) {
this.log.warn(`Cannot remove '${bundleId}'. Original error: ${err.message}`);
return false;
}
},
/**
* Executes the given app on the device under test.
*
* If the app is already running it will be activated. If the app is not installed or cannot be launched then an exception is thrown.
* @param {string} bundleId - The bundle identifier of the application to be launched
* @param {string|string[]} [args] - One or more command line arguments for the app. If the app is already running then this argument is ignored.
* @param {object} [environment] - Environment variables mapping for the app. If the app is already running then this argument is ignored.
* @returns {Promise<void>}
* @this {XCUITestDriver}
*/
async mobileLaunchApp(bundleId, args, environment) {
/** @type { {arguments?: any[], environment?: any, bundleId: string} } */
const launchOptions = {bundleId};
if (args) {
launchOptions.arguments = Array.isArray(args) ? args : [args];
}
if (environment) {
launchOptions.environment = environment;
}
await this.proxyCommand('/wda/apps/launch', 'POST', launchOptions);
},
/**
* Terminates the given app on the device under test.
*
* This command performs termination via [XCTest's `terminate`](https://developer.apple.com/documentation/xctest/xcuiapplication/1500637-terminate) API. If the app is not installed an exception is thrown. If the app is not running then nothing is done.
* @param {string} bundleId - The bundle identifier of the application to be terminated
* @returns {Promise<boolean>} `true` if the app has been terminated successfully; `false` otherwise
* @this {XCUITestDriver}
*/
async mobileTerminateApp(bundleId) {
return /** @type {boolean} */ (
await this.proxyCommand('/wda/apps/terminate', 'POST', {bundleId})
);
},
/**
* Activate the given app on the device under test.
*
* This pushes the app to the foreground if it is running in the background. An exception is thrown if the app is not install or isn't running. Nothing is done if the app is already in the foreground.
*
* @param {string} bundleId - The bundle identifier of the application to be activated
* @returns {Promise<void>}
* @this {XCUITestDriver}
*/
async mobileActivateApp(bundleId) {
await this.proxyCommand('/wda/apps/activate', 'POST', {bundleId});
},
/**
* Kill the given app on the real device under test by instruments service.
*
* If the app is not running or kill failed, then nothing is done.
*
* @remarks `appium-xcuitest-driver` v4.4 does not require `py-ios-device` to be installed.
* @privateRemarks See implementation at https://github.com/YueChen-C/py-ios-device/blob/51f4683c5c3c385a015858ada07a5f1c62d3cf57/ios_device/cli/base.py#L220
* @see https://github.com/YueChen-C/py-ios-device
* @param {string} bundleId - The bundle identifier of the application to be killed
* @returns {Promise<boolean>} `true` if the app has been killed successfully; `false` otherwise
* @group Real Device Only
* @this {XCUITestDriver}
*/
async mobileKillApp(bundleId) {
if (!this.isRealDevice()) {
throw new errors.UnsupportedOperationError('A real device is required');
}
return await /** @type {import('../real-device').RealDevice} */ (this.device).terminateApp(
bundleId, String(this.opts.platformVersion)
);
},
/**
* Queries the state of an installed application from the device under test.
*
* If the app with the given `bundleId` is not installed, an exception will be thrown.
*
* @param {string} bundleId - The bundle identifier of the application to be queried
* @returns {Promise<AppState>} The actual application state code
* @see https://developer.apple.com/documentation/xctest/xcuiapplicationstate?language=objc
* @this {XCUITestDriver}
*/
async mobileQueryAppState(bundleId) {
return /** @type {AppState} */ (await this.proxyCommand('/wda/apps/state', 'POST', {bundleId}));
},
/**
* @param {string} appPath
* @param {object} opts
* @this {XCUITestDriver}
*/
async installApp(appPath, {timeoutMs, strategy} = {}) {
// @ts-ignore Probably a TS bug
await this.mobileInstallApp(appPath, timeoutMs, strategy);
},
/**
* @param {string} bundleId
* @param {object} opts
* @this {XCUITestDriver}
*/
async activateApp(bundleId, opts = {}) {
const {environment, arguments: args} = opts;
// @ts-ignore Probably a TS bug
return await this.mobileLaunchApp(bundleId, args, environment);
},
/**
* @param {string} bundleId
* @this {XCUITestDriver}
*/
async isAppInstalled(bundleId) {
return await this.mobileIsAppInstalled(bundleId);
},
/**
* @param {string} bundleId
* @this {XCUITestDriver}
* @returns {Promise<boolean>}
*/
async terminateApp(bundleId) {
return await this.mobileTerminateApp(bundleId);
},
/**
* @param {string} bundleId
* @this {XCUITestDriver}
*/
async queryAppState(bundleId) {
return await this.mobileQueryAppState(bundleId);
},
/**
* List applications installed on the real device under test
*
* Read [Pushing/Pulling files](https://appium.io/docs/en/writing-running-appium/ios/ios-xctest-file-movement/) for more details.
* @param {'User'|'System'} applicationType - The type of applications to list.
* @returns {Promise<Record<string,any>[]>} A list of apps where each item is a mapping of bundle identifiers to maps of platform-specific app properties.
* @remarks Having `UIFileSharingEnabled` set to `true` in the return app properties map means this app supports file upload/download in its `documents` container.
* @group Real Device Only
*/
async mobileListApps(applicationType = 'User') {
if (!this.isRealDevice()) {
throw new errors.NotImplementedError(`This extension is only supported on real devices`);
}
const service = await services.startInstallationProxyService(this.device.udid);
try {
return await service.listApplications({applicationType});
} finally {
service.close();
}
},
/**
* Deletes application data files, so it could start from the clean state next time
* it is launched.
* This API only works on a Simulator.
*
* @param {string} bundleId Application bundle identifier
* @this {XCUITestDriver}
* @returns {Promise<boolean>} true if any files from the app's data container have been deleted
*/
async mobileClearApp(bundleId) {
if (this.isRealDevice()) {
throw new errors.NotImplementedError(
`This extension is only supported on simulators. ` +
`The only known way to clear app data on real devices ` +
`would be to uninstall the app then perform a fresh install of it.`
);
}
const simctl = /** @type {import('../driver').Simulator} */ (this.device).simctl;
const dataRoot = await simctl.getAppContainer(bundleId, 'data');
this.log.debug(`Got the data container root of ${bundleId} at '${dataRoot}'`);
if (!await fs.exists(dataRoot)) {
return false;
}
await this.mobileTerminateApp(bundleId);
const items = await fs.readdir(dataRoot);
if (!items.length) {
return false;
}
await B.all(items.map((item) => fs.rimraf(path.join(dataRoot, item))));
this.log.info(
`Cleaned up ${util.pluralize('item', items.length, true)} from ${bundleId}'s data container`
);
return true;
},
/**
* Close app (simulate device home button). It is possible to restore
* the app after the timeout or keep it minimized based on the parameter value.
*
* @param {number|{timeout: number?}} [seconds]
* - any positive number of seconds: come back after X seconds
* - any negative number of seconds or zero: never come back
* - undefined/null: never come back
* - {timeout: 5000}: come back after 5 seconds
* - {timeout: null}, {timeout: -2}: never come back
* @this {XCUITestDriver}
*/
async background(seconds) {
const homescreen = '/wda/homescreen';
const deactivateApp = '/wda/deactivateApp';
let endpoint;
let params = {};
const selectEndpoint = (timeoutSeconds) => {
if (!util.hasValue(timeoutSeconds)) {
endpoint = homescreen;
} else if (!isNaN(timeoutSeconds)) {
const duration = parseFloat(timeoutSeconds);
if (duration >= 0) {
params = {duration};
endpoint = deactivateApp;
} else {
endpoint = homescreen;
}
}
};
if (seconds && !_.isNumber(seconds) && _.has(seconds, 'timeout')) {
const timeout = seconds.timeout;
selectEndpoint(isNaN(Number(timeout)) ? timeout : parseFloat(String(timeout)) / 1000.0);
} else {
selectEndpoint(seconds);
}
if (!endpoint) {
throw new errors.InvalidArgumentError(
`Argument value is expected to be a valid number. ` +
`${JSON.stringify(seconds)} has been provided instead`,
);
}
return await this.proxyCommand(endpoint, 'POST', params, endpoint !== homescreen);
},
};
/**
* @typedef {import('../driver').XCUITestDriver} XCUITestDriver
* @typedef {import('./enum').AppState} AppState
*/