-
Notifications
You must be signed in to change notification settings - Fork 246
/
helm.repoExplorer.ts
273 lines (228 loc) · 8.9 KB
/
helm.repoExplorer.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
import * as vscode from 'vscode';
import * as _ from 'lodash';
import { Host } from './host';
import * as helm from './helm.exec';
import { HELM_OUTPUT_COLUMN_SEPARATOR } from './helm';
import { Errorable, failed } from './errorable';
import { parseLineOutput } from './outputUtils';
import { affectsUs } from './components/config/config';
import { Dictionary } from './utils/dictionary';
import { assetUri } from './assets';
export const HELM_EXPLORER_NODE_CATEGORY = 'helm-explorer-node';
export function create(host: Host): HelmRepoExplorer {
return new HelmRepoExplorer(host);
}
export enum RepoExplorerObjectKind {
Repo,
Chart,
ChartVersion,
Error,
}
export interface HelmObject {
readonly nodeCategory: 'helm-explorer-node';
readonly kind: RepoExplorerObjectKind;
getChildren(): Promise<HelmObject[]>;
getTreeItem(): vscode.TreeItem;
}
export interface HelmRepo extends HelmObject {
readonly name: string;
}
export interface HelmRepoChart extends HelmObject {
readonly id: string;
}
export interface HelmRepoChartVersion extends HelmObject {
readonly id: string;
readonly version: string;
}
export function isHelmRepo(o: HelmObject | null | undefined): o is HelmRepo {
return !!o && o.kind === RepoExplorerObjectKind.Repo;
}
export function isHelmRepoChart(o: HelmObject | null | undefined): o is HelmRepoChart {
return !!o && o.kind === RepoExplorerObjectKind.Chart;
}
export function isHelmRepoChartVersion(o: HelmObject | null | undefined): o is HelmRepoChartVersion {
return !!o && o.kind === RepoExplorerObjectKind.ChartVersion;
}
export class HelmRepoExplorer implements vscode.TreeDataProvider<HelmObject> {
private onDidChangeTreeDataEmitter: vscode.EventEmitter<HelmObject | undefined> = new vscode.EventEmitter<HelmObject | undefined>();
readonly onDidChangeTreeData: vscode.Event<HelmObject | undefined> = this.onDidChangeTreeDataEmitter.event;
constructor(host: Host) {
host.onDidChangeConfiguration((change) => {
if (affectsUs(change)) {
this.refresh();
}
});
}
getTreeItem(element: HelmObject): vscode.TreeItem | Thenable<vscode.TreeItem> {
return element.getTreeItem();
}
getChildren(parent?: HelmObject): vscode.ProviderResult<HelmObject[]> {
if (parent) {
return parent.getChildren();
}
return this.getHelmRepos();
}
private async getHelmRepos(): Promise<HelmObject[]> {
const repos = await listHelmRepos();
if (failed(repos)) {
return [ new HelmError('Unable to list Helm repos', repos.error[0]) ];
}
return repos.result;
}
async refresh(): Promise<void> {
await helm.helmExecAsync('repo update');
this.onDidChangeTreeDataEmitter.fire(undefined);
}
}
class HelmExplorerNodeImpl {
readonly nodeCategory = HELM_EXPLORER_NODE_CATEGORY;
}
class HelmError extends HelmExplorerNodeImpl implements HelmObject {
constructor(private readonly text: string, private readonly detail: string) {
super();
}
get kind() { return RepoExplorerObjectKind.Error; }
getTreeItem(): vscode.TreeItem {
const treeItem = new vscode.TreeItem(this.text);
treeItem.tooltip = 'Click for details';
treeItem.command = {
title: 'Show details',
command: 'extension.showInfoMessage',
arguments: [this.detail]
};
return treeItem;
}
async getChildren(): Promise<HelmObject[]> {
return [];
}
}
class HelmRepoImpl extends HelmExplorerNodeImpl implements HelmRepo {
constructor(readonly name: string) {
super();
}
get kind() { return RepoExplorerObjectKind.Repo; }
getTreeItem(): vscode.TreeItem {
const treeItem = new vscode.TreeItem(this.name, vscode.TreeItemCollapsibleState.Collapsed);
treeItem.iconPath = {
light: assetUri("images/light/helm-blue-vector.svg"),
dark: assetUri("images/dark/helm-white-vector.svg"),
};
treeItem.contextValue = 'vsKubernetes.repo';
return treeItem;
}
async getChildren(): Promise<HelmObject[]> {
const charts = await listHelmRepoCharts(this.name);
if (failed(charts)) {
return [ new HelmError('Error fetching charts', charts.error[0]) ];
}
return charts.result;
}
}
class HelmRepoChartImpl extends HelmExplorerNodeImpl implements HelmRepoChart {
private readonly versions: HelmRepoChartVersionImpl[];
private readonly name: string;
constructor(repoName: string, readonly id: string, content: { [key: string]: string }[]) {
super();
this.versions = content.map((e) => new HelmRepoChartVersionImpl(
id,
e['chart version'],
e['app version'],
e.description
));
this.name = id.substring(repoName.length + 1);
}
get kind() { return RepoExplorerObjectKind.Chart; }
getTreeItem(): vscode.TreeItem {
const treeItem = new vscode.TreeItem(this.name, vscode.TreeItemCollapsibleState.Collapsed);
treeItem.contextValue = 'vsKubernetes.chart';
return treeItem;
}
async getChildren(): Promise<HelmObject[]> {
return this.versions;
}
}
class HelmRepoChartVersionImpl extends HelmExplorerNodeImpl implements HelmRepoChartVersion {
constructor(
readonly id: string,
readonly version: string,
private readonly appVersion: string | undefined,
private readonly description: string | undefined
) {
super();
}
get kind() { return RepoExplorerObjectKind.ChartVersion; }
getTreeItem(): vscode.TreeItem {
const treeItem = new vscode.TreeItem(this.version);
treeItem.tooltip = this.tooltip();
treeItem.command = {
command: "extension.helmInspectChart",
title: "Inspect",
arguments: [this]
};
treeItem.contextValue = 'vsKubernetes.chartversion';
return treeItem;
}
async getChildren(): Promise<HelmObject[]> {
return [];
}
private tooltip(): string {
const tooltipLines: string[] = [ this.description ? this.description : 'No description available'];
if (this.appVersion) {
tooltipLines.push(`App version: ${this.appVersion}`);
}
return tooltipLines.join('\n');
}
}
async function listHelmRepos(): Promise<Errorable<HelmRepoImpl[]>> {
const sr = await helm.helmExecAsync("repo list");
// TODO: prompt to run 'helm init' here if needed...
if (!sr || sr.code !== 0) {
return { succeeded: false, error: [sr ? sr.stderr : "Unable to run Helm"] };
}
const repos = sr.stdout.split('\n')
.slice(1)
.map((l) => l.trim())
.filter((l) => l.length > 0)
.map((l) => l.split('\t').map((bit) => bit.trim()))
.map((bits) => new HelmRepoImpl(bits[0]));
return { succeeded: true, result: repos };
}
async function listHelmRepoCharts(repoName: string): Promise<Errorable<HelmRepoChartImpl[]>> {
const syntaxVersion = await helm.helmSyntaxVersion();
const searchCmd = (syntaxVersion === helm.HelmSyntaxVersion.V3) ? 'search repo' : 'search';
const sr = await helm.helmExecAsync(`${searchCmd} ${repoName}/ -l`);
if (!sr || sr.code !== 0) {
return { succeeded: false, error: [ sr ? sr.stderr : "Unable to run Helm" ]};
}
const lines = sr.stdout.split('\n')
.map((l) => l.trim())
.filter((l) => l.length > 0);
const rawEntries = parseLineOutput(lines, HELM_OUTPUT_COLUMN_SEPARATOR);
// Charts can embed newlines in their descriptions. We need to merge
// 'entries' that are actually continuations with their 'parents.'
const entries = mergeContinuationEntries(rawEntries);
const charts = _.chain(entries)
.groupBy((e) => e.name)
.toPairs()
.map((p) => new HelmRepoChartImpl(repoName, p[0], p[1]))
.value();
return { succeeded: true, result: charts };
}
function mergeContinuationEntries(entries: Dictionary<string>[]): Dictionary<string>[] {
const result = Array.of<Dictionary<string>>();
for (const entry of entries) {
if (Object.keys(entry).length === 1) {
// It's a continuation - merge it with the last entry that wasn't a continuation
mergeEntry(result[result.length - 1], entry);
} else {
// It's a new entry - push it
result.push(entry);
}
}
return result;
}
function mergeEntry(mergeInto: Dictionary<string>, mergeFrom: Dictionary<string>): void {
// Because we trim the output lines, continuation descriptions land in
// the 'name' field
mergeInto['description'] = `${mergeInto['description'].trim()} ${mergeFrom['name']}`;
}