Adding status icons for Helm release status (vscode-kubernetes-tools#318

)

src/explorer.ts

@@ -23,6 +23,14 @@ export function createKubernetesResource(kind: kuberesources.ResourceKind, id: s
     return new KubernetesResource(kind, id, metadata);
 }
 
+function getIconForHelmRelease(status: string): vscode.Uri {
+    if (status === "deployed") {
+        return vscode.Uri.file(path.join(__dirname, "../../images/helmDeployed.svg"));
+    } else {
+        return vscode.Uri.file(path.join(__dirname, "../../images/helmFailed.svg"));
+    }
+}
+
 function getIconForPodStatus(status: string): vscode.Uri {
     if (status === "running" || status === "completed") {
         return vscode.Uri.file(path.join(__dirname, "../../images/runningPod.svg"));
@@ -417,7 +425,7 @@ export class KubernetesFileObject implements KubernetesObject {
 class HelmReleaseResource implements KubernetesObject {
     readonly id: string;
 
-    constructor(readonly name: string) {
+    constructor(readonly name: string, readonly status: string) {
         this.id = "helmrelease:" + name;
     }
 
@@ -433,6 +441,7 @@ class HelmReleaseResource implements KubernetesObject {
             arguments: [this]
         };
         treeItem.contextValue = "vsKubernetes.helmRelease";
+        treeItem.iconPath = getIconForHelmRelease(this.status.toLowerCase());
         return treeItem;
     }
 }
@@ -455,6 +464,6 @@ class HelmReleasesFolder extends KubernetesFolder {
             return [new DummyObject("Helm list error", releases.error[0])];
         }
 
-        return releases.result.map((r) => new HelmReleaseResource(r));
+        return releases.result.map((r) => new HelmReleaseResource(r.name, r.status));
     }
 }

src/helm.exec.ts

@@ -12,6 +12,7 @@ import { showWorkspaceFolderPick } from './hostutils';
 import { shell as sh, ShellResult } from './shell';
 import { K8S_RESOURCE_SCHEME, HELM_RESOURCE_AUTHORITY } from './kuberesources.virtualfs';
 import { Errorable } from './errorable';
+import { parseLineOutput } from './outputUtils';
 
 export interface PickChartUIOptions {
     readonly warnIfNoCharts: boolean;
@@ -292,12 +293,12 @@ export async function helmExecAsync(args: string): Promise<ShellResult> {
 
 const HELM_PAGING_PREFIX = "next:";
 
-export async function helmListAll(namespace?: string): Promise<Errorable<string[]>> {
+export async function helmListAll(namespace?: string): Promise<Errorable<{ [key: string]: string }[]>> {
     if (!ensureHelm(EnsureMode.Alert)) {
         return { succeeded: false, error: [ "Helm client is not installed" ] };
     }
 
-    const releases: string[] = [];
+    const releases: {[key: string]: string}[] = [];
     let offset: string | null = null;
 
     do {
@@ -321,9 +322,8 @@ export async function helmListAll(namespace?: string): Promise<Errorable<string[
             }
         }
         if (lines.length > 0) {
-            lines.shift();  // remove the header line
-            const names = lines.map((l) => l.split('\t')[0].trim());
-            releases.push(...names);
+            const helmReleases = parseLineOutput(lines, helm.HELM_OUTPUT_COLUMN_SEPARATOR);
+            releases.push(...helmReleases);
         }
     } while (offset !== null);
 
@@ -427,4 +427,4 @@ export function searchForChart(name: string, version?: string): Requirement {
 export function helmHome(): string {
     const h = process.env.HOME;
     return process.env["HELM_HOME"] || filepath.join(h, '.helm');
-}
+}

src/helm.ts

@@ -1,6 +1,7 @@
 export const PREVIEW_SCHEME = 'helm-template-preview';
 export const PREVIEW_URI = PREVIEW_SCHEME + '://preview';
 export const INSPECT_SCHEME = 'helm-inspect-values';
+export const HELM_OUTPUT_COLUMN_SEPARATOR = /\t+/g;
 
 let previewShown = false;
 
@@ -10,4 +11,4 @@ export function hasPreviewBeenShown(): boolean {
 
 export function recordPreviewHasBeenShown(): void {
     previewShown = true;
-}
+}

src/kubectl.ts

@@ -5,7 +5,9 @@ import { FS } from './fs';
 import { Shell, ShellHandler, ShellResult } from './shell';
 import * as binutil from './binutil';
 import { Errorable } from './errorable';
-import { parseLineOutput } from './kubectlUtils';
+import { parseLineOutput } from './outputUtils';
+
+const KUBECTL_OUTPUT_COLUMN_SEPARATOR = /\s+/g;
 
 export interface Kubectl {
     checkPresent(errorMessageMode: CheckPresentMessageMode): Promise<boolean>;
@@ -237,7 +239,7 @@ async function fromLines(context: Context, command: string): Promise<Errorable<{
     if (shellResult.code === 0) {
         let lines = shellResult.stdout.split('\n');
         lines = lines.filter((l) => l.length > 0);
-        const parsedOutput = parseLineOutput(lines);
+        const parsedOutput = parseLineOutput(lines, KUBECTL_OUTPUT_COLUMN_SEPARATOR);
         return { succeeded: true, result: parsedOutput };
     }
     return { succeeded: false, error: [ shellResult.stderr ] };

src/kubectlUtils.ts

@@ -334,25 +334,3 @@ export async function getResourceAsJson<T extends KubernetesResource | Kubernete
     }
     return shellResult.result;
 }
-
-/**
- * Parse column based output which is seperated by whitespace(s) from kubectl or similar sources
- * for example, kubectl get po
- * @param lineOutput raw output with headers from kubectl or similar sources
- * @return array of objects with key as column header and value
- */
-export function parseLineOutput(lineOutput: string[]): { [key: string]: string }[] {
-    const headers = lineOutput.shift();
-    if (!headers) {
-        return [];
-    }
-    const parsedHeaders = headers.toLowerCase().replace(/\s+/g, '|').split('|');
-    return lineOutput.map((line) => {
-        const lineInfoObject = {};
-        const bits = line.replace(/\s+/g, '|').split('|');
-        bits.forEach((columnValue, index) => {
-            lineInfoObject[parsedHeaders[index]] = columnValue;
-        });
-        return lineInfoObject;
-    });
-}

src/outputUtils.ts

@@ -0,0 +1,22 @@
+/**
+ * Parse column based output which is seperated by whitespace(s) from kubectl or similar sources
+ * for example, kubectl get po
+ * @param lineOutput raw output with headers from kubectl or similar sources
+ * @param columnSeparator a regex for the column separators
+ * @return array of objects with key as column header and value
+ */
+export function parseLineOutput(lineOutput: string[], columnSeparator: RegExp): { [key: string]: string }[] {
+    const headers = lineOutput.shift();
+    if (!headers) {
+        return [];
+    }
+    const parsedHeaders = headers.toLowerCase().replace(columnSeparator, '|').split('|');
+    return lineOutput.map((line) => {
+        const lineInfoObject = {};
+        const bits = line.replace(columnSeparator, '|').split('|');
+        bits.forEach((columnValue, index) => {
+            lineInfoObject[parsedHeaders[index].trim()] = columnValue.trim();
+        });
+        return lineInfoObject;
+    });
+}