Fix uninstalling Helm charts

- Show Helm releases in the project explorer using results from `helm list`
- Add description text for items in the application explorer to helm
  distinguish them
- Refactor Helm commands into their own folder
- Add integration tests for Helm commands

Fixes redhat-developer#3021

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

.vscode/tasks.json

@@ -17,7 +17,7 @@
                 "base": "$tsc-watch",
             },
             "presentation": {
-                "reveal": "silent",
+                "reveal": "never",
             },
         },
         {

package.json

@@ -1477,7 +1477,7 @@
 				},
 				{
 					"command": "openshift.resource.load",
-					"when": "view == openshiftProjectExplorer && viewItem == openshift.k8sObject || viewItem == openshift.k8sObject.helm"
+					"when": "view == openshiftProjectExplorer && viewItem == openshift.k8sObject"
 				},
 				{
 					"command": "openshift.resource.unInstall",

src/explorer.ts

@@ -3,38 +3,33 @@
  *  Licensed under the MIT License. See LICENSE file in the project root for license information.
  *-----------------------------------------------------------------------------------------------*/
 
+import { Context, KubernetesObject } from '@kubernetes/client-node';
+import * as fs from 'fs';
+import * as path from 'path';
 import {
-    Disposable,
+    commands, Disposable,
     Event,
-    EventEmitter,
-    ThemeIcon,
+    EventEmitter, extensions, ThemeIcon,
     TreeDataProvider,
     TreeItem,
     TreeItemCollapsibleState,
     TreeView,
-    Uri,
-    commands,
-    extensions,
-    version,
-    window,
+    Uri, version,
+    window
 } from 'vscode';
-
-import * as fs from 'fs';
-import * as path from 'path';
-import { Platform } from './util/platform';
-
-import { Context, KubernetesObject } from '@kubernetes/client-node';
 import { CliChannel } from './cli';
+import * as Helm from './helm/helm';
 import { Command } from './odo/command';
-import { Odo3, newInstance } from './odo3';
+import { newInstance, Odo3 } from './odo3';
 import { KubeConfigUtils } from './util/kubeUtils';
+import { Platform } from './util/platform';
 import { Progress } from './util/progress';
 import { FileContentChangeNotifier, WatchUtil } from './util/watch';
 import { vsCommand } from './vscommand';
 
 const kubeConfigFolder: string = path.join(Platform.getUserHomePath(), '.kube');
 
-type ExplorerItem = KubernetesObject | Context | TreeItem;
+type ExplorerItem = KubernetesObject | Helm.HelmRelease | Context | TreeItem;
 
 type PackageJSON = {
   version: string;
@@ -142,8 +137,18 @@ export class OpenShiftExplorer implements TreeDataProvider<ExplorerItem>, Dispos
             };
         }
 
-        // otherwise it is a KubernetesObject instance
+        // It's a Helm installation
+        if ('chart' in element) {
+            return {
+                contextValue: 'openshift.k8sObject.helm',
+                label: element.name,
+                collapsibleState: TreeItemCollapsibleState.None,
+                description: 'Helm Release',
+                iconPath: path.resolve(__dirname, '../../images/context/helm.png'),
+            };
+        }
 
+        // otherwise it is a KubernetesObject instance
         if ('kind' in element) {
             if (element.kind === 'project') {
                 return {
@@ -154,8 +159,9 @@ export class OpenShiftExplorer implements TreeDataProvider<ExplorerItem>, Dispos
                 }
             }
             return {
-                contextValue: element.metadata.labels['helm.sh/chart'] ? 'openshift.k8sObject.helm': 'openshift.k8sObject',
+                contextValue: 'openshift.k8sObject',
                 label: element.metadata.name,
+                description: `${element.kind.substring(0, 1).toLocaleUpperCase()}${element.kind.substring(1)}`,
                 collapsibleState: TreeItemCollapsibleState.None,
                 iconPath: path.resolve(__dirname, '../../images/context/component-node.png'),
                 command: {
@@ -229,7 +235,7 @@ export class OpenShiftExplorer implements TreeDataProvider<ExplorerItem>, Dispos
                 }
             }
         } else {
-            result = [...await this.odo3.getDeploymentConfigs(), ...await this.odo3.getDeployments()];
+            result = [...await this.odo3.getDeploymentConfigs(), ...await this.odo3.getDeployments(), ...await Helm.getHelmReleases()];
         }
         // don't show Open In Developer Dashboard if not openshift cluster
         const openshiftResources = await CliChannel.getInstance().executeTool(Command.isOpenshiftCluster());
@@ -260,9 +266,9 @@ export class OpenShiftExplorer implements TreeDataProvider<ExplorerItem>, Dispos
     }
 
     @vsCommand('openshift.resource.unInstall')
-    public static async unInstallHelmChart(component: KubernetesObject) {
-        return Progress.execFunctionWithProgress(`Uninstalling ${component.metadata.name}`, async () => {
-            await CliChannel.getInstance().executeTool(Command.unInstallHelmChart(component.metadata.name));
+    public static async unInstallHelmChart(release: Helm.HelmRelease) {
+        return Progress.execFunctionWithProgress(`Uninstalling ${release.name}`, async () => {
+            await Helm.unInstallHelmChart(release.name);
             OpenShiftExplorer.getInstance().refresh();
         });
     }

src/helm/helm.ts

@@ -0,0 +1,72 @@
+/*-----------------------------------------------------------------------------------------------
+ *  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 * as HelmCommands from './helmCommands';
+
+export type HelmRelease = {
+    name: string;
+    namespace: string;
+    revision: string;
+    updated: string;
+    status: string;
+    chart: string;
+    app_version: string;
+};
+
+/**
+ * Returns a list of all Helm releases in the current namespace on the current cluster.
+ *
+ * @returns a list of all Helm releases in the current namespace on the current cluster
+ */
+export async function getHelmReleases(): Promise<HelmRelease[]> {
+    const res = await CliChannel.getInstance().executeTool(HelmCommands.listHelmReleases());
+    return JSON.parse(res.stdout) as HelmRelease[];
+}
+
+/**
+ * Adds the OpenShift Helm repo to the cluster.
+ *
+ * @returns the CLI output data from running the necessary command
+ */
+export async function addHelmRepo(): Promise<CliExitData> {
+    return await CliChannel.getInstance().executeTool(HelmCommands.addHelmRepo());
+}
+
+/**
+ * Updates the content of all the Helm repos.
+ *
+ * @returns the CLI output data from running the necessary command
+ */
+export async function updateHelmRepo(): Promise<CliExitData> {
+    return await CliChannel.getInstance().executeTool(HelmCommands.updateHelmRepo());
+}
+
+/**
+ * Install a chart from the OpenShift Helm Repo
+ *
+ * @param name the name of the release
+ * @param chartName the name of the chart to install
+ * @param version the version of the chart to use for the release
+ * @returns the CLI output data from running the necessary command
+ */
+export async function installHelmChart(
+    name: string,
+    chartName: string,
+    version: string,
+): Promise<CliExitData> {
+    return await CliChannel.getInstance().executeTool(
+        HelmCommands.installHelmChart(name, chartName, version),
+    );
+}
+
+/**
+ * Uninstalls the given Helm release from the cluster.
+ *
+ * @param name the name of the Helm release to uninstall
+ * @returns the CLI output data from running the necessary command
+ */
+export async function unInstallHelmChart(name: string): Promise<CliExitData> {
+    return await CliChannel.getInstance().executeTool(HelmCommands.unInstallHelmChart(name));
+}

src/helm/helmCommands.ts

@@ -0,0 +1,26 @@
+/*-----------------------------------------------------------------------------------------------
+ *  Copyright (c) Red Hat, Inc. All rights reserved.
+ *  Licensed under the MIT License. See LICENSE file in the project root for license information.
+ *-----------------------------------------------------------------------------------------------*/
+
+import { CommandOption, CommandText } from '../base/command';
+
+export function addHelmRepo(): CommandText {
+    return new CommandText('helm repo add openshift https://charts.openshift.io/');
+}
+
+export function updateHelmRepo(): CommandText {
+    return new CommandText('helm repo update');
+}
+
+export function installHelmChart(name: string, chartName: string, version: string): CommandText {
+    return new CommandText('helm', `install ${name} openshift/${chartName}`, [new CommandOption('--version', version)]);
+}
+
+export function unInstallHelmChart(name: string): CommandText {
+    return new CommandText(`helm uninstall ${name}`);
+}
+
+export function listHelmReleases(): CommandText {
+    return new CommandText('helm', 'list', [new CommandOption('-o', 'json')]);
+}

src/odo/command.ts

@@ -127,22 +127,6 @@ export class Command {
         return new CommandText('oc version');
     }
 
-    static addHelmRepo(): CommandText {
-       return new CommandText('helm repo add openshift https://charts.openshift.io/');
-    }
-
-    static updateHelmRepo(): CommandText {
-        return new CommandText('helm repo update');
-     }
-
-    static installHelmChart(name: string, chartName: string, version: string): CommandText {
-        return new CommandText(`helm install ${name} openshift/${chartName} --version ${version}`);
-    }
-
-    static unInstallHelmChart(name: string): CommandText {
-        return new CommandText(`helm uninstall ${name}`);
-    }
-
     static printOcVersionJson(): CommandText {
         return new CommandText('oc version -ojson');
     }

src/registriesView.ts

@@ -2,32 +2,26 @@
  *  Copyright (c) Red Hat, Inc. All rights reserved.
  *  Licensed under the MIT License. See LICENSE file in the project root for license information.
  *-----------------------------------------------------------------------------------------------*/
+import { Subject } from 'rxjs';
+import validator from 'validator';
 import * as vscode from 'vscode';
 import {
-    TreeDataProvider,
-    TreeItem,
-    Event,
-    EventEmitter,
-    TreeView,
-    window,
-    Uri,
-    TreeItemCollapsibleState,
-    commands,
+    commands, Event,
+    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 {
     ComponentTypeDescription,
     DevfileComponentType,
-    Registry,
+    Registry
 } from './odo/componentType';
 import { StarterProject } from './odo/componentTypeDescription';
+import { Progress } from './util/progress';
 import { vsCommand, VsCommandError } from './vscommand';
-import validator from 'validator';
-import { Command } from './odo/command';
-import { CliExitData } from './cli';
-import { Subject } from 'rxjs';
 import fetch = require('make-fetch-happen');
-import { Progress } from './util/progress';
 
 type ComponentType = Registry;
 
@@ -116,26 +110,6 @@ export class ComponentTypesView implements TreeDataProvider<ComponentType> {
         return this.registries;
     }
 
-    public async addHelmRepo(): Promise<CliExitData> {
-        const response = await getInstance().execute(Command.addHelmRepo());
-        return response;
-    }
-
-    public async updateHelmRepo(): Promise<CliExitData> {
-        const response = await getInstance().execute(Command.updateHelmRepo());
-        return response;
-    }
-
-    public async installHelmChart(name: string, chartName: string, version: string): Promise<CliExitData> {
-        const data = await getInstance().execute(Command.installHelmChart(name, chartName, version));
-        return data;
-    }
-
-    public async unInstallHelmChart(name: string): Promise<CliExitData> {
-        const data = await getInstance().execute(Command.unInstallHelmChart(name));
-        return data;
-    }
-
     public async getAllComponents(): Promise<void> {
         return new Promise<void>((resolve) => {
             let isError = false;

src/webview/helm-chart/helmChartLoader.ts

@@ -6,7 +6,7 @@ import * as path from 'path';
 import * as vscode from 'vscode';
 import * as YAML from 'yaml';
 import { OpenShiftExplorer } from '../../explorer';
-import { ComponentTypesView } from '../../registriesView';
+import * as Helm from '../../helm/helm';
 import { ExtCommandTelemetryEvent } from '../../telemetry';
 import { ExtensionID } from '../../util/constants';
 import { vsCommand } from '../../vscommand';
@@ -36,7 +36,7 @@ export class HelmCommand {
                 chartName: event.chartName,
                 show: true
             });
-            await ComponentTypesView.instance.installHelmChart(event.name, event.chartName, event.version);
+            await Helm.installHelmChart(event.name, event.chartName, event.version);
             vscode.window.showInformationMessage(`Helm Chart: ${event.name} is successfully installed and will be reflected in the tree view.`);
             OpenShiftExplorer.getInstance().refresh();
             panel.webview.postMessage({
@@ -120,8 +120,8 @@ export default class HelmChartLoader {
 
 async function getHelmCharts(eventName: string): Promise<void> {
     if (helmRes.length === 0) {
-        await ComponentTypesView.instance.addHelmRepo();
-        await ComponentTypesView.instance.updateHelmRepo();
+        await Helm.addHelmRepo();
+        await Helm.updateHelmRepo();
         const signupResponse = await fetch('https://charts.openshift.io/index.yaml', {
             method: 'GET'
         });