Merge pull request #545 from telerik/vladimirov/fix-cocoapods-check

Fix cocoapods check and add unit tests for doctor service

Author: rosen-vladimirov

bootstrap.ts

@@ -100,3 +100,4 @@ $injector.requireCommand("doctor", "./commands/doctor");
 
 $injector.require("utils", "./utils");
 $injector.require("bplistParser", "./bplist-parser");
+$injector.require("winreg", "./winreg");

declarations.d.ts

@@ -366,10 +366,11 @@ interface ISysInfoData {
 interface ISysInfo {
 	/**
 	 * Returns information for the current system.
+	 * @param {string} pathToPackageJson Path to package.json of the CLI.
 	 * @param {any} androidToolsInfo Defines paths to adb and android executables.
 	 * @return {IFuture<ISysInfoData>} Object containing information for current system.
 	 */
-	getSysInfo(androidToolsInfo?: {pathToAdb: string, pathToAndroid: string}): IFuture<ISysInfoData>;
+	getSysInfo(pathToPackageJson: string, androidToolsInfo?: {pathToAdb: string, pathToAndroid: string}): IFuture<ISysInfoData>;
 }
 
 interface IHostInfo {
@@ -559,3 +560,104 @@ interface IPluginVariablesHelper {
 	getPluginVariableFromVarOption(variableName: string, configuration?: string): any;
 	simplifyYargsObject(obj: any, configuration?: string): any;
 }
+
+/**
+ * Describes Registry values returned from winreg
+ */
+interface IWinRegResult {
+	/**
+	 * The hostname, if it has been set in the options.
+	 */
+	host: string;
+
+	/**
+	 * The hive id, as specified in the options
+	 */
+	hive: string;
+	/**
+	 * The key, as specified in the options
+	 */
+	key: string;
+
+	/**
+	 * The name of the registry value
+	 */
+	name: string;
+
+	/**
+	 * One of the types:
+	 * 	REG_SZ a string value
+	 * 	REG_MULTI_SZ a multiline string value
+	 * 	REG_EXPAND_SZ an expandable string value
+	 * 	REG_DWORD a double word value (32 bit integer)
+	 * 	REG_QWORD a quad word value (64 bit integer)
+	 * 	REG_BINARY a binary value
+	 * 	REG_NONE a value of unknown type
+	 */
+	type: string;
+
+	/**
+	 * A string containing the value
+	 */
+	value: string;
+}
+
+/**
+ * Describes single registry available for search.
+ */
+interface IHiveId {
+	/**
+	 * Name of the registry that will be checked.
+	 */
+	registry: string;
+}
+
+/**
+ * Describes available for search registry ids.
+ */
+interface IHiveIds {
+	/**
+	 * HKEY_LOCAL_MACHINE
+	 */
+	HKLM: IHiveId;
+
+	/**
+	 * HKEY_CURRENT_USER
+	 */
+	HKCU: IHiveId;
+
+	/**
+	 * HKEY_CLASSES_ROOT
+	 */
+	HKCR: IHiveId;
+
+	/**
+	 * HKEY_CURRENT_CONFIG
+	 */
+	HKCC: IHiveId;
+
+	/**
+	 * HKEY_USERS
+	 */
+	HKU: IHiveId;
+}
+
+/**
+ * Defines reading values from registry. Wrapper for node-winreg module.s
+ */
+interface IWinReg {
+	/**
+	 * Gets specified value from the registry.
+	 * The following options are processed by the Winreg constructor:
+	 * @param {string} valueName Value that has to be checked in the registry.
+	 * @param {IHiveId} hive The optional hive id, the default is HKLM.
+	 * @param {string} key The optional key, the default is the root key
+	 * @param {string} host The optional hostname, must start with the '\\' sequence
+	 */
+	getRegistryValue(valueName: string, hive?: IHiveId, key?: string, host?: string): IFuture<IWinRegResult>;
+
+	/**
+	 * Gets object containing available registries for search.
+	 */
+	registryKeys: IHiveIds;
+}

dispatchers.ts

@@ -2,6 +2,7 @@
 "use strict";
 
 import * as queue from "./queue";
+import * as path from "path";
 
 export class CommandDispatcher implements ICommandDispatcher {
 	constructor(private $logger: ILogger,
@@ -19,7 +20,8 @@ export class CommandDispatcher implements ICommandDispatcher {
 			}
 
 			if (this.$logger.getLevel() === "TRACE") {
-				let sysInfo = this.$sysInfo.getSysInfo().wait();
+				// CommandDispatcher is called from external CLI's only, so pass the path to their package.json
+				let sysInfo = this.$sysInfo.getSysInfo(path.join(__dirname, "..", "..", "package.json")).wait();
 				this.$logger.trace("System information:");
 				this.$logger.trace(sysInfo);
 			}

sys-info-base.ts

@@ -3,26 +3,26 @@
 
 import * as os from "os";
 import * as osenv from "osenv";
-import Future = require("fibers/future");
 import * as path from "path";
 import {quoteString} from "./helpers";
 
 export class SysInfoBase implements ISysInfo {
 	constructor(protected $childProcess: IChildProcess,
 				protected $hostInfo: IHostInfo,
 				protected $iTunesValidator: Mobile.IiTunesValidator,
-				protected $logger: ILogger) { }
+				protected $logger: ILogger,
+				protected $winreg: IWinReg) { }
 
-	private static monoVerRegExp = /version (\d+[.]\d+[.]\d+) /gm;
+	private monoVerRegExp = /version (\d+[.]\d+[.]\d+) /gm;
 	private sysInfoCache: ISysInfoData = undefined;
 
-	public getSysInfo(androidToolsInfo?: {pathToAdb: string, pathToAndroid: string}): IFuture<ISysInfoData> {
+	public getSysInfo(pathToPackageJson: string, androidToolsInfo?: {pathToAdb: string, pathToAndroid: string}): IFuture<ISysInfoData> {
 		return((): ISysInfoData => {
 			if (!this.sysInfoCache) {
 				let res: ISysInfoData = Object.create(null);
 				let procOutput: string;
 
-				let packageJson = require("../../package.json");
+				let packageJson = require(pathToPackageJson);
 				res.procInfo = packageJson.name + "/" + packageJson.version;
 
 				// os stuff
@@ -39,7 +39,7 @@ export class SysInfoBase implements ISysInfo {
 				res.procArch = process.arch;
 				res.nodeVer = process.version;
 
-				procOutput = this.$childProcess.exec("npm -v").wait();
+				procOutput = this.exec("npm -v");
 				res.npmVer = procOutput ? procOutput.split("\n")[0] : null;
 
 				// dependencies
@@ -70,7 +70,7 @@ export class SysInfoBase implements ISysInfo {
 
 				procOutput = this.exec("mono --version");
 				if (!!procOutput) {
-					let match = SysInfoBase.monoVerRegExp.exec(procOutput);
+					let match = this.monoVerRegExp.exec(procOutput);
 					res.monoVer = match ? match[1] : null;
 				} else {
 					res.monoVer = null;
@@ -115,30 +115,25 @@ export class SysInfoBase implements ISysInfo {
 	}
 
 	private winVer(): string {
-		return this.readRegistryValue("ProductName").wait() + " " +
-				this.readRegistryValue("CurrentVersion").wait() + "." +
-				this.readRegistryValue("CurrentBuild").wait();
+		try {
+			return this.readRegistryValue("ProductName").wait() + " " +
+					this.readRegistryValue("CurrentVersion").wait() + "." +
+					this.readRegistryValue("CurrentBuild").wait();
+		} catch (err) {
+			this.$logger.trace(err);
+		}
+
+		return null;
 	}
 
 	private readRegistryValue(valueName: string): IFuture<string> {
-		let future = new Future<string>();
-		let Winreg = require("winreg");
-		let regKey = new Winreg({
-			hive: Winreg.HKLM,
-			key:  '\\Software\\Microsoft\\Windows NT\\CurrentVersion'
-		});
-		regKey.get(valueName, (err: Error, value: any) => {
-			if (err) {
-				future.throw(err);
-			} else {
-				future.return(value.value);
-			}
-		});
-		return future;
+		return ((): string => {
+			return this.$winreg.getRegistryValue(valueName, this.$winreg.registryKeys.HKLM, '\\Software\\Microsoft\\Windows NT\\CurrentVersion').wait().value;
+		}).future<string>()();
 	}
 
 	private unixVer(): string {
-		return this.$childProcess.exec("uname -a").wait();
+		return this.exec("uname -a");
 	}
 
 	private getJavaCompilerVersion(): IFuture<string> {
@@ -156,13 +151,15 @@ export class SysInfoBase implements ISysInfo {
 	private getCocoapodVersion(): string {
 		if(this.$hostInfo.isDarwin) {
 			let cocoapodVersion = this.exec("pod --version");
-			// Output of pod --version could contain some warnings. Find the version in it.
-			let cocoapodVersionMatch = cocoapodVersion.match(/^((?:\d+\.){2}\d+.*?)$/gm);
-			if(cocoapodVersionMatch && cocoapodVersionMatch[0]) {
-				cocoapodVersion = cocoapodVersionMatch[0].trim();
-			}
+			if(cocoapodVersion) {
+				// Output of pod --version could contain some warnings. Find the version in it.
+				let cocoapodVersionMatch = cocoapodVersion.match(/^((?:\d+\.){2}\d+.*?)$/gm);
+				if(cocoapodVersionMatch && cocoapodVersionMatch[0]) {
+					cocoapodVersion = cocoapodVersionMatch[0].trim();
+				}
 
-			return cocoapodVersion;
+				return cocoapodVersion;
+			}
 		}
 
 		return null;