Merge pull request #4404 from NativeScript/vladimirov/fix-CI-output

fix: errors from `tns doctor` are not visible in CI environment

Author: rosen-vladimirov

lib/common/helpers.ts

@@ -309,7 +309,27 @@ export function versionCompare(version1: string | IVersionData, version2: string
 }
 
 export function isInteractive(): boolean {
-	return process.stdout.isTTY && process.stdin.isTTY;
+	const isInteractive = isRunningInTTY() && !isCIEnvironment();
+	return isInteractive;
+}
+
+/**
+ * Checks if current process is running in Text Terminal (TTY)
+ */
+function isRunningInTTY(): boolean {
+	return process.stdout &&
+		process.stdout.isTTY &&
+		process.stdin &&
+		process.stdin.isTTY;
+}
+
+function isCIEnvironment(): boolean {
+	// The following CI environments set their own environment variables that we respect:
+	//  travis: "CI",
+	//  circleCI: "CI",
+	//  jenkins: "JENKINS_HOME"
+
+	return !!(process.env && (process.env.CI || process.env.JENKINS_HOME));
 }
 
 export function toBoolean(str: any): boolean {

lib/common/test/unit-tests/helpers.ts

@@ -861,4 +861,55 @@ const test = require("./test");`,
 			});
 		});
 	});
+
+	describe("isInteractive", () => {
+		const originalEnv = process.env;
+		const originalStdoutIsTTY = process.stdout.isTTY;
+		const originalStdinIsTTY = process.stdin.isTTY;
+		beforeEach(() => {
+			process.env.CI = "";
+			process.env.JENKINS_HOME = "";
+		});
+
+		afterEach(() => {
+			process.env = originalEnv;
+			process.stdout.isTTY = originalStdoutIsTTY;
+			process.stdin.isTTY = originalStdinIsTTY;
+		});
+
+		it("returns false when stdout is not TTY", () => {
+			(<any>process.stdout).isTTY = false;
+			(<any>process.stdin).isTTY = true;
+			assert.isFalse(helpers.isInteractive());
+		});
+
+		it("returns false when stdin is not TTY", () => {
+			(<any>process.stdin).isTTY = false;
+			(<any>process.stdout).isTTY = true;
+			assert.isFalse(helpers.isInteractive());
+		});
+
+		it("returns false when stdout and stdin are TTY, but CI env var is set", () => {
+			(<any>process.stdout).isTTY = true;
+			(<any>process.stdin).isTTY = true;
+			process.env.CI = "true";
+
+			assert.isFalse(helpers.isInteractive());
+		});
+
+		it("returns false when stdout and stdin are TTY, but JENKINS_HOME env var is set", () => {
+			(<any>process.stdout).isTTY = true;
+			(<any>process.stdin).isTTY = true;
+			process.env.JENKINS_HOME = "/usr/local/lib/jenkins";
+
+			assert.isFalse(helpers.isInteractive());
+		});
+
+		it("returns true when stdout and stdin are TTY and neither CI or JENKINS_HOME are set", () => {
+			(<any>process.stdout).isTTY = true;
+			(<any>process.stdin).isTTY = true;
+
+			assert.isTrue(helpers.isInteractive());
+		});
+	});
 });

test/services/doctor-service.ts

@@ -111,17 +111,6 @@ describe("doctorService", () => {
 				filesContents: {
 					file1: `const application = require("application");
 const Observable = require("data/observable").Observable;
-`
-				},
-				expectedShortImports: [
-					{ file: "file1", line: 'const application = require("application");' },
-					{ file: "file1", line: 'const Observable = require("data/observable").Observable;' },
-				]
-			},
-			{
-				filesContents: {
-					file1: `const application = require("application");
-const Observable = require("data/observable").Observable;
 `
 				},
 				expectedShortImports: [

test/services/platform-environment-requirements.ts

@@ -3,7 +3,9 @@ import { PlatformEnvironmentRequirements } from '../../lib/services/platform-env
 import * as stubs from "../stubs";
 import { assert } from "chai";
 import { EOL } from "os";
+const helpers = require("../../lib/common/helpers");
 
+const originalIsInteractive = helpers.isInteractive;
 const platform = "android";
 const cloudBuildsErrorMessage = `In order to test your application use the $ tns login command to log in with your account and then $ tns cloud build command to build your app in the cloud.`;
 const manuallySetupErrorMessage = `To be able to build for ${platform}, verify that your environment is configured according to the system requirements described at `;
@@ -34,6 +36,14 @@ function createTestInjector() {
 }
 
 describe("platformEnvironmentRequirements ", () => {
+	beforeEach(() => {
+		helpers.isInteractive = () => true;
+	});
+
+	afterEach(() => {
+		helpers.isInteractive = originalIsInteractive;
+	});
+
 	describe("checkRequirements", () => {
 		let testInjector: IInjector = null;
 		let platformEnvironmentRequirements: IPlatformEnvironmentRequirements = null;
@@ -221,8 +231,7 @@ describe("platformEnvironmentRequirements ", () => {
 
 		describe("when console is non interactive", () => {
 			beforeEach(() => {
-				(<any>process).stdout.isTTY = false;
-				(<any>process.stdin).isTTY = false;
+				helpers.isInteractive = () => false;
 				mockDoctorService({ canExecuteLocalBuild: false });
 			});