-
-
Notifications
You must be signed in to change notification settings - Fork 44
/
utils.js
302 lines (273 loc) · 9.44 KB
/
utils.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
import log from './logger';
import _ from 'lodash';
import { exec } from 'teen_process';
import { waitForCondition } from 'asyncbox';
import { getVersion } from 'appium-xcode';
import { getDevices } from 'node-simctl';
import { fs, tempDir } from 'appium-support';
import { Certificate } from './certificate';
import path from 'path';
import Simulator from './simulator-xcode-6';
import fkill from 'fkill';
const DEFAULT_SIM_SHUTDOWN_TIMEOUT = 30000;
const BIOMETRICS = {
touchId: 'fingerTouch',
faceId: 'pearl',
};
function toBiometricDomainComponent (name) {
if (!BIOMETRICS[name]) {
throw new Error(`'${name}' is not a valid biometric. Use one of: ${JSON.stringify(_.keys(BIOMETRICS))}`);
}
return BIOMETRICS[name];
}
// pgrep/pkill exit codes:
// 0 One or more processes were matched.
// 1 No processes were matched.
// 2 Invalid options were specified on the command line.
// 3 An internal error occurred.
async function pkill (appName, forceKill = false) {
let args = forceKill ? ['-9'] : [];
args.push('-x', appName);
try {
await exec('pkill', args);
return 0;
} catch (err) {
if (!_.isUndefined(err.code)) {
throw new Error(`Cannot forcefully terminate ${appName}. pkill error code: ${err.code}`);
}
log.error(`Received unexpected error while trying to kill ${appName}: ${err.message}`);
throw err;
}
}
async function killAllSimulators (timeout = DEFAULT_SIM_SHUTDOWN_TIMEOUT) {
log.debug('Killing all iOS Simulators');
const xcodeVersion = await getVersion(true);
const appName = xcodeVersion.major >= 7 ? 'Simulator' : 'iOS Simulator';
// later versions are slower to close
timeout = timeout * (xcodeVersion.major >= 8 ? 2 : 1);
try {
await exec('xcrun', ['simctl', 'shutdown', xcodeVersion.major > 8 ? 'all' : 'booted'], {timeout});
} catch (ign) {}
const pids = [];
try {
const {stdout} = await exec('pgrep', ['-f', `${appName}.app/Contents/MacOS/`]);
if (stdout.trim()) {
pids.push(...(stdout.trim().split(/\s+/)));
}
} catch (e) {
if (e.code === 1) {
log.debug(`${appName} is not running. Continuing...`);
return;
}
if (_.isEmpty(pids)) {
log.warn(`pgrep error ${e.code} while detecting whether ${appName} is running. Trying to kill anyway.`);
}
}
if (!_.isEmpty(pids)) {
log.debug(`Using fkill to kill processes: ${pids.join(', ')}`);
try {
await fkill(pids, {force: true});
} catch (ign) {}
}
log.debug(`Using pkill to kill application: ${appName}`);
try {
await pkill(appName, true);
} catch (ign) {}
// wait for all the devices to be shutdown before Continuing
// but only print out the failed ones when they are actually fully failed
let remainingDevices = [];
async function allSimsAreDown () {
remainingDevices = [];
let devices = await getDevices();
devices = _.flatten(_.values(devices));
return _.every(devices, (sim) => {
let state = sim.state.toLowerCase();
let done = state === 'shutdown' ||
state === 'unavailable' ||
state === 'disconnected';
if (!done) {
remainingDevices.push(`${sim.name} (${sim.sdk}, udid: ${sim.udid}) is still in state '${state}'`);
}
return done;
});
}
try {
await waitForCondition(allSimsAreDown, {
waitMs: timeout,
intervalMs: 200
});
} catch (err) {
if (remainingDevices.length > 0) {
log.warn(`The following devices are still not in the correct state after ${timeout} ms:`);
for (let device of remainingDevices) {
log.warn(` ${device}`);
}
}
throw err;
}
}
async function endAllSimulatorDaemons () {
log.debug('Ending all simulator daemons');
for (let servicePattern of ['com.apple.iphonesimulator', 'com.apple.CoreSimulator']) {
log.debug(`Killing any other ${servicePattern} daemons`);
let launchCtlCommand = `launchctl list | grep ${servicePattern} | cut -f 3 | xargs -n 1 launchctl`;
try {
let stopCmd = `${launchCtlCommand} stop`;
await exec('bash', ['-c', stopCmd]);
} catch (err) {
log.warn(`Could not stop ${servicePattern} daemons, carrying on anyway!`);
}
try {
let removeCmd = `${launchCtlCommand} remove`;
await exec('bash', ['-c', removeCmd]);
} catch (err) {
log.warn(`Could not remove ${servicePattern} daemons, carrying on anyway!`);
}
}
// waiting until the simulator service has died.
try {
await waitForCondition(async () => {
let {stdout} = await exec('bash', ['-c',
`ps -e | grep launchd_sim | grep -v bash | grep -v grep | awk {'print$1'}`]);
return stdout.trim().length === 0;
}, {waitMs: 5000, intervalMs: 500});
} catch (err) {
log.warn(`Could not end all simulator daemons, carrying on!`);
}
log.debug('Finishing ending all simulator daemons');
}
async function getSimulatorInfo (udid) {
// see the README for github.com/appium/node-simctl for example output of getDevices()
let devices = await getDevices();
devices = _.toPairs(devices)
.map((pair) => pair[1])
.reduce((a, b) => a.concat(b), []);
return _.find(devices, (sim) => sim.udid === udid);
}
async function simExists (udid) {
return !!(await getSimulatorInfo(udid));
}
async function safeRimRaf (delPath, tryNum = 0) {
try {
await fs.rimraf(delPath);
} catch (err) {
if (tryNum < 20) {
if (err.message.indexOf('ENOTEMPTY') !== -1) {
log.debug(`Path '${delPath}' was not empty during delete; retrying`);
return await safeRimRaf(delPath, tryNum + 1);
} else if (err.message.indexOf('ENOENT') !== -1) {
log.debug(`Path '${delPath}' did not exist when we tried to delete, ignoring`);
return await safeRimRaf(delPath, tryNum + 1);
}
}
}
}
/**
* Install an SSL certificate to a device with given udid
* @param {string} pemText SSL pem text
* @param {string} udid Identifier of the Simulator
*/
async function installSSLCert (pemText, udid) {
// Check that openssl is installed on the path
try {
await fs.which('openssl');
} catch (e) {
log.debug(`customSSLCert requires openssl to be available on path`);
log.errorAndThrow(`Command 'openssl' not found`);
}
// Check that sqlite3 is installed on the path
try {
await fs.which('sqlite3');
} catch (e) {
log.debug(`customSSLCert requires sqlite3 to be available on path`);
log.errorAndThrow(`Command 'sqlite3' not found`);
}
// Create a temporary file to store PEM text
// (a temp file is necessary to run `openssl` shell commands, can't be done in memory)
let tempFileName = path.resolve(await tempDir.openDir(), 'temp-ssl-cert.pem');
let pathToKeychain = new Simulator(udid).getDir();
await fs.writeFile(tempFileName, pemText);
try {
await fs.stat(pathToKeychain);
} catch (e) {
log.debug(`Could not install SSL certificate. No simulator with udid '${udid}'`);
log.errorAndThrow(e);
}
// Do the certificate installation
let certificate = new Certificate(tempFileName);
log.debug(`Installing certificate to ${pathToKeychain}`);
await certificate.add(pathToKeychain);
// Remove the temporary file
await fs.unlink(tempFileName);
return certificate;
}
async function uninstallSSLCert (pemText, udid) {
try {
let tempFileName = path.resolve(__dirname, 'temp-ssl-cert.pem');
let pathToKeychain = path.resolve(new Simulator(udid).getDir());
await fs.writeFile(tempFileName, pemText);
let certificate = new Certificate(tempFileName);
await certificate.remove(pathToKeychain);
await fs.unlink(tempFileName);
return certificate;
} catch (e) {
log.debug(`Could not uninstall SSL certificate. No simulator with udid '${udid}'`);
log.errorAndThrow(e);
}
}
/**
* Check if the Simulator already has this SSL certificate
* @param {string} pemText PEM text of SSL cert
* @param {string} udid Identifier of the Simulator
*/
async function hasSSLCert (pemText, udid) {
const tempFileName = path.resolve(await tempDir.openDir(), 'temp-ssl-cert.pem');
const pathToKeychain = new Simulator(udid).getDir();
await fs.writeFile(tempFileName, pemText);
const certificate = new Certificate(tempFileName);
return certificate.has(pathToKeychain);
}
/**
* Runs a command line sqlite3 query
*
* @param {string} db - Full path to sqlite database
* @param {string} query - The actual query string
* @param {...string} queryParams - The list of query parameters
* @returns {string} sqlite command stdout
*/
async function execSQLiteQuery (db, query, ...queryParams) {
query = query.replace(/\n+/g, ' ');
let queryTokens = query.split('?');
let formattedQuery = [];
queryParams
.map((param) => `${param}`)
.forEach((param, i) => {
formattedQuery.push(queryTokens[i]);
formattedQuery.push(param.replace(/'/g, "''"));
});
formattedQuery.push(queryTokens[queryTokens.length - 1]);
log.debug(`Executing SQL query "${formattedQuery.join('')}" on '${db}'`);
try {
return (await exec('sqlite3', ['-line', db, formattedQuery.join('')])).stdout;
} catch (err) {
throw new Error(`Cannot execute SQLite query "${formattedQuery.join('')}" to '${db}'. ` +
`Original error: ${err.stderr}`);
}
}
async function getDeveloperRoot () {
const {stdout} = await exec('xcode-select', ['-p']);
return stdout.trim();
}
export {
killAllSimulators,
endAllSimulatorDaemons,
safeRimRaf,
simExists,
getSimulatorInfo,
installSSLCert,
uninstallSSLCert,
hasSSLCert,
execSQLiteQuery,
toBiometricDomainComponent,
getDeveloperRoot,
};