feat: show decoded value for base64 values in Secrets, ConfigMaps (redhat-developer#663)

Signed-off-by: Andre Dietisheim <[email protected]>

Author: adietish

src/main/kotlin/com/redhat/devtools/intellij/kubernetes/editor/inlay/Base64InlayHintsProvider.kt

@@ -0,0 +1,94 @@
+@file:Suppress("UnstableApiUsage")
+
+package com.redhat.devtools.intellij.kubernetes.editor.inlay
+
+import com.intellij.codeInsight.hints.ChangeListener
+import com.intellij.codeInsight.hints.FactoryInlayHintsCollector
+import com.intellij.codeInsight.hints.ImmediateConfigurable
+import com.intellij.codeInsight.hints.InlayHintsCollector
+import com.intellij.codeInsight.hints.InlayHintsProvider
+import com.intellij.codeInsight.hints.InlayHintsSink
+import com.intellij.codeInsight.hints.NoSettings
+import com.intellij.codeInsight.hints.SettingsKey
+import com.intellij.codeInsight.hints.presentation.PresentationFactory
+import com.intellij.json.psi.JsonProperty
+import com.intellij.openapi.editor.Editor
+import com.intellij.openapi.editor.impl.EditorImpl
+import com.intellij.psi.PsiElement
+import com.intellij.psi.PsiFile
+import com.intellij.refactoring.suggested.endOffset
+import com.intellij.refactoring.suggested.startOffset
+import com.intellij.ui.dsl.builder.panel
+import com.redhat.devtools.intellij.kubernetes.editor.util.decodeBase64
+import com.redhat.devtools.intellij.kubernetes.editor.util.getContent
+import com.redhat.devtools.intellij.kubernetes.editor.util.getData
+import com.redhat.devtools.intellij.kubernetes.editor.util.getKubernetesResourceInfo
+import com.redhat.devtools.intellij.kubernetes.editor.util.isKubernetesResource
+import org.jetbrains.yaml.psi.YAMLKeyValue
+import javax.swing.JComponent
+
+internal class Base64InlayHintsProvider: InlayHintsProvider<NoSettings> {
+
+	override val key: SettingsKey<NoSettings> = SettingsKey("LSP.hints")
+	override val name: String = "Kubernetes"
+	override val previewText: String = "Preview"
+
+	override fun createSettings(): NoSettings {
+		return NoSettings()
+	}
+
+	override fun createConfigurable(settings: NoSettings): ImmediateConfigurable {
+		return object : ImmediateConfigurable {
+			override fun createComponent(listener: ChangeListener): JComponent = panel {}
+
+			override val mainCheckboxText: String = "Show hints for:"
+
+			override val cases: List<ImmediateConfigurable.Case> = emptyList()
+		}
+	}
+
+	override fun getCollectorFor(
+		file: PsiFile,
+		editor: Editor,
+		settings: NoSettings,
+		sink: InlayHintsSink
+	): InlayHintsCollector? {
+		val project = editor.project ?: return null
+		val virtualFile = file.virtualFile ?: return null
+		val info = getKubernetesResourceInfo(virtualFile, project)
+		if (!isKubernetesResource("Secret", info)
+			&& !isKubernetesResource("ConfigMap", info)
+		) {
+			return null
+		}
+		return Collector(editor)
+	}
+
+	private class Collector(editor: Editor): FactoryInlayHintsCollector(editor) {
+		override fun collect(element: PsiElement, editor: Editor, sink: InlayHintsSink): Boolean {
+			if (!element.isValid) {
+				return true
+			}
+			val content = getContent(element) ?: return true
+			val data = getData(content) ?: return true
+			data.children.toList()
+				.forEach { child ->
+					val value = when (child) {
+						is YAMLKeyValue ->
+							child.value?.text
+						is JsonProperty ->
+							child.value?.text
+						else -> null
+					}
+					val decoded = decodeBase64(value)
+					if (decoded != null) {
+						val presentation = PresentationFactory(editor as EditorImpl).smallText(decoded)
+						sink.addInlineElement(child.endOffset, true, presentation, false)
+					}
+				}
+
+			return true
+		}
+
+	}
+}

src/main/kotlin/com/redhat/devtools/intellij/kubernetes/editor/util/ResourceEditorUtils.kt

@@ -10,13 +10,15 @@
  ******************************************************************************/
 package com.redhat.devtools.intellij.kubernetes.editor.util
 
+import com.intellij.json.psi.JsonElement
 import com.intellij.json.psi.JsonElementGenerator
 import com.intellij.json.psi.JsonFile
 import com.intellij.json.psi.JsonProperty
 import com.intellij.json.psi.JsonValue
 import com.intellij.openapi.application.ReadAction
 import com.intellij.openapi.editor.Document
 import com.intellij.openapi.project.Project
+import com.intellij.openapi.util.text.Strings
 import com.intellij.openapi.vfs.VirtualFile
 import com.intellij.psi.PsiDocumentManager
 import com.intellij.psi.PsiElement
@@ -27,9 +29,12 @@ import org.jetbrains.yaml.YAMLElementGenerator
 import org.jetbrains.yaml.YAMLUtil
 import org.jetbrains.yaml.psi.YAMLFile
 import org.jetbrains.yaml.psi.YAMLKeyValue
+import org.jetbrains.yaml.psi.YAMLPsiElement
 import org.jetbrains.yaml.psi.YAMLValue
+import java.util.Base64
 
 private const val KEY_METADATA = "metadata"
+private const val KEY_DATA = "data"
 private const val KEY_RESOURCE_VERSION = "resourceVersion"
 
 /**
@@ -59,6 +64,11 @@ fun isKubernetesResource(resourceInfo: KubernetesResourceInfo?): Boolean {
             && resourceInfo?.typeInfo?.kind?.isNotBlank() ?: false
 }
 
+fun isKubernetesResource(kind: String, resourceInfo: KubernetesResourceInfo?): Boolean {
+    return resourceInfo?.typeInfo?.apiGroup?.isNotBlank() ?: false
+            && kind == resourceInfo?.typeInfo?.kind
+}
+
 /**
  * Returns [KubernetesResourceInfo] for the given file and project. Returns `null` if it could not be retrieved.
  *
@@ -134,6 +144,13 @@ private fun createOrUpdateResourceVersion(resourceVersion: String, metadata: YAM
     }
 }
 
+fun getContent(element: PsiElement): PsiElement? {
+    if (element !is PsiFile) {
+        return null
+    }
+    return getContent(element)
+}
+
 private fun getContent(file: PsiFile): PsiElement? {
     return when (file) {
         is YAMLFile -> {
@@ -172,6 +189,35 @@ private fun getMetadata(content: PsiElement): PsiElement? {
     }
 }
 
+fun getData(element: PsiElement): PsiElement? {
+    return when (element) {
+        is YAMLPsiElement ->
+            element.children
+                .filterIsInstance(YAMLKeyValue::class.java)
+                .find { it.name == KEY_DATA }
+                ?.value
+        is JsonElement ->
+            element.children.toList()
+                .filterIsInstance(JsonProperty::class.java)
+                .find { it.name == KEY_DATA }
+                ?.value
+        else ->
+            null
+    }
+}
+
+fun decodeBase64(value: String?): String? {
+    if (Strings.isEmptyOrSpaces(value)) {
+        return null
+    }
+    return try {
+        val bytes = Base64.getDecoder().decode(value)
+        String(bytes)
+    } catch (e: IllegalArgumentException) {
+        null
+    }
+}
+
 private fun getResourceVersion(metadata: YAMLKeyValue): YAMLKeyValue? {
     return metadata.value?.children
         ?.filterIsInstance(YAMLKeyValue::class.java)

src/main/resources/META-INF/plugin.xml

@@ -206,6 +206,9 @@
         <nonProjectFileWritingAccessExtension implementation="com.redhat.devtools.intellij.common.editor.AllowNonProjectEditing" />
         <postStartupActivity implementation="com.redhat.devtools.intellij.kubernetes.KubernetesPluginInitializer" />
         <editorTabTitleProvider implementation="com.redhat.devtools.intellij.kubernetes.editor.ResourceEditorTabTitleProvider"/>
+        <codeInsight.inlayProvider language="yaml"
+                                   implementationClass="com.redhat.devtools.intellij.kubernetes.editor.inlay.Base64InlayHintsProvider"
+                                   id="MarkdownTableInlayProvider"/>
     </extensions>
 
     <extensionPoints>