Updating deployment.yaml doesn't reflect into openshift #4472

Fixes: #4472

Signed-off-by: Victor Rubezhny <vrubezhny@redhat.com>

Author: vrubezhny

package-lock.json

@@ -77,6 +77,7 @@
 		"shelljs": "^0.10.0"
 	},
 	"devDependencies": {
+		"@apidevtools/json-schema-ref-parser": "^12.0.2",
 		"@codemirror/lang-yaml": "^6.1.2",
 		"@devfile/api": "^2.2.2-1716821574",
 		"@kubernetes/client-node": "^0.22.3",
@@ -190,7 +191,8 @@
 		"xterm-addon-serialize": "^0.11.0",
 		"xterm-addon-web-links": "^0.9.0",
 		"xterm-addon-webgl": "^0.16.0",
-		"xterm-headless": "^5.3.0"
+		"xterm-headless": "^5.3.0",
+		"yaml": "^2.8.0"
 	},
 	"overrides": {
 		"cookie": "^1.0.2",

package.json

@@ -90,6 +90,30 @@ export class CliChannel {
         return result;
     }
 
+    async executeToolWithText(command: CommandText, opts?: cp.ExecOptions, fail = true, stdout?: string): Promise<CliExitData> {
+        const commandActual = command.toString();
+        const commandPrivacy = command.privacyMode(true).toString();
+        const [cmd] = commandActual.split(' ');
+        const toolLocation = await ToolsConfig.detect(cmd);
+        const optsCopy = CliChannel.applyEnv(opts, CliChannel.createTelemetryEnv())
+
+        const result: CliExitData = await ChildProcessUtil.Instance.execute(
+            toolLocation ? commandActual.replace(cmd, `"${toolLocation}"`) : commandActual, optsCopy, stdout);
+
+        if (result.error && fail) {
+            if (result.error.code && result.error.code.toString() === 'ERR_CHILD_PROCESS_STDIO_MAXBUFFER') {
+                void vscode.window.showErrorMessage('Do you want to change the maximum \'stdout\' buffer size by modifying the \'openshiftToolkit.execMaxBufferLength\' preference value?', 'Yes', 'Cancel')
+                    .then((answer)=> {
+                        if (answer === 'Yes') {
+                            void vscode.commands.executeCommand('workbench.action.openSettings', 'openshiftToolkit.execMaxBufferLength');
+                        }
+                    });
+            }
+            throw new VsCommandError(`${result.error.message}`, `Error when running command: ${commandPrivacy}`, result.error);
+        };
+        return result;
+    }
+
     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/cli.ts

@@ -28,7 +28,7 @@ import { CommandOption, CommandText } from './base/command';
 import { ExecutionContext } from './cli';
 import * as Helm from './helm/helm';
 import { HelmRepo } from './helm/helmChartType';
-import { getOutputFormat, helmfsUri, kubefsUri } from './k8s/vfs/kuberesources.virtualfs';
+import { getOutputFormat, helmfsUri, kubefsUri } from './k8s/vfs/kuberesources.utils';
 import { Oc } from './oc/ocWrapper';
 import { Component } from './openshift/component';
 import { getServiceKindStubs, getServices } from './openshift/serviceHelpers';

src/explorer.ts

@@ -6,9 +6,9 @@
 import { Context as KcuContext } from '@kubernetes/client-node/dist/config_types';
 import {
     authentication,
-    commands, env, ExtensionContext, languages, QuickPickItemKind,
+    commands, Diagnostic, env, ExtensionContext, languages, QuickPickItemKind,
     StatusBarAlignment,
-    StatusBarItem, window,
+    StatusBarItem, TextDocument, window,
     workspace
 } from 'vscode';
 import { extension as k8sExtension } from 'vscode-kubernetes-tools-api';
@@ -26,7 +26,8 @@ import { Console as K8sConsole } from './k8s/console';
 import { DeploymentConfig as K8sDeploymentConfig } from './k8s/deploymentConfig';
 import { Route as K8sRoute } from './k8s/route';
 import { KubernetesResourceLinkProvider } from './k8s/vfs/kuberesources.linkprovider';
-import { K8S_RESOURCE_SCHEME, K8S_RESOURCE_SCHEME_READONLY, KubernetesResourceVirtualFileSystemProvider } from './k8s/vfs/kuberesources.virtualfs';
+import { K8S_RESOURCE_SCHEME, K8S_RESOURCE_SCHEME_READONLY, K8sResourceCache } from './k8s/vfs/kuberesources.utils';
+import { KubernetesResourceVirtualFileSystemProvider } from './k8s/vfs/kuberesources.virtualfs';
 import { Oc } from './oc/ocWrapper';
 import { OdoPreference } from './odo/odoPreference';
 import { Cluster } from './openshift/cluster';
@@ -53,7 +54,6 @@ import { WelcomePage } from './welcomePage';
 import { registerYamlHandlers } from './yaml/yamlDocumentFeatures';
 import { YamlFileCommands } from './yamlFileCommands';
 
-// eslint-disable-next-line @typescript-eslint/no-empty-function
 // this method is called when your extension is deactivated
 export function deactivate(): void {
     // intentionally left blank
@@ -87,6 +87,30 @@ export async function activate(extensionContext: ExtensionContext): Promise<unkn
     // Link from resources to referenced resources
     const resourceLinkProvider = new KubernetesResourceLinkProvider();
 
+    // Diagnostics for K8s resources
+    async function updateDiagnostics(document: TextDocument): Promise<void> {
+        if ( document.languageId !== 'yaml' && document.languageId !== 'json') return;
+
+        const diagnostics: Diagnostic[] = await K8sResourceCache.Instance.validateResourceDocument(document.uri, document.getText());;
+
+        diagnosticCollection.set(document.uri, diagnostics);
+    }
+
+    const diagnosticCollection = languages.createDiagnosticCollection(extensionContext.extension.id);
+    window.onDidChangeActiveTextEditor(editor => {
+        if (editor) {
+            void updateDiagnostics(editor.document);
+        }
+    });
+
+    workspace.onDidChangeTextDocument(event => {
+        void updateDiagnostics(event.document);
+    });
+
+    if (window.activeTextEditor) {
+        void updateDiagnostics(window.activeTextEditor.document);
+    }
+
     const crcStatusItem = window.createStatusBarItem(StatusBarAlignment.Left);
     crcStatusItem.command = 'openshift.explorer.stopCluster';
 
@@ -138,6 +162,9 @@ export async function activate(extensionContext: ExtensionContext): Promise<unkn
 
         // Link from resources to referenced resources
         languages.registerDocumentLinkProvider({ scheme: K8S_RESOURCE_SCHEME }, resourceLinkProvider),
+
+        // Diagnostic collection for K8s Resources
+        diagnosticCollection
     ];
 
     disposable.push(...registerCommands());

src/extension.ts

@@ -3,16 +3,15 @@
  *  Licensed under the MIT License. See LICENSE file in the project root for license information.
  *-----------------------------------------------------------------------------------------------*/
 
+import * as _ from 'lodash';
+import * as querystring from 'querystring';
 import * as vscode from 'vscode';
 import { DocumentLinkProvider, Uri } from 'vscode';
-
-import * as querystring from 'querystring';
-import * as _ from 'lodash';
-import { MappingItem, Node, NodeProvider } from './locator-util';
+import * as jl from './json-locator';
 import * as kuberesources from './kuberesources';
+import { K8S_RESOURCE_SCHEME, K8S_RESOURCE_SCHEME_READONLY, getOutputFormat, helmfsUri, kubefsUri } from './kuberesources.utils';
+import { MappingItem, Node, NodeProvider } from './locator-util';
 import * as yl from './yaml-locator';
-import * as jl from './json-locator';
-import { K8S_RESOURCE_SCHEME, K8S_RESOURCE_SCHEME_READONLY, getOutputFormat, helmfsUri, kubefsUri } from './kuberesources.virtualfs';
 
 // >>> URI Cache >>>
 
@@ -38,10 +37,7 @@ function cacheEditingUris() {
 export class KubernetesResourceLinkProvider implements DocumentLinkProvider {
     provideDocumentLinks(document: vscode.TextDocument, _token: vscode.CancellationToken): vscode.ProviderResult<vscode.DocumentLink[]> {
         const sourceKind = k8sKind(document);
-        const df = getDocumentFormat(document);
-        const docs = (df === 'yaml' || df === 'yml') ?
-                yl.yamlLocator.getYamlDocuments(document)
-                    : df === 'json' ? jl.jsonLocator.getJsonDocuments(document) : [];
+        const docs = getParsedDocuments(document);
         const leaves = getLeafNodes(docs);
 
         try {
@@ -54,13 +50,21 @@ export class KubernetesResourceLinkProvider implements DocumentLinkProvider {
     }
 }
 
+export function getParsedDocuments(document: vscode.TextDocument): NodeProvider[] {
+    const df = getDocumentFormat(document);
+    const docs = (df === 'yaml' || df === 'yml') ?
+            yl.yamlLocator.getYamlDocuments(document)
+                : df === 'json' ? jl.jsonLocator.getJsonDocuments(document) : [];
+    return docs;
+}
+
 function getDocumentFormat(document: vscode.TextDocument): string | undefined {
     const path = document.uri.path;
     const sepIndex = path.indexOf('.');
     return sepIndex >= 0 ? path.substring(sepIndex + 1).toLocaleLowerCase() : undefined;
 }
 
-function getLeafNodes(docs: NodeProvider[]): Node[] {
+export function getLeafNodes(docs: NodeProvider[]): Node[] {
     const rootNodes = _.flatMap(docs, (d) => d.nodes);
     const nonRootNodes = _.flatMap(rootNodes, (n) => descendants(n));
     const allNodes = rootNodes.concat(nonRootNodes);
@@ -80,13 +84,20 @@ function getLink(document: vscode.TextDocument, sourceKind: string, node: Node):
     return undefined;
 }
 
-function range(document: vscode.TextDocument, node: MappingItem) {
+export function range(document: vscode.TextDocument, node: MappingItem): vscode.Range {
     return new vscode.Range(
         document.positionAt(node.value.startPosition),
         document.positionAt(node.value.endPosition)
     );
 }
 
+export function keyRange(document: vscode.TextDocument, node: MappingItem): vscode.Range {
+    return new vscode.Range(
+        document.positionAt(node.key.startPosition),
+        document.positionAt(node.key.endPosition)
+    );
+}
+
 function descendants(node: Node): Node[] {
     const direct = children(node);
     const indirect = direct.map((n) => descendants(n));