Merge pull request #19 from NativeScript/tnikolov/find-git

Find the path to the git executable on different platforms.

Author: TomaNikolov

lib/helpers.ts

@@ -1,6 +1,8 @@
-import { platform } from "os";
+import { HostInfo } from "./host-info";
 
 export class Helpers {
+	constructor(private hostInfo: HostInfo) { }
+
 	public getPropertyName(method: Function): string {
 		if (method) {
 			let match = method.toString().match(/(?:return\s+?.*\.(.+);)|(?:=>\s*?.*\.(.+)\b)/);
@@ -17,7 +19,7 @@ export class Helpers {
 			return value;
 		}
 
-		return (platform() === "win32") ? this.cmdQuote(value) : this.bashQuote(value);
+		return this.hostInfo.isWindows ? this.cmdQuote(value) : this.bashQuote(value);
 	}
 
 	private bashQuote(s: string): string {

lib/index.ts

@@ -14,7 +14,7 @@ const childProcess = new ChildProcess();
 const winReg = new WinReg();
 const hostInfo = new HostInfo(winReg);
 const fileSystem = new FileSystem();
-const helpers = new Helpers();
+const helpers = new Helpers(hostInfo);
 const androidToolsInfo = new AndroidToolsInfo(childProcess, fileSystem, hostInfo);
 
 const sysInfo: NativeScriptDoctor.ISysInfo = new SysInfo(childProcess, fileSystem, helpers, hostInfo, winReg, androidToolsInfo);

lib/sys-info.ts

@@ -193,7 +193,7 @@ export class SysInfo implements NativeScriptDoctor.ISysInfo {
 
 	public async isAndroidSdkConfiguredCorrectly(): Promise<boolean> {
 		return this.getValueForProperty(() => this.isAndroidSdkConfiguredCorrectlyCache, async (): Promise<boolean> => {
-			const output = await this.childProcess.spawnFromEvent(this.androidToolsInfo.getPathToEmulatorExecutable(), ['-help'], "close", { ignoreError: true });
+			const output = await this.childProcess.spawnFromEvent(this.androidToolsInfo.getPathToEmulatorExecutable(), ["-help"], "close", { ignoreError: true });
 
 			return output && output.stdout.indexOf("usage: emulator") >= 0;
 		});
@@ -209,10 +209,14 @@ export class SysInfo implements NativeScriptDoctor.ISysInfo {
 
 	public getGitVersion(): Promise<string> {
 		return this.getValueForProperty(() => this.gitVerCache, async (): Promise<string> => {
-			const output = await this.execCommand("git --version");
+			const gitPath = await this.getGitPath();
+			if (!gitPath) {
+				return null;
+			}
+
+			const output = await this.execCommand(`${this.helpers.quoteString(gitPath)} --version`);
 			const matches = SysInfo.GIT_VERSION_REGEXP.exec(output);
 			return matches && matches[1];
-
 		});
 	}
 
@@ -340,6 +344,61 @@ export class SysInfo implements NativeScriptDoctor.ISysInfo {
 		this.shouldCache = shouldCache;
 	}
 
+	public getGitPath(): Promise<string> {
+		return this.hostInfo.isWindows ? this.findGitWin32() : this.findGitUnix();
+	}
+
+	private async findGitWin32(): Promise<string> {
+		let result: string;
+		const win32Paths = [process.env["ProgramFiles"], process.env["ProgramFiles(x86)"]];
+		for (const win32Path of win32Paths) {
+			result = this.findSystemGitWin32(win32Path);
+			if (result) {
+				return result;
+			}
+		}
+
+		result = this.findGitHubGitWin32();
+		return result ? result : await this.findGitCore("where");
+	}
+
+	private findSystemGitWin32(base: string): string {
+		if (!base) {
+			return null;
+		}
+
+		return this.findSpecificGit(path.join(base, "Git", "cmd", "git.exe"));
+	}
+
+	private findGitHubGitWin32(): string {
+		const github = path.join(process.env["LOCALAPPDATA"], "GitHub");
+		if (!this.fileSystem.exists(github)) {
+			return null;
+		}
+
+		const children = this.fileSystem.readDirectory(github);
+		const git = children.filter(child => /^PortableGit/.test(child))[0];
+		if (!this.fileSystem.exists(git)) {
+			return null;
+		}
+
+		return this.findSpecificGit(path.join(github, git, "cmd", "git.exe"));
+	}
+
+	private findSpecificGit(gitPath: string): string {
+		return this.fileSystem.exists(gitPath) ? gitPath : null;
+	}
+
+	private async findGitUnix(): Promise<string> {
+		return await this.findGitCore("which");
+	}
+
+	private async findGitCore(command: string, options?: any): Promise<string> {
+		const result = await this.execCommand(`${command} git`);
+
+		return result && result.split("\n")[0].trim();
+	}
+
 	private async getValueForProperty<T>(property: Function, getValueMethod: () => Promise<T>): Promise<T> {
 		if (this.shouldCache) {
 			const propertyName = this.helpers.getPropertyName(property);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "nativescript-doctor",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "description": "Library that helps identifying if the environment can be used for development of {N} apps.",
   "main": "lib/index.js",
   "types": "./typings/nativescript-doctor.d.ts",

test/sys-info.ts

@@ -6,7 +6,8 @@ import { ChildProcess } from "../lib/wrappers/child-process";
 
 const JavaHomeName = "JAVA_HOME";
 const AndroidHomeName = "ANDROID_HOME";
-const helpers = new Helpers();
+const PROGRAM_FILES = "ProgramFiles";
+const PROGRAM_FILES_ENV_PATH = "C:\\Program Files";
 
 interface IChildProcessResultDescription {
 	result?: any;
@@ -29,6 +30,7 @@ interface IChildProcessResults {
 	podVersion: IChildProcessResultDescription;
 	pod: IChildProcessResultDescription;
 	nativeScriptCliVersion: IChildProcessResultDescription;
+	git: IChildProcessResultDescription;
 }
 
 interface IHostInfoMockOptions {
@@ -73,16 +75,19 @@ function createChildProcessResults(childProcessResult: IChildProcessResults): ID
 		"xcodebuild -version": childProcessResult.xCodeVersion,
 		"pod --version": childProcessResult.podVersion,
 		"pod": childProcessResult.pod,
-		'adb': childProcessResult.adbVersion,
-		'adb version': childProcessResult.adbVersion,
+		"adb": childProcessResult.adbVersion,
+		"adb version": childProcessResult.adbVersion,
 		"'adb' version": childProcessResult.adbVersion, // for Mac and Linux
-		'android': childProcessResult.androidInstalled,
-		'android.bat': childProcessResult.androidInstalled, // for Windows
+		"android": childProcessResult.androidInstalled,
+		"android.bat": childProcessResult.androidInstalled, // for Windows
 		"mono --version": childProcessResult.monoVersion,
-		"git --version": childProcessResult.gitVersion,
+		"'git' --version": childProcessResult.gitVersion, // for Mac and Linux
+		'"C:\\Program Files\\Git\\cmd\\git.exe" --version': childProcessResult.gitVersion, // for Windows
+		'"C:\\Program Files/Git/cmd/git.exe" --version': childProcessResult.gitVersion, // When running Windows test on the Non-Windows platform
 		"gradle -v": childProcessResult.gradleVersion,
 		"tns --version": childProcessResult.nativeScriptCliVersion,
-		"emulator": { shouldThrowError: false }
+		"emulator": { shouldThrowError: false },
+		"which git": childProcessResult.git
 	};
 }
 
@@ -128,9 +133,11 @@ function mockSysInfo(childProcessResult: IChildProcessResults, hostInfoOptions?:
 
 	const fileSystem: any = {
 		exists: () => Promise.resolve((fileSystemOptions || {}).existsResult),
-		extractZip: () => Promise.resolve()
+		extractZip: () => Promise.resolve(),
+		readDirectory: () => Promise.resolve([])
 	};
 
+	const helpers = new Helpers(hostInfo);
 	return new SysInfo(childProcess, fileSystem, helpers, hostInfo, winreg, androidToolsInfo);
 }
 
@@ -169,6 +176,7 @@ describe("SysInfo unit tests", () => {
 				}
 			};
 
+			const helpers = new Helpers(null);
 			sysInfo = new SysInfo(childProcess, null, helpers, null, null, androidToolsInfo);
 		});
 
@@ -221,7 +229,8 @@ describe("SysInfo unit tests", () => {
 				gitVersion: { result: setStdOut("git version 1.9.5") },
 				podVersion: { result: setStdOut("0.38.2") },
 				pod: { result: setStdOut("success") },
-				nativeScriptCliVersion: { result: setStdOut("2.5.0") }
+				nativeScriptCliVersion: { result: setStdOut("2.5.0") },
+				git: { result: setStdOut("git") }
 			};
 
 			delete process.env[JavaHomeName];
@@ -253,8 +262,11 @@ describe("SysInfo unit tests", () => {
 			});
 
 			it("on Windows", async () => {
+				const originalProgramFiles = process.env[PROGRAM_FILES];
+				process.env[PROGRAM_FILES] = PROGRAM_FILES_ENV_PATH;
 				sysInfo = mockSysInfo(childProcessResult, { isWindows: true, isDarwin: false, dotNetVersion: "4.5.1" });
 				let result = await sysInfo.getSysInfo();
+				process.env[PROGRAM_FILES] = originalProgramFiles;
 				assertCommonValues(result);
 				assert.deepEqual(result.xcodeVer, null);
 				assert.deepEqual(result.cocoaPodsVer, null);
@@ -287,8 +299,11 @@ describe("SysInfo unit tests", () => {
 			});
 
 			it("is null when OS is not Mac", async () => {
+				const originalProgramFiles = process.env[PROGRAM_FILES];
+				process.env[PROGRAM_FILES] = PROGRAM_FILES_ENV_PATH;
 				sysInfo = mockSysInfo(childProcessResult, { isWindows: true, isDarwin: false, dotNetVersion: "4.5.1" });
 				let result = await sysInfo.getSysInfo();
+				process.env[PROGRAM_FILES] = originalProgramFiles;
 				assert.deepEqual(result.cocoaPodsVer, null);
 			});
 
@@ -324,7 +339,8 @@ describe("SysInfo unit tests", () => {
 					gitVersion: { shouldThrowError: true },
 					podVersion: { shouldThrowError: true },
 					pod: { shouldThrowError: true },
-					nativeScriptCliVersion: { shouldThrowError: true }
+					nativeScriptCliVersion: { shouldThrowError: true },
+					git: { shouldThrowError: false }
 				};
 				androidToolsInfo.validateAndroidHomeEnvVariable = (): any[] => [1];
 			});
@@ -346,7 +362,10 @@ describe("SysInfo unit tests", () => {
 				};
 
 				it("on Windows", async () => {
+					const originalProgramFiles = process.env[PROGRAM_FILES];
+					process.env[PROGRAM_FILES] = PROGRAM_FILES_ENV_PATH;
 					sysInfo = mockSysInfo(childProcessResult, { isWindows: true, isDarwin: false, dotNetVersion: "4.5.1" });
+					process.env[PROGRAM_FILES] = originalProgramFiles;
 					await assertAllValuesAreNull();
 				});
 

typings/interfaces.ts

@@ -81,6 +81,12 @@ declare module NativeScriptDoctor {
 		 */
 		getGitVersion(): Promise<string>;
 
+		/**
+		 * Returns the path to the currently installed Git.
+		 * @return {Promise<string>} Returns the path to the currently installed Git. It will return null if Git is not installed.
+		 */
+		getGitPath(): Promise<string>;
+
 		/**
 		 * Returns the currently installed Gradle version.
 		 * @return {Promise<string>} Returns the currently installed Gradle version. It will return null if Gradle is not installed.