Merge pull request #3733 from NativeScript/fatme/emulator-api

Expose emulator api

Author: Fatme

PublicAPI.md

@@ -53,6 +53,9 @@ const tns = require("nativescript");
 * [sysInfo](#sysinfo)
 	* [getSupportedNodeVersionRange](#getsupportednodeversionrange)
 	* [getSystemWarnings](#getsystemwarnings)
+* [devicesService](#devicesService)
+	* [getAvailableEmulators](#getAvailableEmulators)
+	* [startEmulator](#startEmulator)
 
 ## Module projectService
 
@@ -1198,6 +1201,45 @@ tns.sysInfo.getSystemWarnings()
 	.catch(err => console.error(`Error while trying to get system warnings: ${err}`));
 ```
 
+## devicesService
+The `devicesService` module allows interaction with devices and emulators. You can get a list of the available emulators or start a specific emulator.
+
+### getAvailableEmulators
+The `getAvailableEmulators` method returns object of all running and available emulators. The result is in the following format: 
+```JavaScript
+	{
+		android: {
+			devices: Mobile.IDeviceInfo[],
+			errors: string[]
+		},
+		ios: {
+			devices: Mobile.IDeviceInfo[],
+			errors: string[]
+		}
+	}
+```
+
+This method accepts platform parameter. If provided only devices by specified platform will be returned.
+
+* Usage
+```TypeScript
+tns.devicesService.getAvailableEmulators()
+	.then(availableEmulatorsOutput => {
+		Object.keys(availableEmulatorsOutput)
+			.forEach(platform => {
+				availableEmulatorsOutput[platform].devices.forEach(device => console.log(device));
+			})
+	})
+```
+
+### startEmulator
+The `startEmulator` method starts the emulator specified by provided options. Returns an array of errors if something unexpected happens or null otherwise.
+* Usage
+```TypeScript
+tns.devicesService.startEmulator({imageIdentifier: "my emulator imageIdentifier"})
+	.then(errors => { });
+```
+
 ## How to add a new method to Public API
 CLI is designed as command line tool and when it is used as a library, it does not give you access to all of the methods. This is mainly implementation detail. Most of the CLI's code is created to work in command line, not as a library, so before adding method to public API, most probably it will require some modification.
 For example the `$options` injected module contains information about all `--` options passed on the terminal. When the CLI is used as a library, the options are not populated. Before adding method to public API, make sure its implementation does not rely on `$options`.

lib/bootstrap.ts

@@ -140,8 +140,6 @@ $injector.requireCommand("update", "./commands/update");
 $injector.require("iOSLogFilter", "./services/ios-log-filter");
 $injector.require("projectChangesService", "./services/project-changes-service");
 
-$injector.require("emulatorPlatformService", "./services/emulator-platform-service");
-
 $injector.require("pbxprojDomXcode", "./node/pbxproj-dom-xcode");
 $injector.require("xcode", "./node/xcode");
 

lib/commands/run.ts

@@ -94,10 +94,9 @@ export class RunAndroidCommand implements ICommand {
 		private $injector: IInjector,
 		private $platformService: IPlatformService,
 		private $projectData: IProjectData,
-		private $options: IOptions) {
-	}
+		private $options: IOptions) { }
 
-	public async execute(args: string[]): Promise<void> {
+	public execute(args: string[]): Promise<void> {
 		return this.runCommand.execute(args);
 	}
 

lib/common

@@ -91,6 +91,10 @@ interface IDebugOptions {
 	 * If not provided, defaults to 10 seconds.
 	 */
 	timeout?: string;
+	/**
+	 * The sdk version of the emulator.
+	 */
+	sdk?: string;
 }
 
 /**

lib/definitions/debug.d.ts

@@ -264,7 +264,6 @@ interface ITrackPlatformAction extends IPlatform {
 interface IPlatformData {
 	frameworkPackageName: string;
 	platformProjectService: IPlatformProjectService;
-	emulatorServices: Mobile.IEmulatorPlatformServices;
 	projectRoot: string;
 	normalizedPlatformName: string;
 	appDestinationDirectoryPath: string;

lib/definitions/emulator-platform-service.d.ts

@@ -27,7 +27,8 @@ export class LiveSyncCommandHelper implements ILiveSyncCommandHelper {
 			platform,
 			emulator,
 			skipDeviceDetectionInterval: true,
-			skipInferPlatform: !platform
+			skipInferPlatform: !platform,
+			sdk: this.$options.sdk
 		});
 
 		const devices = this.$devicesService.getDeviceInstances()

lib/definitions/platform.d.ts

@@ -17,8 +17,7 @@ export class AndroidProjectService extends projectServiceBaseLib.PlatformProject
 
 	private isAndroidStudioTemplate: boolean;
 
-	constructor(private $androidEmulatorServices: Mobile.IEmulatorPlatformServices,
-		private $androidToolsInfo: IAndroidToolsInfo,
+	constructor(private $androidToolsInfo: IAndroidToolsInfo,
 		private $childProcess: IChildProcess,
 		private $errors: IErrors,
 		$fs: IFileSystem,
@@ -72,7 +71,6 @@ export class AndroidProjectService extends projectServiceBaseLib.PlatformProject
 				normalizedPlatformName: "Android",
 				appDestinationDirectoryPath: path.join(...appDestinationDirectoryArr),
 				platformProjectService: this,
-				emulatorServices: this.$androidEmulatorServices,
 				projectRoot: projectRoot,
 				deviceBuildOutputPath: path.join(...deviceBuildOutputArr),
 				getValidBuildOutputData: (buildOptions: IBuildOutputOptions): IValidBuildOutputData => {

lib/helpers/livesync-command-helper.ts

@@ -129,7 +129,10 @@ export class IOSDebugService extends DebugServiceBase implements IPlatformDebugS
 			args: args,
 			appId: debugData.applicationIdentifier,
 			skipInstall: true,
-			device: debugData.deviceIdentifier
+			device: debugData.deviceIdentifier,
+			justlaunch: debugOptions.justlaunch,
+			timeout: debugOptions.timeout,
+			sdk: debugOptions.sdk
 		});
 
 		const pid = getPidFromiOSSimulatorLogs(debugData.applicationIdentifier, launchResult);

lib/services/android-project-service.ts

@@ -39,7 +39,6 @@ export class IOSProjectService extends projectServiceBaseLib.PlatformProjectServ
 		private $cocoapodsService: ICocoaPodsService,
 		private $errors: IErrors,
 		private $logger: ILogger,
-		private $iOSEmulatorServices: Mobile.IEmulatorPlatformServices,
 		private $injector: IInjector,
 		$projectDataService: IProjectDataService,
 		private $prompter: IPrompter,
@@ -76,7 +75,6 @@ export class IOSProjectService extends projectServiceBaseLib.PlatformProjectServ
 				normalizedPlatformName: "iOS",
 				appDestinationDirectoryPath: path.join(projectRoot, projectData.projectName),
 				platformProjectService: this,
-				emulatorServices: this.$iOSEmulatorServices,
 				projectRoot: projectRoot,
 				deviceBuildOutputPath: path.join(projectRoot, constants.BUILD_DIR, "device"),
 				emulatorBuildOutputPath: path.join(projectRoot, constants.BUILD_DIR, "emulator"),

lib/services/emulator-platform-service.ts

@@ -121,6 +121,11 @@ function createTestInjector(projectPath: string, projectName: string, xcode?: IX
 	testInjector.register("httpClient", {});
 	testInjector.register("platformEnvironmentRequirements", {});
 	testInjector.register("plistParser", {});
+	testInjector.register("androidEmulatorServices", {});
+	testInjector.register("androidEmulatorDiscovery", {
+		on: () => ({})
+	});
+	testInjector.register("emulatorHelper", {});
 
 	return testInjector;
 }

lib/services/ios-debug-service.ts

@@ -83,7 +83,6 @@ function createTestInjector(): IInjector {
 	testInjector.register("xmlValidator", XmlValidator);
 	testInjector.register("config", StaticConfigLib.Configuration);
 	testInjector.register("projectChangesService", ProjectChangesLib.ProjectChangesService);
-	testInjector.register("emulatorPlatformService", stubs.EmulatorPlatformService);
 	testInjector.register("analyticsService", {
 		track: async (): Promise<any> => undefined
 	});

lib/services/ios-project-service.ts

@@ -33,7 +33,6 @@ class PlatformData implements IPlatformData {
 			// intentionally left blank
 		}
 	};
-	emulatorServices: Mobile.IEmulatorPlatformServices = null;
 	projectRoot = "";
 	deviceBuildOutputPath = "";
 	getValidBuildOutputData = (buildOptions: IBuildOutputOptions) => ({ packageNames: [""] });
@@ -143,7 +142,6 @@ function createTestInjector() {
 	testInjector.register("preparePlatformJSService", {});
 	testInjector.register("childProcess", ChildProcessLib.ChildProcess);
 	testInjector.register("projectChangesService", ProjectChangesLib.ProjectChangesService);
-	testInjector.register("emulatorPlatformService", stubs.EmulatorPlatformService);
 	testInjector.register("analyticsService", {
 		track: async () => async (): Promise<any[]> => undefined
 	});