microsoft/vscode-react-native

Public

mirrored from https://github.com/microsoft/vscode-react-nativeAvailable

CodeCommitsIssuesPull requestsActionsInsightsSecurity
0.17.0

Branches

Tags

  • No tags available.
0Branches0Tags
Go to file
Add file
Code

Clone

HTTPS

Download ZIP

src/extension/android/adb.ts

217lines · modeblame

52f3873ddigeff10 years ago1// Copyright (c) Microsoft Corporation. All rights reserved.
2// Licensed under the MIT license. See LICENSE file in the project root for details.
3
4import * as Q from "q";
5
db6fd42aRuslan Bikkinin7 years ago6import { ChildProcess, ISpawnResult } from "../../common/node/childProcess";
7import { CommandExecutor } from "../../common/commandExecutor";
8import * as path from "path";
9import * as fs from "fs";
10import { ILogger } from "../log/LogHelper";
8b383051Ruslan Bikkinin7 years ago11import * as os from "os";
d7d405aeYuri Skorokhodov7 years ago12import * as nls from "vscode-nls";
13const localize = nls.loadMessageBundle();
52f3873ddigeff10 years ago14
ce7fd946digeff10 years ago15// See android versions usage at: http://developer.android.com/about/dashboards/index.html
52f3873ddigeff10 years ago16export enum AndroidAPILevel {
ce7fd946digeff10 years ago17Marshmallow = 23,
52f3873ddigeff10 years ago18LOLLIPOP_MR1 = 22,
19LOLLIPOP = 21, /* Supports adb reverse */
20KITKAT = 19,
21JELLY_BEAN_MR2 = 18,
22JELLY_BEAN_MR1 = 17,
23JELLY_BEAN = 16,
24ICE_CREAM_SANDWICH_MR1 = 15,
25GINGERBREAD_MR1 = 10,
26}
27
7daed3fcArtem Egorov8 years ago28enum KeyEvents {
29KEYCODE_BACK = 4,
30KEYCODE_DPAD_UP = 19,
31KEYCODE_DPAD_DOWN = 20,
32KEYCODE_DPAD_CENTER = 23,
33KEYCODE_MENU = 82,
34}
35
52f3873ddigeff10 years ago36export enum DeviceType {
37AndroidSdkEmulator, // These seem to have emulator-<port> ids
27710197Vladimir Kotikov8 years ago38Other,
52f3873ddigeff10 years ago39}
40
41export interface IDevice {
42id: string;
43isOnline: boolean;
44type: DeviceType;
45}
46
7daed3fcArtem Egorov8 years ago47const AndroidSDKEmulatorPattern = /^emulator-\d{1,5}$/;
52f3873ddigeff10 years ago48
7daed3fcArtem Egorov8 years ago49export class AdbHelper {
db6fd42aRuslan Bikkinin7 years ago50private childProcess: ChildProcess = new ChildProcess();
51private commandExecutor: CommandExecutor = new CommandExecutor();
52private adbExecutable: string = "";
78c2b4deRedMickey6 years ago53private launchActivity: string;
db6fd42aRuslan Bikkinin7 years ago54
78c2b4deRedMickey6 years ago55constructor(projectRoot: string, logger?: ILogger, launchActivity: string = "MainActivity") {
10e2def9Yuri Skorokhodov6 years ago56this.adbExecutable = this.getAdbPath(projectRoot, logger);
78c2b4deRedMickey6 years ago57this.launchActivity = launchActivity;
db6fd42aRuslan Bikkinin7 years ago58}
52f3873ddigeff10 years ago59
60/**
61* Gets the list of Android connected devices and emulators.
62*/
db6fd42aRuslan Bikkinin7 years ago63public getConnectedDevices(): Q.Promise<IDevice[]> {
64return this.childProcess.execToString(`${this.adbExecutable} devices`)
52f3873ddigeff10 years ago65.then(output => {
66return this.parseConnectedDevices(output);
67});
68}
69
78c2b4deRedMickey6 years ago70public setLaunchActivity(launchActivity: string): void {
71this.launchActivity = launchActivity;
72}
73
52f3873ddigeff10 years ago74/**
75* Broadcasts an intent to reload the application in debug mode.
76*/
db6fd42aRuslan Bikkinin7 years ago77public switchDebugMode(projectRoot: string, packageName: string, enable: boolean, debugTarget?: string): Q.Promise<void> {
78let enableDebugCommand = `${this.adbExecutable} ${debugTarget ? "-s " + debugTarget : ""} shell am broadcast -a "${packageName}.RELOAD_APP_ACTION" --ez jsproxy ${enable}`;
b57ea017Artem Egorov8 years ago79return new CommandExecutor(projectRoot).execute(enableDebugCommand)
80.then(() => { // We should stop and start application again after RELOAD_APP_ACTION, otherwise app going to hangs up
81let deferred = Q.defer();
82setTimeout(() => {
83this.stopApp(projectRoot, packageName, debugTarget)
84.then(() => {
85return deferred.resolve({});
86});
87}, 200); // We need a little delay after broadcast command
88
89return deferred.promise;
90})
91.then(() => {
92return this.launchApp(projectRoot, packageName, debugTarget);
93});
52f3873ddigeff10 years ago94}
95
96/**
97* Sends an intent which launches the main activity of the application.
98*/
db6fd42aRuslan Bikkinin7 years ago99public launchApp(projectRoot: string, packageName: string, debugTarget?: string): Q.Promise<void> {
78c2b4deRedMickey6 years ago100let launchAppCommand = `${this.adbExecutable} ${debugTarget ? "-s " + debugTarget : ""} shell am start -n ${packageName}/.${this.launchActivity}`;
52f3873ddigeff10 years ago101return new CommandExecutor(projectRoot).execute(launchAppCommand);
102}
103
db6fd42aRuslan Bikkinin7 years ago104public stopApp(projectRoot: string, packageName: string, debugTarget?: string): Q.Promise<void> {
105let stopAppCommand = `${this.adbExecutable} ${debugTarget ? "-s " + debugTarget : ""} shell am force-stop ${packageName}`;
b57ea017Artem Egorov8 years ago106return new CommandExecutor(projectRoot).execute(stopAppCommand);
107}
108
db6fd42aRuslan Bikkinin7 years ago109public apiVersion(deviceId: string): Q.Promise<AndroidAPILevel> {
52f3873ddigeff10 years ago110return this.executeQuery(deviceId, "shell getprop ro.build.version.sdk").then(output =>
111parseInt(output, 10));
112}
113
db6fd42aRuslan Bikkinin7 years ago114public reverseAdb(deviceId: string, packagerPort: number): Q.Promise<void> {
b57ea017Artem Egorov8 years ago115return this.execute(deviceId, `reverse tcp:${packagerPort} tcp:${packagerPort}`);
52f3873ddigeff10 years ago116}
117
db6fd42aRuslan Bikkinin7 years ago118public showDevMenu(deviceId?: string): Q.Promise<void> {
119let command = `${this.adbExecutable} ${deviceId ? "-s " + deviceId : ""} shell input keyevent ${KeyEvents.KEYCODE_MENU}`;
7daed3fcArtem Egorov8 years ago120return this.commandExecutor.execute(command);
121}
122
db6fd42aRuslan Bikkinin7 years ago123public reloadApp(deviceId?: string): Q.Promise<void> {
e23ea82cAlter Code7 years ago124let command = `${this.adbExecutable} ${deviceId ? "-s " + deviceId : ""} shell input text "RR"`;
125return this.commandExecutor.execute(command);
7daed3fcArtem Egorov8 years ago126}
127
db6fd42aRuslan Bikkinin7 years ago128public getOnlineDevices(): Q.Promise<IDevice[]> {
7daed3fcArtem Egorov8 years ago129return this.getConnectedDevices().then(devices => {
130return devices.filter(device =>
131device.isOnline);
132});
133}
134
db6fd42aRuslan Bikkinin7 years ago135public startLogCat(adbParameters: string[]): ISpawnResult {
136return new ChildProcess().spawn(`${this.adbExecutable}`, adbParameters);
137}
138
8b383051Ruslan Bikkinin7 years ago139public parseSdkLocation(fileContent: string, logger?: ILogger) {
140const matches = fileContent.match(/^sdk\.dir=(.+)$/m);
141if (!matches || !matches[1]) {
142if (logger) {
d7d405aeYuri Skorokhodov7 years ago143logger.info(localize("NoSdkDirFoundInLocalPropertiesFile", "No sdk.dir value found in local.properties file. Using Android SDK location from PATH."));
8b383051Ruslan Bikkinin7 years ago144}
145return null;
146}
147
148let sdkLocation = matches[1].trim();
149if (os.platform() === "win32") {
150// For Windows we need to unescape files separators and drive letter separators
151sdkLocation = sdkLocation.replace(/\\\\/g, "\\").replace("\\:", ":");
152}
153if (logger) {
d7d405aeYuri Skorokhodov7 years ago154logger.info(localize("UsindAndroidSDKLocationDefinedInLocalPropertiesFile", "Using Android SDK location defined in android/local.properties file: {0}.", sdkLocation));
8b383051Ruslan Bikkinin7 years ago155}
156
157return sdkLocation;
158}
159
10e2def9Yuri Skorokhodov6 years ago160public 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
163const sdkLocation = this.getSdkLocationFromLocalPropertiesFile(projectRoot, logger);
164return sdkLocation ? `"${path.join(sdkLocation, "platform-tools", "adb")}"` : "adb";
165}
166
db6fd42aRuslan Bikkinin7 years ago167private parseConnectedDevices(input: string): IDevice[] {
52f3873ddigeff10 years ago168let result: IDevice[] = [];
169let regex = new RegExp("^(\\S+)\\t(\\S+)$", "mg");
170let match = regex.exec(input);
171while (match != null) {
172result.push({ id: match[1], isOnline: match[2] === "device", type: this.extractDeviceType(match[1]) });
173match = regex.exec(input);
174}
175return result;
176}
177
db6fd42aRuslan Bikkinin7 years ago178private extractDeviceType(id: string): DeviceType {
52f3873ddigeff10 years ago179return id.match(AndroidSDKEmulatorPattern)
180? DeviceType.AndroidSdkEmulator
181: DeviceType.Other;
182}
183
db6fd42aRuslan Bikkinin7 years ago184private executeQuery(deviceId: string, command: string): Q.Promise<string> {
52f3873ddigeff10 years ago185return this.childProcess.execToString(this.generateCommandForDevice(deviceId, command));
186}
187
db6fd42aRuslan Bikkinin7 years ago188private execute(deviceId: string, command: string): Q.Promise<void> {
52f3873ddigeff10 years ago189return this.commandExecutor.execute(this.generateCommandForDevice(deviceId, command));
190}
191
db6fd42aRuslan Bikkinin7 years ago192private generateCommandForDevice(deviceId: string, adbCommand: string): string {
193return `${this.adbExecutable} -s "${deviceId}" ${adbCommand}`;
194}
195
196private getSdkLocationFromLocalPropertiesFile(projectRoot: string, logger?: ILogger): string | null {
197const localPropertiesFilePath = path.join(projectRoot, "android", "local.properties");
198if (!fs.existsSync(localPropertiesFilePath)) {
199if (logger) {
d7d405aeYuri Skorokhodov7 years ago200logger.info(localize("LocalPropertiesFileDoesNotExist", "local.properties file doesn't exist. Using Android SDK location from PATH."));
db6fd42aRuslan Bikkinin7 years ago201}
202return null;
203}
204
8b383051Ruslan Bikkinin7 years ago205let fileContent: string;
db6fd42aRuslan Bikkinin7 years ago206try {
207fileContent = fs.readFileSync(localPropertiesFilePath).toString();
208} catch (e) {
209if (logger) {
d7d405aeYuri Skorokhodov7 years ago210logger.error(localize("CouldNotReadFrom", "Couldn't read from {0}.", localPropertiesFilePath), e, e.stack);
211logger.info(localize("UsingAndroidSDKLocationFromPATH", "Using Android SDK location from PATH."));
db6fd42aRuslan Bikkinin7 years ago212}
213return null;
214}
8b383051Ruslan Bikkinin7 years ago215return this.parseSdkLocation(fileContent, logger);
52f3873ddigeff10 years ago216}
217}