Merge pull request #27 from NativeScript/fatme/ns-cli-integration

Integrate doctor package in {N} CLI

Author: Fatme

README.md

@@ -99,16 +99,19 @@ Library that helps identifying if the environment can be used for development of
 		console.log("mono: ", monoVersion);
 
 		const nodeVersion = await sysInfo.getNodeVersion();
-		console.log("node: ", nodeVer);
+		console.log("node: ", nodeVersion);
+
+		const npmVersion = await sysInfo.getNpmVersion();
+		console.log("npm: ", npmVersion);
 
 		const nodeGypVersion = await sysInfo.getNodeGypVersion();
 		console.log("node-gyp: ", nodeGypVersion);
 
 		const osName = await sysInfo.getOs();
 		console.log("os: ", osName);
 
-		const xcodeprojGemLocation = await sysInfo.getXCodeProjGemLocation();
-		console.log("xcodeproj gem location: ", xcodeprojGemLocation);
+		const xcodeprojLocation = await sysInfo.getXCodeProjLocation();
+		console.log("xcodeproj location: ", xcodeprojLocation);
 
 		const xcodeVersion = await sysInfo.getXCodeVersion();
 		console.log("xcode: ", xcodeVersion);
@@ -131,6 +134,9 @@ Library that helps identifying if the environment can be used for development of
 		const isCocoaPodsUpdateRequired = await sysInfo.isCocoaPodsUpdateRequired();
 		console.log("is CocoaPods update required: ", isCocoaPodsUpdateRequired);
 
+		const pythonInfo = await sysInfo.getPythonInfo();
+		console.log("python info: ", pythonInfo );
+
 		const sysInfoData = await sysInfo.getSysInfo();
 		console.log("sysInfo: ", sysInfoData);
 
@@ -166,17 +172,23 @@ Library that helps identifying if the environment can be used for development of
 		 */
 		getNodeVersion(): Promise<string>;
 
+		/**
+		 * Returns the currently installed npm version.
+		 * @return {Promise<string>} Returns the currently installed npm version.
+		 */
+		getNpmVersion(): Promise<string>;
+
 		/**
 		 * Returns the currently installed node-gyp version.
 		 * @return {Promise<string>} Returns the currently installed node-gyp version. If node-gyp is not installed it will return null.
 		 */
 		getNodeGypVersion(): Promise<string>;
 
 		/**
-		 * Returns the xcodeproj gem location.
-		 * @return {Promise<string>} Returns the xcodeproj gem location. If the the xcodeproj gem is not installed it will return null.
+		 * Returns the xcodeproj location.
+		 * @return {Promise<string>} Returns the xcodeproj location. If the the xcodeproj is not installed it will return null.
 		 */
-		getXcodeprojGemLocation(): Promise<string>;
+		getXcodeprojLocation(): Promise<string>;
 
 		/**
 		 * Checks if iTunes is installed.
@@ -198,9 +210,10 @@ Library that helps identifying if the environment can be used for development of
 
 		/**
 		 * Returns the currently installed ADB version.
+		 * @param {string} pathToAdb Defines path to adb
 		 * @return {Promise<string>} Returns the currently installed ADB version. It will return null if ADB is not installed.
 		 */
-		getAdbVersion(): Promise<string>;
+		getAdbVersion(pathToAdb?: string): Promise<string>;
 
 		/**
 		 * Checks if Android is installed.
@@ -258,9 +271,10 @@ Library that helps identifying if the environment can be used for development of
 
 		/**
 		 * Returns the whole system information.
+		 * @param {ISysInfoConfig} config
 		 * @return {Promise<ISysInfoData>} The system information.
 		 */
-		getSysInfo(): Promise<ISysInfoData>;
+		getSysInfo(config?: ISysInfoConfig): Promise<ISysInfoData>;
 
 		/**
 		 * If set to true each method will cache it's result. The default value is true.
@@ -386,7 +400,7 @@ Library that helps identifying if the environment can be used for development of
 		 * xcodeproj gem location, as returned by `which gem xcodeproj`.
 		 * @type {string}
 		 */
-		xcodeprojGemLocation: string;
+		xcodeprojLocation: string;
 
 		/**
 		 * true id CocoaPods can successfully execute pod install.

lib/doctor.ts

@@ -28,9 +28,9 @@ export class Doctor implements NativeScriptDoctor.IDoctor {
 		return false;
 	}
 
-	public async getWarnings(): Promise<NativeScriptDoctor.IWarning[]> {
+	public async getWarnings(config?: NativeScriptDoctor.ISysInfoConfig): Promise<NativeScriptDoctor.IWarning[]> {
 		let result: NativeScriptDoctor.IWarning[] = [];
-		const sysInfoData = await this.sysInfo.getSysInfo();
+		const sysInfoData = await this.sysInfo.getSysInfo(config);
 
 		const androidHomeValidationErrors = this.androidToolsInfo.validateAndroidHomeEnvVariable();
 		if (androidHomeValidationErrors.length > 0) {
@@ -78,7 +78,7 @@ export class Doctor implements NativeScriptDoctor.IDoctor {
 				});
 			}
 
-			if (!sysInfoData.xcodeprojGemLocation) {
+			if (!sysInfoData.xcodeprojLocation) {
 				result.push({
 					warning: "WARNING: xcodeproj gem is not installed or is not configured properly.",
 					additionalInformation: "You will not be able to build your projects for iOS." + EOL
@@ -123,6 +123,23 @@ export class Doctor implements NativeScriptDoctor.IDoctor {
 					platforms: [Constants.IOS_PLATFORM_NAME]
 				});
 			}
+
+			if (!sysInfoData.pythonInfo.isInstalled) {
+				result.push({
+					warning: `WARNING: Couldn't retrieve installed python packages.`,
+					additionalInformation: "We cannot verify your python installation is setup correctly. Please, make sure you have both 'python' and 'pip' installed." + EOL
+						+ `Error while validating Python packages. Error is: ${sysInfoData.pythonInfo.installationErrorMessage}`,
+					platforms: [Constants.IOS_PLATFORM_NAME]
+				});
+			}
+
+			if (!sysInfoData.pythonInfo.isSixPackageInstalled) {
+				result.push({
+					warning: `WARNING: The Python 'six' package not found.`,
+					additionalInformation: "This package is required by the Debugger library (LLDB) for iOS. You can install it by first making sure you have pip installed and then running 'pip install six' from the terminal.",
+					platforms: [Constants.IOS_PLATFORM_NAME]
+				});
+			}
 		} else {
 			result.push({
 				warning: "NOTE: You can develop for iOS only on Mac OS X systems.",

lib/local-build-requirements/ios-local-build-requirements.ts

@@ -7,7 +7,7 @@ export class IosLocalBuildRequirements {
 	public async checkRequirements(): Promise<boolean> {
 		if (!this.hostInfo.isDarwin ||
 			!await this.sysInfo.getXcodeVersion() ||
-			!await this.sysInfo.getXcodeprojGemLocation()) {
+			!await this.sysInfo.getXcodeprojLocation()) {
 			return false;
 		}
 

lib/sys-info.ts

@@ -25,7 +25,7 @@ export class SysInfo implements NativeScriptDoctor.ISysInfo {
 	private npmVerCache: string;
 	private nodeVerCache: string;
 	private nodeGypVerCache: string;
-	private xCodeprojGemLocationCache: string;
+	private xCodeprojLocationCache: string;
 	private iTunesInstalledCache: boolean;
 	private cocoaPodsVerCache: string;
 	private osCache: string;
@@ -38,6 +38,7 @@ export class SysInfo implements NativeScriptDoctor.ISysInfo {
 	private isCocoaPodsWorkingCorrectlyCache: boolean;
 	private nativeScriptCliVersionCache: string;
 	private xcprojInfoCache: NativeScriptDoctor.IXcprojInfo;
+	private pythonInfoCache: NativeScriptDoctor.IPythonInfo;
 	private isCocoaPodsUpdateRequiredCache: boolean;
 	private shouldCache: boolean = true;
 	private isAndroidSdkConfiguredCorrectlyCache: boolean;
@@ -102,9 +103,9 @@ export class SysInfo implements NativeScriptDoctor.ISysInfo {
 		});
 	}
 
-	public getXcodeprojGemLocation(): Promise<string> {
-		return this.getValueForProperty(() => this.xCodeprojGemLocationCache, async (): Promise<string> => {
-			const output = await this.execCommand("gem which xcodeproj");
+	public getXcodeprojLocation(): Promise<string> {
+		return this.getValueForProperty(() => this.xCodeprojLocationCache, async (): Promise<string> => {
+			const output = await this.execCommand("which xcodeproj");
 			return output ? output.trim() : null;
 		});
 	}
@@ -152,12 +153,13 @@ export class SysInfo implements NativeScriptDoctor.ISysInfo {
 		});
 	}
 
-	public getAdbVersion(): Promise<string> {
+	public getAdbVersion(pathToAdb?: string): Promise<string> {
 		return this.getValueForProperty(() => this.adbVerCache, async (): Promise<string> => {
 			let output: IProcessInfo = null;
-			const pathToAdbFromAndroidHome = await this.androidToolsInfo.getPathToAdbFromAndroidHome();
-			if (pathToAdbFromAndroidHome) {
-				output = await this.childProcess.spawnFromEvent(pathToAdbFromAndroidHome, ["version"], "close", { ignoreError: true });
+
+			pathToAdb = pathToAdb || await this.androidToolsInfo.getPathToAdbFromAndroidHome();
+			if (pathToAdb) {
+				output = await this.childProcess.spawnFromEvent(pathToAdb, ["version"], "close", { ignoreError: true });
 			}
 
 			return output && output.stdout ? this.getVersionFromString(output.stdout) : null;
@@ -213,7 +215,7 @@ export class SysInfo implements NativeScriptDoctor.ISysInfo {
 		});
 	}
 
-	public getSysInfo(): Promise<NativeScriptDoctor.ISysInfoData> {
+	public getSysInfo(config?: NativeScriptDoctor.ISysInfoConfig): Promise<NativeScriptDoctor.ISysInfoData> {
 		return this.getValueForProperty(() => this.sysInfoCache, async (): Promise<NativeScriptDoctor.ISysInfoData> => {
 			const result: NativeScriptDoctor.ISysInfoData = Object.create(null);
 
@@ -231,10 +233,10 @@ export class SysInfo implements NativeScriptDoctor.ISysInfo {
 			result.dotNetVer = await this.hostInfo.dotNetVersion();
 			result.javacVersion = await this.getJavaCompilerVersion();
 			result.xcodeVer = await this.getXcodeVersion();
-			result.xcodeprojGemLocation = await this.getXcodeprojGemLocation();
+			result.xcodeprojLocation = await this.getXcodeprojLocation();
 			result.itunesInstalled = await this.isITunesInstalled();
 			result.cocoaPodsVer = await this.getCocoaPodsVersion();
-			result.adbVer = await this.getAdbVersion();
+			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();
@@ -246,6 +248,8 @@ export class SysInfo implements NativeScriptDoctor.ISysInfo {
 			result.isCocoaPodsUpdateRequired = await this.isCocoaPodsUpdateRequired();
 			result.isAndroidSdkConfiguredCorrectly = await this.isAndroidSdkConfiguredCorrectly();
 
+			result.pythonInfo = await this.getPythonInfo();
+
 			return result;
 		});
 	}
@@ -307,6 +311,27 @@ export class SysInfo implements NativeScriptDoctor.ISysInfo {
 		});
 	}
 
+	public getPythonInfo(): Promise<NativeScriptDoctor.IPythonInfo> {
+		return this.getValueForProperty(() => this.pythonInfoCache, async (): Promise<NativeScriptDoctor.IPythonInfo> => {
+			if (this.hostInfo.isDarwin) {
+				try {
+					await this.childProcess.exec(`python -c "import six"`);
+				} catch (error) {
+					// error.code = 1 so the Python is present, but we don't have six.
+					if (error.code === 1) {
+						return { isInstalled: true, isSixPackageInstalled: false };
+					}
+
+					return { isInstalled: false, isSixPackageInstalled: false, installationErrorMessage: error.message };
+				}
+
+				return { isInstalled: true, isSixPackageInstalled: true };
+			}
+
+			return null;
+		});
+	}
+
 	public isCocoaPodsUpdateRequired(): Promise<boolean> {
 		return this.getValueForProperty(() => this.isCocoaPodsUpdateRequiredCache, async (): Promise<boolean> => {
 			let xcprojInfo = await this.getXcprojInfo();

test/sys-info.ts

@@ -13,6 +13,7 @@ const PROGRAM_FILES_ENV_PATH = "C:\\Program Files";
 interface IChildProcessResultDescription {
 	result?: any;
 	shouldThrowError?: boolean;
+	errorCode?: number;
 }
 
 interface ICLIOutputVersionTestCase {
@@ -37,6 +38,7 @@ interface IChildProcessResults {
 	pod: IChildProcessResultDescription;
 	nativeScriptCliVersion: IChildProcessResultDescription;
 	git: IChildProcessResultDescription;
+	pythonInfo?: IChildProcessResultDescription;
 }
 
 interface IHostInfoMockOptions {
@@ -92,7 +94,8 @@ function createChildProcessResults(childProcessResult: IChildProcessResults): ID
 		"gradle -v": childProcessResult.gradleVersion,
 		"tns --version": childProcessResult.nativeScriptCliVersion,
 		"emulator": { shouldThrowError: false },
-		"which git": childProcessResult.git
+		"which git": childProcessResult.git,
+		'python -c "import six"': childProcessResult.pythonInfo
 	};
 }
 
@@ -101,7 +104,12 @@ function getResultFromChildProcess(childProcessResultDescription: IChildProcessR
 		if (options && options.ignoreError) {
 			return null;
 		} else {
-			throw new Error(`This one throws error. (${command})`);
+			const error = new Error(`This one throws error. (${command})`);
+			if (childProcessResultDescription.errorCode) {
+				(<any>error).code = childProcessResultDescription.errorCode;
+			}
+
+			throw error;
 		}
 	}
 
@@ -331,6 +339,50 @@ describe("SysInfo unit tests", () => {
 			});
 		});
 
+		describe("when android info is incorrect", () => {
+			it("pathToAdb is null", async () => {
+				childProcessResult.adbVersion = {
+					result: null
+				};
+				sysInfo = mockSysInfo(childProcessResult, { isWindows: false, isDarwin: false, dotNetVersion: "4.5.1"}, null);
+				const adbVersion = await sysInfo.getAdbVersion();
+				const isAndroidSdkConfiguredCorrectly = await sysInfo.isAndroidSdkConfiguredCorrectly();
+				assert.deepEqual(adbVersion, null);
+				assert.deepEqual(isAndroidSdkConfiguredCorrectly, undefined);
+			});
+		});
+
+		describe("pythonInfo", () => {
+			it("should return null when platform is windows", async () => {
+				sysInfo = mockSysInfo(childProcessResult, { isWindows: true, isDarwin: false, dotNetVersion: "4.5.1"}, null);
+				const pythonInfo = await sysInfo.getPythonInfo();
+				assert.deepEqual(pythonInfo, null);
+			});
+			it("should return null when platform is linux", async () => {
+				sysInfo = mockSysInfo(childProcessResult, { isWindows: false, isDarwin: false, dotNetVersion: "4.5.1"}, null);
+				const pythonInfo = await sysInfo.getPythonInfo();
+				assert.deepEqual(pythonInfo, null);
+			});
+			it("should return {isInstalled: true, isSixPackageInstalled: true} when python is correctly installed on Mac", async () => {
+				childProcessResult.pythonInfo = { result: "" };
+				sysInfo = mockSysInfo(childProcessResult, { isWindows: false, isDarwin: true, dotNetVersion: "4.5.1" }, null);
+				const pythonInfo = await sysInfo.getPythonInfo();
+				assert.deepEqual(pythonInfo, { isInstalled: true, isSixPackageInstalled: true });
+			});
+			it("should return {isInstalled: false, isSixPackageInstalled: false} when python check throws an error", async () => {
+				childProcessResult.pythonInfo = { shouldThrowError: true };
+				sysInfo = mockSysInfo(childProcessResult, { isWindows: false, isDarwin: true, dotNetVersion: "4.5.1" }, null);
+				const pythonInfo = await sysInfo.getPythonInfo();
+				assert.deepEqual(pythonInfo, { isInstalled: false, isSixPackageInstalled: false, installationErrorMessage: "This one throws error. (python -c \"import six\")" });
+			});
+			it("should return {isInstalled: true, isSixPackageInstalled: false} when python is installed but six package is not", async () => {
+				childProcessResult.pythonInfo = { shouldThrowError: true, errorCode: 1 };
+				sysInfo = mockSysInfo(childProcessResult, { isWindows: false, isDarwin: true, dotNetVersion: "4.5.1"}, null);
+				const pythonInfo = await sysInfo.getPythonInfo();
+				assert.deepEqual(pythonInfo, { isInstalled: true, isSixPackageInstalled: false });
+			});
+		});
+
 		const testData: ICLIOutputVersionTestCase[] = [
 			{
 				testedProperty: "nativeScriptCliVersion",