forked from vscode-kubernetes-tools/vscode-kubernetes-tools
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Support navigation on cluster resources (vscode-kubernetes-tools#342)
- Loading branch information
Showing
5 changed files
with
226 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,166 @@ | ||
| import * as vscode from 'vscode'; | ||
| import * as querystring from 'querystring'; | ||
| import * as _ from 'lodash'; | ||
|
|
||
| import * as kuberesources from './kuberesources'; | ||
| import { kubefsUri } from './kuberesources.virtualfs'; | ||
| import { helmfsUri } from './helm.exec'; | ||
| import * as yl from './yaml-support/yaml-locator'; | ||
|
|
||
| export class KubernetesResourceLinkProvider implements vscode.DocumentLinkProvider { | ||
| provideDocumentLinks(document: vscode.TextDocument, token: vscode.CancellationToken): vscode.ProviderResult<vscode.DocumentLink[]> { | ||
| const sourceKind = k8sKind(document); | ||
| const yaml = yl.yamlLocator.getYamlDocuments(document); | ||
| const leaves: yl.YamlNode[] = getLeafNodes(yaml); | ||
| const links = leaves.map((l) => getLink(document, sourceKind, l)) | ||
| .filter((l) => !!l); | ||
| return links; | ||
| } | ||
| } | ||
|
|
||
| function getLeafNodes(yaml: yl.YamlDocument[]): yl.YamlNode[] { | ||
| const rootNodes = _.flatMap(yaml, (d) => d.nodes); | ||
| const nonRootNodes = _.flatMap(rootNodes, (n) => descendants(n)); | ||
| const allNodes = rootNodes.concat(nonRootNodes); | ||
| const leafNodes = allNodes.filter((n) => isLeaf(n)); | ||
| return leafNodes; | ||
| } | ||
|
|
||
| function getLink(document: vscode.TextDocument, sourceKind: string, node: yl.YamlNode): vscode.DocumentLink | undefined { | ||
| if (yl.isMappingItem(node)) { | ||
| return getLinkFromPair(document, sourceKind, node); | ||
| } | ||
| return undefined; | ||
| } | ||
|
|
||
| function range(document: vscode.TextDocument, node: yl.YamlMappingItem) { | ||
| return new vscode.Range( | ||
| document.positionAt(node.value.startPosition), | ||
| document.positionAt(node.value.endPosition) | ||
| ); | ||
| } | ||
|
|
||
| function descendants(node: yl.YamlNode): yl.YamlNode[] { | ||
| const direct = children(node); | ||
| const indirect = direct.map((n) => descendants(n)); | ||
| const all = direct.concat(...indirect); | ||
| return all; | ||
| } | ||
|
|
||
| function children(node: yl.YamlNode): yl.YamlNode[] { | ||
| if (yl.isMapping(node)) { | ||
| return node.mappings; | ||
| } else if (yl.isSequence(node)) { | ||
| return node.items; | ||
| } else if (yl.isMappingItem(node)) { | ||
| if (yl.isMapping(node.value) || yl.isSequence(node.value)) { | ||
| return [node.value]; | ||
| } | ||
| return []; | ||
| } else { | ||
| return []; | ||
| } | ||
| } | ||
|
|
||
| function isLeaf(node: yl.YamlNode): boolean { | ||
| return yl.isMappingItem(node) && node.value.kind === 'SCALAR'; | ||
| } | ||
|
|
||
| function key(node: yl.YamlNode): string | undefined { | ||
| if (node && yl.isMappingItem(node)) { | ||
| return node.key.raw; | ||
| } | ||
| return undefined; | ||
| } | ||
|
|
||
| function parentKey(node: yl.YamlNode): string | undefined { | ||
| const parent = node.parent; | ||
| if (!parent || !parent.parent || !yl.isMapping(parent.parent)) { | ||
| return undefined; | ||
| } | ||
| const parentPair = parent.parent.mappings.find((mi) => mi.value === parent); | ||
| return key(parentPair); | ||
| } | ||
|
|
||
| function siblings(node: yl.YamlMappingItem): yl.YamlMappingItem[] { | ||
| const parent = node.parent; | ||
| if (parent && yl.isMapping(parent)) { | ||
| return parent.mappings; | ||
| } | ||
| return []; | ||
| } | ||
|
|
||
| function sibling(node: yl.YamlMappingItem, name: string): string | undefined { | ||
| return siblings(node).filter((n) => n.key.raw === name) | ||
| .map((n) => n.value.raw) | ||
| [0]; | ||
| } | ||
|
|
||
| function getLinkFromPair(document: vscode.TextDocument, sourceKind: string, node: yl.YamlMappingItem): vscode.DocumentLink | undefined { | ||
| const uri = getLinkUri(sourceKind, node); | ||
| if (!uri) { | ||
| return undefined; | ||
| } | ||
| return new vscode.DocumentLink(range(document, node), uri); | ||
| } | ||
|
|
||
| function getLinkUri(sourceKind: string, node: yl.YamlMappingItem): vscode.Uri | undefined { | ||
| // Things that apply to all source resource types | ||
| if (key(node) === 'release' && parentKey(node) === 'labels') { | ||
| return helmfsUri(node.value.raw); | ||
| } | ||
| if (key(node) === 'namespace' && parentKey(node) === 'metadata') { | ||
| return kubefsUri(null, `ns/${node.value.raw}`, 'yaml'); | ||
| } | ||
|
|
||
| // Source=type-specific navigation | ||
| switch (sourceKind) { | ||
| case kuberesources.allKinds.deployment.abbreviation: | ||
| return getLinkUriFromDeployment(node); | ||
| case kuberesources.allKinds.persistentVolume.abbreviation: | ||
| return getLinkUriFromPV(node); | ||
| case kuberesources.allKinds.persistentVolumeClaim.abbreviation: | ||
| return getLinkUriFromPVC(node); | ||
| default: | ||
| return undefined; | ||
| } | ||
| } | ||
|
|
||
| function getLinkUriFromDeployment(node: yl.YamlMappingItem): vscode.Uri | undefined { | ||
| if (key(node) === 'claimName' && parentKey(node) === 'persistentVolumeClaim') { | ||
| return kubefsUri(null, `pvc/${node.value.raw}`, 'yaml'); | ||
| } else if (key(node) === 'name' && parentKey(node) === 'configMap') { | ||
| return kubefsUri(null, `cm/${node.value.raw}`, 'yaml'); | ||
| } else if (key(node) === 'name' && parentKey(node) === 'secretKeyRef') { | ||
| return kubefsUri(null, `secrets/${node.value.raw}`, 'yaml'); | ||
| } else { | ||
| return undefined; | ||
| } | ||
| } | ||
|
|
||
| function getLinkUriFromPV(node: yl.YamlMappingItem): vscode.Uri | undefined { | ||
| if (key(node) === 'storageClassName') { | ||
| return kubefsUri(null, `sc/${node.value.raw}`, 'yaml'); | ||
| } else if (key(node) === 'name' && parentKey(node) === 'claimRef') { | ||
| return kubefsUri(sibling(node, 'namespace'), `pvc/${node.value.raw}`, 'yaml'); | ||
| } else { | ||
| return undefined; | ||
| } | ||
| } | ||
|
|
||
| function getLinkUriFromPVC(node: yl.YamlMappingItem): vscode.Uri | undefined { | ||
| if (key(node) === 'storageClassName') { | ||
| return kubefsUri(null, `sc/${node.value.raw}`, 'yaml'); | ||
| } else if (key(node) === 'volumeName') { | ||
| return kubefsUri(null, `pv/${node.value.raw}`, 'yaml'); | ||
| } else { | ||
| return undefined; | ||
| } | ||
| } | ||
|
|
||
| function k8sKind(document: vscode.TextDocument): string { | ||
| const query = querystring.parse(document.uri.query); | ||
| const k8sid: string = query.value; | ||
| const kindSepIndex = k8sid.indexOf('/'); | ||
| return k8sid.substring(0, kindSepIndex); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| import * as vscode from 'vscode'; | ||
|
|
||
| export function findParentYaml(document: vscode.TextDocument, line: number): number { | ||
| const indent = yamlIndentLevel(document.lineAt(line).text); | ||
| while (line >= 0) { | ||
| const txt = document.lineAt(line); | ||
| if (yamlIndentLevel(txt.text) < indent) { | ||
| return line; | ||
| } | ||
| line = line - 1; | ||
| } | ||
| return line; | ||
| } | ||
|
|
||
| function yamlIndentLevel(str: string): number { | ||
| let i = 0; | ||
|
|
||
| while (true) { | ||
| if (str.length <= i || !isYamlIndentChar(str.charAt(i))) { | ||
| return i; | ||
| } | ||
| ++i; | ||
| } | ||
| } | ||
|
|
||
| function isYamlIndentChar(ch: string): boolean { | ||
| return ch === ' ' || ch === '-'; | ||
| } |