Merge pull request #8 from NativeScript/milanov/update-doctor-checks

Update doctor checks

Author: TsvetanMilanov

Gruntfile.js

@@ -4,17 +4,17 @@ module.exports = function (grunt) {
 			options: grunt.file.readJSON("tsconfig.json").compilerOptions,
 
 			devlib: {
-				src: ["lib/**/*.ts"],
+				src: ["lib/**/*.ts", "typings/**/*.ts"],
 				reference: "lib/.d.ts"
 			},
 
 			devall: {
-				src: ["lib/**/*.ts", "test/**/*.ts"],
+				src: ["lib/**/*.ts", "test/**/*.ts", "typings/**/*.ts"],
 				reference: "lib/.d.ts"
 			},
 
 			release_build: {
-				src: ["lib/**/*.ts", "test/**/*.ts"],
+				src: ["lib/**/*.ts", "test/**/*.ts", "typings/**/*.ts"],
 				reference: "lib/.d.ts",
 				options: {
 					sourceMap: false,
@@ -26,7 +26,7 @@ module.exports = function (grunt) {
 		tslint: {
 			build: {
 				files: {
-					src: ["lib/**/*.ts", "test/**/*.ts", "!**/*.d.ts"]
+					src: ["lib/**/*.ts", "test/**/*.ts", "typings/**/*.ts", "!**/*.d.ts"]
 				},
 				options: {
 					configuration: grunt.file.readJSON("./tslint.json")

lib/doctor.ts

@@ -5,10 +5,9 @@ import { HostInfo } from "./host-info";
 import { AndroidLocalBuildRequirements } from "./local-build-requirements/android-local-build-requirements";
 import { IosLocalBuildRequirements } from "./local-build-requirements/ios-local-build-requirements";
 import { Helpers } from "./helpers";
-import { IWarning } from "../typings/nativescript-doctor";
 import * as semver from "semver";
 
-export class Doctor {
+export class Doctor implements NativeScriptDoctor.IDoctor {
 	private static MIN_SUPPORTED_POD_VERSION = "0.38.2";
 
 	constructor(private androidLocalBuildRequirements: AndroidLocalBuildRequirements,
@@ -29,8 +28,8 @@ export class Doctor {
 		return false;
 	}
 
-	public async getWarnings(): Promise<IWarning[]> {
-		const result: IWarning[] = [];
+	public async getWarnings(): Promise<NativeScriptDoctor.IWarning[]> {
+		const result: NativeScriptDoctor.IWarning[] = [];
 		const sysInfoData = await this.sysInfo.getSysInfo();
 
 		if (!sysInfoData.adbVer) {
@@ -39,7 +38,8 @@ export class Doctor {
 				additionalInformation: "For Android-related operations, the AppBuilder CLI will use a built-in version of adb." + EOL
 				+ "To avoid possible issues with the native Android emulator, Genymotion or connected" + EOL
 				+ "Android devices, verify that you have installed the latest Android SDK and" + EOL
-				+ "its dependencies as described in http://developer.android.com/sdk/index.html#Requirements" + EOL
+				+ "its dependencies as described in http://developer.android.com/sdk/index.html#Requirements" + EOL,
+				platforms: [Constants.ANDROID_PLATFORM_NAME]
 			});
 		}
 
@@ -48,7 +48,8 @@ export class Doctor {
 				warning: "WARNING: The Android SDK is not installed or is not configured properly.",
 				additionalInformation: "You will not be able to run your apps in the native emulator. To be able to run apps" + EOL
 				+ "in the native Android emulator, verify that you have installed the latest Android SDK " + EOL
-				+ "and its dependencies as described in http://developer.android.com/sdk/index.html#Requirements" + EOL
+				+ "and its dependencies as described in http://developer.android.com/sdk/index.html#Requirements" + EOL,
+				platforms: [Constants.ANDROID_PLATFORM_NAME]
 			});
 		}
 
@@ -57,23 +58,34 @@ export class Doctor {
 				result.push({
 					warning: "WARNING: Xcode is not installed or is not configured properly.",
 					additionalInformation: "You will not be able to build your projects for iOS or run them in the iOS Simulator." + EOL
-					+ "To be able to build for iOS and run apps in the native emulator, verify that you have installed Xcode." + EOL
+					+ "To be able to build for iOS and run apps in the native emulator, verify that you have installed Xcode." + EOL,
+					platforms: [Constants.IOS_PLATFORM_NAME]
 				});
 			}
 
 			if (!sysInfoData.xcodeprojGemLocation) {
 				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
-					+ "To be able to build for iOS and run apps in the native emulator, verify that you have installed xcodeproj." + EOL
+					+ "To be able to build for iOS and run apps in the native emulator, verify that you have installed xcodeproj." + EOL,
+					platforms: [Constants.IOS_PLATFORM_NAME]
 				});
 			}
 
 			if (!sysInfoData.cocoaPodsVer) {
 				result.push({
 					warning: "WARNING: CocoaPods is not installed or is not configured properly.",
 					additionalInformation: "You will not be able to build your projects for iOS if they contain plugin with CocoaPod file." + EOL
-					+ "To be able to build such projects, verify that you have installed CocoaPods."
+					+ "To be able to build such projects, verify that you have installed CocoaPods.",
+					platforms: [Constants.IOS_PLATFORM_NAME]
+				});
+			}
+
+			if (sysInfoData.cocoaPodsVer && sysInfoData.isCocoaPodsUpdateRequired) {
+				result.push({
+					warning: "WARNING: CocoaPods update required.",
+					additionalInformation: `You are using CocoaPods version ${sysInfoData.cocoaPodsVer} which does not support Xcode ${sysInfoData.xcodeVer} yet.${EOL}${EOL}You can update your cocoapods by running $sudo gem install cocoapods from a terminal.${EOL}${EOL}In order for the NativeScript CLI to be able to work correctly with this setup you need to install xcproj command line tool and add it to your PATH.Xcproj can be installed with homebrew by running $ brew install xcproj from the terminal`,
+					platforms: [Constants.IOS_PLATFORM_NAME]
 				});
 			}
 
@@ -82,7 +94,8 @@ export class Doctor {
 				if (!isCocoaPodsWorkingCorrectly) {
 					result.push({
 						warning: "WARNING: There was a problem with CocoaPods",
-						additionalInformation: "Verify that CocoaPods are configured properly."
+						additionalInformation: "Verify that CocoaPods are configured properly.",
+						platforms: [Constants.IOS_PLATFORM_NAME]
 					});
 				}
 			}
@@ -91,13 +104,15 @@ export class Doctor {
 				result.push({
 					warning: `WARNING: Your current CocoaPods version is earlier than ${Doctor.MIN_SUPPORTED_POD_VERSION}.`,
 					additionalInformation: "You will not be able to build your projects for iOS if they contain plugin with CocoaPod file." + EOL
-					+ `To be able to build such projects, verify that you have at least ${Doctor.MIN_SUPPORTED_POD_VERSION} version installed.`
+					+ `To be able to build such projects, verify that you have at least ${Doctor.MIN_SUPPORTED_POD_VERSION} version installed.`,
+					platforms: [Constants.IOS_PLATFORM_NAME]
 				});
 			}
 		} else {
 			result.push({
 				warning: "NOTE: You can develop for iOS only on Mac OS X systems.",
-				additionalInformation: "To be able to work with iOS devices and projects, you need Mac OS X Mavericks or later." + EOL
+				additionalInformation: "To be able to work with iOS devices and projects, you need Mac OS X Mavericks or later." + EOL,
+				platforms: [Constants.IOS_PLATFORM_NAME]
 			});
 		}
 
@@ -108,7 +123,8 @@ export class Doctor {
 				+ "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)" + EOL
-				+ "or http://docs.oracle.com/javase/7/docs/webnotes/install/ (for JDK 7)." + EOL
+				+ "or http://docs.oracle.com/javase/7/docs/webnotes/install/ (for JDK 7)." + EOL,
+				platforms: [Constants.ANDROID_PLATFORM_NAME]
 			});
 		}
 
@@ -117,7 +133,8 @@ export class Doctor {
 				warning: "WARNING: 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." + EOL
+				+ "in https://git-scm.com/downloads and add the git executable to your PATH." + EOL,
+				platforms: Constants.SUPPORTED_PLATFORMS
 			});
 		}
 
@@ -134,7 +151,7 @@ export class Doctor {
 		}
 
 		if (!this.isPlatformSupported(platform)) {
-			throw new Error(`Platform ${platform} is not supported. The supported platforms are: ${Constants.SUPPORTED_PLATFORMS.join(", ")}`);
+			throw new Error(`Platform ${platform} is not supported.The supported platforms are: ${Constants.SUPPORTED_PLATFORMS.join(", ")} `);
 		}
 	}
 }

lib/index.ts

@@ -7,19 +7,21 @@ import { Helpers } from "./helpers";
 import { Doctor } from "./doctor";
 import { AndroidLocalBuildRequirements } from "./local-build-requirements/android-local-build-requirements";
 import { IosLocalBuildRequirements } from "./local-build-requirements/ios-local-build-requirements";
+import { Constants as constants } from "./constants";
 
 const childProcess = new ChildProcess();
-const winreg = new WinReg();
-const hostInfo = new HostInfo(winreg);
+const winReg = new WinReg();
+const hostInfo = new HostInfo(winReg);
 const fileSystem = new FileSystem();
 const helpers = new Helpers();
-const sysInfo = new SysInfo(childProcess, fileSystem, helpers, hostInfo, winreg);
+const sysInfo = new SysInfo(childProcess, fileSystem, helpers, hostInfo, winReg);
 
 const androidLocalBuildRequirements = new AndroidLocalBuildRequirements(sysInfo);
 const iOSLocalBuildRequirements = new IosLocalBuildRequirements(sysInfo, hostInfo);
 const doctor = new Doctor(androidLocalBuildRequirements, helpers, hostInfo, iOSLocalBuildRequirements, sysInfo);
 
 export {
 	sysInfo,
-	doctor
+	doctor,
+	constants
 };

lib/sys-info.ts

@@ -5,12 +5,12 @@ import { ExecOptions } from "child_process";
 import { WinReg } from "./winreg";
 import { Helpers } from "./helpers";
 import { platform } from "os";
-import { ISysInfoData } from "../typings/nativescript-doctor";
 import * as path from "path";
 import * as osenv from "osenv";
 import * as temp from "temp";
+import * as semver from "semver";
 
-export class SysInfo {
+export class SysInfo implements NativeScriptDoctor.ISysInfo {
 	// Different java has different format for `java -version` command.
 	private static JAVA_VERSION_REGEXP = /(?:openjdk|java) version \"((?:\d+\.)+(?:\d+))/i;
 
@@ -36,14 +36,17 @@ export class SysInfo {
 	private monoVerCache: string;
 	private gitVerCache: string;
 	private gradleVerCache: string;
-	private sysInfoCache: ISysInfoData;
+	private sysInfoCache: NativeScriptDoctor.ISysInfoData;
 	private isCocoaPodsWorkingCorrectlyCache: boolean = null;
+	private nativeScriptCliVersionCache: string;
+	private xcprojInfoCache: NativeScriptDoctor.IXcprojInfo;
+	private isCocoaPodsUpdateRequiredCache: boolean = null;
 
 	constructor(private childProcess: ChildProcess,
 		private fileSystem: FileSystem,
 		private helpers: Helpers,
 		private hostInfo: HostInfo,
-		private winreg: WinReg) { }
+		private winReg: WinReg) { }
 
 	public async getJavaVersion(): Promise<string> {
 		if (!this.javaVerCache) {
@@ -224,9 +227,9 @@ export class SysInfo {
 		return this.gradleVerCache;
 	}
 
-	public async getSysInfo(): Promise<ISysInfoData> {
+	public async getSysInfo(): Promise<NativeScriptDoctor.ISysInfoData> {
 		if (!this.sysInfoCache) {
-			const result: ISysInfoData = Object.create(null);
+			const result: NativeScriptDoctor.ISysInfoData = Object.create(null);
 
 			// os stuff
 			result.platform = platform();
@@ -252,6 +255,8 @@ export class SysInfo {
 			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();
 
 			this.sysInfoCache = result;
 		}
@@ -284,6 +289,50 @@ export class SysInfo {
 		return !!this.isCocoaPodsWorkingCorrectlyCache;
 	}
 
+	public async getNativeScriptCliVersion(): Promise<string> {
+		if (!this.nativeScriptCliVersionCache) {
+			const output = await this.execCommand("tns --version");
+			this.nativeScriptCliVersionCache = output ? output.trim() : output;
+		}
+
+		return this.nativeScriptCliVersionCache;
+	}
+
+	public async getXcprojInfo(): Promise<NativeScriptDoctor.IXcprojInfo> {
+		if (!this.xcprojInfoCache) {
+			const cocoaPodsVersion = await this.getCocoaPodsVersion();
+			const xcodeVersion = await this.getXcodeVersion();
+
+			// CocoaPods with version lower than 1.0.0 don't support Xcode 7.3 yet
+			// https://github.com/CocoaPods/CocoaPods/issues/2530#issuecomment-210470123
+			// as a result of this all .pbxprojects touched by CocoaPods get converted to XML plist format
+			const shouldUseXcproj = cocoaPodsVersion && !!(semver.lt(cocoaPodsVersion, "1.0.0") && semver.gte(xcodeVersion, "7.3.0"));
+			let xcprojAvailable: boolean;
+
+			if (shouldUseXcproj) {
+				// If that's the case we can use xcproj gem to convert them back to ASCII plist format
+				xcprojAvailable = !!(await this.exec("xcproj --version"))
+			}
+
+			this.xcprojInfoCache = { shouldUseXcproj, xcprojAvailable };
+		}
+
+		return this.xcprojInfoCache;
+	}
+
+	public async isCocoaPodsUpdateRequired(): Promise<boolean> {
+		if (this.isCocoaPodsUpdateRequiredCache === null) {
+			let xcprojInfo = await this.getXcprojInfo();
+			if (xcprojInfo.shouldUseXcproj && !xcprojInfo.xcprojAvailable) {
+				this.isCocoaPodsUpdateRequiredCache = true;
+			} else {
+				this.isCocoaPodsUpdateRequiredCache = false;
+			}
+		}
+
+		return this.isCocoaPodsUpdateRequiredCache;
+	}
+
 	private async exec(cmd: string, execOptions?: ExecOptions): Promise<IProcessInfo> {
 		if (cmd) {
 			try {
@@ -314,12 +363,12 @@ export class SysInfo {
 		let productName: string;
 		let currentVersion: string;
 		let currentBuild: string;
-		const hive = this.winreg.registryKeys.HKLM;
+		const hive = this.winReg.registryKeys.HKLM;
 		const key = "\\Software\\Microsoft\\Windows NT\\CurrentVersion";
 
-		productName = await this.winreg.getRegistryValue("ProductName", hive, key);
-		currentVersion = await this.winreg.getRegistryValue("CurrentVersion", hive, key);
-		currentBuild = await this.winreg.getRegistryValue("CurrentBuild", hive, key);
+		productName = await this.winReg.getRegistryValue("ProductName", hive, key);
+		currentVersion = await this.winReg.getRegistryValue("CurrentVersion", hive, key);
+		currentBuild = await this.winReg.getRegistryValue("CurrentBuild", hive, key);
 
 		return `${productName} ${currentVersion}.${currentBuild}`;
 	}

test/sys-info.ts

@@ -2,7 +2,6 @@ import * as assert from "assert";
 import * as path from "path";
 import { SysInfo } from "../lib/sys-info";
 import { ChildProcess } from "../lib/wrappers/child-process";
-import { ISysInfoData } from "../typings/nativescript-doctor";
 
 const JavaHomeName = "JAVA_HOME";
 const AndroidHomeName = "ANDROID_HOME";
@@ -26,6 +25,7 @@ interface IChildProcessResults {
 	gitVersion: IChildProcessResultDescription;
 	podVersion: IChildProcessResultDescription;
 	pod: IChildProcessResultDescription;
+	nativeScriptCliVersion: IChildProcessResultDescription;
 }
 
 interface IHostInfoMockOptions {
@@ -54,7 +54,8 @@ function createChildProcessResults(childProcessResult: IChildProcessResults): ID
 		'android.bat': childProcessResult.androidInstalled, // for Windows
 		"mono --version": childProcessResult.monoVersion,
 		"git --version": childProcessResult.gitVersion,
-		"gradle -v": childProcessResult.gradleVersion
+		"gradle -v": childProcessResult.gradleVersion,
+		"tns --version": childProcessResult.nativeScriptCliVersion
 	};
 }
 
@@ -182,7 +183,8 @@ describe("SysInfo unit tests", () => {
 				gradleVersion: { result: setStdOut("Gradle 2.8") },
 				gitVersion: { result: setStdOut("git version 1.9.5") },
 				podVersion: { result: setStdOut("0.38.2") },
-				pod: { result: setStdOut("success") }
+				pod: { result: setStdOut("success") },
+				nativeScriptCliVersion: { result: setStdOut("2.5.0") }
 			};
 
 			delete process.env[JavaHomeName];
@@ -195,7 +197,7 @@ describe("SysInfo unit tests", () => {
 		});
 
 		describe("returns correct results when everything is installed", () => {
-			let assertCommonValues = (result: ISysInfoData) => {
+			let assertCommonValues = (result: NativeScriptDoctor.ISysInfoData) => {
 				assert.deepEqual(result.npmVer, childProcessResult.npmV.result.stdout);
 				assert.deepEqual(result.javaVer, "1.8.0");
 				assert.deepEqual(result.javacVersion, "1.8.0_60");
@@ -205,6 +207,7 @@ describe("SysInfo unit tests", () => {
 				assert.deepEqual(result.monoVer, "1.0.6");
 				assert.deepEqual(result.gradleVer, "2.8");
 				assert.deepEqual(result.gitVer, "1.9.5");
+				assert.deepEqual(result.nativeScriptCliVersion, childProcessResult.nativeScriptCliVersion.result.stdout);
 			};
 
 			it("on Windows", async () => {
@@ -277,7 +280,8 @@ describe("SysInfo unit tests", () => {
 					gradleVersion: { shouldThrowError: true },
 					gitVersion: { shouldThrowError: true },
 					podVersion: { shouldThrowError: true },
-					pod: { shouldThrowError: true }
+					pod: { shouldThrowError: true },
+					nativeScriptCliVersion: { shouldThrowError: true }
 				};
 			});