fix: support multi-resource yaml files

* added support for multi-resource yaml files
* added tests for KubernetesTypeInfo

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

Author: adietish

src/main/java/com/redhat/devtools/intellij/common/validation/KubernetesResourceInfo.java

@@ -18,6 +18,8 @@
 import com.intellij.psi.PsiFile;
 import com.intellij.psi.PsiNamedElement;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+import org.jetbrains.yaml.psi.YAMLDocument;
 import org.jetbrains.yaml.psi.YAMLFile;
 import org.jetbrains.yaml.psi.YAMLKeyValue;
 import org.jetbrains.yaml.psi.YAMLValue;
@@ -34,39 +36,46 @@ public class KubernetesResourceInfo {
     private String namespace;
     private KubernetesTypeInfo typeInfo;
 
-    public KubernetesResourceInfo(String name, String namespace, KubernetesTypeInfo info) {
+    KubernetesResourceInfo(String name, String namespace, KubernetesTypeInfo info) {
         this.name = name;
         this.namespace = namespace;
         this.typeInfo = info;
     }
 
-    public KubernetesResourceInfo() {
-    }
+    private KubernetesResourceInfo() {}
 
-    public static KubernetesResourceInfo extractMeta(PsiFile file) {
+    public static KubernetesResourceInfo create(PsiFile file) {
         KubernetesResourceInfo resourceInfo = new KubernetesResourceInfo();
         if (file instanceof JsonFile) {
-            extractJsonMeta((JsonFile) file, resourceInfo);
+            create((JsonFile) file, resourceInfo);
         } else if (file instanceof YAMLFile) {
-            extractYAMLMeta((YAMLFile) file, resourceInfo);
+            create((YAMLFile) file, resourceInfo);
         }
-        resourceInfo.setTypeInfo(KubernetesTypeInfo.extractMeta(file));
+        resourceInfo.setTypeInfo(KubernetesTypeInfo.create(file));
         return resourceInfo;
     }
 
-    private static void extractJsonMeta(JsonFile file, KubernetesResourceInfo resourceInfo) {
+    private static void create(JsonFile file, KubernetesResourceInfo resourceInfo) {
         JsonValue content = file.getTopLevelValue();
         if (content == null) {
             return;
         }
         content.acceptChildren(new ResourceVisitor(resourceInfo));
     }
 
-    private static void extractYAMLMeta(YAMLFile file, KubernetesResourceInfo resourceInfo) {
+    private static void create(YAMLFile file, KubernetesResourceInfo resourceInfo) {
         if (file.getDocuments().isEmpty()) {
             return;
         }
-        YAMLValue content = file.getDocuments().get(0).getTopLevelValue();
+        // only use the first document in the file
+        create(file.getDocuments().get(0), resourceInfo);
+    }
+
+    private static void create(YAMLDocument document, KubernetesResourceInfo resourceInfo) {
+        if (document == null) {
+            return;
+        }
+        YAMLValue content = document.getTopLevelValue();
         if (content == null) {
             return;
         }
@@ -89,11 +98,7 @@ public void setNamespace(String namespace) {
         this.namespace = namespace;
     }
 
-    public KubernetesTypeInfo getTypeInfo() {
-        return typeInfo;
-    }
-
-    public void setTypeInfo(KubernetesTypeInfo typeInfo) {
+    private void setTypeInfo(KubernetesTypeInfo typeInfo) {
         this.typeInfo = typeInfo;
     }
 
@@ -121,34 +126,41 @@ private static class ResourceVisitor extends PsiElementVisitor {
 
         private final KubernetesResourceInfo info;
 
-        public ResourceVisitor(KubernetesResourceInfo info) {
+        private ResourceVisitor(KubernetesResourceInfo info) {
             this.info = info;
         }
 
         @Override
         public void visitElement(@NotNull PsiElement element) {
-            if (!(element instanceof PsiNamedElement)) {
+            if (!(element instanceof PsiNamedElement namedElement)) {
                 return;
             }
-            PsiNamedElement namedElement = (PsiNamedElement) element;
             if (KEY_METADATA.equals(namedElement.getName())) {
-                if (namedElement instanceof JsonProperty) {
-                    ((JsonProperty) namedElement).getValue().acceptChildren(visitMetadata());
-                } else if (namedElement instanceof YAMLKeyValue) {
-                    ((YAMLKeyValue) namedElement).getValue().acceptChildren(visitMetadata());
+                var value = getValue(namedElement);
+                if (value != null) {
+                    value.acceptChildren(visitMetadata());
                 }
             }
         }
 
+        private @Nullable PsiElement getValue(PsiNamedElement namedElement) {
+            if (namedElement instanceof JsonProperty) {
+                return ((JsonProperty) namedElement).getValue();
+            } else if (namedElement instanceof YAMLKeyValue) {
+                return ((YAMLKeyValue) namedElement).getValue();
+            } else {
+                return null;
+            }
+        }
+
         @NotNull
         private PsiElementVisitor visitMetadata() {
             return new PsiElementVisitor() {
                 @Override
-                public void visitElement(PsiElement element) {
-                    if (!(element instanceof PsiNamedElement)) {
+                public void visitElement(@NotNull PsiElement element) {
+                    if (!(element instanceof PsiNamedElement namedElement)) {
                         return;
                     }
-                    PsiNamedElement namedElement = (PsiNamedElement) element;
                     if (KEY_NAME.equals(namedElement.getName())) {
                         setName(namedElement);
                     } else if (KEY_NAMESPACE.equals(namedElement.getName())) {
@@ -177,7 +189,7 @@ private String valueOrNull(JsonProperty property) {
                 }
 
                 private String valueOrNull(YAMLKeyValue key) {
-                    return key.getValueText() != null ? key.getValueText() : null;
+                    return key.getValueText();
                 }
 
             };

src/main/java/com/redhat/devtools/intellij/common/validation/KubernetesTypeInfo.java

@@ -13,18 +13,26 @@
 import com.intellij.json.psi.JsonFile;
 import com.intellij.json.psi.JsonProperty;
 import com.intellij.json.psi.JsonValue;
+import com.intellij.openapi.util.text.StringUtil;
 import com.intellij.psi.PsiElement;
 import com.intellij.psi.PsiElementVisitor;
 import com.intellij.psi.PsiFile;
-import java.util.Objects;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.yaml.psi.YAMLDocument;
 import org.jetbrains.yaml.psi.YAMLFile;
 import org.jetbrains.yaml.psi.YAMLKeyValue;
 import org.jetbrains.yaml.psi.YAMLValue;
 
+import java.util.List;
+import java.util.Objects;
+
 public class KubernetesTypeInfo {
+
+    private static final String KEY_API_VERSION = "apiVersion";
+    private static final String KEY_KIND = "kind";
+
     private String apiGroup = "";
-    private String kind= "";
+    private String kind = "";
 
     public KubernetesTypeInfo(String apiGroup, String kind) {
         this.apiGroup = apiGroup;
@@ -33,55 +41,72 @@ public KubernetesTypeInfo(String apiGroup, String kind) {
 
     public KubernetesTypeInfo() {}
 
-    public static KubernetesTypeInfo extractMeta(PsiFile file) {
-        KubernetesTypeInfo info = new KubernetesTypeInfo();
+    public static KubernetesTypeInfo create(PsiFile file) {
         if (file instanceof JsonFile) {
-            extractJsonMeta((JsonFile) file, info);
+            return create((JsonFile) file);
         } else if (file instanceof YAMLFile) {
-            extractYAMLMeta((YAMLFile) file, info);
+            return create((YAMLFile) file);
+        } else {
+            return null;
         }
-        return info;
     }
 
-    private static void extractJsonMeta(JsonFile file, KubernetesTypeInfo info) {
-        JsonValue content = file.getTopLevelValue();
+    private static KubernetesTypeInfo create(JsonFile file) {
+        var collector = new JsonKubernetesTypeInfoVisitor();
+        final JsonValue content = file.getTopLevelValue();
         if (content != null) {
-            content.acceptChildren(new PsiElementVisitor() {
-                @Override
-                public void visitElement(@NotNull PsiElement element) {
-                    if (element instanceof JsonProperty) {
-                        JsonProperty property = (JsonProperty) element;
-                        if (property.getName().equals("apiVersion")) {
-                            info.setApiGroup(property.getValue().getText());
-                        } else if (property.getName().equals("kind")) {
-                            info.setKind(property.getValue().getText());
-                        }
-                    }
-                }
-            });
+            content.acceptChildren(collector);
         }
+        return collector.getKubernetesTypeInfo();
     }
 
-    private static void extractYAMLMeta(YAMLFile file, KubernetesTypeInfo info) {
-        if (!file.getDocuments().isEmpty()) {
-            YAMLValue content = file.getDocuments().get(0).getTopLevelValue();
-            if (content != null) {
-            content.acceptChildren(new PsiElementVisitor() {
-                    @Override
-                    public void visitElement(@NotNull PsiElement element) {
-                        if (element instanceof YAMLKeyValue) {
-                            YAMLKeyValue property = (YAMLKeyValue) element;
-                            if (property.getKeyText().equals("apiVersion")) {
-                                info.setApiGroup(property.getValueText());
-                            } else if (property.getKeyText().equals("kind")) {
-                                info.setKind(property.getValueText());
-                            }
-                        }
-                    }
-                });
+    /**
+     * Extracts the k8s metadata of the first document in the given YAML file.
+     *
+     * @param file the yaml file to extract the k8s metadata of
+     *
+     * @return the k8s metadata of the first document in the given file
+     */
+    private static KubernetesTypeInfo create(YAMLFile file) {
+        if (file == null
+                || file.getDocuments().isEmpty()) {
+            return null;
+        }
+
+        // only use the first document in the file
+        return create(file.getDocuments().get(0));
+    }
 
+    /**
+     * Creates a list of {@link KubernetesTypeInfo} for the given YAML file.
+     * If the given file contains several documents then KubernetesTypeInfo's for each document will be created.
+     * If there's only a single document only a single KuberenetesTypeInfo is created.
+     * Returns {@code null} if the given file is {@code null} or empty.
+     *
+     * @param file the yaml file to create KubernetesTypeInfo's for
+     *
+     * @return KubernetesTypeInfos of all the documents in the given file
+     */
+    static List<KubernetesTypeInfo> createTypes(YAMLFile file) {
+        if (file == null
+                || file.getDocuments().isEmpty()) {
+            return null;
+        }
+
+        return file.getDocuments().stream()
+                .map(KubernetesTypeInfo::create)
+                .toList();
+    }
+
+    public static KubernetesTypeInfo create(YAMLDocument document) {
+        final KubernetesTypeInfoVisitor collector = new YAMLKubernetesTypeInfoVisitor();
+        if (document != null) {
+            final YAMLValue content = document.getTopLevelValue();
+            if (content != null) {
+                content.acceptChildren(collector);
             }
         }
+        return collector.getKubernetesTypeInfo();
     }
 
     public String getApiGroup() {
@@ -121,11 +146,65 @@ public String toString() {
 
     public static KubernetesTypeInfo fromFileName(String filename) {
         int index = filename.indexOf('_');
-            String apiGroup = (index != (-1))?filename.substring(0, index):"";
-            String kind = (index != (-1))?filename.substring(index + 1):filename;
-            index = kind.lastIndexOf('.');
-            kind = (index != (-1))?kind.substring(0, index):kind;
-            return new KubernetesTypeInfo(apiGroup, kind);
+        String apiGroup = (index != (-1)) ? filename.substring(0, index) : "";
+        String kind = (index != (-1)) ? filename.substring(index + 1) : filename;
+        index = kind.lastIndexOf('.');
+        kind = (index != (-1)) ? kind.substring(0, index) : kind;
+        return new KubernetesTypeInfo(apiGroup, kind);
+    }
+
+    private static abstract class KubernetesTypeInfoVisitor extends PsiElementVisitor {
 
+        private KubernetesTypeInfo info = null;
+
+        protected void setApiGroup(String apiGroup) {
+            existingOrCreate().setApiGroup(apiGroup);
         }
+
+        protected void setKind(String kind) {
+            existingOrCreate().setKind(kind);
+        }
+
+        private KubernetesTypeInfo existingOrCreate() {
+            if (info == null) {
+                this.info = new KubernetesTypeInfo();
+            }
+            return info;
+        }
+
+        public KubernetesTypeInfo getKubernetesTypeInfo() {
+            return info;
+        }
+    }
+
+    static class YAMLKubernetesTypeInfoVisitor extends KubernetesTypeInfoVisitor {
+        @Override
+        public void visitElement(@NotNull PsiElement element) {
+            if (element instanceof YAMLKeyValue property) {
+                String value = StringUtil.unquoteString(property.getValueText());
+                if (property.getKeyText().equals(KEY_API_VERSION)) {
+                    setApiGroup(value);
+                } else if (property.getKeyText().equals(KEY_KIND)) {
+                    setKind(value);
+                }
+            }
+        }
+    }
+
+    static class JsonKubernetesTypeInfoVisitor extends KubernetesTypeInfoVisitor {
+        @Override
+        public void visitElement(@NotNull PsiElement element) {
+            if (element instanceof JsonProperty property
+                    && property.getValue() != null
+                    && property.getValue().getText() != null) {
+                String value = StringUtil.unquoteString(property.getValue().getText());
+                if (property.getName().equals(KEY_API_VERSION)) {
+                    setApiGroup(value);
+                } else if (property.getName().equals(KEY_KIND)) {
+                    setKind(value);
+                }
+            }
+        }
+    }
+
 }

src/main/java/com/redhat/devtools/intellij/common/validation/SchemaProvider.java

@@ -41,7 +41,7 @@ public boolean isAvailable(@NotNull VirtualFile file) {
         return ApplicationManager.getApplication().runReadAction((Computable<Boolean>) () -> {
             PsiFile psiFile = PsiManager.getInstance(project).findFile(file);
             if (psiFile != null) {
-                KubernetesTypeInfo fileInfo = KubernetesTypeInfo.extractMeta(psiFile);
+                KubernetesTypeInfo fileInfo = KubernetesTypeInfo.create(psiFile);
                 return info.equals(fileInfo);
             }
             return false;