adb-emu-commands.js
11.5 KB
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
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
import log from '../logger.js';
import _ from 'lodash';
import net from 'net';
import { util } from 'appium-support';
import B from 'bluebird';
const PHONE_NUMBER_PATTERN = /^[+]?[(]?[0-9]*[)]?[-\s.]?[0-9]*[-\s.]?[0-9]{2,}$/im;
let emuMethods = {};
emuMethods.POWER_AC_STATES = {
POWER_AC_ON: 'on',
POWER_AC_OFF: 'off'
};
emuMethods.GSM_CALL_ACTIONS = {
GSM_CALL: 'call',
GSM_ACCEPT: 'accept',
GSM_CANCEL: 'cancel',
GSM_HOLD: 'hold'
};
emuMethods.GSM_VOICE_STATES = {
GSM_VOICE_UNREGISTERED: 'unregistered',
GSM_VOICE_HOME: 'home',
GSM_VOICE_ROAMING: 'roaming',
GSM_VOICE_SEARCHING: 'searching',
GSM_VOICE_DENIED: 'denied',
GSM_VOICE_OFF: 'off',
GSM_VOICE_ON: 'on'
};
emuMethods.GSM_SIGNAL_STRENGTHS = [0, 1, 2, 3, 4];
emuMethods.NETWORK_SPEED = {
GSM: 'gsm', // GSM/CSD (up: 14.4, down: 14.4).
SCSD: 'scsd', // HSCSD (up: 14.4, down: 57.6).
GPRS: 'gprs', // GPRS (up: 28.8, down: 57.6).
EDGE: 'edge', // EDGE/EGPRS (up: 473.6, down: 473.6).
UMTS: 'umts', // UMTS/3G (up: 384.0, down: 384.0).
HSDPA: 'hsdpa', // HSDPA (up: 5760.0, down: 13,980.0).
LTE: 'lte', // LTE (up: 58,000, down: 173,000).
EVDO: 'evdo', // EVDO (up: 75,000, down: 280,000).
FULL: 'full' // No limit, the default (up: 0.0, down: 0.0).
};
emuMethods.SENSORS = {
ACCELERATION: 'acceleration',
LIGHT: 'light',
PROXIMITY: 'proximity',
TEMPERATURE: 'temperature',
PRESSURE: 'pressure',
HUMIDITY: 'humidity'
};
/**
* Check the emulator state.
*
* @return {boolean} True if Emulator is visible to adb.
*/
emuMethods.isEmulatorConnected = async function isEmulatorConnected () {
let emulators = await this.getConnectedEmulators();
return !!_.find(emulators, (x) => x && x.udid === this.curDeviceId);
};
/**
* Verify the emulator is connected.
*
* @throws {error} If Emulator is not visible to adb.
*/
emuMethods.verifyEmulatorConnected = async function verifyEmulatorConnected () {
if (!(await this.isEmulatorConnected())) {
throw new Error(`The emulator "${this.curDeviceId}" was unexpectedly disconnected`);
}
};
/**
* Emulate fingerprint touch event on the connected emulator.
*
* @param {string} fingerprintId - The ID of the fingerprint.
*/
emuMethods.fingerprint = async function fingerprint (fingerprintId) {
if (!fingerprintId) {
throw new Error('Fingerprint id parameter must be defined');
}
// the method used only works for API level 23 and above
let level = await this.getApiLevel();
if (level < 23) {
throw new Error(`Device API Level must be >= 23. Current Api level '${level}'`);
}
await this.adbExecEmu(['finger', 'touch', fingerprintId]);
};
/**
* Change the display orientation on the connected emulator.
* The orientation is changed (PI/2 is added) every time
* this method is called.
*/
emuMethods.rotate = async function rotate () {
await this.adbExecEmu(['rotate']);
};
/**
* Emulate power state change on the connected emulator.
*
* @param {string} state ['on'] - Either 'on' or 'off'.
*/
emuMethods.powerAC = async function powerAC (state = 'on') {
if (_.values(emuMethods.POWER_AC_STATES).indexOf(state) === -1) {
throw new Error(`Wrong power AC state sent '${state}'. Supported values: ${_.values(emuMethods.POWER_AC_STATES)}]`);
}
await this.adbExecEmu(['power', 'ac', state]);
};
/**
* Emulate sensors values on the connected emulator.
*
* @param {string} sensor - Sensor type declared in SENSORS items.
* @param {number|string} value - Number to set as the sensor value.
* @throws {Error} - If sensor type or sensor value is not defined
*/
emuMethods.sensorSet = async function sensorSet (sensor, value) {
if (!_.includes(emuMethods.SENSORS, sensor)) {
throw new Error(`Unsupported sensor sent '${sensor}'. Supported values: ${_.values(emuMethods.SENSORS)}]`);
}
value = parseFloat(value);
if (isNaN(value)) {
throw new Error(`Missing sensor value argument. You need to provide a valid number to set to the sensor.`);
}
await this.adbExecEmu(['sensor', 'set', sensor, value]);
};
/**
* Emulate power capacity change on the connected emulator.
*
* @param {string|number} percent [100] - Percentage value in range [0, 100].
*/
emuMethods.powerCapacity = async function powerCapacity (percent = 100) {
percent = parseInt(percent, 10);
if (isNaN(percent) || percent < 0 || percent > 100) {
throw new Error(`The percentage value should be valid integer between 0 and 100`);
}
await this.adbExecEmu(['power', 'capacity', percent]);
};
/**
* Emulate power off event on the connected emulator.
*/
emuMethods.powerOFF = async function powerOFF () {
await this.powerAC(emuMethods.POWER_AC_STATES.POWER_AC_OFF);
await this.powerCapacity(0);
};
/**
* Emulate send SMS event on the connected emulator.
*
* @param {string|number} phoneNumber - The phone number of message sender.
* @param {string} message [''] - The message content.
* @throws {error} If phone number has invalid format.
*/
emuMethods.sendSMS = async function sendSMS (phoneNumber, message = '') {
message = message.trim();
if (message === '') {
throw new Error('Sending an SMS requires a message');
}
phoneNumber = `${phoneNumber}`.replace(/\s*/, '');
if (!PHONE_NUMBER_PATTERN.test(phoneNumber)) {
throw new Error(`Invalid sendSMS phoneNumber param ${phoneNumber}`);
}
await this.adbExecEmu(['sms', 'send', phoneNumber, message]);
};
/**
* Emulate GSM call event on the connected emulator.
*
* @param {string|number} phoneNumber - The phone number of the caller.
* @param {string} action [''] - One of available GSM call actions.
* @throws {error} If phone number has invalid format.
* @throws {error} If _action_ value is invalid.
*/
emuMethods.gsmCall = async function gsmCall (phoneNumber, action = '') {
if (_.values(emuMethods.GSM_CALL_ACTIONS).indexOf(action) === -1) {
throw new Error(`Invalid gsm action param ${action}. Supported values: ${_.values(emuMethods.GSM_CALL_ACTIONS)}`);
}
phoneNumber = `${phoneNumber}`.replace(/\s*/, '');
if (!PHONE_NUMBER_PATTERN.test(phoneNumber)) {
throw new Error(`Invalid gsmCall phoneNumber param ${phoneNumber}`);
}
await this.adbExecEmu(['gsm', action, phoneNumber]);
};
/**
* Emulate GSM signal strength change event on the connected emulator.
*
* @param {string|number} strength [4] - A number in range [0, 4];
* @throws {error} If _strength_ value is invalid.
*/
emuMethods.gsmSignal = async function gsmSignal (strength = 4) {
strength = parseInt(strength, 10);
if (emuMethods.GSM_SIGNAL_STRENGTHS.indexOf(strength) === -1) {
throw new Error(`Invalid signal strength param ${strength}. Supported values: ${_.values(emuMethods.GSM_SIGNAL_STRENGTHS)}`);
}
log.info('gsm signal-profile <strength> changes the reported strength on next (15s) update.');
await this.adbExecEmu(['gsm', 'signal-profile', strength]);
};
/**
* Emulate GSM voice event on the connected emulator.
*
* @param {string} state ['on'] - Either 'on' or 'off'.
* @throws {error} If _state_ value is invalid.
*/
emuMethods.gsmVoice = async function gsmVoice (state = 'on') {
// gsm voice <state> allows you to change the state of your GPRS connection
if (_.values(emuMethods.GSM_VOICE_STATES).indexOf(state) === -1) {
throw new Error(`Invalid gsm voice state param ${state}. Supported values: ${_.values(emuMethods.GSM_VOICE_STATES)}`);
}
await this.adbExecEmu(['gsm', 'voice', state]);
};
/**
* Emulate network speed change event on the connected emulator.
*
* @param {string} speed ['full'] - One of possible NETWORK_SPEED values.
* @throws {error} If _speed_ value is invalid.
*/
emuMethods.networkSpeed = async function networkSpeed (speed = 'full') {
// network speed <speed> allows you to set the network speed emulation.
if (_.values(emuMethods.NETWORK_SPEED).indexOf(speed) === -1) {
throw new Error(`Invalid network speed param ${speed}. Supported values: ${_.values(emuMethods.NETWORK_SPEED)}`);
}
await this.adbExecEmu(['network', 'speed', speed]);
};
/**
* @typedef {Object} ExecTelnetOptions
* @property {number} execTimeout [60000] A timeout used to wait for a server
* reply to the given command
* @property {number} connTimeout [5000] Console connection timeout in milliseconds
* @property {number} initTimeout [5000] Telnet console initialization timeout
* in milliseconds (the time between connection happens and the command prompt
* is available)
*/
/**
* Executes a command through emulator telnet console interface and returns its output
*
* @param {Array<string>|string} cmd - The actual command to execute. See
* https://developer.android.com/studio/run/emulator-console for more details
* on available commands
* @param {ExecTelnetOptions} opts
* @returns {string} The command output
* @throws {Error} If there was an error while connecting to the Telnet console
* or if the given command returned non-OK response
*/
emuMethods.execEmuConsoleCommand = async function execTelnet (cmd, opts = {}) {
const portMatch = /emulator-(\d+)/i.exec(this.curDeviceId);
if (!portMatch) {
throw new Error(`Cannot parse the console port number from the device identifier '${this.curDeviceId}'. ` +
`Is it an emulator?`);
}
const host = '127.0.0.1';
const port = parseInt(portMatch[1], 10);
const {
execTimeout = 60000,
connTimeout = 5000,
initTimeout = 5000,
} = opts;
await this.resetTelnetAuthToken();
const okFlag = /^OK$/m;
const nokFlag = /^KO\b/m;
const eol = '\r\n';
const client = net.connect({
host,
port,
});
return await new B((resolve, reject) => {
const connTimeoutObj = setTimeout(
() => reject(new Error(`Cannot connect to the Emulator console at ${host}:${port} ` +
`after ${connTimeout}ms`)), connTimeout);
let execTimeoutObj;
let initTimeoutObj;
let isCommandSent = false;
let serverResponse = [];
client.once('error', (e) => {
clearTimeout(connTimeoutObj);
reject(new Error(`Cannot connect to the Emulator console at ${host}:${port}. ` +
`Original error: ${e.message}`));
});
client.once('connect', () => {
clearTimeout(connTimeoutObj);
initTimeoutObj = setTimeout(
() => reject(new Error(`Did not get the initial response from the Emulator console at ${host}:${port} ` +
`after ${initTimeout}ms`)), initTimeout);
});
client.on('data', (chunk) => {
serverResponse.push(chunk);
const output = Buffer.concat(serverResponse).toString('utf8').trim();
if (okFlag.test(output)) {
// The initial incoming data chunk confirms the interface is ready for input
if (!isCommandSent) {
clearTimeout(initTimeoutObj);
serverResponse = [];
log.debug(`Executing Emulator console command: ${cmd}`);
client.write(_.isArray(cmd) ? util.quote(cmd) : cmd);
client.write(eol);
isCommandSent = true;
execTimeoutObj = setTimeout(
() => reject(new Error(`Did not get any response from the Emulator console at ${host}:${port} ` +
`to '${cmd}' command after ${execTimeout}ms`)), execTimeout);
return;
}
clearTimeout(execTimeoutObj);
client.end();
const outputArr = output.split(eol);
// remove the redundant OK flag from the resulting command output
return resolve(outputArr.slice(0, outputArr.length - 1).join('\n').trim());
} else if (nokFlag.test(output)) {
clearTimeout(initTimeoutObj);
clearTimeout(execTimeoutObj);
client.end();
const outputArr = output.split(eol);
return reject(_.trim(_.last(outputArr)));
}
});
});
};
export default emuMethods;