"use strict"; var spawn = require('win-spawn') , exec = require('child_process').exec , path = require('path') , fs = require('fs') , net = require('net') , mkdirp = require('mkdirp') , status = require('../../server/status.js') , logger = require('../../server/logger.js').get('appium') , async = require('async') , ncp = require('ncp') , _ = require('underscore') , helpers = require('../../helpers.js') , unzipFile = helpers.unzipFile , testZipArchive = helpers.testZipArchive , AdmZip = require('adm-zip') , getTempPath = helpers.getTempPath , rimraf = require('rimraf') , Logcat = require('./logcat.js') , isWindows = helpers.isWindows() , temp = require('temp') , helperJarPath = path.resolve(__dirname, 'helpers'); var ADB = function (opts) { if (!opts) { opts = {}; } if (typeof opts.sdkRoot === "undefined") { opts.sdkRoot = process.env.ANDROID_HOME || ''; } this.compressXml = opts.compressXml; this.sdkRoot = opts.sdkRoot; this.udid = opts.udid; this.appDeviceReadyTimeout = opts.appDeviceReadyTimeout; this.useKeystore = opts.useKeystore; this.keystorePath = opts.keystorePath; this.keystorePassword = opts.keystorePassword; this.keyAlias = opts.keyAlias; this.keyPassword = opts.keyPassword; this.adb = "adb"; this.adbCmd = this.adb; this.curDeviceId = null; this.emulatorPort = null; this.debugMode = true; this.logcat = null; this.binaries = {}; this.instrumentProc = null; }; ADB.prototype.debug = function (msg) { if (this.debugMode) { logger.info("[ADB] " + msg); } }; ADB.prototype.checkSdkBinaryPresent = function (binary, cb) { logger.info("Checking whether " + binary + " is present"); var binaryLoc = null; var binaryName = binary; var cmd = "which"; if (isWindows) { if (binaryName === "android") { binaryName += ".bat"; } else { if (binaryName.indexOf(".exe", binaryName.length - 4) === -1) { binaryName += ".exe"; } } cmd = "where"; } if (this.sdkRoot) { var binaryLocs = [ path.resolve(this.sdkRoot, "platform-tools", binaryName) , path.resolve(this.sdkRoot, "tools", binaryName) ]; // put supported build tool dir names here var supportedBuildToolDirs = [ '17.0.0' , '18.0.1' , '19.0.0' , '19.0.1' , 'android-4.2.2' , 'android-4.3' , 'android-4.4' ]; // add the possible paths for supported build tools _.each(supportedBuildToolDirs, function (versionDir) { binaryLocs.push(path.resolve(this.sdkRoot, "build-tools", versionDir, binaryName)); }.bind(this)); _.each(binaryLocs, function (loc) { if (fs.existsSync(loc)) binaryLoc = loc; }); if (binaryLoc === null) { cb(new Error("Could not find " + binary + " in tools, platform-tools, " + "or supported build-tools under \"" + this.sdkRoot + "\"; " + "do you have android SDK or build-tools installed into this " + "location? Supported build tools are: " + supportedBuildToolDirs.join(', '))); return; } this.debug("Using " + binary + " from " + binaryLoc); binaryLoc = '"' + binaryLoc.trim() + '"'; this.binaries[binary] = binaryLoc; cb(null, binaryLoc); } else { exec(cmd + " " + binary, { maxBuffer: 524288 }, function (err, stdout) { if (stdout) { this.debug("Using " + binary + " from " + stdout); cb(null, stdout); } else { cb(new Error("Could not find " + binary + "; do you have the Android " + "SDK installed and the tools + platform-tools folders " + "added to your PATH?")); } }.bind(this)); } }; ADB.prototype.checkAdbPresent = function (cb) { this.checkSdkBinaryPresent("adb", function (err, binaryLoc) { if (err) return cb(err); if (this.adbCmd === this.adb) { // if adbCmd is the same as default adb, update it too this.adbCmd = binaryLoc.trim(); } this.adb = binaryLoc.trim(); cb(null); }.bind(this)); }; ADB.prototype.checkAaptPresent = function (cb) { this.checkSdkBinaryPresent("aapt", cb); }; ADB.prototype.checkZipAlignPresent = function (cb) { this.checkSdkBinaryPresent("zipalign", cb); }; ADB.prototype.exec = function (cmd, opts, cb) { if (!cb && typeof opts === 'function') { cb = opts; opts = {}; } if (!cmd) { return cb(new Error("You need to pass in a command to exec()")); } cmd = this.adbCmd + ' ' + cmd; logger.debug("executing: " + cmd); opts = _.defaults(opts, {maxBuffer: 524288}); exec(cmd, opts, function (err, stdout, stderr) { if (err) logger.warn(err); cb(err, stdout, stderr); }); }; ADB.prototype.shell = function (cmd, cb) { if (cmd.indexOf('"') === -1) { cmd = '"' + cmd + '"'; } var execCmd = 'shell ' + cmd; this.exec(execCmd, cb); }; ADB.prototype.spawn = function (args) { args.unshift(this.curDeviceId); args.unshift('-s'); var adbCmd = this.adb.replace(/"/g, ''); logger.debug("spawning: " + adbCmd + " " + args.join(" ")); return spawn(adbCmd, args); }; // android:process= may be defined in AndroidManifest.xml // http://developer.android.com/reference/android/R.attr.html#process // note that the process name when used with ps must be truncated to the last 15 chars // ps -c com.example.android.apis becomes ps -c le.android.apis ADB.prototype.processFromManifest = function (localApk, cb) { this.checkAaptPresent(function (err) { if (err) return cb(err); var extractProcess = [this.binaries.aapt, 'dump', 'xmltree', localApk, 'AndroidManifest.xml'].join(' '); logger.debug("processFromManifest: " + extractProcess); exec(extractProcess, { maxBuffer: 524288 }, function (err, stdout, stderr) { if (err || stderr) { logger.warn(stderr); return cb(new Error("processFromManifest failed. " + err)); } var result = null; var lines = stdout.split("\n"); var applicationRegex = new RegExp(/\s+E: application \(line=\d+\).*/); var applicationFound = false; var attributeRegex = new RegExp(/\s+A: .+/); var processRegex = new RegExp(/\s+A: android:process\(0x01010011\)="([^"]+).*"/); for (var i = 0; i < lines.length; i++) { var line = lines[i]; if (!applicationFound) { if (applicationRegex.test(line)) { applicationFound = true; } } else { var notAttribute = !attributeRegex.test(line); // process must be an attribute after application. if (notAttribute) { break; } var process = processRegex.exec(line); // this is an application attribute process. if (process && process.length > 1) { result = process[1]; // must trim to last 15 for android's ps binary if (result.length > 15) result = result.substr(result.length - 15); break; } } } cb(null, result); }); }.bind(this)); }; ADB.prototype.packageAndLaunchActivityFromManifest = function (localApk, cb) { this.checkAaptPresent(function (err) { if (err) return cb(err); var badging = [this.binaries.aapt, 'dump', 'badging', localApk].join(' '); logger.debug("packageAndLaunchActivityFromManifest: " + badging); exec(badging, { maxBuffer: 524288 }, function (err, stdout, stderr) { if (err || stderr) { logger.warn(stderr); return cb(new Error("packageAndLaunchActivityFromManifest failed. " + err)); } var apkPackage = new RegExp(/package: name='([^']+)'/g).exec(stdout); if (apkPackage && apkPackage.length >= 2) { apkPackage = apkPackage[1]; } else { apkPackage = null; } var apkActivity = new RegExp(/launchable-activity: name='([^']+)'/g).exec(stdout); if (apkActivity && apkActivity.length >= 2) { apkActivity = apkActivity[1]; } else { apkActivity = null; } logger.debug("badging package: " + apkPackage); logger.debug("badging act: " + apkActivity); cb(null, apkPackage, apkActivity); }); }.bind(this)); }; ADB.prototype.processExists = function (process, cb) { if (!this.isValidClass(process)) return cb(new Error("Invalid process name: " + process)); var existsCmd = "ps list -c " + process; this.shell(existsCmd, function (err, stdout) { if (err) { logger.warn(err); return cb(err); } var exists = false; if (stdout) { var lines = stdout.split(/\r?\n/); if (lines.length > 1) { var found = lines[1]; if (found && /\S/.test(found)) { exists = true; } } } cb(null, exists); }); }; ADB.prototype.compileManifest = function (manifest, manifestPackage, targetPackage, cb) { logger.info("Compiling manifest " + manifest); var platform = helpers.getAndroidPlatform(); if (!platform || !platform[1]) { return cb(new Error("Required platform doesn't exist (API level >= 17)")); } // Compile manifest into manifest.xml.apk var compileManifest = [this.binaries.aapt + ' package -M "', manifest + '"', ' --rename-manifest-package "', manifestPackage + '"', ' --rename-instrumentation-target-package "', targetPackage + '"', ' -I "', path.resolve(platform[1], 'android.jar') + '" -F "', manifest, '.apk" -f'].join(''); logger.debug(compileManifest); exec(compileManifest, { maxBuffer: 524288 }, function (err, stdout, stderr) { if (err) { logger.debug(stderr); return cb("error compiling manifest"); } logger.debug("Compiled manifest"); cb(); }); }; ADB.prototype.insertManifest = function (manifest, srcApk, dstApk, cb) { logger.info("Inserting manifest, src: " + srcApk + ", dst: " + dstApk); var extractManifest = function (cb) { logger.debug("Extracting manifest"); // Extract compiled manifest from manifest.xml.apk unzipFile(manifest + '.apk', function (err, stderr) { if (err) { logger.info("Error unzipping manifest apk, here's stderr:"); logger.debug(stderr); return cb(err); } cb(); }); }; var createTmpApk = function (cb) { logger.debug("Writing tmp apk. " + srcApk + ' to ' + dstApk); ncp(srcApk, dstApk, cb); }; var testDstApk = function (cb) { logger.debug("Testing new tmp apk."); testZipArchive(dstApk, cb); }; var moveManifest = function (cb) { if (isWindows) { var java = path.resolve(process.env.JAVA_HOME, 'bin', 'java'); java = isWindows ? '"' + java + '.exe"' : '"' + java + '"'; var moveManifestCmd = '"' + path.resolve(helperJarPath, 'move_manifest.jar') + '"'; moveManifestCmd = [java, '-jar', moveManifestCmd, '"' + dstApk + '"', '"' + manifest + '"'].join(' '); logger.debug("Moving manifest with: " + moveManifestCmd); exec(moveManifestCmd, { maxBuffer: 524288 }, function (err) { if (err) { logger.info("Got error moving manifest: " + err); return cb(err); } logger.debug("Inserted manifest."); cb(null); }); } else { // Insert compiled manifest into /tmp/appPackage.clean.apk // -j = keep only the file, not the dirs // -m = move manifest into target apk. var replaceCmd = 'zip -j -m "' + dstApk + '" "' + manifest + '"'; logger.debug("Moving manifest with: " + replaceCmd); exec(replaceCmd, { maxBuffer: 524288 }, function (err) { if (err) { logger.info("Got error moving manifest: " + err); return cb(err); } logger.debug("Inserted manifest."); cb(); }); } }; async.series([ function (cb) { extractManifest(cb); }, function (cb) { createTmpApk(cb); }, function (cb) { testDstApk(cb); }, function (cb) { moveManifest(cb); } ], cb); }; ADB.prototype.signWithDefaultCert = function (apk, cb) { var signPath = path.resolve(helperJarPath, 'sign.jar'); var resign = 'java -jar "' + signPath + '" "' + apk + '" --override'; logger.debug("Resigning apk with: " + resign); exec(resign, { maxBuffer: 524288 }, function (err, stdout, stderr) { if (stderr.indexOf("Input is not an existing file") !== -1) { logger.warn("Could not resign apk, got non-existing file error"); return cb(new Error("Could not sign apk. Are you sure " + "the file path is correct: " + JSON.stringify(apk))); } cb(err); }); }; ADB.prototype.signWithCustomCert = function (apk, cb) { var jarsigner = path.resolve(process.env.JAVA_HOME, 'bin', 'jarsigner'); jarsigner = isWindows ? '"' + jarsigner + '.exe"' : '"' + jarsigner + '"'; var java = path.resolve(process.env.JAVA_HOME, 'bin', 'java'); java = isWindows ? '"' + java + '.exe"' : '"' + java + '"'; var unsign = '"' + path.resolve(helperJarPath, 'unsign.jar') + '"'; unsign = [java, '-jar', unsign, '"' + apk + '"'].join(' '); if (!fs.existsSync(this.keystorePath)) { return cb(new Error("Keystore doesn't exist. " + this.keystorePath)); } var sign = [jarsigner, '"' + apk + '"', '-sigalg MD5withRSA', '-digestalg SHA1', '-keystore "' + this.keystorePath + '"', '-storepass "' + this.keystorePassword + '"', '-keypass "' + this.keyPassword + '"', '"' + this.keyAlias + '"'].join(' '); logger.debug("Unsigning apk with: " + unsign); exec(unsign, { maxBuffer: 524288 }, function (err, stdout, stderr) { if (err || stderr) { logger.warn(stderr); return cb(new Error("Could not unsign apk. Are you sure " + "the file path is correct: " + JSON.stringify(apk))); } logger.debug("Signing apk with: " + sign); exec(sign, { maxBuffer: 524288 }, function (err, stdout, stderr) { if (err || stderr) { logger.warn(stderr); return cb(new Error("Could not sign apk. Are you sure " + "the file path is correct: " + JSON.stringify(apk))); } cb(err); }); }); }; ADB.prototype.sign = function (apk, cb) { async.series([ function (cb) { if (this.useKeystore) { this.signWithCustomCert(apk, cb); } else { this.signWithDefaultCert(apk, cb); } }.bind(this), function (cb) { this.zipAlignApk(apk, cb); }.bind(this), ], cb); }; ADB.prototype.zipAlignApk = function (apk, cb) { logger.info("Zip-aligning " + apk); this.checkZipAlignPresent(function (err) { if (err) return cb(err); var alignedApk = temp.path({prefix: 'appium', suffix: '.tmp'}); mkdirp.sync(path.dirname(alignedApk)); var alignApk = [this.binaries.zipalign, '-f', '4', '"' + apk + '"', '"' + alignedApk + '"'].join(' '); logger.debug("zipAlignApk: " + alignApk); exec(alignApk, { maxBuffer: 524288 }, function (err, stdout, stderr) { if (err || stderr) { logger.warn(stderr); return cb(new Error("zipAlignApk failed. " + err)); } if (fs.existsSync(apk)) fs.unlinkSync(apk); fs.renameSync(alignedApk, apk); cb(); }); }.bind(this)); }; // returns true when already signed, false otherwise. ADB.prototype.checkApkCert = function (apk, pkg, cb) { if (!fs.existsSync(apk)) { logger.debug("APK doesn't exist. " + apk); return cb(null, false); } if (this.useKeystore) { return this.checkCustomApkCert(apk, pkg, cb); } var verifyPath = path.resolve(helperJarPath, 'verify.jar'); var resign = 'java -jar "' + verifyPath + '" "' + apk + '"'; logger.debug("Checking app cert for " + apk + ": " + resign); exec(resign, { maxBuffer: 524288 }, function (err) { if (err) { logger.debug("App not signed with debug cert."); return cb(null, false); } logger.debug("App already signed."); this.zipAlignApk(apk, function (err) { if (err) return cb(err); cb(null, true); }); }.bind(this)); }; ADB.prototype.checkCustomApkCert = function (apk, pkg, cb) { var h = "a-fA-F0-9"; var md5Str = ['.*MD5.*((?:[', h, ']{2}:){15}[', h, ']{2})'].join(''); var md5 = new RegExp(md5Str, 'mi'); var keytool = path.resolve(process.env.JAVA_HOME, 'bin', 'keytool'); keytool = isWindows ? '"' + keytool + '.exe"' : '"' + keytool + '"'; this.getKeystoreMd5(keytool, md5, function (err, keystoreHash) { if (err) return cb(err); this.checkApkKeystoreMatch(keytool, md5, keystoreHash, pkg, apk, cb); }.bind(this)); }; ADB.prototype.getKeystoreMd5 = function (keytool, md5re, cb) { var keystoreHash; var keystore = [keytool, '-v', '-list', '-alias "' + this.keyAlias + '"', '-keystore "' + this.keystorePath + '"', '-storepass "' + this.keystorePassword + '"'].join(' '); logger.debug("Printing keystore md5: " + keystore); exec(keystore, { maxBuffer: 524288 }, function (err, stdout) { if (err) return cb(err); keystoreHash = md5re.exec(stdout); keystoreHash = keystoreHash ? keystoreHash[1] : null; logger.debug('Keystore MD5: ' + keystoreHash); cb(null, keystoreHash); }); }; ADB.prototype.checkApkKeystoreMatch = function (keytool, md5re, keystoreHash, pkg, apk, cb) { var entryHash = null; var zip = new AdmZip(apk); var rsa = /^META-INF\/.*\.[rR][sS][aA]$/; var entries = zip.getEntries(); var responded = false; var examined = 0; var onExamine = function (err, matched) { examined++; if (!responded) { if (err) { responded = true; return cb(err); } else if (matched) { responded = true; return cb(null, true); } else if (examined === entries.length) { responded = true; return cb(null, false); } } }; var checkMd5 = function (err, stdout) { if (responded) return; entryHash = md5re.exec(stdout); entryHash = entryHash ? entryHash[1] : null; logger.debug('entryHash MD5: ' + entryHash); logger.debug(' keystore MD5: ' + keystoreHash); var matchesKeystore = entryHash && entryHash === keystoreHash; logger.debug('Matches keystore? ' + matchesKeystore); if (matchesKeystore) { onExamine(null, true); } else { onExamine(null, false); } }; for (var i = 0; i < entries.length; i++) { if (responded) break; var entry = entries.pop(); // meta-inf tends to be at the end entry = entry.entryName; if (!rsa.test(entry)) { onExamine(null, false); continue; } logger.debug("Entry: " + entry); var entryPath = path.join(getTempPath(), pkg, 'cert'); logger.debug("entryPath: " + entryPath); var entryFile = path.join(entryPath, entry); logger.debug("entryFile: " + entryFile); // ensure /tmp/pkg/cert/ doesn't exist or extract will fail. rimraf.sync(entryPath); // META-INF/CERT.RSA zip.extractEntryTo(entry, entryPath, true); // overwrite = true logger.debug("extracted!"); // check for match var md5Entry = [keytool, '-v', '-printcert', '-file', entryFile].join(' '); logger.debug("Printing apk md5: " + md5Entry); exec(md5Entry, { maxBuffer: 524288 }, checkMd5); } }; ADB.prototype.getDevicesWithRetry = function (timeoutMs, cb) { if (typeof timeoutMs === "function") { cb = timeoutMs; timeoutMs = 20000; } var start = Date.now(); logger.info("Trying to find a connected android device"); var error = new Error("Could not find a connected Android device."); var getDevices = function () { this.getConnectedDevices(function (err, devices) { if (err || devices.length < 1) { if ((Date.now() - start) > timeoutMs) { cb(error); } else { logger.info("Could not find devices, restarting adb server..."); setTimeout(function () { this.restartAdb(function () { getDevices(); }.bind(this)); }.bind(this), 1000); } } else { cb(null, devices); } }.bind(this)); }.bind(this); getDevices(); }; ADB.prototype.getApiLevel = function (cb) { logger.info("Getting device API level"); this.shell("getprop ro.build.version.sdk", function (err, stdout) { if (err) { logger.warn(err); cb(err); } else { logger.info("Device is at API Level " + stdout.trim()); cb(null, stdout); } }); }; ADB.prototype.getEmulatorPort = function (cb) { logger.info("Getting running emulator port"); if (this.emulatorPort !== null) { return cb(null, this.emulatorPort); } this.getConnectedDevices(function (err, devices) { if (err || devices.length < 1) { cb(new Error("No devices connected")); } else { // pick first device var port = this.getPortFromEmulatorString(devices[0].udid); if (port) { cb(null, port); } else { cb(new Error("Emulator port not found")); } } }.bind(this)); }; ADB.prototype.rimraf = function (path, cb) { this.shell('rm -rf ' + path, cb); }; ADB.prototype.push = function (localPath, remotePath, cb) { try { localPath = JSON.parse(localPath); } catch (e) { } localPath = JSON.stringify(localPath); this.exec('push ' + localPath + ' ' + remotePath, cb); }; ADB.prototype.pull = function (remotePath, localPath, cb) { try { localPath = JSON.parse(localPath); } catch (e) { } localPath = JSON.stringify(localPath); this.exec('pull ' + remotePath + ' ' + localPath, cb); }; ADB.prototype.getPortFromEmulatorString = function (emStr) { var portPattern = /emulator-(\d+)/; if (portPattern.test(emStr)) { return parseInt(portPattern.exec(emStr)[1], 10); } return false; }; ADB.prototype.getRunningAVD = function (avdName, cb) { logger.info("Trying to find " + avdName + " emulator"); this.getConnectedEmulators(function (err, emulators) { if (err || emulators.length < 1) { return cb(new Error("No emulators connected"), null); } else { async.forEach(emulators, function (emulator, asyncCb) { this.setEmulatorPort(emulator.port); this.sendTelnetCommand("avd name", function (err, runningAVDName) { if (avdName === runningAVDName) { logger.info("Found emulator " + avdName + " in port " + emulator.port); this.setDeviceId(emulator.udid); return cb(null, emulator); } asyncCb(); }.bind(this)); }.bind(this), function (err) { logger.info("Emulator " + avdName + " not running"); cb(err, null); }); } }.bind(this)); }; ADB.prototype.getRunningAVDWithRetry = function (avdName, timeoutMs, cb) { var start = Date.now(); var error = new Error("Could not find " + avdName + " emulator."); var getAVD = function () { this.getRunningAVD(avdName.replace('@', ''), function (err, runningAVD) { if (err || runningAVD === null) { if ((Date.now() - start) > timeoutMs) { cb(error); } else { setTimeout(function () { getAVD(); }.bind(this), 2000); } } else { cb(); } }.bind(this)); }.bind(this); getAVD(); }; ADB.prototype.killAllEmulators = function (cb) { var killallCmd = isWindows ? "TASKKILL /IM emulator.exe" : "/usr/bin/killall -m emulator*"; exec(killallCmd, { maxBuffer: 524288 }, function (err) { if (err) { logger.info("Could not kill emulator. It was probably not running.: " + err.message); } cb(); }); }; ADB.prototype.launchAVD = function (avdName, avdArgs, cb) { logger.info("Launching Emulator with AVD " + avdName); this.checkSdkBinaryPresent("emulator", function (err, emulatorBinaryPath) { if (err) return cb(err); if (avdName[0] !== "@") { avdName = "@" + avdName; } if (avdArgs === null) { avdArgs = [avdName]; } else { avdArgs = [avdName, avdArgs]; } var proc = spawn(emulatorBinaryPath.substr(1, emulatorBinaryPath.length - 2), avdArgs); proc.on("error", function (err) { logger.error("Unable to start Emulator: " + err.message); // actual error will get caught by getRunningAVDWithRetry }); proc.stderr.on('data', function (data) { logger.error("Unable to start Emulator: " + data); }); proc.stdout.on('data', function (data) { if (data.toString().indexOf('ERROR') > -1) { logger.error("Unable to start Emulator: " + data); } }); this.getRunningAVDWithRetry(avdName.replace('@', ''), 120000, function (err) { if (err) return cb(err); this.waitForEmulatorReady(120000, cb); }.bind(this)); }.bind(this)); }; ADB.prototype.waitForEmulatorReady = function (timeoutMs, cb) { var start = Date.now(); var error = new Error("Emulator is not ready."); logger.info("Waiting until emulator is ready"); var getBootAnimStatus = function () { this.shell("getprop init.svc.bootanim", function (err, stdout) { if (err || stdout === null || stdout.indexOf('stopped') !== 0) { if ((Date.now() - start) > timeoutMs) { cb(error); } else { setTimeout(function () { getBootAnimStatus(); }.bind(this), 3000); } } else { cb(); } }.bind(this)); }.bind(this); getBootAnimStatus(); }; ADB.prototype.getConnectedDevices = function (cb) { this.debug("Getting connected devices..."); this.exec("devices", function (err, stdout) { if (err) return cb(err); if (stdout.toLowerCase().indexOf("error") !== -1) { logger.error(stdout); cb(new Error(stdout)); } else { var devices = []; _.each(stdout.split("\n"), function (line) { if (line.trim() !== "" && line.indexOf("List of devices") === -1 && line.indexOf("* daemon") === -1 && line.indexOf("offline") === -1) { var lineInfo = line.split("\t"); // state is either "device" or "offline", afaict devices.push({udid: lineInfo[0], state: lineInfo[1]}); } }); this.debug(devices.length + " device(s) connected"); cb(null, devices); } }.bind(this)); }; ADB.prototype.getConnectedEmulators = function (cb) { logger.debug("Getting connected emulators"); this.getConnectedDevices(function (err, devices) { if (err) return cb(err); var emulators = []; _.each(devices, function (device) { var port = this.getPortFromEmulatorString(device.udid); if (port) { device.port = port; emulators.push(device); } }.bind(this)); logger.debug(emulators.length + " emulator(s) connected"); cb(null, emulators); }.bind(this)); }; ADB.prototype.forwardPort = function (systemPort, devicePort, cb) { this.debug("Forwarding system:" + systemPort + " to device:" + devicePort); this.exec("forward tcp:" + systemPort + " tcp:" + devicePort, cb); }; ADB.prototype.forwardAbstractPort = function (systemPort, devicePort, cb) { this.debug("Forwarding system:" + systemPort + " to abstract device:" + devicePort); this.exec("forward tcp:" + systemPort + " localabstract:" + devicePort, cb); }; ADB.prototype.isDeviceConnected = function (cb) { this.getConnectedDevices(function (err, devices) { if (err) { cb(err); } else { cb(null, devices.length > 0); } }); }; /* * Check whether the ADB connection is up */ ADB.prototype.ping = function (cb) { this.shell("echo 'ping'", function (err, stdout) { if (!err && stdout.indexOf("ping") === 0) { cb(null, true); } else if (err) { cb(err); } else { cb(new Error("ADB ping failed, returned: " + stdout)); } }); }; ADB.prototype.setDeviceId = function (deviceId) { logger.info("Setting device id to " + deviceId); this.curDeviceId = deviceId; this.adbCmd = this.adb + " -s " + deviceId; }; ADB.prototype.setEmulatorPort = function (emPort) { this.emulatorPort = emPort; }; ADB.prototype.waitForDevice = function (cb) { var doWait = function (innerCb) { this.debug("Waiting for device to be ready and to respond to shell " + "commands (timeout = " + this.appDeviceReadyTimeout + ")"); var movedOn = false , timeoutSecs = parseInt(this.appDeviceReadyTimeout, 10); setTimeout(function () { if (!movedOn) { movedOn = true; innerCb("Device did not become ready in " + timeoutSecs + " secs; " + "are you sure it's powered on?"); } }.bind(this), timeoutSecs * 1000); this.exec("wait-for-device", function (err) { if (!movedOn) { if (err) { logger.error("Error running wait-for-device"); movedOn = true; innerCb(err); } else { this.shell("echo 'ready'", function (err) { if (!movedOn) { movedOn = true; if (err) { logger.error("Error running shell echo: " + err); innerCb(err); } else { innerCb(); } } }.bind(this)); } } }.bind(this)); }.bind(this); doWait(function (err) { if (err) { this.restartAdb(function () { this.getConnectedDevices(function () { doWait(cb); }); }.bind(this)); } else { cb(null); } }.bind(this)); }; ADB.prototype.restartAdb = function (cb) { this.exec("kill-server", function (err) { if (err) { logger.error("Error killing ADB server, going to see if it's online " + "anyway"); } cb(); }); }; ADB.prototype.restart = function (cb) { async.series([ this.stopLogcat.bind(this) , this.restartAdb.bind(this) , this.waitForDevice.bind(this) , this.startLogcat.bind(this) ], cb); }; ADB.prototype.startLogcat = function (cb) { if (this.logcat !== null) { cb(new Error("Trying to start logcat capture but it's already started!")); return; } var adbCmd = this.adbCmd.replace(/"/g, ''); this.logcat = new Logcat({ adbCmd: adbCmd , debug: false , debugTrace: false }); this.logcat.startCapture(cb); }; ADB.prototype.stopLogcat = function (cb) { if (this.logcat !== null) { this.logcat.stopCapture(cb); this.logcat = null; } else { cb(); } }; ADB.prototype.getLogcatLogs = function () { if (this.logcat === null) { throw new Error("Can't get logcat logs since logcat hasn't started"); } return this.logcat.getLogs(); }; ADB.prototype.getPIDsByName = function (name, cb) { logger.info("Getting all processes with '" + name + "'"); this.shell("ps '" + name + "'", function (err, stdout) { if (err) return cb(err); stdout = stdout.trim(); var procs = []; var outlines = stdout.split("\n"); _.each(outlines, function (outline) { if (outline.indexOf(name) !== -1) { procs.push(outline); } }); if (procs.length < 1) { logger.info("No matching processes found"); return cb(null, []); } var pids = []; _.each(procs, function (proc) { var match = /[^\t ]+[\t ]+([0-9]+)/.exec(proc); if (match) { pids.push(parseInt(match[1], 10)); } }); if (pids.length !== procs.length) { var msg = "Could not extract PIDs from ps output. PIDS: " + JSON.stringify(pids) + ", Procs: " + JSON.stringify(procs); return cb(new Error(msg)); } cb(null, pids); }); }; ADB.prototype.killProcessesByName = function (name, cb) { logger.info("Attempting to kill all '" + name + "' processes"); this.getPIDsByName(name, function (err, pids) { if (err) return cb(err); var killNext = function (err) { if (err) return cb(err); var pid = pids.pop(); if (typeof pid !== "undefined") { this.killProcessByPID(pid, killNext); } else { cb(); } }.bind(this); killNext(); }.bind(this)); }; ADB.prototype.killProcessByPID = function (pid, cb) { logger.info("Attempting to kill process " + pid); this.shell("kill " + pid, cb); }; ADB.prototype.startApp = function (pkg, activity, waitPkg, waitActivity, retry, stopApp, cb) { if (typeof waitPkg === "function") { cb = waitPkg; waitPkg = false; waitActivity = false; retry = true; stopApp = true; } else if (typeof waitActivity === "function") { cb = waitActivity; waitActivity = false; retry = true; stopApp = true; } else if (typeof retry === "function") { cb = retry; retry = true; stopApp = true; } else if (typeof stopApp === "function") { cb = stopApp; stopApp = true; } else if (typeof stopApp === "undefined") { stopApp = true; } // Prevent null wait package. waitPkg = waitPkg || pkg; var stop = stopApp ? "-S " : ""; var cmd = "am start " + stop + "-a android.intent.action.MAIN " + "-c android.intent.category.LAUNCHER -f 0x10200000 " + "-n " + pkg + "/" + activity; this.shell(cmd, function (err, stdout) { if (err) return cb(err); if (stdout.indexOf("Error: Activity class") !== -1 && stdout.indexOf("does not exist") !== -1) { if (!activity) { return cb(new Error("Parameter 'app-activity' is required for launching application")); } if (retry && activity[0] !== ".") { logger.info("We tried to start an activity that doesn't exist, " + "retrying with . prepended to activity"); activity = "." + activity; retry = false; return this.startApp(pkg, activity, waitPkg, waitActivity, retry, stopApp, cb); } else { var msg = "Activity used to start app doesn't exist! Make sure " + "it exists"; logger.error(msg); return cb(new Error(msg)); } } if (waitActivity) { this.waitForActivity(waitPkg, waitActivity, cb); } else { cb(); } }.bind(this)); }; ADB.prototype.isValidClass = function (classString) { // some.package/some.package.Activity return new RegExp(/^[a-zA-Z0-9\./_]+$/).exec(classString); }; ADB.prototype.broadcastProcessEnd = function (intent, process, cb) { // start the broadcast without waiting for it to finish. this.broadcast(intent, function () {}); // wait for the process to end var start = Date.now(); var timeoutMs = 40000; var intMs = 400; var waitForDeath = function () { this.processExists(process, function (err, exists) { if (!exists) { cb(); } else if ((Date.now() - start) < timeoutMs) { setTimeout(waitForDeath, intMs); } else { cb(new Error("Process never died within " + timeoutMs + " ms.")); } }); }.bind(this); waitForDeath(); }; ADB.prototype.broadcast = function (intent, cb) { if (!this.isValidClass(intent)) return cb(new Error("Invalid intent " + intent)); var cmd = "am broadcast -a " + intent; logger.info("Broadcasting: " + cmd); this.shell(cmd, cb); }; ADB.prototype.endAndroidCoverage = function () { if (this.instrumentProc) this.instrumentProc.kill(); }; ADB.prototype.androidCoverage = function (instrumentClass, waitPkg, waitActivity, cb) { if (!this.isValidClass(instrumentClass)) return cb(new Error("Invalid class " + instrumentClass)); /* [ '/path/to/android-sdk-macosx/platform-tools/adb', '-s', 'emulator-5554', 'shell', 'am', 'instrument', '-e', 'coverage', 'true', '-w', 'com.example.Pkg/com.example.Pkg.instrumentation.MyInstrumentation' ] */ var args = this.adbCmd.split(' ').concat(('shell am instrument -e coverage true -w ' + instrumentClass).split(' ')); logger.info("Collecting coverage data with: " + args.join(' ')); var adbPath = args.shift().replace(/\"/g, ''); // spawn fails on '"' var alreadyReturned = false; this.instrumentProc = spawn(adbPath, args); // am instrument runs for the life of the app process. this.instrumentProc.on('error', function (err) { logger.error(err); if (!alreadyReturned) { alreadyReturned = true; return cb(err); } }); this.waitForActivity(waitPkg, waitActivity, function (err) { if (!alreadyReturned) { alreadyReturned = true; return cb(err); } }); }; ADB.prototype.getFocusedPackageAndActivity = function (cb) { logger.info("Getting focused package and activity"); var cmd = "dumpsys window windows" , nullRe = new RegExp(/mFocusedApp=null/) , searchRe = new RegExp(/mFocusedApp.+ ([a-zA-Z0-9\._]+)\/(\.?[^\} ]+).*\}/); this.shell(cmd, function (err, stdout) { if (err) return cb(err); var foundMatch = false; var foundNullMatch = false; _.each(stdout.split("\n"), function (line) { var match = searchRe.exec(line); if (match) { foundMatch = match; } else if (nullRe.test(line)) { foundNullMatch = true; } }); if (foundMatch) { cb(null, foundMatch[1].trim(), foundMatch[2].trim()); } else if (foundNullMatch) { cb(null, null, null); } else { cb(new Error("Could not parse activity from dumpsys")); } }.bind(this)); }; ADB.prototype.waitForActivityOrNot = function (pkg, activity, not, waitMs, cb) { if (typeof waitMs === "function") { cb = waitMs; waitMs = 20000; } if (!pkg) return cb(new Error("Package must not be null.")); logger.info("Waiting for activity to " + (not ? "not" : "") + " be focused"); var intMs = 750 , endAt = Date.now() + waitMs; if (activity.indexOf(pkg) === 0) { activity = activity.substring(pkg.length); } var checkForActivity = function (foundPackage, foundActivity) { var foundAct = false; if (foundPackage === pkg) { _.each(activity.split(','), function (act) { act = act.trim(); if (act === foundActivity || "." + act === foundActivity) { foundAct = true; } }); } return foundAct; }; var wait = function () { this.getFocusedPackageAndActivity(function (err, foundPackage, foundActivity) { var foundAct = checkForActivity(foundPackage, foundActivity); if ((!not && foundAct) || (not && !foundAct)) { cb(); } else if (Date.now() < endAt) { if (err) logger.info(err); setTimeout(wait, intMs); } else { var verb = not ? "stopped" : "started"; var msg = pkg + "/" + activity + " never " + verb + ". Current: " + foundPackage + "/" + foundActivity; logger.error(msg); cb(new Error(msg)); } }.bind(this)); }.bind(this); wait(); }; ADB.prototype.waitForActivity = function (pkg, act, waitMs, cb) { this.waitForActivityOrNot(pkg, act, false, waitMs, cb); }; ADB.prototype.waitForNotActivity = function (pkg, act, waitMs, cb) { this.waitForActivityOrNot(pkg, act, true, waitMs, cb); }; ADB.prototype.uninstallApk = function (pkg, cb) { logger.info("Uninstalling " + pkg); this.exec("uninstall " + pkg, {timeout: 20000}, function (err, stdout) { if (err) { logger.error(err); cb(err); } else { stdout = stdout.trim(); // stdout may contain warnings meaning success is not on the first line. if (stdout.indexOf("Success") !== -1) { logger.debug("App was uninstalled"); } else { logger.debug("App was not uninstalled, maybe it wasn't on device?"); } cb(); } }); }; ADB.prototype.installRemote = function (remoteApk, cb) { var cmd = 'pm install -r ' + remoteApk; this.shell(cmd, function (err, stdout) { if (err) return cb(err); if (stdout.indexOf("Failure") !== -1) { return cb(new Error("Remote install failed: " + stdout)); } cb(); }); }; ADB.prototype.install = function (apk, replace, cb) { if (typeof replace === "function") { cb = replace; replace = true; } var cmd = 'install '; if (replace) { cmd += '-r '; } cmd += '"' + apk + '"'; this.exec(cmd, cb); }; ADB.prototype.mkdir = function (remotePath, cb) { this.shell('mkdir -p ' + remotePath, cb); }; ADB.prototype.instrument = function (pkg, activity, instrumentWith, cb) { if (activity[0] !== ".") { pkg = ""; } var cmd = "am instrument -e main_activity '" + pkg + activity + "' " + instrumentWith; cmd = cmd.replace(/\.+/g, '.'); // Fix pkg..activity error this.shell(cmd, function (err, stdout) { if (err) return cb(err); if (stdout.indexOf("Exception") !== -1) { logger.error(stdout); var msg = stdout.split("\n")[0] || "Unknown exception during " + "instrumentation"; return cb(new Error(msg)); } cb(); }); }; ADB.prototype.checkAndSignApk = function (apk, pkg, cb) { this.checkApkCert(apk, pkg, function (err, appSigned) { if (err) return cb(err); if (!appSigned) { this.sign(apk, cb); } else { cb(); } }.bind(this)); }; ADB.prototype.forceStop = function (pkg, cb) { this.shell('am force-stop ' + pkg, cb); }; ADB.prototype.clear = function (pkg, cb) { this.shell("pm clear " + pkg, cb); }; ADB.prototype.stopAndClear = function (pkg, cb) { this.forceStop(pkg, function (err) { if (err) return cb(err); this.clear(pkg, cb); }.bind(this)); }; ADB.prototype.isAppInstalled = function (pkg, cb) { var installed = false; logger.debug("Getting install status for " + pkg); var listPkgCmd = "pm list packages -3 " + pkg; this.shell(listPkgCmd, function (err, stdout) { if (err) return cb(err); var apkInstalledRgx = new RegExp('^package:' + pkg.replace(/([^a-zA-Z])/g, "\\$1") + '$', 'm'); installed = apkInstalledRgx.test(stdout); this.debug("App is" + (!installed ? " not" : "") + " installed"); cb(null, installed); }.bind(this)); }; ADB.prototype.back = function (cb) { this.debug("Pressing the BACK button"); var cmd = this.adbCmd + " shell input keyevent 4"; exec(cmd, { maxBuffer: 524288 }, function () { cb(); }); }; ADB.prototype.goToHome = function (cb) { this.debug("Pressing the HOME button"); this.keyevent(3, cb); }; ADB.prototype.keyevent = function (keycode, cb) { var code = parseInt(keycode, 10); // keycode must be an int. var cmd = 'input keyevent ' + code; this.shell(cmd, cb); }; ADB.prototype.isScreenLocked = function (cb) { var cmd = "dumpsys window"; this.shell(cmd, function (err, stdout) { if (err) return cb(err); var dumpsysFile = path.resolve(__dirname, "..", "..", "..", ".dumpsys.log"); logger.info("Writing dumpsys output to " + dumpsysFile); fs.writeFileSync(dumpsysFile, stdout); var screenLocked = /mShowingLockscreen=\w+/gi.exec(stdout); var samsungNoteUnlocked = /mScreenOnFully=\w+/gi.exec(stdout); var gbScreenLocked = /mCurrentFocus.+Keyguard/gi.exec(stdout); if (screenLocked && screenLocked[0]) { if (screenLocked[0].split('=')[1] === 'false') { cb(null, false); } else { cb(null, true); } } else if (gbScreenLocked && gbScreenLocked[0]) { cb(null, true); } else if (samsungNoteUnlocked && samsungNoteUnlocked[0]) { if (samsungNoteUnlocked[0].split('=')[1] === 'true') { cb(null, false); } else { cb(null, true); } } else { cb(null, false); } }); }; ADB.prototype.sendTelnetCommand = function (command, cb) { logger.info("Sending telnet command to device: " + command); this.getEmulatorPort(function (err, port) { if (err) return cb(err); var conn = net.createConnection(port, 'localhost'); var connected = false; var readyRegex = /^OK$/m; var dataStream = ""; var res = null; var onReady = function () { logger.info("Socket connection to device ready"); conn.write(command + "\n"); }; conn.on('connect', function () { logger.info("Socket connection to device created"); }); conn.on('data', function (data) { data = data.toString('utf8'); if (!connected) { if (readyRegex.test(data)) { connected = true; onReady(); } } else { dataStream += data; if (readyRegex.test(data)) { res = dataStream.replace(readyRegex, "").trim(); logger.info("Telnet command got response: " + res); conn.write("quit\n"); } } }); conn.on('close', function () { if (res === null) { cb(new Error("Never got a response from command")); } else { cb(null, res); } }); }); }; module.exports = ADB;