Get sysInfos based on specified platform

In case when android platform is specified, checks only android related things. In case when iOS platform is specified, checks only iOS related things. When no platform is specified, checks both Android and iOS things. This will improve the time {N} CLI needs to check if environment is correctly configured for platform specific commands. This also will fix failing cloud builds.

Author: Fatme

lib/doctor.ts

@@ -32,6 +32,51 @@ export class Doctor implements NativeScriptDoctor.IDoctor {
 		let result: NativeScriptDoctor.IInfo[] = [];
 		const sysInfoData = await this.sysInfo.getSysInfo(config);
 
+		result = result.concat(
+			this.processSysInfoItem({
+				item: sysInfoData.gitVer,
+				infoMessage: "Git is installed and is configured properly.",
+				warningMessage: "Git is not installed or not configured properly.",
+				additionalInformation: "You will not be able to create and work with Screen Builder projects." + EOL
+					+ "To be able to work with Screen Builder projects, download and install Git as described" + EOL
+					+ "in https://git-scm.com/downloads and add the git executable to your PATH.",
+				platforms: Constants.SUPPORTED_PLATFORMS
+			})
+		);
+
+		if (config && config.platform === Constants.ANDROID_PLATFORM_NAME) {
+			result = result.concat(this.getAndroidInfos(sysInfoData));
+		}
+
+		if (config && config.platform === Constants.IOS_PLATFORM_NAME) {
+			result = result.concat(await this.getiOSInfos(sysInfoData));
+		}
+
+		if (!config || !config.platform) {
+			result = result.concat(this.getAndroidInfos(sysInfoData), await this.getiOSInfos(sysInfoData));
+		}
+
+		if (!this.hostInfo.isDarwin) {
+			result.push({
+				message: "Local builds for iOS can be executed only on a macOS system. To build for iOS on a different operating system, you can use the NativeScript cloud infrastructure.",
+				additionalInformation: "",
+				platforms: [Constants.IOS_PLATFORM_NAME],
+				type: Constants.INFO_TYPE_NAME
+			});
+		}
+
+		return result;
+	}
+
+	public async getWarnings(config?: NativeScriptDoctor.ISysInfoConfig): Promise<NativeScriptDoctor.IWarning[]> {
+		const info = await this.getInfos(config);
+		return info.filter(item => item.type === Constants.WARNING_TYPE_NAME)
+			.map(item => this.convertInfoToWarning(item));
+	}
+
+	private getAndroidInfos(sysInfoData: NativeScriptDoctor.ISysInfoData): NativeScriptDoctor.IInfo[] {
+		let result: NativeScriptDoctor.IInfo[] = [];
+
 		result = result.concat(
 			this.processValidationErrors({
 				warnings: this.androidToolsInfo.validateAndroidHomeEnvVariable(),
@@ -66,9 +111,24 @@ export class Doctor implements NativeScriptDoctor.IDoctor {
 				warnings: this.androidToolsInfo.validateJavacVersion(sysInfoData.javacVersion),
 				infoMessage: "Javac is installed and is configured properly.",
 				platforms: [Constants.ANDROID_PLATFORM_NAME]
+			}),
+			this.processSysInfoItem({
+				item: sysInfoData.javacVersion,
+				infoMessage: "The Java Development Kit (JDK) is installed and is configured properly.",
+				warningMessage: "The Java Development Kit (JDK) is not installed or is not configured properly.",
+				additionalInformation: "You will not be able to work with the Android SDK and you might not be able" + EOL
+					+ "to perform some Android-related operations. To ensure that you can develop and" + EOL
+					+ "test your apps for Android, verify that you have installed the JDK as" + EOL
+					+ "described in http://docs.oracle.com/javase/8/docs/technotes/guides/install/install_overview.html (for JDK 8).",
+				platforms: [Constants.ANDROID_PLATFORM_NAME]
 			})
 		);
 
+		return result;
+	}
+
+	private async getiOSInfos(sysInfoData: NativeScriptDoctor.ISysInfoData): Promise<NativeScriptDoctor.IInfo[]> {
+		let result: NativeScriptDoctor.IInfo[] = [];
 		if (this.hostInfo.isDarwin) {
 			result = result.concat(
 				this.processSysInfoItem({
@@ -103,7 +163,7 @@ export class Doctor implements NativeScriptDoctor.IDoctor {
 					platforms: [Constants.IOS_PLATFORM_NAME]
 				})
 			);
-
+	
 			if (sysInfoData.xcodeVer && sysInfoData.cocoaPodsVer) {
 				let isCocoaPodsWorkingCorrectly = await this.sysInfo.isCocoaPodsWorkingCorrectly();
 				result = result.concat(
@@ -116,7 +176,7 @@ export class Doctor implements NativeScriptDoctor.IDoctor {
 					})
 				);
 			}
-
+	
 			result = result.concat(
 				this.processSysInfoItem({
 					item: !sysInfoData.cocoaPodsVer || !semver.valid(sysInfoData.cocoaPodsVer) || !semver.lt(sysInfoData.cocoaPodsVer, Doctor.MIN_SUPPORTED_POD_VERSION),
@@ -144,46 +204,9 @@ export class Doctor implements NativeScriptDoctor.IDoctor {
 			);
 		}
 
-		result = result.concat(
-			this.processSysInfoItem({
-				item: sysInfoData.javacVersion,
-				infoMessage: "The Java Development Kit (JDK) is installed and is configured properly.",
-				warningMessage: "The Java Development Kit (JDK) is not installed or is not configured properly.",
-				additionalInformation: "You will not be able to work with the Android SDK and you might not be able" + EOL
-					+ "to perform some Android-related operations. To ensure that you can develop and" + EOL
-					+ "test your apps for Android, verify that you have installed the JDK as" + EOL
-					+ "described in http://docs.oracle.com/javase/8/docs/technotes/guides/install/install_overview.html (for JDK 8).",
-				platforms: [Constants.ANDROID_PLATFORM_NAME]
-			}),
-			this.processSysInfoItem({
-				item: sysInfoData.gitVer,
-				infoMessage: "Git is installed and is configured properly.",
-				warningMessage: "Git is not installed or not configured properly.",
-				additionalInformation: "You will not be able to create and work with Screen Builder projects." + EOL
-					+ "To be able to work with Screen Builder projects, download and install Git as described" + EOL
-					+ "in https://git-scm.com/downloads and add the git executable to your PATH.",
-				platforms: Constants.SUPPORTED_PLATFORMS
-			})
-		);
-
-		if (!this.hostInfo.isDarwin) {
-			result.push({
-				message: "Local builds for iOS can be executed only on a macOS system. To build for iOS on a different operating system, you can use the NativeScript cloud infrastructure.",
-				additionalInformation: "",
-				platforms: [Constants.IOS_PLATFORM_NAME],
-				type: Constants.INFO_TYPE_NAME
-			});
-		}
-
 		return result;
 	}
 
-	public async getWarnings(config?: NativeScriptDoctor.ISysInfoConfig): Promise<NativeScriptDoctor.IWarning[]> {
-		const info = await this.getInfos(config);
-		return info.filter(item => item.type === Constants.WARNING_TYPE_NAME)
-			.map(item => this.convertInfoToWarning(item));
-	}
-
 	private processSysInfoItem(data: { item: string | boolean, infoMessage: string, warningMessage: string, additionalInformation?: string, platforms: string[] }): NativeScriptDoctor.IInfo {
 		if (!data.item) {
 			return {

lib/sys-info.ts

@@ -9,6 +9,8 @@ import * as path from "path";
 import * as osenv from "osenv";
 import * as temp from "temp";
 import * as semver from "semver";
+import { constants } from "zlib";
+import { Constants } from "./constants";
 
 export class SysInfo implements NativeScriptDoctor.ISysInfo {
 	private static JAVA_COMPILER_VERSION_REGEXP = /^javac (.*)/im;
@@ -34,7 +36,11 @@ export class SysInfo implements NativeScriptDoctor.ISysInfo {
 	private monoVerCache: string;
 	private gitVerCache: string;
 	private gradleVerCache: string;
-	private sysInfoCache: NativeScriptDoctor.ISysInfoData;
+
+	private commonSysInfoCache: NativeScriptDoctor.ICommonSysInfoData;
+	private androidSysInfoCache: NativeScriptDoctor.IAndroidSysInfoData;
+	private iOSSysInfoCache: NativeScriptDoctor.IiOSSysInfoData;
+
 	private isCocoaPodsWorkingCorrectlyCache: boolean;
 	private nativeScriptCliVersionCache: string;
 	private xcprojInfoCache: NativeScriptDoctor.IXcprojInfo;
@@ -215,43 +221,16 @@ export class SysInfo implements NativeScriptDoctor.ISysInfo {
 		});
 	}
 
-	public getSysInfo(config?: NativeScriptDoctor.ISysInfoConfig): Promise<NativeScriptDoctor.ISysInfoData> {
-		return this.getValueForProperty(() => this.sysInfoCache, async (): Promise<NativeScriptDoctor.ISysInfoData> => {
-			const result: NativeScriptDoctor.ISysInfoData = Object.create(null);
-
-			// os stuff
-			result.platform = platform();
-			result.shell = osenv.shell();
-			result.os = await this.getOs();
-
-			// node stuff
-			result.procArch = process.arch;
-			result.nodeVer = await this.getNodeVersion();
-			result.npmVer = await this.getNpmVersion();
-			result.nodeGypVer = await this.getNodeGypVersion();
-
-			result.dotNetVer = await this.hostInfo.dotNetVersion();
-			result.javacVersion = await this.getJavaCompilerVersion();
-			result.xcodeVer = await this.getXcodeVersion();
-			result.xcodeprojLocation = await this.getXcodeprojLocation();
-			result.itunesInstalled = await this.isITunesInstalled();
-			result.cocoaPodsVer = await this.getCocoaPodsVersion();
-			result.adbVer = await this.getAdbVersion(config && config.androidToolsInfo && config.androidToolsInfo.pathToAdb);
-			result.androidInstalled = await this.isAndroidInstalled();
-			result.monoVer = await this.getMonoVersion();
-			result.gitVer = await this.getGitVersion();
-			result.gradleVer = await this.getGradleVersion();
-			result.isCocoaPodsWorkingCorrectly = await this.isCocoaPodsWorkingCorrectly();
-
-			result.nativeScriptCliVersion = await this.getNativeScriptCliVersion();
-
-			result.isCocoaPodsUpdateRequired = await this.isCocoaPodsUpdateRequired();
-			result.isAndroidSdkConfiguredCorrectly = await this.isAndroidSdkConfiguredCorrectly();
+	public async getSysInfo(config?: NativeScriptDoctor.ISysInfoConfig): Promise<NativeScriptDoctor.ISysInfoData> {
+		if (config && config.platform === Constants.ANDROID_PLATFORM_NAME) {
+			return <NativeScriptDoctor.ISysInfoData>Object.assign(await this.getCommonSysInfo(), await this.getAndroidSysInfo(config));
+		}
 
-			result.pythonInfo = await this.getPythonInfo();
+		if (config && config.platform === Constants.IOS_PLATFORM_NAME) {
+			return <NativeScriptDoctor.ISysInfoData>Object.assign(await this.getCommonSysInfo(), await this.getiOSSysInfo());
+		}
 
-			return result;
-		});
+		return Object.assign(await this.getCommonSysInfo(), await this.getAndroidSysInfo(), await this.getiOSSysInfo());
 	}
 
 	public isCocoaPodsWorkingCorrectly(): Promise<boolean> {
@@ -467,4 +446,55 @@ export class SysInfo implements NativeScriptDoctor.ISysInfo {
 	private unixVer(): Promise<string> {
 		return this.execCommand("uname -a");
 	}
+
+	private getCommonSysInfo(): Promise<NativeScriptDoctor.ICommonSysInfoData> {
+		return this.getValueForProperty(() => this.commonSysInfoCache, async (): Promise<NativeScriptDoctor.ICommonSysInfoData> => {
+			const result: NativeScriptDoctor.ICommonSysInfoData = Object.create(null);
+
+			// os stuff
+			result.platform = platform();
+			result.shell = osenv.shell();
+			result.os = await this.getOs();
+			result.procArch = process.arch;
+			result.nodeVer = await this.getNodeVersion();
+			result.npmVer = await this.getNpmVersion();
+			result.nodeGypVer = await this.getNodeGypVersion();
+			result.nativeScriptCliVersion = await this.getNativeScriptCliVersion();
+			result.gitVer = await this.getGitVersion();
+
+			return result;
+		});
+	}
+
+	private async getiOSSysInfo(): Promise<NativeScriptDoctor.IiOSSysInfoData> {
+		return this.getValueForProperty(() => this.iOSSysInfoCache, async (): Promise<NativeScriptDoctor.IiOSSysInfoData> => {
+			const result: NativeScriptDoctor.IiOSSysInfoData = Object.create(null);
+
+			result.xcodeVer = await this.getXcodeVersion();
+			result.xcodeprojLocation = await this.getXcodeprojLocation();
+			result.itunesInstalled = await this.isITunesInstalled();
+			result.cocoaPodsVer = await this.getCocoaPodsVersion();
+			result.isCocoaPodsWorkingCorrectly = await this.isCocoaPodsWorkingCorrectly();
+			result.isCocoaPodsUpdateRequired = await this.isCocoaPodsUpdateRequired();
+			result.pythonInfo = await this.getPythonInfo();
+
+			return result;
+		});
+	}
+
+	private async getAndroidSysInfo(config?: NativeScriptDoctor.ISysInfoConfig): Promise<NativeScriptDoctor.IAndroidSysInfoData> {
+		return this.getValueForProperty(() => this.androidSysInfoCache, async (): Promise<NativeScriptDoctor.IAndroidSysInfoData> => {
+			const result: NativeScriptDoctor.IAndroidSysInfoData = Object.create(null);
+
+			result.dotNetVer = await this.hostInfo.dotNetVersion();
+			result.javacVersion = await this.getJavaCompilerVersion();
+			result.adbVer = await this.getAdbVersion(config && config.androidToolsInfo && config.androidToolsInfo.pathToAdb);
+			result.androidInstalled = await this.isAndroidInstalled();
+			result.monoVer = await this.getMonoVersion();
+			result.gradleVer = await this.getGradleVersion();
+			result.isAndroidSdkConfiguredCorrectly = await this.isAndroidSdkConfiguredCorrectly();
+
+			return result;
+		});
+	}
 }

test/sys-info.ts

@@ -4,6 +4,7 @@ import { EOL } from "os";
 import { SysInfo } from "../lib/sys-info";
 import { Helpers } from "../lib/helpers";
 import { ChildProcess } from "../lib/wrappers/child-process";
+import { constants } from "zlib";
 
 const JavaHomeName = "JAVA_HOME";
 const AndroidHomeName = "ANDROID_HOME";
@@ -493,5 +494,74 @@ ${expectedCliVersion}`;
 				});
 			});
 		});
+
+		describe("returns correct sysInfo when", () => {
+			const assertCommonSysInfo = (result: NativeScriptDoctor.ISysInfoData) => {
+				assert.deepEqual(result.npmVer, childProcessResult.npmV.result.stdout);
+				assert.deepEqual(result.nodeVer, "6.0.0");
+				assert.deepEqual(result.nodeGypVer, childProcessResult.nodeGypVersion.result.stdout);
+				assert.deepEqual(result.gitVer, "1.9.5");
+				assert.deepEqual(result.nativeScriptCliVersion, childProcessResult.nativeScriptCliVersion.result.stdout);
+			};
+
+			const assertAndroidSysInfo = (result: NativeScriptDoctor.IAndroidSysInfoData) => {
+				assert.deepEqual(result.adbVer, "1.0.32");
+				assert.deepEqual(result.androidInstalled, false);
+				assert.deepEqual(result.monoVer, "1.0.6");
+				assert.deepEqual(result.gradleVer, "2.8");
+				assert.deepEqual(result.javacVersion, "1.8.0_60");
+				assert.deepEqual(result.isAndroidSdkConfiguredCorrectly, undefined);
+			};
+
+			const assertiOSSysInfo = (result: NativeScriptDoctor.IiOSSysInfoData) => {
+				assert.deepEqual(result.xcodeVer, "6.4.0");
+				assert.deepEqual(result.itunesInstalled, undefined);
+				assert.deepEqual(result.cocoaPodsVer, "0.38.2");
+				assert.deepEqual(result.xcodeprojLocation, null);
+				assert.deepEqual(result.isCocoaPodsWorkingCorrectly, undefined);
+				assert.deepEqual(result.xcprojInfo, undefined);
+				assert.deepEqual(result.isCocoaPodsUpdateRequired, false);
+				assert.deepEqual(result.pythonInfo, {isInstalled: false, isSixPackageInstalled: false, installationErrorMessage: "Cannot read property 'shouldThrowError' of undefined"});
+			};
+
+			it("iOS platform is specified", async () => {
+				sysInfo = mockSysInfo(childProcessResult, { isWindows: false, isDarwin: true, dotNetVersion });
+				const result = await sysInfo.getSysInfo({platform: "iOS"});
+
+				assertCommonSysInfo(result);
+				assertiOSSysInfo(result);
+				// Android specific properties should be undefined
+				assert.deepEqual(result.adbVer, undefined);
+				assert.deepEqual(result.androidInstalled, undefined);
+				assert.deepEqual(result.monoVer, undefined);
+				assert.deepEqual(result.gradleVer, undefined);
+				assert.deepEqual(result.javacVersion, undefined);
+				assert.deepEqual(result.isAndroidSdkConfiguredCorrectly, undefined);
+			});
+			it("Android platform is specified", async () => {
+				sysInfo = mockSysInfo(childProcessResult, { isWindows: false, isDarwin: true, dotNetVersion });
+				const result = await sysInfo.getSysInfo({platform: "Android"});
+
+				assertCommonSysInfo(result);
+				assertAndroidSysInfo(result);
+				// iOS specific properties should be undefined
+				assert.deepEqual(result.xcodeVer, undefined);
+				assert.deepEqual(result.itunesInstalled, undefined);
+				assert.deepEqual(result.cocoaPodsVer, undefined);
+				assert.deepEqual(result.xcodeprojLocation, undefined);
+				assert.deepEqual(result.isCocoaPodsWorkingCorrectly, undefined);
+				assert.deepEqual(result.xcprojInfo, undefined);
+				assert.deepEqual(result.isCocoaPodsUpdateRequired, undefined);
+				assert.deepEqual(result.pythonInfo, undefined);
+				
+			});
+			it("no platform is specified", async() => {
+				sysInfo = mockSysInfo(childProcessResult, { isWindows: false, isDarwin: true, dotNetVersion });
+				const result = await sysInfo.getSysInfo();
+				assertCommonSysInfo(result);
+				assertAndroidSysInfo(result);
+				assertiOSSysInfo(result);
+			});
+		});
 	});
 });