Skip to content

Commit

Permalink
fix: using Android inner grep instead of OS one, replacing CRLF with LF
Browse files Browse the repository at this point in the history
  • Loading branch information
@noomorph
noomorph committed Sep 14, 2018
1 parent 8576b4c commit cbb7d70
Show file tree
Hide file tree
Showing 5 changed files with 77 additions and 75 deletions.
70 changes: 34 additions & 36 deletions detox/src/devices/android/ADB.js
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
const _ = require('lodash');
const path = require('path');
const {execWithRetriesAndLogs, spawnAndLog} = require('../../utils/exec');
const pipeCommands = require('../../utils/pipeCommands');
const {escape} = require('../../utils/pipeCommands');
const EmulatorTelnet = require('./EmulatorTelnet');
const Environment = require('../../utils/environment');

Expand All @@ -12,7 +12,7 @@ class ADB {

async devices() {
const output = (await this.adbCmd('', 'devices')).stdout;
return await this.parseAdbDevicesConsoleOutput(output);
return this.parseAdbDevicesConsoleOutput(output);
}

async unlockScreen(deviceId) {
Expand All @@ -31,8 +31,7 @@ class ADB {
}

async _getPowerStatus(deviceId) {
const grep = pipeCommands.search.regexp;
const stdout = await this.shell(deviceId, `dumpsys power | ${grep('^[ ]*m[UW].*=')}`);
const stdout = await this.shell(deviceId, `dumpsys power | grep "^[ ]*m[UW].*="`);

return stdout
.split('\n')
Expand Down Expand Up @@ -89,7 +88,7 @@ class ADB {
}

async now(deviceId) {
return this.shell(deviceId, `date "+\\"%Y-%m-%d %T.000\\""`);
return this.shell(deviceId, `date +"%Y-%m-%d %T.000"`);
}

async install(deviceId, apkPath) {
Expand All @@ -110,21 +109,16 @@ class ADB {
}

async pidof(deviceId, bundleId) {
const bundleIdRegex = pipeCommands.escape.inQuotedRegexp(bundleId) + '[ ]*$';
const grep = pipeCommands.search.regexp;
const bundleIdRegex = escape.inQuotedRegexp(bundleId) + '$';

const processes = await this.shell(deviceId, `ps | ${grep(bundleIdRegex)}`).catch(() => '');
const processes = await this.shell(deviceId, `ps | grep "${bundleIdRegex}"`).catch(() => '');
if (!processes) {
return NaN;
}

return parseInt(processes.split(' ').filter(Boolean)[1], 10);
}

async shell(deviceId, cmd, options) {
return (await this.adbCmd(deviceId, `shell ${cmd}`, options)).stdout.trim();
}

async getFileSize(deviceId, filename) {
const { stdout, stderr } = await this.adbCmd(deviceId, 'shell wc -c ' + filename).catch(e => e);

Expand All @@ -136,7 +130,7 @@ class ADB {
}

async isFileOpen(deviceId, filename) {
const openedByProcesses = await this.shell(deviceId, 'lsof ' + filename);
const openedByProcesses = await this.shell(deviceId, `lsof | grep -e "${escape.inQuotedString(filename)}" || true`);
return openedByProcesses.length > 0;
}

Expand All @@ -155,7 +149,7 @@ class ADB {
}

async screencap(deviceId, path) {
return this.adbCmd(deviceId, `shell screencap ${path}`);
await this.shell(deviceId, `screencap ${path}`);
}

/***
Expand Down Expand Up @@ -211,11 +205,34 @@ class ADB {
}

async pull(deviceId, src, dst = '') {
return this.adbCmd(deviceId, `pull "${src}" "${dst}"`);
await this.adbCmd(deviceId, `pull "${src}" "${dst}"`);
}

async rm(deviceId, path, force = false) {
return this.adbCmd(deviceId, `shell rm ${force ? '-f' : ''} "${path}"`);
await this.shell(deviceId, `rm ${force ? '-f' : ''} "${path}"`);
}

async listInstrumentation(deviceId) {
return this.shell(deviceId, 'pm list instrumentation');
}

async getInstrumentationRunner(deviceId, bundleId) {
const instrumentationRunners = await this.listInstrumentation(deviceId);
const instrumentationRunner = this._instrumentationRunnerForBundleId(instrumentationRunners, bundleId);
if (instrumentationRunner === 'undefined') {
throw new Error(`No instrumentation runner found on device ${deviceId} for package ${bundleId}`);
}

return instrumentationRunner;
}

_instrumentationRunnerForBundleId(instrumentationRunners, bundleId) {
const runnerForBundleRegEx = new RegExp(`^instrumentation:(.*) \\(target=${bundleId.replace(new RegExp('\\.', 'g'), "\\.")}\\)$`, 'gm');
return _.get(runnerForBundleRegEx.exec(instrumentationRunners), [1], 'undefined');
}

async shell(deviceId, cmd, options) {
return (await this.adbCmd(deviceId, `shell "${escape.inQuotedString(cmd)}"`, options)).stdout.trim();
}

async adbCmd(deviceId, params, options) {
Expand All @@ -224,7 +241,7 @@ class ADB {
const retries = _.get(options, 'retries', 1);
_.unset(options, 'retries');

return await execWithRetriesAndLogs(cmd, options, undefined, retries);
return execWithRetriesAndLogs(cmd, options, undefined, retries);
}

/***
Expand All @@ -234,25 +251,6 @@ class ADB {
const serial = deviceId ? ['-s', deviceId] : [];
return spawnAndLog(this.adbBin, [...serial, ...params]);
}

async listInstrumentation(deviceId) {
return await this.shell(deviceId, 'pm list instrumentation');
}

instrumentationRunnerForBundleId(instrumentationRunners, bundleId) {
const runnerForBundleRegEx = new RegExp(`^instrumentation:(.*) \\(target=${bundleId.replace(new RegExp('\\.', 'g'), "\\.")}\\)$`, 'gm');
return _.get(runnerForBundleRegEx.exec(instrumentationRunners), [1], 'undefined');
}

async getInstrumentationRunner(deviceId, bundleId) {
const instrumentationRunners = await this.listInstrumentation(deviceId);
const instrumentationRunner = this.instrumentationRunnerForBundleId(instrumentationRunners, bundleId);
if (instrumentationRunner === 'undefined') {
throw new Error(`No instrumentation runner found on device ${deviceId} for package ${bundleId}`);
}

return instrumentationRunner;
}
}

module.exports = ADB;
30 changes: 12 additions & 18 deletions detox/src/devices/android/ADB.test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,20 +46,22 @@ describe('ADB', () => {
});

it(`pidof (success)`, async () => {
adb.shell = async () => `u0_a19 2199 1701 3554600 70264 0 0 s com.google.android.ext.services `;
jest.spyOn(adb, 'shell').mockImplementation(async () =>
`u0_a19 2199 1701 3554600 70264 0 0 s com.google.android.ext.services `);

expect(await adb.pidof('', 'com.google.android.ext.services')).toBe(2199);
});

it(`pidof (failure)`, async () => {
adb.shell = async () => ``;
jest.spyOn(adb, 'shell').mockImplementation(async () => '');
expect(await adb.pidof('', 'com.google.android.ext.services')).toBe(NaN);
});

describe('unlockScreen', () => {
const deviceId = 'mockEmulator';

async function unlockScreenWithPowerStatus(mWakefulness, mUserActivityTimeoutOverrideFromWindowManager) {
adb.shell = jest.fn().mockReturnValue(`
jest.spyOn(adb, 'shell').mockImplementation(async () => `
mWakefulness=${mWakefulness}
mWakefulnessChanging=false
mWakeLockSummary=0x0
Expand Down Expand Up @@ -116,11 +118,11 @@ describe('ADB', () => {

it(`listInstrumentation passes the right deviceId`, async () => {
const deviceId = 'aDeviceId';
const spyShell = jest.spyOn(adb, 'shell');
jest.spyOn(adb, 'shell');

await adb.listInstrumentation(deviceId);

expect(spyShell).toBeCalledWith(deviceId, expect.any(String));
expect(adb.shell).toBeCalledWith(deviceId, 'pm list instrumentation');
});

it(`Parse 'adb device' output`, async () => {
Expand All @@ -144,18 +146,7 @@ describe('ADB', () => {
expect(actual).toEqual(parsedDevices);
});

it(`getInstrumentationRunner passes the right deviceId`, async () => {
const deviceId = 'aDeviceId';
const spyRunnerForBundle = jest.spyOn(adb, 'instrumentationRunnerForBundleId');
spyRunnerForBundle.mockReturnValue('');
const spyShell = jest.spyOn(adb, 'shell');

await adb.getInstrumentationRunner(deviceId, 'com.whatever.package');

expect(spyShell).toBeCalledWith(deviceId, expect.any(String));
});

it(`instrumentationRunnerForBundleId parses the correct runner for the package`, async () => {
it(`getInstrumentationRunner parses the correct runner for the package`, async () => {
const expectedRunner = "com.example.android.apis/.app.LocalSampleInstrumentation";
const expectedPackage = "com.example.android.apis";
const instrumentationRunnersShellOutput =
Expand All @@ -164,8 +155,11 @@ describe('ADB', () => {
`instrumentation:${expectedRunner} (target=${expectedPackage})\n` +
"instrumentation:org.chromium.webview_shell/.WebViewLayoutTestRunner (target=org.chromium.webview_shell)\n";

const result = await adb.instrumentationRunnerForBundleId(instrumentationRunnersShellOutput, expectedPackage);
jest.spyOn(adb, 'shell').mockImplementation(async () => instrumentationRunnersShellOutput);

const result = await adb.getInstrumentationRunner('aDeviceId', expectedPackage);

expect(adb.shell).toBeCalledWith('aDeviceId', 'pm list instrumentation');
expect(result).toEqual(expectedRunner);
});
});
Expand Down
12 changes: 6 additions & 6 deletions detox/src/devices/android/EmulatorTelnet.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,18 +36,18 @@ class EmulatorTelnet {
this.connection.shell((error, stream) => {
stream.write(`${command}\n`);
stream.on('data', (data) => {
const result = data.toString();
if (result.includes('\n')) {
resolve(result);
const result = data.toString();
if (result.includes('\n')) {
resolve(result);
}
}
}
);
});
});
}

async avdName() {
return await this.exec('avd name');
return this.exec('avd name');
}

async kill() {
Expand All @@ -61,7 +61,7 @@ class EmulatorTelnet {
}

async rotate() {
return await this.shell('rotate');
return this.shell('rotate');
}
}

Expand Down
8 changes: 8 additions & 0 deletions detox/src/utils/exec.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,14 @@ async function execWithRetriesAndLogs(bin, options, statusLogs, retries = 10, in
// log.error(`${_operationCounter}: stderr:`, result.stderr);
//}

if (typeof result.stdout === 'string') {
result.stdout = result.stdout.replace(/\r\n/g, '\n');
}

if (typeof result.stderr === 'string') {
result.stderr = result.stderr.replace(/\r\n/g, '\n');
}

return result;
}

Expand Down
32 changes: 17 additions & 15 deletions detox/src/utils/pipeCommands.js
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
const SPECIAL_CHARS = /([\^\$\[\]\*\.\\])/g;

const escapeInQuotedString = (fragment) => fragment.replace(/"/g, '\\"');
const escapeInQuotedRegexp = (fragment) => fragment.replace(SPECIAL_CHARS, "\\$1");

function win32Implementation() {
const escapeInQuotedStringWin32 = (fragment) => fragment.replace(/"/g, '""');
const escapeInQuotedRegexpWin32 = escapeInQuotedStringWin32;
const searchRegexpWin32 = (pattern) => `findstr /R /C:"${escapeInQuotedStringWin32(pattern)}"`;
const searchFragmentWin32 = (fragment) => `findstr /C:"${escapeInQuotedStringWin32(fragment)}"`;
const addCRLF = 'find /v ""';
const searchRegexpWin32 = (pattern) => `${addCRLF} | findstr /R /C:"${escapeInQuotedString(pattern)}"`;
const searchFragmentWin32 = (fragment) => `${addCRLF} | findstr /C:"${escapeInQuotedString(fragment)}"`;

return {
escape: {
inQuotedString: escapeInQuotedStringWin32,
inQuotedRegexp: escapeInQuotedRegexpWin32,
inQuotedString: escapeInQuotedString,
inQuotedRegexp: escapeInQuotedRegexp,
},
search: {
regexp: searchRegexpWin32,
Expand All @@ -17,17 +21,13 @@ function win32Implementation() {
}

function nixImplementation() {
const SPECIAL_CHARS = /(["\^\$\[\]\*\.\\])/g;

const escapeInQuotedStringNix = (fragment) => fragment.replace(/"/g, '\\"');
const escapeInQuotedRegexpNix = (fragment) => fragment.replace(SPECIAL_CHARS, "\\$1");
const searchRegexpNix = (pattern) => `grep "${escapeInQuotedStringNix(pattern)}"`;
const searchFragmentNix = (fragment) => `grep -e "${escapeInQuotedStringNix(fragment)}"`;
const searchRegexpNix = (pattern) => `grep "${escapeInQuotedString(pattern)}"`;
const searchFragmentNix = (fragment) => `grep -e "${escapeInQuotedString(fragment)}"`;

return {
escape: {
inQuotedString: escapeInQuotedStringNix,
inQuotedRegexp: escapeInQuotedRegexpNix,
inQuotedString: escapeInQuotedString,
inQuotedRegexp: escapeInQuotedRegexp,
},
search: {
regexp: searchRegexpNix,
Expand All @@ -36,6 +36,8 @@ function nixImplementation() {
};
}

module.exports = process.platform === 'win32'
const isRunningInCMDEXE = process.platform === 'win32' && !process.env['SHELL'];

module.exports = isRunningInCMDEXE
? win32Implementation()
: nixImplementation();

0 comments on commit cbb7d70

Please sign in to comment.