[WIP] fix cli -> tools cycle

Signed-off-by: David Thompson <davthomp@redhat.com>

Author: datho7561

src/cli.ts

@@ -8,76 +8,15 @@ import * as cp from 'child_process';
 import * as vscode from 'vscode';
 import { CommandText } from './base/command';
 import { ToolsConfig } from './tools';
-import { Filters } from './util/filters';
+import { ChildProcessUtil, CliExitData } from './util/childProcessUtil';
 import { WindowUtil } from './util/windowUtils';
 import { VsCommandError } from './vscommand';
 
-export interface CliExitData {
-    readonly error: cp.ExecException;
-    readonly stdout: string;
-    readonly stderr: string;
-    readonly cwd?: string;
-}
-
-export interface Cli {
-    execute(cmd: string, opts?: cp.ExecOptions): Promise<CliExitData>;
-    executeTool(command: CommandText, opts?: cp.ExecOptions): Promise<CliExitData>;
-    spawn(cmd: string, params: string[], opts: cp.SpawnOptions): cp.ChildProcess;
-    spawnTool(cmd: CommandText, opts: cp.SpawnOptions): Promise<cp.ChildProcess>;
-    executeInTerminal(cmd: CommandText, cwd: string, terminalName: string): void;
-}
-
-export interface OdoChannel {
-    print(text: string): void;
-    show(): void;
-}
-
-function prettifyJson(str: string): string {
-    let jsonData: string;
-    try {
-        jsonData = JSON.stringify(JSON.parse(str), null, 2);
-    } catch (ignore) {
-        const hidePass = Filters.filterToken(str);
-        return Filters.filterPassword(hidePass);
-    }
-    return jsonData;
-}
-
-class OdoChannelImpl implements OdoChannel {
-    private readonly channel: vscode.OutputChannel = vscode.window.createOutputChannel('OpenShift');
-
-    show(): void {
-        this.channel.show();
-    }
-
-    print(text: string): void {
-        const textData = prettifyJson(text);
-        this.channel.append(textData);
-        if (!textData.endsWith('\n')) {
-            this.channel.append('\n');
-        }
-        if (
-            vscode.workspace
-                .getConfiguration('openshiftToolkit')
-                .get<boolean>('showChannelOnOutput')
-        ) {
-            this.channel.show();
-        }
-    }
-}
-
-// TODO Refactor to OdoCli or OpenShiftCli class
-// This is Cli interface implementation that lets
-// execute commands and prints commands and output
-// to an output channel
-
-export class CliChannel implements Cli {
+export class CliChannel {
 
     private static telemetrySettings = new VSCodeSettings();
     private static instance: CliChannel;
 
-    private odoChannel: OdoChannel = new OdoChannelImpl();
-
     static getInstance(): CliChannel {
         if (!CliChannel.instance) {
             CliChannel.instance = new CliChannel();
@@ -86,34 +25,9 @@ export class CliChannel implements Cli {
     }
 
     showOutput(): void {
-        this.odoChannel.show();
-    }
-
-    execute(cmd: string, opts: cp.ExecOptions = {}): Promise<CliExitData> {
-        return new Promise<CliExitData>((resolve) => {
-            if (opts.maxBuffer === undefined) {
-                opts.maxBuffer = 2 * 1024 * 1024;
-            }
-            cp.exec(cmd, opts, (error: cp.ExecException, stdout: string, stderr: string) => {
-                // filter out info about update
-                this.odoChannel.print(cmd);
-                this.odoChannel.print(stdout);
-                this.odoChannel.print(stderr);
-                // do not reject it here, because caller in some cases need the error and the streams
-                // to make a decision
-                // Filter update message text which starts with `---`
-                resolve({ error, stdout: stdout.trim(), stderr: stderr.trim(), cwd: opts?.cwd?.toString() });
-            });
-        });
+        ChildProcessUtil.Instance.show();
     }
 
-    // if (TelemetryConfiguration.getInstance().isEnabled()) {
-    //     this.envVars.put("ODO_TRACKING_CONSENT", "yes");
-    //     this.envVars.put("TELEMETRY_CALLER", "intellij");
-    // } else {
-    //     this.envVars.put("ODO_TRACKING_CONSENT", "no");
-    // }
-
     static createTelemetryEnv(): {[key:string]: string} {
         const env = {
             ...process.env,
@@ -145,7 +59,7 @@ export class CliChannel implements Cli {
         const [cmd] = commandActual.split(' ');
         const toolLocation = await ToolsConfig.detect(cmd);
         const optsCopy = CliChannel.applyEnv(opts, CliChannel.createTelemetryEnv())
-        const result: CliExitData = await this.execute(toolLocation ? commandActual.replace(cmd, `"${toolLocation}"`) : commandActual, optsCopy);
+        const result: CliExitData = await ChildProcessUtil.Instance.execute(toolLocation ? commandActual.replace(cmd, `"${toolLocation}"`) : commandActual, optsCopy);
         if (result.error && fail) {
             throw new VsCommandError(`${result.error.message}`, `Error when running command: ${commandPrivacy}`, result.error);
         };
@@ -163,10 +77,6 @@ export class CliChannel implements Cli {
         terminal.show();
     }
 
-    spawn(cmd: string, params: string[], opts: cp.SpawnOptions = {cwd: undefined, env: process.env}): cp.ChildProcess {
-        return cp.spawn(cmd, params, opts);
-    }
-
     async spawnTool(cmd: CommandText, opts: cp.SpawnOptions = {cwd: undefined, env: process.env}): Promise<cp.ChildProcess> {
         const toolLocation = await ToolsConfig.detect(cmd.command);
         const optWithTelemetryEnv = CliChannel.applyEnv(opts, CliChannel.createTelemetryEnv());

src/helm/helm.ts

@@ -2,7 +2,8 @@
  *  Copyright (c) Red Hat, Inc. All rights reserved.
  *  Licensed under the MIT License. See LICENSE file in the project root for license information.
  *-----------------------------------------------------------------------------------------------*/
-import { CliChannel, CliExitData } from '../cli';
+import { CliChannel } from '../cli';
+import { CliExitData } from '../util/childProcessUtil';
 import * as HelmCommands from './helmCommands';
 
 export type HelmRelease = {

src/k8s/build.ts

@@ -5,11 +5,11 @@
 
 import { QuickPickItem, window } from 'vscode';
 import { ClusterExplorerV1 } from 'vscode-kubernetes-tools-api';
+import { CommandOption, CommandText } from '../base/command';
+import { CliChannel } from '../cli';
 import { Progress } from '../util/progress';
-import * as common from './common';
 import { vsCommand, VsCommandError } from '../vscommand';
-import { CommandOption, CommandText } from '../base/command';
-import { Cli, CliChannel } from '../cli';
+import * as common from './common';
 
 export class Build {
 
@@ -56,7 +56,7 @@ export class Build {
       }
   };
 
-    protected static readonly odo: Cli = CliChannel.getInstance();
+    protected static readonly cli = CliChannel.getInstance();
 
     static getNodeContributor(): ClusterExplorerV1.NodeContributor {
       return {
@@ -97,7 +97,7 @@ export class Build {
         let result: Promise<string> = null;
         if (!buildName) buildName = await common.selectResourceByName(await Build.getBuildConfigNames('You have no BuildConfigs available to start a build'), 'Select a BuildConfig to start a build');
         if (buildName) {
-            result = Progress.execFunctionWithProgress('Starting build', () => Build.odo.executeTool(Build.command.startBuild(buildName)))
+            result = Progress.execFunctionWithProgress('Starting build', () => Build.cli.executeTool(Build.command.startBuild(buildName)))
                 .then(() => `Build '${buildName}' successfully started`)
                 .catch((err) => Promise.reject(new VsCommandError(`Failed to start build with error '${err}'`, 'Failed to start build')));
         }
@@ -108,7 +108,7 @@ export class Build {
     static async showLog(context: { impl: any}): Promise<string> {
         const build = await Build.selectBuild(context, 'Select a Build to see the logs');
         if (build) {
-            Build.odo.executeInTerminal(Build.command.showLog(build, '-build'), undefined, `OpenShift: Show '${build}' Build Log`);
+            Build.cli.executeInTerminal(Build.command.showLog(build, '-build'), undefined, `OpenShift: Show '${build}' Build Log`);
         }
         return null;
     }
@@ -125,7 +125,7 @@ export class Build {
             }
         }
         if (resourceId) {
-            Build.odo.executeInTerminal(Build.command.rebuildFrom(resourceId), undefined, `OpenShift: Rebuild '${resourceId}' Build`);
+            Build.cli.executeInTerminal(Build.command.rebuildFrom(resourceId), undefined, `OpenShift: Rebuild '${resourceId}' Build`);
         }
         return null;
     }
@@ -134,7 +134,7 @@ export class Build {
     static async followLog(context: { impl: any}): Promise<string> {
         const build = await Build.selectBuild(context, 'Select a build to follow the logs');
         if (build) {
-            Build.odo.executeInTerminal(Build.command.followLog(build, '-build'), undefined, `OpenShift: Follow '${build}' Build Log`);
+            Build.cli.executeInTerminal(Build.command.followLog(build, '-build'), undefined, `OpenShift: Follow '${build}' Build Log`);
         }
         return null;
     }
@@ -144,7 +144,7 @@ export class Build {
         let result: null | string | Promise<string> | PromiseLike<string> = null;
         const build = await Build.selectBuild(context, 'Select a build to delete');
         if (build) {
-            result = Progress.execFunctionWithProgress('Deleting build', () => Build.odo.executeTool(Build.command.delete(build)))
+            result = Progress.execFunctionWithProgress('Deleting build', () => Build.cli.executeTool(Build.command.delete(build)))
                 .then(() => `Build '${build}' successfully deleted`)
                 .catch((err) => Promise.reject(new VsCommandError(`Failed to delete build with error '${err}'`, 'Failed to delete build')));
         }

src/odo.ts

@@ -14,15 +14,15 @@ import * as fs from 'fs';
 import { pathExistsSync } from 'fs-extra';
 import * as path from 'path';
 import * as tempfile from 'tmp';
-import { ProviderResult, QuickPickItem, Terminal, Uri, WorkspaceFolder, commands, workspace } from 'vscode';
+import { commands, ProviderResult, QuickPickItem, Terminal, Uri, workspace, WorkspaceFolder } from 'vscode';
 import { CommandText } from './base/command';
 import * as cliInstance from './cli';
-import { CliExitData } from './cli';
 import { Command } from './odo/command';
 import { AnalyzeResponse, ComponentType, ComponentTypeAdapter, DevfileComponentType, Registry } from './odo/componentType';
 import { ComponentDescription } from './odo/componentTypeDescription';
 import { Project } from './odo/project';
 import { ToolsConfig } from './tools';
+import { ChildProcessUtil, CliExitData } from './util/childProcessUtil';
 import { KubeConfigUtils } from './util/kubeUtils';
 import { Platform } from './util/platform';
 import { WindowUtil } from './util/windowUtils';
@@ -58,14 +58,14 @@ export interface Odo {
     getProjects(): Promise<Project[]>;
     getCompTypesJson():Promise<DevfileComponentType[]>;
     getComponentTypes(): Promise<ComponentTypeAdapter[]>;
-    execute(command: CommandText, cwd?: string, fail?: boolean, addEnv?: any): Promise<cliInstance.CliExitData>;
+    execute(command: CommandText, cwd?: string, fail?: boolean, addEnv?: any): Promise<CliExitData>;
     executeInTerminal(command: CommandText, cwd?: string, name?: string, addEnv?: any): Promise<void>;
     requireLogin(): Promise<boolean>;
     createProject(name: string): Promise<void>;
     deleteProject(projectName: string): Promise<void>;
     createComponentFromFolder(type: string, registryName: string, name: string, path: Uri, starterName?: string, useExistingDevfile?: boolean, customDevfilePath?: string): Promise<void>;
     createService(formData: any): Promise<void>;
-    loadItems<I>(result: cliInstance.CliExitData, fetch: (data) => I[]): I[];
+    loadItems<I>(result: CliExitData, fetch: (data) => I[]): I[];
     getRegistries(): Promise<Registry[]>;
     addRegistry(name: string, url: string, token: string): Promise<Registry>;
     removeRegistry(name: string): Promise<void>;
@@ -118,7 +118,6 @@ export interface Odo {
 }
 
 export class OdoImpl implements Odo {
-    private static cli: cliInstance.Cli = cliInstance.CliChannel.getInstance();
 
     private static instance: Odo;
 
@@ -130,7 +129,7 @@ export class OdoImpl implements Odo {
     }
 
     async getActiveCluster(): Promise<string> {
-        const result: cliInstance.CliExitData = await this.execute(
+        const result: CliExitData = await this.execute(
             Command.printOdoVersion(), process.cwd(), false
         );
 
@@ -183,15 +182,15 @@ export class OdoImpl implements Odo {
     }
 
     public async getCompTypesJson(): Promise<DevfileComponentType[]> {
-        const result: cliInstance.CliExitData = await this.execute(Command.listCatalogComponentsJson(), undefined, true, this.getKubeconfigEnv());
+        const result: CliExitData = await this.execute(Command.listCatalogComponentsJson(), undefined, true, this.getKubeconfigEnv());
         const componentTypes: DevfileComponentType[] = this.loadJSON(result.stdout);
         return componentTypes;
     }
 
     public async getComponentTypes(): Promise<ComponentType[]> {
         // if kc is produced, KUBECONFIG env var is empty or pointing
 
-        const result: cliInstance.CliExitData = await this.execute(Command.listCatalogComponentsJson(), undefined, true, this.getKubeconfigEnv());
+        const result: CliExitData = await this.execute(Command.listCatalogComponentsJson(), undefined, true, this.getKubeconfigEnv());
         const componentTypes: DevfileComponentType[] = this.loadJSON(result.stdout);
         const devfileItems: ComponentTypeAdapter[] = [];
 
@@ -203,7 +202,7 @@ export class OdoImpl implements Odo {
     public async describeComponent(contextPath: string, experimental = false): Promise<ComponentDescription | undefined> {
         const expEnv = experimental ? {ODO_EXPERIMENTAL_MODE: 'true'} : {};
         try {
-            const describeCmdResult: cliInstance.CliExitData = await this.execute(
+            const describeCmdResult: CliExitData = await this.execute(
                 Command.describeComponentJson(), contextPath, false, expEnv
             );
             return JSON.parse(describeCmdResult.stdout) as ComponentDescription;
@@ -220,13 +219,13 @@ export class OdoImpl implements Odo {
         terminal.show();
     }
 
-    public async execute(command: CommandText, cwd?: string, fail = true, addEnv = {}): Promise<cliInstance.CliExitData> {
+    public async execute(command: CommandText, cwd?: string, fail = true, addEnv = {}): Promise<CliExitData> {
         const env = cliInstance.CliChannel.createTelemetryEnv();
         const commandActual = `${command}`;
         const commandPrivacy = `${command.privacyMode(true)}`;
         const [cmd] = commandActual.split(' ');
         const toolLocation = await ToolsConfig.detect(cmd);
-        const result: cliInstance.CliExitData = await OdoImpl.cli.execute(
+        const result: CliExitData = await ChildProcessUtil.Instance.execute(
             toolLocation ? commandActual.replace(cmd, `"${toolLocation}"`) : commandActual,
             cwd ? {cwd, env: {...env, ...addEnv}} : { env: {...env, ...addEnv} }
         );
@@ -293,7 +292,7 @@ export class OdoImpl implements Odo {
         return parse;
     }
 
-    public loadItems<I>(result: cliInstance.CliExitData, fetch: (data) => I[] = (data): I[] => data.items): I[] {
+    public loadItems<I>(result: CliExitData, fetch: (data) => I[] = (data): I[] => data.items): I[] {
         let data: I[] = [];
         try {
             const items = fetch(JSON.parse(result.stdout));
@@ -372,7 +371,7 @@ export class OdoImpl implements Odo {
 
     public async canCreatePod(): Promise<boolean> {
         try {
-            const result: cliInstance.CliExitData = await this.execute(Command.canCreatePod());
+            const result: CliExitData = await this.execute(Command.canCreatePod());
             if (result.stdout === 'yes') {
                 return true;
             }
@@ -384,7 +383,7 @@ export class OdoImpl implements Odo {
 
     public async isPodmanPresent(): Promise<boolean> {
         try {
-            const result: cliInstance.CliExitData = await this.execute(Command.printOdoVersionJson());
+            const result: CliExitData = await this.execute(Command.printOdoVersionJson());
             if ('podman' in JSON.parse(result.stdout)) {
                 return true;
             }

src/odo3.ts

@@ -5,12 +5,13 @@
 
 import { KubernetesObject } from '@kubernetes/client-node';
 import { CommandText } from './base/command';
-import { CliChannel, CliExitData } from './cli';
+import { CliChannel } from './cli';
 import { Command as CommonCommand, loadItems } from './k8s/common';
 import { Command as DeploymentCommand } from './k8s/deployment';
 import { DeploymentConfig } from './k8s/deploymentConfig';
 import { Command } from './odo/command';
 import { ComponentDescription } from './odo/componentTypeDescription';
+import { CliExitData } from './util/childProcessUtil';
 
 export interface Odo3 {
     getNamespaces(): Promise<KubernetesObject[]>;

src/openshift/cluster.ts

@@ -4,17 +4,18 @@
  *-----------------------------------------------------------------------------------------------*/
 
 import { KubernetesObject } from '@kubernetes/client-node';
-import { ExtensionContext, QuickInputButton, QuickPickItem, QuickPickItemButtonEvent, Terminal, ThemeIcon, Uri, Progress as VProgress, WebviewPanel, commands, env, window, workspace } from 'vscode';
-import { CliChannel, CliExitData } from '../cli';
+import { commands, env, ExtensionContext, Progress as VProgress, QuickInputButton, QuickPickItem, QuickPickItemButtonEvent, Terminal, ThemeIcon, Uri, WebviewPanel, window, workspace } from 'vscode';
+import { CliChannel } from '../cli';
 import { getInstance } from '../odo';
 import { Command } from '../odo/command';
+import { CliExitData } from '../util/childProcessUtil';
 import { TokenStore } from '../util/credentialManager';
 import { Filters } from '../util/filters';
 import { KubeConfigUtils } from '../util/kubeUtils';
 import { Platform } from '../util/platform';
 import { Progress } from '../util/progress';
 import { WindowUtil } from '../util/windowUtils';
-import { VsCommandError, vsCommand } from '../vscommand';
+import { vsCommand, VsCommandError } from '../vscommand';
 import ClusterViewLoader from '../webview/cluster/clusterViewLoader';
 import OpenShiftItem, { clusterRequired } from './openshiftItem';
 import fetch = require('make-fetch-happen');

src/registriesView.ts

@@ -10,7 +10,6 @@ import {
     EventEmitter, TreeDataProvider,
     TreeItem, TreeItemCollapsibleState, TreeView, Uri, window
 } from 'vscode';
-import { CliExitData } from './cli';
 import { getInstance, Odo, OdoImpl } from './odo';
 import { Command } from './odo/command';
 import {
@@ -19,6 +18,7 @@ import {
     Registry
 } from './odo/componentType';
 import { StarterProject } from './odo/componentTypeDescription';
+import { CliExitData } from './util/childProcessUtil';
 import { Progress } from './util/progress';
 import { vsCommand, VsCommandError } from './vscommand';
 import fetch = require('make-fetch-happen');