Merge pull request #25 from NativeScript/vladimirov/detect-java-9

Add check for JAVA 9

Author: rosen-vladimirov

.travis.yml

@@ -1,6 +1,6 @@
 language: node_js
 node_js:
-- '4'
+- '6'
 git:
   submodules: false
 before_script:

README.md

@@ -79,8 +79,6 @@ Library that helps identifying if the environment can be used for development of
 		// The default value is true. If set to false the result of each check for each element
 		// of the sys info will not be cached.
 		setShouldCacheSysInfo(false);
-		const javaVersion = await sysInfo.getJavaVersion();
-		console.log("java: ", javaVersion);
 
 		const javacVersion = await sysInfo.getJavaCompilerVersion();
 		console.log("javac: ", javacVersion);
@@ -150,12 +148,6 @@ Library that helps identifying if the environment can be used for development of
 	 * Describes methods which helps collecting system information.
 	 */
 	interface ISysInfo {
-		/**
-		 * Returns the currently installed Java version.
-		 * @return {Promise<string>} The currently installed Java version.
-		 */
-		getJavaVersion(): Promise<string>;
-
 		/**
 		 * Returns the currently installed Java compiler version.
 		 * @return {Promise<string>} The currently installed Java compiler version.
@@ -336,12 +328,6 @@ Library that helps identifying if the environment can be used for development of
 		nodeGypVer: string;
 
 		// dependencies
-		/**
-		 * Version of java, as returned by `java -version`.
-		 * @type {string}
-		 */
-		javaVer: string;
-
 		/**
 		 * Xcode version string as returned by `xcodebuild -version`. Valid only on Mac.
 		 * @type {string}

lib/android-tools-info.ts

@@ -2,6 +2,7 @@ import { ChildProcess } from "./wrappers/child-process";
 import { FileSystem } from "./wrappers/file-system";
 import { HostInfo } from "./host-info";
 import { Constants } from "./constants";
+import { Helpers } from './helpers';
 import { EOL } from "os";
 import * as semver from "semver";
 import * as path from "path";
@@ -13,14 +14,16 @@ export class AndroidToolsInfo implements NativeScriptDoctor.IAndroidToolsInfo {
 	private static REQUIRED_BUILD_TOOLS_RANGE_PREFIX = ">=23";
 	private static VERSION_REGEX = /((\d+\.){2}\d+)/;
 	private static MIN_JAVA_VERSION = "1.8.0";
+	private static MAX_JAVA_VERSION = "1.9.0";
 
 	private toolsInfo: NativeScriptDoctor.IAndroidToolsInfoData;
 	private androidHome = process.env["ANDROID_HOME"];
 	private pathToEmulatorExecutable: string;
 
 	constructor(private childProcess: ChildProcess,
 		private fs: FileSystem,
-		private hostInfo: HostInfo) { }
+		private hostInfo: HostInfo,
+		private helpers: Helpers) { }
 
 	public getToolsInfo(): NativeScriptDoctor.IAndroidToolsInfoData {
 		if (!this.toolsInfo) {
@@ -86,17 +89,27 @@ export class AndroidToolsInfo implements NativeScriptDoctor.IAndroidToolsInfo {
 		return errors;
 	}
 
-	public validateJavacVersion(installedJavaVersion: string): NativeScriptDoctor.IWarning[] {
+	public validateJavacVersion(installedJavaCompilerVersion: string): NativeScriptDoctor.IWarning[] {
 		const errors: NativeScriptDoctor.IWarning[] = [];
 
 		let additionalMessage = "You will not be able to build your projects for Android." + EOL
 			+ "To be able to build for Android, verify that you have installed The Java Development Kit (JDK) and configured it according to system requirements as" + EOL +
 			" described in " + this.getSystemRequirementsLink();
-		let matchingVersion = (installedJavaVersion || "").match(AndroidToolsInfo.VERSION_REGEX);
-		if (matchingVersion && matchingVersion[1]) {
-			if (semver.lt(matchingVersion[1], AndroidToolsInfo.MIN_JAVA_VERSION)) {
+
+		const matchingVersion = this.helpers.appendZeroesToVersion(installedJavaCompilerVersion || "", 3).match(AndroidToolsInfo.VERSION_REGEX);
+		const installedJavaCompilerSemverVersion = matchingVersion && matchingVersion[1];
+		if (installedJavaCompilerSemverVersion) {
+			let warning: string = null;
+
+			if (semver.lt(installedJavaCompilerSemverVersion, AndroidToolsInfo.MIN_JAVA_VERSION)) {
+				warning = `Javac version ${installedJavaCompilerVersion} is not supported. You have to install at least ${AndroidToolsInfo.MIN_JAVA_VERSION}.`;
+			} else if (semver.gte(installedJavaCompilerSemverVersion, AndroidToolsInfo.MAX_JAVA_VERSION)) {
+				warning = `Javac version ${installedJavaCompilerVersion} is not supported. You have to install version ${AndroidToolsInfo.MIN_JAVA_VERSION}.`;
+			}
+
+			if (warning) {
 				errors.push({
-					warning: `Javac version ${installedJavaVersion} is not supported. You have to install at least ${AndroidToolsInfo.MIN_JAVA_VERSION}.`,
+					warning,
 					additionalInformation: additionalMessage,
 					platforms: [Constants.ANDROID_PLATFORM_NAME]
 				});
@@ -140,7 +153,7 @@ export class AndroidToolsInfo implements NativeScriptDoctor.IAndroidToolsInfo {
 			errors.push({
 				warning: "The ANDROID_HOME environment variable points to incorrect directory. You will not be able to perform any build-related operations for Android.",
 				additionalInformation: "To be able to perform Android build-related operations, set the `ANDROID_HOME` variable to point to the root of your Android SDK installation directory, " +
-				"where you will find `tools` and `platform-tools` directories.",
+					"where you will find `tools` and `platform-tools` directories.",
 				platforms: [Constants.ANDROID_PLATFORM_NAME]
 			});
 		}
@@ -299,22 +312,7 @@ export class AndroidToolsInfo implements NativeScriptDoctor.IAndroidToolsInfo {
 	}
 
 	private getSystemRequirementsLink(): string {
-		let linkToSystemRequirements: string;
-		switch (process.platform) {
-			case "linux":
-				linkToSystemRequirements = "http://docs.nativescript.org/setup/ns-cli-setup/ns-setup-linux.html#system-requirements";
-				break;
-			case "win32":
-				linkToSystemRequirements = "http://docs.nativescript.org/setup/ns-cli-setup/ns-setup-win.html#system-requirements";
-				break;
-			case "darwin":
-				linkToSystemRequirements = "http://docs.nativescript.org/setup/ns-cli-setup/ns-setup-os-x.html#system-requirements";
-				break;
-			default:
-				linkToSystemRequirements = "";
-		}
-
-		return linkToSystemRequirements;
+		return Constants.SYSTEM_REQUIREMENTS_LINKS[process.platform] || "";
 	}
 
 	private isAndroidHomeValid(): boolean {

lib/constants.ts

@@ -2,4 +2,9 @@ export class Constants {
 	public static ANDROID_PLATFORM_NAME = "Android";
 	public static IOS_PLATFORM_NAME = "iOS";
 	public static SUPPORTED_PLATFORMS = [Constants.ANDROID_PLATFORM_NAME, Constants.IOS_PLATFORM_NAME];
+	public static SYSTEM_REQUIREMENTS_LINKS: IDictionary<string> = {
+		"win32": "http://docs.nativescript.org/setup/ns-cli-setup/ns-setup-win.html#system-requirements",
+		"linux": "http://docs.nativescript.org/setup/ns-cli-setup/ns-setup-linux.html#system-requirements",
+		"darwin": "http://docs.nativescript.org/setup/ns-cli-setup/ns-setup-os-x.html#system-requirements",
+	};
 }

lib/doctor.ts

@@ -131,14 +131,13 @@ export class Doctor implements NativeScriptDoctor.IDoctor {
 			});
 		}
 
-		if (!sysInfoData.javaVer) {
+		if (!sysInfoData.javacVersion) {
 			result.push({
 				warning: "WARNING: 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)" + EOL
-				+ "or http://docs.oracle.com/javase/7/docs/webnotes/install/ (for JDK 7)." + EOL,
+				+ "described in http://docs.oracle.com/javase/8/docs/technotes/guides/install/install_overview.html (for JDK 8)." + EOL,
 				platforms: [Constants.ANDROID_PLATFORM_NAME]
 			});
 		}

lib/helpers.ts

@@ -22,10 +22,18 @@ export class Helpers {
 		return this.hostInfo.isWindows ? this.cmdQuote(value) : this.bashQuote(value);
 	}
 
+	/**
+	 * Appends zeroes to a version string until it reaches a specified length.
+	 * @param {string} version The version on which to append zeroes.
+	 * @param {number} requiredVersionLength The required length of the version string.
+	 * @returns {string} Appended version string. In case input is null, undefined or empty string, it is returned immediately without appending anything.
+	 */
 	public appendZeroesToVersion(version: string, requiredVersionLength: number): string {
-		const zeroesToAppend = requiredVersionLength - version.split(".").length;
-		for (let index = 0; index < zeroesToAppend; index++) {
-			version += ".0";
+		if (version) {
+			const zeroesToAppend = requiredVersionLength - version.split(".").length;
+			for (let index = 0; index < zeroesToAppend; index++) {
+				version += ".0";
+			}
 		}
 
 		return version;

lib/index.ts

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

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

@@ -6,7 +6,6 @@ export class AndroidLocalBuildRequirements {
 		const androidToolsInfo = await this.androidToolsInfo.validateInfo();
 		if (androidToolsInfo.length ||
 			!await this.sysInfo.getJavaCompilerVersion() ||
-			!await this.sysInfo.getJavaVersion() ||
 			!await this.sysInfo.getAdbVersion()) {
 			return false;
 		}

lib/sys-info.ts

@@ -4,16 +4,13 @@ import { HostInfo } from "./host-info";
 import { ExecOptions } from "child_process";
 import { WinReg } from "./winreg";
 import { Helpers } from "./helpers";
-import { platform } from "os";
+import { platform, EOL } from "os";
 import * as path from "path";
 import * as osenv from "osenv";
 import * as temp from "temp";
 import * as semver from "semver";
 
 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;
-
 	private static JAVA_COMPILER_VERSION_REGEXP = /^javac (.*)/im;
 	private static XCODE_VERSION_REGEXP = /Xcode (.*)/;
 	private static VERSION_REGEXP = /(\d{1,})\.(\d{1,})\.*([\w-]{0,})/m;
@@ -23,7 +20,6 @@ export class SysInfo implements NativeScriptDoctor.ISysInfo {
 
 	private monoVerRegExp = /version (\d+[.]\d+[.]\d+) /gm;
 
-	private javaVerCache: string;
 	private javaCompilerVerCache: string;
 	private xCodeVerCache: string;
 	private npmVerCache: string;
@@ -53,26 +49,14 @@ export class SysInfo implements NativeScriptDoctor.ISysInfo {
 		private winReg: WinReg,
 		private androidToolsInfo: NativeScriptDoctor.IAndroidToolsInfo) { }
 
-	public getJavaVersion(): Promise<string> {
-		return this.getValueForProperty(() => this.javaVerCache, async (): Promise<string> => {
-			try {
-				const spawnResult = await this.childProcess.spawnFromEvent("java", ["-version"], "exit");
-				const matches = spawnResult && SysInfo.JAVA_VERSION_REGEXP.exec(spawnResult.stderr);
-				return matches && matches[1];
-			} catch (err) {
-				return null;
-			}
-		});
-	}
-
 	public getJavaCompilerVersion(): Promise<string> {
 		return this.getValueForProperty(() => this.javaCompilerVerCache, async (): Promise<string> => {
 			const javaCompileExecutableName = "javac";
 			const javaHome = process.env["JAVA_HOME"];
 			const pathToJavaCompilerExecutable = javaHome ? path.join(javaHome, "bin", javaCompileExecutableName) : javaCompileExecutableName;
 			try {
 				const output = await this.childProcess.exec(`"${pathToJavaCompilerExecutable}" -version`);
-				return SysInfo.JAVA_COMPILER_VERSION_REGEXP.exec(output.stderr)[1];
+				return SysInfo.JAVA_COMPILER_VERSION_REGEXP.exec(`${output.stderr}${EOL}${output.stdout}`)[1];
 			} catch (err) {
 				return null;
 			}
@@ -245,7 +229,6 @@ export class SysInfo implements NativeScriptDoctor.ISysInfo {
 			result.nodeGypVer = await this.getNodeGypVersion();
 
 			result.dotNetVer = await this.hostInfo.dotNetVersion();
-			result.javaVer = await this.getJavaVersion();
 			result.javacVersion = await this.getJavaCompilerVersion();
 			result.xcodeVer = await this.getXcodeVersion();
 			result.xcodeprojGemLocation = await this.getXcodeprojGemLocation();

package.json

@@ -23,10 +23,12 @@
   },
   "homepage": "https://github.com/NativeScript/nativescript-doctor#readme",
   "devDependencies": {
+    "@types/chai": "4.1.0",
     "@types/mocha": "2.2.32",
     "@types/semver": "5.3.30",
     "@types/temp": "0.8.29",
     "@types/winreg": "1.2.30",
+    "chai": "4.1.2",
     "grunt": "1.0.1",
     "grunt-contrib-clean": "1.0.0",
     "grunt-contrib-watch": "1.0.0",

test/android-tools-info.ts

@@ -0,0 +1,77 @@
+import { AndroidToolsInfo } from '../lib/android-tools-info';
+import { EOL } from 'os';
+import { assert } from "chai";
+import { ChildProcess } from '../lib/wrappers/child-process';
+import { FileSystem } from '../lib/wrappers/file-system';
+import { HostInfo } from '../lib/host-info';
+import { Helpers } from '../lib/helpers';
+import { Constants } from '../lib/constants';
+
+interface ITestData {
+	javacVersion: string;
+	warnings?: string[];
+}
+
+describe("androidToolsInfo", () => {
+	const additionalInformation = "You will not be able to build your projects for Android." + EOL
+	+ "To be able to build for Android, verify that you have installed The Java Development Kit (JDK) and configured it according to system requirements as" + EOL +
+	" described in " + Constants.SYSTEM_REQUIREMENTS_LINKS[process.platform];
+
+	const getAndroidToolsInfo = (): AndroidToolsInfo => {
+		const childProcess: ChildProcess = <any>{};
+		const fs: FileSystem = <any>{};
+		const hostInfo: HostInfo = <any>{};
+		const helpers: Helpers = new Helpers(<any>{});
+		return new AndroidToolsInfo(childProcess, fs, hostInfo, helpers);
+	};
+
+	describe("validateJavacVersion", () => {
+		const testData: ITestData[] = [
+			{
+				javacVersion: "1.8.0"
+			},
+			{
+				javacVersion: "1.8.0_152"
+			},
+			{
+				javacVersion: "9",
+				warnings: ["Javac version 9 is not supported. You have to install version 1.8.0."]
+			},
+			{
+				javacVersion: "9.0.1",
+				warnings: ["Javac version 9.0.1 is not supported. You have to install version 1.8.0."]
+			},
+			{
+				javacVersion: "1.7.0",
+				warnings: ["Javac version 1.7.0 is not supported. You have to install at least 1.8.0."]
+			},
+			{
+				javacVersion: "1.7.0_132",
+				warnings: ["Javac version 1.7.0_132 is not supported. You have to install at least 1.8.0."]
+			},
+			{
+				javacVersion: null,
+				warnings: ["Error executing command 'javac'. Make sure you have installed The Java Development Kit (JDK) and set JAVA_HOME environment variable."]
+			}
+		];
+
+		testData.forEach(({ javacVersion, warnings }) => {
+			it(`returns correct result when version is ${javacVersion}`, () => {
+				const androidToolsInfo = getAndroidToolsInfo();
+				const actualWarnings = androidToolsInfo.validateJavacVersion(javacVersion);
+				let expectedWarnings: NativeScriptDoctor.IWarning[] = [];
+				if (warnings && warnings.length) {
+					expectedWarnings = warnings.map(warning => {
+						return {
+							platforms: [Constants.ANDROID_PLATFORM_NAME],
+							warning,
+							additionalInformation
+						};
+					});
+				}
+
+				assert.deepEqual(actualWarnings, expectedWarnings);
+			});
+		});
+	});
+});