Ability to prevent logging python execution info (#7464)

DonJayamanne · web-flow · commit 993fc553a199 · 2019-09-18T21:36:02.000+04:00
diff --git a/src/client/common/constants.ts b/src/client/common/constants.ts
@@ -80,6 +80,8 @@ export namespace Delays {
 
 export const STANDARD_OUTPUT_CHANNEL = 'STANDARD_OUTPUT_CHANNEL';
 
+export const isCI = process.env.TRAVIS === 'true' || process.env.TF_BUILD !== undefined;
+
 export function isTestExecution(): boolean {
     return process.env.VSC_PYTHON_CI_TEST === '1' || isUnitTestExecution();
 }
diff --git a/src/client/common/process/logger.ts b/src/client/common/process/logger.ts
@@ -1,8 +1,11 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
-import { inject, injectable, named } from 'inversify';
-import { STANDARD_OUTPUT_CHANNEL } from '../constants';
 
+'use strict';
+
+import { inject, injectable, named } from 'inversify';
+import { workspace } from 'vscode';
+import { isCI, isTestExecution, STANDARD_OUTPUT_CHANNEL } from '../constants';
 import { traceInfo } from '../logger';
 import { IOutputChannel, IPathUtils } from '../types';
 import { Logging } from '../utils/localize';
@@ -13,9 +16,18 @@ export class ProcessLogger implements IProcessLogger {
     constructor(
         @inject(IOutputChannel) @named(STANDARD_OUTPUT_CHANNEL) private readonly outputChannel: IOutputChannel,
         @inject(IPathUtils) private readonly pathUtils: IPathUtils
-    ) {}
+    ) { }
 
     public logProcess(file: string, args: string[], options?: SpawnOptions) {
+        if (
+            !isTestExecution() &&
+            isCI &&
+            !workspace.getConfiguration('python', null).get<boolean>('enableProcessLogging', true)
+        ) {
+            // Added to disable logging of process execution commands during UI Tests.
+            // Used only during UI Tests (hence this setting need not be exposed as a valid setting).
+            return;
+        }
         const argsList = args.reduce((accumulator, current, index) => {
             let formattedArg = this.pathUtils.getDisplayName(current).toCommandArgument();
             if (current[0] === '\'' || current[0] === '"') {

Original file line number	Diff line number	Diff line change
`@@ -80,6 +80,8 @@ export namespace Delays {`
`80`	`80`
`81`	`81`	`export const STANDARD_OUTPUT_CHANNEL = 'STANDARD_OUTPUT_CHANNEL';`
`82`	`82`
	`83`	`+export const isCI = process.env.TRAVIS === 'true' \|\| process.env.TF_BUILD !== undefined;`
	`84`	`+`
`83`	`85`	`export function isTestExecution(): boolean {`
`84`	`86`	`return process.env.VSC_PYTHON_CI_TEST === '1' \|\| isUnitTestExecution();`
`85`	`87`	`}`