feat(openapi): interfaces properly generated

Signed-off-by: Marc Nuri <marc@marcnuri.com>
fabric8io · Oct 25, 2024 · a4e40ee · a4e40ee
1 parent 0c1c753
commit a4e40ee
Show file tree

Hide file tree

Showing 9 changed files with 162 additions and 34 deletions.
diff --git a/kubernetes-model-generator/openapi/generator/pkg/openapi/openapi-gen-processors.go b/kubernetes-model-generator/openapi/generator/pkg/openapi/openapi-gen-processors.go
@@ -98,7 +98,7 @@ func processProtobufOneof(_ *generator.Context, pkg *types.Package, t *types.Typ
 		// Ensure it's exported
 		t.Members[memberIndex].Type.Name.Name = publicInterfaceName(m.Type.Name.Name)
 		//// Add comment tag to the referenced type and mark it as an interface
-		//t.Members[memberIndex].Type.CommentLines = append(m.Type.CommentLines, "+k8s:openapi-gen=x-kubernetes-fabric8-type:interface")
+		t.Members[memberIndex].Type.CommentLines = append(m.Type.CommentLines, "+k8s:openapi-gen=x-kubernetes-fabric8-type:interface")
 		// Add comment tag to the current type to mark it as it has fields that are interfaces (useful for the OpenAPI Java generator)
 		t.CommentLines = addOrAppend(t.CommentLines, "+k8s:openapi-gen=x-kubernetes-fabric8-interface-fields:", m.Name)
 	}

diff --git a/...n-plugin/src/main/java/io/fabric8/kubernetes/schema/generator/model/ClassInformation.java b/...n-plugin/src/main/java/io/fabric8/kubernetes/schema/generator/model/ClassInformation.java
@@ -0,0 +1,55 @@
+/*
+ * Copyright (C) 2015 Red Hat, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.fabric8.kubernetes.schema.generator.model;
+
+import io.fabric8.kubernetes.schema.generator.ImportManager;
+import io.fabric8.kubernetes.schema.generator.ImportOrderComparator;
+import io.fabric8.kubernetes.schema.generator.schema.SchemaUtils;
+import io.swagger.v3.oas.models.media.Schema;
+import lombok.Getter;
+
+import java.util.Map;
+import java.util.Set;
+import java.util.TreeSet;
+
+@Getter
+public class ClassInformation implements ImportManager {
+
+  private final Set<String> imports;
+  private final String packageName;
+  private final boolean isInterface;
+  private final JsonSubTypes jsonSubTypes;
+
+  ClassInformation(SchemaUtils schemaUtils, Map.Entry<String, Schema<?>> clazz) {
+    imports = new TreeSet<>(new ImportOrderComparator());
+    final var classKey = clazz.getKey();
+    final var classSchema = clazz.getValue();
+    packageName = schemaUtils.toModelPackage(classKey.substring(0, classKey.lastIndexOf('.')));
+    isInterface = SchemaUtils.isInterface(classSchema);
+    if (isInterface) {
+      addImport("com.fasterxml.jackson.annotation.JsonSubTypes");
+      addImport("com.fasterxml.jackson.annotation.JsonTypeInfo");
+      addImport("com.fasterxml.jackson.databind.annotation.JsonTypeResolver");
+      jsonSubTypes = new JsonSubTypes(classSchema);
+    } else {
+      jsonSubTypes = null;
+    }
+  }
+
+  boolean isEditable() {
+    return !isInterface();
+  }
+}
diff --git a/...maven-plugin/src/main/java/io/fabric8/kubernetes/schema/generator/model/JsonSubTypes.java b/...maven-plugin/src/main/java/io/fabric8/kubernetes/schema/generator/model/JsonSubTypes.java
@@ -0,0 +1,33 @@
+/*
+ * Copyright (C) 2015 Red Hat, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.fabric8.kubernetes.schema.generator.model;
+
+import io.fabric8.kubernetes.schema.generator.schema.SchemaUtils;
+import io.swagger.v3.oas.models.media.Schema;
+import lombok.Getter;
+
+import java.util.List;
+
+@Getter
+public class JsonSubTypes {
+
+  private final List<String> subTypes;
+
+  JsonSubTypes(Schema<?> classSchema) {
+    this.subTypes = SchemaUtils.interfaceImplementation(classSchema);
+  }
+
+}
diff --git a/...ven-plugin/src/main/java/io/fabric8/kubernetes/schema/generator/model/ModelGenerator.java b/...ven-plugin/src/main/java/io/fabric8/kubernetes/schema/generator/model/ModelGenerator.java
@@ -100,7 +100,6 @@ void generate() {
 
   private void processTemplate(TemplateContext ret) {
     ret.put("emptySpace", " "); // TODO: remove after generator migration, current workaround so that models match with jsonschema2pojo
-
     ret.addAllImports(initDefaultImports());
     if (ret.getApiVersion() != null) {
       ret.addImport("io.fabric8.kubernetes.model.annotation.Version");
@@ -130,35 +129,45 @@ private void processTemplate(TemplateContext ret) {
       deserializer = "com.fasterxml.jackson.databind.JsonDeserializer.None.class";
     }
     ret.put("classJsonDeserializeUsing", deserializer);
+    ret.addImport("com.fasterxml.jackson.annotation.JsonInclude");
+    ret.put("classJsonInclude", "NON_NULL");
+    if (!ret.getClassInformation().isInterface()) {
+      ret.addImport("com.fasterxml.jackson.annotation.JsonPropertyOrder");
+      ret.put("propertyOrder", SchemaUtils.propertyOrder(ret.getClassSchema()));
+      ret.addImport("lombok.ToString");
+      ret.put("lombokToString", true);
+      ret.addImport("lombok.EqualsAndHashCode");
+      ret.put("lombokEqualsAndHashCode", true);
+      ret.addImport("lombok.experimental.Accessors");
+      ret.put("lombokAccessors", true);
+    }
     ret.put("package", ret.getPackageName());
     if (settings.isGenerateJavadoc()) {
       ret.put("hasDescription", !sanitizeDescription(ret.getClassSchema().getDescription()).trim().isEmpty());
       ret.put("description", sanitizeDescription(ret.getClassSchema().getDescription()));
     }
-    ret.addImport("com.fasterxml.jackson.annotation.JsonInclude");
-    ret.put("classJsonInclude", "NON_NULL");
-    ret.put("classInterface", ret.isInterface() ? "interface" : "class");
+    ret.put("classInterface", ret.getClassInformation().isInterface() ? "interface" : "class");
     ret.put("className", ret.getClassSimpleName());
-    ret.put("implementsExtends", ret.isInterface() ? "extends" : "implements");
+    ret.put("implementsExtends", ret.getClassInformation().isInterface() ? "extends" : "implements");
     ret.put("implementedInterfaces", resolveImplementedInterfaces(ret));
     final List<Map<String, Object>> templateFields = templateFields(ret);
     ret.put("fields", templateFields);
     if (!templateFields.isEmpty()) {
       ret.put("hasFields", true);
       ret.addImport("com.fasterxml.jackson.annotation.JsonProperty");
     }
-    ret.put("propertyOrder", SchemaUtils.propertyOrder(ret.getClassSchema()));
+    ret.put("editable", ret.getClassInformation().isEditable());
     ret.put("builderPackage", settings.getBuilderPackage());
-    if (!ret.isInterface() && settings.isAddBuildableReferences()) {
+    if (!ret.getClassInformation().isInterface() && settings.isAddBuildableReferences()) {
       ret.put("buildable", false);
       ret.addImport("io.sundr.builder.annotations.Buildable");
       ret.addImport("io.sundr.builder.annotations.BuildableReference");
       ret.put("buildableReferences", buildableReferences(ret, templateFields));
-    } else if (!ret.isInterface()) {
+    } else if (!ret.getClassInformation().isInterface()) {
       ret.addImport("io.sundr.builder.annotations.Buildable");
       ret.put("buildable", true);
     }
-    if (!ret.getSchemaProperties().containsKey("additionalProperties") && !ret.isInterface()) {
+    if (!ret.getSchemaProperties().containsKey("additionalProperties") && !ret.getClassInformation().isInterface()) {
       ret.put("additionalProperties", true);
       ret.addImport("java.util.LinkedHashMap");
       ret.addImport("java.util.Map");
@@ -255,8 +264,8 @@ private Path resolvePackageDirectory(TemplateContext templateContext) {
 
   private String resolveImplementedInterfaces(TemplateContext templateContext) {
     final StringBuilder implementedInterfaces = new StringBuilder();
-    // Editable (all classes except interfaces)
-    if (!templateContext.isInterface()) {
+    if (templateContext.getClassInformation().isEditable()) {
+      templateContext.addImport("com.fasterxml.jackson.annotation.JsonIgnore");
       templateContext.addImport(settings.getBuilderPackage() + "." + "Editable");
       implementedInterfaces.append("Editable<").append(templateContext.getClassSimpleName()).append("Builder>");
       implementedInterfaces.append(" , "); // TODO: weird comma introduced by jsonschema2pojo
@@ -333,12 +342,7 @@ private void writeFile(TemplateContext context, String fileContents) {
   private static Set<String> initDefaultImports() {
     return new HashSet<>(Arrays.asList(
         "javax.annotation.Generated",
-        "com.fasterxml.jackson.annotation.JsonIgnore",
-        "com.fasterxml.jackson.annotation.JsonPropertyOrder",
-        "com.fasterxml.jackson.databind.annotation.JsonDeserialize",
-        "lombok.EqualsAndHashCode",
-        "lombok.ToString",
-        "lombok.experimental.Accessors"));
+        "com.fasterxml.jackson.databind.annotation.JsonDeserialize"));
   }
 
 }
diff --git a/...en-plugin/src/main/java/io/fabric8/kubernetes/schema/generator/model/TemplateContext.java b/...en-plugin/src/main/java/io/fabric8/kubernetes/schema/generator/model/TemplateContext.java
@@ -18,48 +18,44 @@
 import io.fabric8.kubernetes.schema.generator.ApiVersion;
 import io.fabric8.kubernetes.schema.generator.GeneratorSettings;
 import io.fabric8.kubernetes.schema.generator.ImportManager;
-import io.fabric8.kubernetes.schema.generator.ImportOrderComparator;
 import io.fabric8.kubernetes.schema.generator.schema.SchemaUtils;
 import io.swagger.v3.oas.models.media.Schema;
 import lombok.Getter;
 
+import java.util.Collection;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
-import java.util.Set;
-import java.util.TreeSet;
 
 @Getter
 final class TemplateContext implements ImportManager {
 
   private final String classKey;
   private final Schema<?> classSchema;
   private final ApiVersion apiVersion;
-  private final String packageName;
+  private final ClassInformation classInformation;
+  // TODO: Move to ClassInformation
   private final boolean inRootPackage;
   private final String classSimpleName;
   private final String className;
-  private final boolean isInterface;
   private final boolean hasMetadata;
   private final String kubernetesListType;
   private final Map<String, Object> context;
-  private final Set<String> imports;
 
   TemplateContext(GeneratorSettings settings, Map.Entry<String, Schema<?>> clazz) {
     final SchemaUtils schemaUtils = new SchemaUtils(settings);
     classKey = clazz.getKey();
     classSchema = clazz.getValue();
     apiVersion = settings.getApiVersions().get(classKey);
-    packageName = schemaUtils.toModelPackage(classKey.substring(0, classKey.lastIndexOf('.')));
-    inRootPackage = packageName.equals(settings.getPackageName());
+    classInformation = new ClassInformation(schemaUtils, clazz);
+    inRootPackage = getClassInformation().getPackageName().equals(settings.getPackageName());
     classSimpleName = SchemaUtils.refToClassName(classKey);
-    className = packageName + "." + classSimpleName;
-    isInterface = SchemaUtils.isInterface(classSchema);
-    imports = new TreeSet<>(new ImportOrderComparator());
+    className = getClassInformation().getPackageName() + "." + classSimpleName;
     kubernetesListType = apiVersion == null ? null : schemaUtils.kubernetesListType(this, classSchema);
     hasMetadata = apiVersion != null && kubernetesListType == null && schemaUtils.isHasMetadata(classSchema);
     context = new HashMap<>();
-    context.put("imports", imports);
+    context.put("imports", classInformation.getImports());
+    context.put("classInformation", classInformation);
   }
 
   void put(String key, Object value) {
@@ -74,6 +70,16 @@ boolean isNamespaced() {
     return getApiVersion() != null && getApiVersion().isNamespaced();
   }
 
+  @Override
+  public String getPackageName() {
+    return getClassInformation().getPackageName();
+  }
+
+  @Override
+  public Collection<String> getImports() {
+    return getClassInformation().getImports();
+  }
+
   @Override
   public boolean hasSimpleClassName(String className) {
     // If the provided class name matches the current class simple name it means that we'll need the fully

diff --git a/...maven-plugin/src/main/java/io/fabric8/kubernetes/schema/generator/schema/SchemaUtils.java b/...maven-plugin/src/main/java/io/fabric8/kubernetes/schema/generator/schema/SchemaUtils.java
@@ -36,12 +36,14 @@
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.LinkedHashMap;
+import java.util.List;
 import java.util.Locale;
 import java.util.Map;
 import java.util.Objects;
 import java.util.Optional;
 import java.util.Set;
 import java.util.stream.Collectors;
+import java.util.stream.Stream;
 
 public class SchemaUtils {
 
@@ -270,6 +272,16 @@ public static Set<String> interfaceFields(Schema<?> schema) {
     return Collections.emptySet();
   }
 
+  public static List<String> interfaceImplementation(Schema<?> schema) {
+    if (schema.getExtensions() != null && schema.getExtensions().containsKey("x-kubernetes-fabric8-implementation")) {
+      return Stream.of(schema.getExtensions().get("x-kubernetes-fabric8-implementation").toString().split(","))
+          .map(SchemaUtils::refToClassName)
+          .sorted()
+          .collect(Collectors.toList());
+    }
+    return Collections.emptyList();
+  }
+
   public static boolean isArray(Schema<?> schema) {
     return schema instanceof ArraySchema;
   }

diff --git a/...erator/openapi/maven-plugin/src/main/resources/templates/model_class_annotations.mustache b/...erator/openapi/maven-plugin/src/main/resources/templates/model_class_annotations.mustache
@@ -22,22 +22,28 @@
 {{#classJsonInclude}}
 @JsonInclude(JsonInclude.Include.{{.}})
 {{/classJsonInclude}}
-@JsonPropertyOrder({
 {{#propertyOrder}}
+@JsonPropertyOrder({
 {{#isEmpty}}
 
 {{/isEmpty}}
 {{#properties}}
     "{{.}}"{{^-last}},{{/-last}}
 {{/properties}}
-{{/propertyOrder}}
 })
+{{/propertyOrder}}
+{{#lombokToString}}
 @ToString
+{{/lombokToString}}
+{{#lombokEqualsAndHashCode}}
 @EqualsAndHashCode
+{{/lombokEqualsAndHashCode}}
+{{#lombokAccessors}}
 @Accessors(prefix = {
     "_",
     ""
 })
+{{/lombokAccessors}}
 {{#buildable}}
 @Buildable(editableEnabled = false, validationEnabled = false, generateBuilderPackage = false, lazyCollectionInitEnabled = false, builderPackage = "{{builderPackage}}")
 {{/buildable}}
@@ -59,4 +65,13 @@
 {{#group}}
 {{.}}
 {{/group}}
+{{#classInformation.jsonSubTypes}}
+@JsonTypeResolver(io.fabric8.kubernetes.model.jackson.UnwrappedTypeResolverBuilder.class)
+@JsonSubTypes({
+{{#subTypes}}
+    @JsonSubTypes.Type({{.}}.class),
+{{/subTypes}}
+})
+@JsonTypeInfo(use = JsonTypeInfo.Id.DEDUCTION)
+{{/classInformation.jsonSubTypes}}
 @Generated("jsonschema2pojo")
diff --git a/...-model-generator/openapi/maven-plugin/src/main/resources/templates/model_methods.mustache b/...-model-generator/openapi/maven-plugin/src/main/resources/templates/model_methods.mustache
@@ -48,6 +48,7 @@
     }
 
 {{/fields}}
+{{#editable}}
     @JsonIgnore
     public {{className}}Builder edit() {
         return new {{className}}Builder(this);
@@ -58,6 +59,7 @@
         return edit();
     }
 
+{{/editable}}
 {{#additionalProperties}}
     @JsonAnyGetter
     public Map<String, Object> getAdditionalProperties() {

diff --git a/...lugin/src/test/java/io/fabric8/kubernetes/schema/generator/model/TemplateContextTest.java b/...lugin/src/test/java/io/fabric8/kubernetes/schema/generator/model/TemplateContextTest.java
@@ -26,6 +26,7 @@
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.HashSet;
+import java.util.List;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertFalse;
@@ -116,8 +117,8 @@ void kubernetesListType_podList() {
 
   @Test
   void context() {
-    assertEquals(1, templateContext.getContext().size());
-    assertEquals(new HashSet<>(Collections.singletonList("imports")), templateContext.getContext().keySet());
+    assertEquals(2, templateContext.getContext().size());
+    assertEquals(new HashSet<>(List.of("imports", "classInformation")), templateContext.getContext().keySet());
   }
 
   @Test