初始化提交
This commit is contained in:
466
lib/xcodebuild.js
Normal file
466
lib/xcodebuild.js
Normal file
@@ -0,0 +1,466 @@
|
||||
import { retryInterval } from 'asyncbox';
|
||||
import { SubProcess, exec } from 'teen_process';
|
||||
import { logger, timing } from '@appium/support';
|
||||
import defaultLogger from './logger';
|
||||
import B from 'bluebird';
|
||||
import {
|
||||
setRealDeviceSecurity, setXctestrunFile,
|
||||
updateProjectFile, resetProjectFile, killProcess,
|
||||
getWDAUpgradeTimestamp, isTvOS
|
||||
} from './utils';
|
||||
import _ from 'lodash';
|
||||
import path from 'path';
|
||||
import { WDA_RUNNER_BUNDLE_ID } from './constants';
|
||||
|
||||
|
||||
const DEFAULT_SIGNING_ID = 'iPhone Developer';
|
||||
const PREBUILD_DELAY = 0;
|
||||
const RUNNER_SCHEME_IOS = 'WebDriverAgentRunner';
|
||||
const LIB_SCHEME_IOS = 'WebDriverAgentLib';
|
||||
|
||||
const ERROR_WRITING_ATTACHMENT = 'Error writing attachment data to file';
|
||||
const ERROR_COPYING_ATTACHMENT = 'Error copying testing attachment';
|
||||
const IGNORED_ERRORS = [
|
||||
ERROR_WRITING_ATTACHMENT,
|
||||
ERROR_COPYING_ATTACHMENT,
|
||||
'Failed to remove screenshot at path',
|
||||
];
|
||||
const IGNORED_ERRORS_PATTERN = new RegExp(
|
||||
'(' +
|
||||
IGNORED_ERRORS
|
||||
.map((errStr) => _.escapeRegExp(errStr))
|
||||
.join('|') +
|
||||
')'
|
||||
);
|
||||
|
||||
const RUNNER_SCHEME_TV = 'WebDriverAgentRunner_tvOS';
|
||||
const LIB_SCHEME_TV = 'WebDriverAgentLib_tvOS';
|
||||
|
||||
const REAL_DEVICES_CONFIG_DOCS_LINK = 'https://appium.github.io/appium-xcuitest-driver/latest/preparation/real-device-config/';
|
||||
|
||||
const xcodeLog = logger.getLogger('Xcode');
|
||||
|
||||
|
||||
export class XcodeBuild {
|
||||
/** @type {SubProcess} */
|
||||
xcodebuild;
|
||||
|
||||
/**
|
||||
* @param {import('appium-xcode').XcodeVersion} xcodeVersion
|
||||
* @param {any} device
|
||||
* // TODO: make args typed
|
||||
* @param {import('@appium/types').StringRecord} [args={}]
|
||||
* @param {import('@appium/types').AppiumLogger?} [log=null]
|
||||
*/
|
||||
constructor (xcodeVersion, device, args = {}, log = null) {
|
||||
this.xcodeVersion = xcodeVersion;
|
||||
|
||||
this.device = device;
|
||||
this.log = log ?? defaultLogger;
|
||||
|
||||
this.realDevice = args.realDevice;
|
||||
|
||||
this.agentPath = args.agentPath;
|
||||
this.bootstrapPath = args.bootstrapPath;
|
||||
|
||||
this.platformVersion = args.platformVersion;
|
||||
this.platformName = args.platformName;
|
||||
this.iosSdkVersion = args.iosSdkVersion;
|
||||
|
||||
this.showXcodeLog = args.showXcodeLog;
|
||||
|
||||
this.xcodeConfigFile = args.xcodeConfigFile;
|
||||
this.xcodeOrgId = args.xcodeOrgId;
|
||||
this.xcodeSigningId = args.xcodeSigningId || DEFAULT_SIGNING_ID;
|
||||
this.keychainPath = args.keychainPath;
|
||||
this.keychainPassword = args.keychainPassword;
|
||||
|
||||
this.prebuildWDA = args.prebuildWDA;
|
||||
this.usePrebuiltWDA = args.usePrebuiltWDA;
|
||||
this.useSimpleBuildTest = args.useSimpleBuildTest;
|
||||
|
||||
this.useXctestrunFile = args.useXctestrunFile;
|
||||
|
||||
this.launchTimeout = args.launchTimeout;
|
||||
|
||||
this.wdaRemotePort = args.wdaRemotePort;
|
||||
|
||||
this.updatedWDABundleId = args.updatedWDABundleId;
|
||||
this.derivedDataPath = args.derivedDataPath;
|
||||
|
||||
this.mjpegServerPort = args.mjpegServerPort;
|
||||
|
||||
this.prebuildDelay = _.isNumber(args.prebuildDelay) ? args.prebuildDelay : PREBUILD_DELAY;
|
||||
|
||||
this.allowProvisioningDeviceRegistration = args.allowProvisioningDeviceRegistration;
|
||||
|
||||
this.resultBundlePath = args.resultBundlePath;
|
||||
this.resultBundleVersion = args.resultBundleVersion;
|
||||
|
||||
this._didBuildFail = false;
|
||||
this._didProcessExit = false;
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @param {any} noSessionProxy
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
async init (noSessionProxy) {
|
||||
this.noSessionProxy = noSessionProxy;
|
||||
|
||||
if (this.useXctestrunFile) {
|
||||
const deviveInfo = {
|
||||
isRealDevice: this.realDevice,
|
||||
udid: this.device.udid,
|
||||
platformVersion: this.platformVersion,
|
||||
platformName: this.platformName
|
||||
};
|
||||
this.xctestrunFilePath = await setXctestrunFile(deviveInfo, this.iosSdkVersion, this.bootstrapPath, this.wdaRemotePort);
|
||||
return;
|
||||
}
|
||||
|
||||
// if necessary, update the bundleId to user's specification
|
||||
if (this.realDevice) {
|
||||
// In case the project still has the user specific bundle ID, reset the project file first.
|
||||
// - We do this reset even if updatedWDABundleId is not specified,
|
||||
// since the previous updatedWDABundleId test has generated the user specific bundle ID project file.
|
||||
// - We don't call resetProjectFile for simulator,
|
||||
// since simulator test run will work with any user specific bundle ID.
|
||||
await resetProjectFile(this.agentPath);
|
||||
if (this.updatedWDABundleId) {
|
||||
await updateProjectFile(this.agentPath, this.updatedWDABundleId);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @returns {Promise<string|undefined>}
|
||||
*/
|
||||
async retrieveDerivedDataPath () {
|
||||
if (this.derivedDataPath) {
|
||||
return this.derivedDataPath;
|
||||
}
|
||||
|
||||
// avoid race conditions
|
||||
if (this._derivedDataPathPromise) {
|
||||
return await this._derivedDataPathPromise;
|
||||
}
|
||||
|
||||
this._derivedDataPathPromise = (async () => {
|
||||
let stdout;
|
||||
try {
|
||||
({stdout} = await exec('xcodebuild', ['-project', this.agentPath, '-showBuildSettings']));
|
||||
} catch (err) {
|
||||
this.log.warn(`Cannot retrieve WDA build settings. Original error: ${err.message}`);
|
||||
return;
|
||||
}
|
||||
|
||||
const pattern = /^\s*BUILD_DIR\s+=\s+(\/.*)/m;
|
||||
const match = pattern.exec(stdout);
|
||||
if (!match) {
|
||||
this.log.warn(`Cannot parse WDA build dir from ${_.truncate(stdout, {length: 300})}`);
|
||||
return;
|
||||
}
|
||||
this.log.debug(`Parsed BUILD_DIR configuration value: '${match[1]}'`);
|
||||
// Derived data root is two levels higher over the build dir
|
||||
this.derivedDataPath = path.dirname(path.dirname(path.normalize(match[1])));
|
||||
this.log.debug(`Got derived data root: '${this.derivedDataPath}'`);
|
||||
return this.derivedDataPath;
|
||||
})();
|
||||
return await this._derivedDataPathPromise;
|
||||
}
|
||||
|
||||
/**
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
async reset () {
|
||||
// if necessary, reset the bundleId to original value
|
||||
if (this.realDevice && this.updatedWDABundleId) {
|
||||
await resetProjectFile(this.agentPath);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
async prebuild () {
|
||||
// first do a build phase
|
||||
this.log.debug('Pre-building WDA before launching test');
|
||||
this.usePrebuiltWDA = true;
|
||||
await this.start(true);
|
||||
|
||||
if (this.prebuildDelay > 0) {
|
||||
// pause a moment
|
||||
await B.delay(this.prebuildDelay);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
async cleanProject () {
|
||||
const libScheme = isTvOS(this.platformName) ? LIB_SCHEME_TV : LIB_SCHEME_IOS;
|
||||
const runnerScheme = isTvOS(this.platformName) ? RUNNER_SCHEME_TV : RUNNER_SCHEME_IOS;
|
||||
|
||||
for (const scheme of [libScheme, runnerScheme]) {
|
||||
this.log.debug(`Cleaning the project scheme '${scheme}' to make sure there are no leftovers from previous installs`);
|
||||
await exec('xcodebuild', [
|
||||
'clean',
|
||||
'-project', this.agentPath,
|
||||
'-scheme', scheme,
|
||||
]);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @param {boolean} [buildOnly=false]
|
||||
* @returns {{cmd: string, args: string[]}}
|
||||
*/
|
||||
getCommand (buildOnly = false) {
|
||||
const cmd = 'xcodebuild';
|
||||
/** @type {string[]} */
|
||||
const args = [];
|
||||
|
||||
// figure out the targets for xcodebuild
|
||||
const [buildCmd, testCmd] = this.useSimpleBuildTest ? ['build', 'test'] : ['build-for-testing', 'test-without-building'];
|
||||
if (buildOnly) {
|
||||
args.push(buildCmd);
|
||||
} else if (this.usePrebuiltWDA || this.useXctestrunFile) {
|
||||
args.push(testCmd);
|
||||
} else {
|
||||
args.push(buildCmd, testCmd);
|
||||
}
|
||||
|
||||
if (this.allowProvisioningDeviceRegistration) {
|
||||
// To -allowProvisioningDeviceRegistration flag takes effect, -allowProvisioningUpdates needs to be passed as well.
|
||||
args.push('-allowProvisioningUpdates', '-allowProvisioningDeviceRegistration');
|
||||
}
|
||||
|
||||
if (this.resultBundlePath) {
|
||||
args.push('-resultBundlePath', this.resultBundlePath);
|
||||
}
|
||||
|
||||
if (this.resultBundleVersion) {
|
||||
args.push('-resultBundleVersion', this.resultBundleVersion);
|
||||
}
|
||||
|
||||
if (this.useXctestrunFile && this.xctestrunFilePath) {
|
||||
args.push('-xctestrun', this.xctestrunFilePath);
|
||||
} else {
|
||||
const runnerScheme = isTvOS(this.platformName) ? RUNNER_SCHEME_TV : RUNNER_SCHEME_IOS;
|
||||
args.push('-project', this.agentPath, '-scheme', runnerScheme);
|
||||
if (this.derivedDataPath) {
|
||||
args.push('-derivedDataPath', this.derivedDataPath);
|
||||
}
|
||||
}
|
||||
args.push('-destination', `id=${this.device.udid}`);
|
||||
|
||||
const versionMatch = new RegExp(/^(\d+)\.(\d+)/).exec(this.platformVersion);
|
||||
if (versionMatch) {
|
||||
args.push(
|
||||
`${isTvOS(this.platformName) ? 'TV' : 'IPHONE'}OS_DEPLOYMENT_TARGET=${versionMatch[1]}.${versionMatch[2]}`
|
||||
);
|
||||
} else {
|
||||
this.log.warn(`Cannot parse major and minor version numbers from platformVersion "${this.platformVersion}". ` +
|
||||
'Will build for the default platform instead');
|
||||
}
|
||||
|
||||
if (this.realDevice) {
|
||||
if (this.xcodeConfigFile) {
|
||||
this.log.debug(`Using Xcode configuration file: '${this.xcodeConfigFile}'`);
|
||||
args.push('-xcconfig', this.xcodeConfigFile);
|
||||
}
|
||||
if (this.xcodeOrgId && this.xcodeSigningId) {
|
||||
args.push(
|
||||
`DEVELOPMENT_TEAM=${this.xcodeOrgId}`,
|
||||
`CODE_SIGN_IDENTITY=${this.xcodeSigningId}`,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
if (!process.env.APPIUM_XCUITEST_TREAT_WARNINGS_AS_ERRORS) {
|
||||
// This sometimes helps to survive Xcode updates
|
||||
args.push('GCC_TREAT_WARNINGS_AS_ERRORS=0');
|
||||
}
|
||||
|
||||
// Below option slightly reduces build time in debug build
|
||||
// with preventing to generate `/Index/DataStore` which is used by development
|
||||
args.push('COMPILER_INDEX_STORE_ENABLE=NO');
|
||||
|
||||
return {cmd, args};
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {boolean} [buildOnly=false]
|
||||
* @returns {Promise<SubProcess>}
|
||||
*/
|
||||
async createSubProcess (buildOnly = false) {
|
||||
if (!this.useXctestrunFile && this.realDevice) {
|
||||
if (this.keychainPath && this.keychainPassword) {
|
||||
await setRealDeviceSecurity(this.keychainPath, this.keychainPassword);
|
||||
}
|
||||
}
|
||||
|
||||
const {cmd, args} = this.getCommand(buildOnly);
|
||||
this.log.debug(`Beginning ${buildOnly ? 'build' : 'test'} with command '${cmd} ${args.join(' ')}' ` +
|
||||
`in directory '${this.bootstrapPath}'`);
|
||||
/** @type {Record<string, any>} */
|
||||
const env = Object.assign({}, process.env, {
|
||||
USE_PORT: this.wdaRemotePort,
|
||||
WDA_PRODUCT_BUNDLE_IDENTIFIER: this.updatedWDABundleId || WDA_RUNNER_BUNDLE_ID,
|
||||
});
|
||||
if (this.mjpegServerPort) {
|
||||
// https://github.com/appium/WebDriverAgent/pull/105
|
||||
env.MJPEG_SERVER_PORT = this.mjpegServerPort;
|
||||
}
|
||||
const upgradeTimestamp = await getWDAUpgradeTimestamp();
|
||||
if (upgradeTimestamp) {
|
||||
env.UPGRADE_TIMESTAMP = upgradeTimestamp;
|
||||
}
|
||||
this._didBuildFail = false;
|
||||
const xcodebuild = new SubProcess(cmd, args, {
|
||||
cwd: this.bootstrapPath,
|
||||
env,
|
||||
detached: true,
|
||||
stdio: ['ignore', 'pipe', 'pipe'],
|
||||
});
|
||||
|
||||
let logXcodeOutput = !!this.showXcodeLog;
|
||||
const logMsg = _.isBoolean(this.showXcodeLog)
|
||||
? `Output from xcodebuild ${this.showXcodeLog ? 'will' : 'will not'} be logged`
|
||||
: 'Output from xcodebuild will only be logged if any errors are present there';
|
||||
this.log.debug(`${logMsg}. To change this, use 'showXcodeLog' desired capability`);
|
||||
|
||||
const onStreamLine = (/** @type {string} */ line) => {
|
||||
if (this.showXcodeLog === false || IGNORED_ERRORS_PATTERN.test(line)) {
|
||||
return;
|
||||
}
|
||||
// if we have an error we want to output the logs
|
||||
// otherwise the failure is inscrutible
|
||||
// but do not log permission errors from trying to write to attachments folder
|
||||
if (line.includes('Error Domain=')) {
|
||||
logXcodeOutput = true;
|
||||
// handle case where xcode returns 0 but is failing
|
||||
this._didBuildFail = true;
|
||||
}
|
||||
if (logXcodeOutput) {
|
||||
xcodeLog.info(line);
|
||||
}
|
||||
};
|
||||
for (const streamName of ['stderr', 'stdout']) {
|
||||
xcodebuild.on(`line-${streamName}`, onStreamLine);
|
||||
}
|
||||
|
||||
return xcodebuild;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* @param {boolean} [buildOnly=false]
|
||||
* @returns {Promise<import('@appium/types').StringRecord>}
|
||||
*/
|
||||
async start (buildOnly = false) {
|
||||
this.xcodebuild = await this.createSubProcess(buildOnly);
|
||||
|
||||
// wrap the start procedure in a promise so that we can catch, and report,
|
||||
// any startup errors that are thrown as events
|
||||
return await new B((resolve, reject) => {
|
||||
this.xcodebuild.once('exit', (code, signal) => {
|
||||
xcodeLog.error(`xcodebuild exited with code '${code}' and signal '${signal}'`);
|
||||
this.xcodebuild.removeAllListeners();
|
||||
this.didProcessExit = true;
|
||||
if (this._didBuildFail || (!signal && code !== 0)) {
|
||||
let errorMessage = `xcodebuild failed with code ${code}.` +
|
||||
` This usually indicates an issue with the local Xcode setup or WebDriverAgent` +
|
||||
` project configuration or the driver-to-platform version mismatch.`;
|
||||
if (!this.showXcodeLog) {
|
||||
errorMessage += ` Consider setting 'showXcodeLog' capability to true in` +
|
||||
` order to check the Appium server log for build-related error messages.`;
|
||||
} else if (this.realDevice) {
|
||||
errorMessage += ` Consider checking the WebDriverAgent configuration guide` +
|
||||
` for real iOS devices at ${REAL_DEVICES_CONFIG_DOCS_LINK}.`;
|
||||
}
|
||||
return reject(new Error(errorMessage));
|
||||
}
|
||||
// in the case of just building, the process will exit and that is our finish
|
||||
if (buildOnly) {
|
||||
return resolve();
|
||||
}
|
||||
});
|
||||
|
||||
return (async () => {
|
||||
try {
|
||||
const timer = new timing.Timer().start();
|
||||
await this.xcodebuild.start(true);
|
||||
if (!buildOnly) {
|
||||
resolve(/** @type {import('@appium/types').StringRecord} */ (await this.waitForStart(timer)));
|
||||
}
|
||||
} catch (err) {
|
||||
let msg = `Unable to start WebDriverAgent: ${err}`;
|
||||
this.log.error(msg);
|
||||
reject(new Error(msg));
|
||||
}
|
||||
})();
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @param {any} timer
|
||||
* @returns {Promise<import('@appium/types').StringRecord?>}
|
||||
*/
|
||||
async waitForStart (timer) {
|
||||
// try to connect once every 0.5 seconds, until `launchTimeout` is up
|
||||
this.log.debug(`Waiting up to ${this.launchTimeout}ms for WebDriverAgent to start`);
|
||||
let currentStatus = null;
|
||||
try {
|
||||
const retries = Math.trunc(this.launchTimeout / 500);
|
||||
await retryInterval(retries, 1000, async () => {
|
||||
if (this._didProcessExit) {
|
||||
// there has been an error elsewhere and we need to short-circuit
|
||||
return currentStatus;
|
||||
}
|
||||
|
||||
const proxyTimeout = this.noSessionProxy.timeout;
|
||||
this.noSessionProxy.timeout = 1000;
|
||||
try {
|
||||
currentStatus = await this.noSessionProxy.command('/status', 'GET');
|
||||
if (currentStatus && currentStatus.ios && currentStatus.ios.ip) {
|
||||
this.agentUrl = currentStatus.ios.ip;
|
||||
}
|
||||
this.log.debug(`WebDriverAgent information:`);
|
||||
this.log.debug(JSON.stringify(currentStatus, null, 2));
|
||||
} catch (err) {
|
||||
throw new Error(`Unable to connect to running WebDriverAgent: ${err.message}`);
|
||||
} finally {
|
||||
this.noSessionProxy.timeout = proxyTimeout;
|
||||
}
|
||||
});
|
||||
|
||||
if (this._didProcessExit) {
|
||||
// there has been an error elsewhere and we need to short-circuit
|
||||
return currentStatus;
|
||||
}
|
||||
|
||||
this.log.debug(`WebDriverAgent successfully started after ${timer.getDuration().asMilliSeconds.toFixed(0)}ms`);
|
||||
} catch (err) {
|
||||
this.log.debug(err.stack);
|
||||
throw new Error(
|
||||
`We were not able to retrieve the /status response from the WebDriverAgent server after ${this.launchTimeout}ms timeout.` +
|
||||
`Try to increase the value of 'appium:wdaLaunchTimeout' capability as a possible workaround.`
|
||||
);
|
||||
}
|
||||
return currentStatus;
|
||||
}
|
||||
|
||||
/**
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
async quit () {
|
||||
await killProcess('xcodebuild', this.xcodebuild);
|
||||
}
|
||||
}
|
||||
|
||||
export default XcodeBuild;
|
||||
Reference in New Issue
Block a user