microsoft/vscode-react-native
Publicmirrored from https://github.com/microsoft/vscode-react-nativeAvailable
src/extension/android/adb.ts
217lines · modeblame
52f3873ddigeff10 years ago | 1 | // Copyright (c) Microsoft Corporation. All rights reserved. |
| 2 | // Licensed under the MIT license. See LICENSE file in the project root for details. | |
| 3 | | |
| 4 | import * as Q from "q"; | |
| 5 | | |
db6fd42aRuslan Bikkinin7 years ago | 6 | import { ChildProcess, ISpawnResult } from "../../common/node/childProcess"; |
| 7 | import { CommandExecutor } from "../../common/commandExecutor"; | |
| 8 | import * as path from "path"; | |
| 9 | import * as fs from "fs"; | |
| 10 | import { ILogger } from "../log/LogHelper"; | |
8b383051Ruslan Bikkinin7 years ago | 11 | import * as os from "os"; |
d7d405aeYuri Skorokhodov7 years ago | 12 | import * as nls from "vscode-nls"; |
| 13 | const localize = nls.loadMessageBundle(); | |
52f3873ddigeff10 years ago | 14 | |
ce7fd946digeff10 years ago | 15 | // See android versions usage at: http://developer.android.com/about/dashboards/index.html |
52f3873ddigeff10 years ago | 16 | export enum AndroidAPILevel { |
ce7fd946digeff10 years ago | 17 | Marshmallow = 23, |
52f3873ddigeff10 years ago | 18 | LOLLIPOP_MR1 = 22, |
| 19 | LOLLIPOP = 21, /* Supports adb reverse */ | |
| 20 | KITKAT = 19, | |
| 21 | JELLY_BEAN_MR2 = 18, | |
| 22 | JELLY_BEAN_MR1 = 17, | |
| 23 | JELLY_BEAN = 16, | |
| 24 | ICE_CREAM_SANDWICH_MR1 = 15, | |
| 25 | GINGERBREAD_MR1 = 10, | |
| 26 | } | |
| 27 | | |
7daed3fcArtem Egorov8 years ago | 28 | enum KeyEvents { |
| 29 | KEYCODE_BACK = 4, | |
| 30 | KEYCODE_DPAD_UP = 19, | |
| 31 | KEYCODE_DPAD_DOWN = 20, | |
| 32 | KEYCODE_DPAD_CENTER = 23, | |
| 33 | KEYCODE_MENU = 82, | |
| 34 | } | |
| 35 | | |
52f3873ddigeff10 years ago | 36 | export enum DeviceType { |
| 37 | AndroidSdkEmulator, // These seem to have emulator-<port> ids | |
27710197Vladimir Kotikov8 years ago | 38 | Other, |
52f3873ddigeff10 years ago | 39 | } |
| 40 | | |
| 41 | export interface IDevice { | |
| 42 | id: string; | |
| 43 | isOnline: boolean; | |
| 44 | type: DeviceType; | |
| 45 | } | |
| 46 | | |
7daed3fcArtem Egorov8 years ago | 47 | const AndroidSDKEmulatorPattern = /^emulator-\d{1,5}$/; |
52f3873ddigeff10 years ago | 48 | |
7daed3fcArtem Egorov8 years ago | 49 | export class AdbHelper { |
db6fd42aRuslan Bikkinin7 years ago | 50 | private childProcess: ChildProcess = new ChildProcess(); |
| 51 | private commandExecutor: CommandExecutor = new CommandExecutor(); | |
| 52 | private adbExecutable: string = ""; | |
78c2b4deRedMickey6 years ago | 53 | private launchActivity: string; |
db6fd42aRuslan Bikkinin7 years ago | 54 | |
78c2b4deRedMickey6 years ago | 55 | constructor(projectRoot: string, logger?: ILogger, launchActivity: string = "MainActivity") { |
10e2def9Yuri Skorokhodov6 years ago | 56 | this.adbExecutable = this.getAdbPath(projectRoot, logger); |
78c2b4deRedMickey6 years ago | 57 | this.launchActivity = launchActivity; |
db6fd42aRuslan Bikkinin7 years ago | 58 | } |
52f3873ddigeff10 years ago | 59 | |
| 60 | /** | |
| 61 | * Gets the list of Android connected devices and emulators. | |
| 62 | */ | |
db6fd42aRuslan Bikkinin7 years ago | 63 | public getConnectedDevices(): Q.Promise<IDevice[]> { |
| 64 | return this.childProcess.execToString(`${this.adbExecutable} devices`) | |
52f3873ddigeff10 years ago | 65 | .then(output => { |
| 66 | return this.parseConnectedDevices(output); | |
| 67 | }); | |
| 68 | } | |
| 69 | | |
78c2b4deRedMickey6 years ago | 70 | public setLaunchActivity(launchActivity: string): void { |
| 71 | this.launchActivity = launchActivity; | |
| 72 | } | |
| 73 | | |
52f3873ddigeff10 years ago | 74 | /** |
| 75 | * Broadcasts an intent to reload the application in debug mode. | |
| 76 | */ | |
db6fd42aRuslan Bikkinin7 years ago | 77 | public switchDebugMode(projectRoot: string, packageName: string, enable: boolean, debugTarget?: string): Q.Promise<void> { |
| 78 | let enableDebugCommand = `${this.adbExecutable} ${debugTarget ? "-s " + debugTarget : ""} shell am broadcast -a "${packageName}.RELOAD_APP_ACTION" --ez jsproxy ${enable}`; | |
b57ea017Artem Egorov8 years ago | 79 | return new CommandExecutor(projectRoot).execute(enableDebugCommand) |
| 80 | .then(() => { // We should stop and start application again after RELOAD_APP_ACTION, otherwise app going to hangs up | |
| 81 | let deferred = Q.defer(); | |
| 82 | setTimeout(() => { | |
| 83 | this.stopApp(projectRoot, packageName, debugTarget) | |
| 84 | .then(() => { | |
| 85 | return deferred.resolve({}); | |
| 86 | }); | |
| 87 | }, 200); // We need a little delay after broadcast command | |
| 88 | | |
| 89 | return deferred.promise; | |
| 90 | }) | |
| 91 | .then(() => { | |
| 92 | return this.launchApp(projectRoot, packageName, debugTarget); | |
| 93 | }); | |
52f3873ddigeff10 years ago | 94 | } |
| 95 | | |
| 96 | /** | |
| 97 | * Sends an intent which launches the main activity of the application. | |
| 98 | */ | |
db6fd42aRuslan Bikkinin7 years ago | 99 | public launchApp(projectRoot: string, packageName: string, debugTarget?: string): Q.Promise<void> { |
78c2b4deRedMickey6 years ago | 100 | let launchAppCommand = `${this.adbExecutable} ${debugTarget ? "-s " + debugTarget : ""} shell am start -n ${packageName}/.${this.launchActivity}`; |
52f3873ddigeff10 years ago | 101 | return new CommandExecutor(projectRoot).execute(launchAppCommand); |
| 102 | } | |
| 103 | | |
db6fd42aRuslan Bikkinin7 years ago | 104 | public stopApp(projectRoot: string, packageName: string, debugTarget?: string): Q.Promise<void> { |
| 105 | let stopAppCommand = `${this.adbExecutable} ${debugTarget ? "-s " + debugTarget : ""} shell am force-stop ${packageName}`; | |
b57ea017Artem Egorov8 years ago | 106 | return new CommandExecutor(projectRoot).execute(stopAppCommand); |
| 107 | } | |
| 108 | | |
db6fd42aRuslan Bikkinin7 years ago | 109 | public apiVersion(deviceId: string): Q.Promise<AndroidAPILevel> { |
52f3873ddigeff10 years ago | 110 | return this.executeQuery(deviceId, "shell getprop ro.build.version.sdk").then(output => |
| 111 | parseInt(output, 10)); | |
| 112 | } | |
| 113 | | |
db6fd42aRuslan Bikkinin7 years ago | 114 | public reverseAdb(deviceId: string, packagerPort: number): Q.Promise<void> { |
b57ea017Artem Egorov8 years ago | 115 | return this.execute(deviceId, `reverse tcp:${packagerPort} tcp:${packagerPort}`); |
52f3873ddigeff10 years ago | 116 | } |
| 117 | | |
db6fd42aRuslan Bikkinin7 years ago | 118 | public showDevMenu(deviceId?: string): Q.Promise<void> { |
| 119 | let command = `${this.adbExecutable} ${deviceId ? "-s " + deviceId : ""} shell input keyevent ${KeyEvents.KEYCODE_MENU}`; | |
7daed3fcArtem Egorov8 years ago | 120 | return this.commandExecutor.execute(command); |
| 121 | } | |
| 122 | | |
db6fd42aRuslan Bikkinin7 years ago | 123 | public reloadApp(deviceId?: string): Q.Promise<void> { |
e23ea82cAlter Code7 years ago | 124 | let command = `${this.adbExecutable} ${deviceId ? "-s " + deviceId : ""} shell input text "RR"`; |
| 125 | return this.commandExecutor.execute(command); | |
7daed3fcArtem Egorov8 years ago | 126 | } |
| 127 | | |
db6fd42aRuslan Bikkinin7 years ago | 128 | public getOnlineDevices(): Q.Promise<IDevice[]> { |
7daed3fcArtem Egorov8 years ago | 129 | return this.getConnectedDevices().then(devices => { |
| 130 | return devices.filter(device => | |
| 131 | device.isOnline); | |
| 132 | }); | |
| 133 | } | |
| 134 | | |
db6fd42aRuslan Bikkinin7 years ago | 135 | public startLogCat(adbParameters: string[]): ISpawnResult { |
| 136 | return new ChildProcess().spawn(`${this.adbExecutable}`, adbParameters); | |
| 137 | } | |
| 138 | | |
8b383051Ruslan Bikkinin7 years ago | 139 | public parseSdkLocation(fileContent: string, logger?: ILogger) { |
| 140 | const matches = fileContent.match(/^sdk\.dir=(.+)$/m); | |
| 141 | if (!matches || !matches[1]) { | |
| 142 | if (logger) { | |
d7d405aeYuri Skorokhodov7 years ago | 143 | logger.info(localize("NoSdkDirFoundInLocalPropertiesFile", "No sdk.dir value found in local.properties file. Using Android SDK location from PATH.")); |
8b383051Ruslan Bikkinin7 years ago | 144 | } |
| 145 | return null; | |
| 146 | } | |
| 147 | | |
| 148 | let sdkLocation = matches[1].trim(); | |
| 149 | if (os.platform() === "win32") { | |
| 150 | // For Windows we need to unescape files separators and drive letter separators | |
| 151 | sdkLocation = sdkLocation.replace(/\\\\/g, "\\").replace("\\:", ":"); | |
| 152 | } | |
| 153 | if (logger) { | |
d7d405aeYuri Skorokhodov7 years ago | 154 | logger.info(localize("UsindAndroidSDKLocationDefinedInLocalPropertiesFile", "Using Android SDK location defined in android/local.properties file: {0}.", sdkLocation)); |
8b383051Ruslan Bikkinin7 years ago | 155 | } |
| 156 | | |
| 157 | return sdkLocation; | |
| 158 | } | |
| 159 | | |
10e2def9Yuri Skorokhodov6 years ago | 160 | public getAdbPath(projectRoot: string, logger?: ILogger): string { |
| 161 | // Trying to read sdk location from local.properties file and if we succueded then | |
| 162 | // we would run adb from inside it, otherwise we would rely to PATH | |
| 163 | const sdkLocation = this.getSdkLocationFromLocalPropertiesFile(projectRoot, logger); | |
| 164 | return sdkLocation ? `"${path.join(sdkLocation, "platform-tools", "adb")}"` : "adb"; | |
| 165 | } | |
| 166 | | |
db6fd42aRuslan Bikkinin7 years ago | 167 | private parseConnectedDevices(input: string): IDevice[] { |
52f3873ddigeff10 years ago | 168 | let result: IDevice[] = []; |
| 169 | let regex = new RegExp("^(\\S+)\\t(\\S+)$", "mg"); | |
| 170 | let match = regex.exec(input); | |
| 171 | while (match != null) { | |
| 172 | result.push({ id: match[1], isOnline: match[2] === "device", type: this.extractDeviceType(match[1]) }); | |
| 173 | match = regex.exec(input); | |
| 174 | } | |
| 175 | return result; | |
| 176 | } | |
| 177 | | |
db6fd42aRuslan Bikkinin7 years ago | 178 | private extractDeviceType(id: string): DeviceType { |
52f3873ddigeff10 years ago | 179 | return id.match(AndroidSDKEmulatorPattern) |
| 180 | ? DeviceType.AndroidSdkEmulator | |
| 181 | : DeviceType.Other; | |
| 182 | } | |
| 183 | | |
db6fd42aRuslan Bikkinin7 years ago | 184 | private executeQuery(deviceId: string, command: string): Q.Promise<string> { |
52f3873ddigeff10 years ago | 185 | return this.childProcess.execToString(this.generateCommandForDevice(deviceId, command)); |
| 186 | } | |
| 187 | | |
db6fd42aRuslan Bikkinin7 years ago | 188 | private execute(deviceId: string, command: string): Q.Promise<void> { |
52f3873ddigeff10 years ago | 189 | return this.commandExecutor.execute(this.generateCommandForDevice(deviceId, command)); |
| 190 | } | |
| 191 | | |
db6fd42aRuslan Bikkinin7 years ago | 192 | private generateCommandForDevice(deviceId: string, adbCommand: string): string { |
| 193 | return `${this.adbExecutable} -s "${deviceId}" ${adbCommand}`; | |
| 194 | } | |
| 195 | | |
| 196 | private getSdkLocationFromLocalPropertiesFile(projectRoot: string, logger?: ILogger): string | null { | |
| 197 | const localPropertiesFilePath = path.join(projectRoot, "android", "local.properties"); | |
| 198 | if (!fs.existsSync(localPropertiesFilePath)) { | |
| 199 | if (logger) { | |
d7d405aeYuri Skorokhodov7 years ago | 200 | logger.info(localize("LocalPropertiesFileDoesNotExist", "local.properties file doesn't exist. Using Android SDK location from PATH.")); |
db6fd42aRuslan Bikkinin7 years ago | 201 | } |
| 202 | return null; | |
| 203 | } | |
| 204 | | |
8b383051Ruslan Bikkinin7 years ago | 205 | let fileContent: string; |
db6fd42aRuslan Bikkinin7 years ago | 206 | try { |
| 207 | fileContent = fs.readFileSync(localPropertiesFilePath).toString(); | |
| 208 | } catch (e) { | |
| 209 | if (logger) { | |
d7d405aeYuri Skorokhodov7 years ago | 210 | logger.error(localize("CouldNotReadFrom", "Couldn't read from {0}.", localPropertiesFilePath), e, e.stack); |
| 211 | logger.info(localize("UsingAndroidSDKLocationFromPATH", "Using Android SDK location from PATH.")); | |
db6fd42aRuslan Bikkinin7 years ago | 212 | } |
| 213 | return null; | |
| 214 | } | |
8b383051Ruslan Bikkinin7 years ago | 215 | return this.parseSdkLocation(fileContent, logger); |
52f3873ddigeff10 years ago | 216 | } |
| 217 | } |