add annotation @PreserveUnknownFields for field

Signed-off-by: wineway <[email protected]>

Author: wineway

crd-generator/api/src/main/java/io/fabric8/crd/generator/AbstractJsonSchema.java

@@ -87,6 +87,7 @@ public abstract class AbstractJsonSchema<T, B> {
   public static final String ANNOTATION_REQUIRED = "io.fabric8.generator.annotation.Required";
   public static final String ANNOTATION_NOT_NULL = "javax.validation.constraints.NotNull";
   public static final String ANNOTATION_SCHEMA_FROM = "io.fabric8.crd.generator.annotation.SchemaFrom";
+  public static final String ANNOTATION_PERSERVE_UNKNOWN_FIELDS = "io.fabric8.crd.generator.annotation.PreserveUnknownFields";
   public static final String ANNOTATION_SCHEMA_SWAP = "io.fabric8.crd.generator.annotation.SchemaSwap";
   public static final String ANNOTATION_SCHEMA_SWAPS = "io.fabric8.crd.generator.annotation.SchemaSwaps";
 
@@ -125,21 +126,25 @@ protected static class SchemaPropsOptions {
     final boolean nullable;
     final boolean required;
 
+    final boolean preserveUnknownFields;
+
     SchemaPropsOptions() {
       min = Optional.empty();
       max = Optional.empty();
       pattern = Optional.empty();
       nullable = false;
       required = false;
+      preserveUnknownFields = false;
     }
 
     public SchemaPropsOptions(Optional<Double> min, Optional<Double> max, Optional<String> pattern,
-        boolean nullable, boolean required) {
+        boolean nullable, boolean required, boolean preserveUnknownFields) {
       this.min = min;
       this.max = max;
       this.pattern = pattern;
       this.nullable = nullable;
       this.required = required;
+      this.preserveUnknownFields = preserveUnknownFields;
     }
 
     public Optional<Double> getMin() {
@@ -161,6 +166,10 @@ public boolean isNullable() {
     public boolean getRequired() {
       return required;
     }
+
+    public boolean isPreserveUnknownFields() {
+      return preserveUnknownFields;
+    }
   }
 
   /**
@@ -280,7 +289,8 @@ private T internalFromImpl(TypeDef definition, Set<String> visited, InternalSche
           facade.max,
           facade.pattern,
           facade.nullable,
-          facade.required);
+          facade.required,
+          facade.preserveSelfUnknownFields);
 
       addProperty(possiblyRenamedProperty, builder, possiblyUpdatedSchema, options);
     }
@@ -310,6 +320,7 @@ private static class PropertyOrAccessor {
     private boolean required;
     private boolean ignored;
     private boolean preserveUnknownFields;
+    private boolean preserveSelfUnknownFields;
     private String description;
     private TypeRef schemaFrom;
 
@@ -374,6 +385,9 @@ public void process() {
           case ANNOTATION_JSON_ANY_SETTER:
             preserveUnknownFields = true;
             break;
+          case ANNOTATION_PERSERVE_UNKNOWN_FIELDS:
+            preserveSelfUnknownFields = true;
+            break;
           case ANNOTATION_SCHEMA_FROM:
             schemaFrom = extractClassRef(a.getParameters().get("type"));
             break;
@@ -413,6 +427,10 @@ public boolean isPreserveUnknownFields() {
       return preserveUnknownFields;
     }
 
+    public boolean isPreserveSelfUnknownFields() {
+      return preserveSelfUnknownFields;
+    }
+
     public String getDescription() {
       return description;
     }
@@ -450,6 +468,7 @@ private static class PropertyFacade {
     private boolean required;
     private boolean ignored;
     private boolean preserveUnknownFields;
+    private boolean preserveSelfUnknownFields;
     private final Property original;
     private String nameContributedBy;
     private String descriptionContributedBy;
@@ -528,6 +547,10 @@ public Property process() {
           preserveUnknownFields = true;
         }
 
+        if (p.isPreserveSelfUnknownFields()) {
+          preserveSelfUnknownFields = true;
+        }
+
         if (p.contributeSchemaFrom()) {
           schemaFrom = p.getSchemaFrom();
         }

crd-generator/api/src/main/java/io/fabric8/crd/generator/annotation/PreserveUnknownFields.java

@@ -0,0 +1,26 @@
+/**
+ * Copyright (C) 2022 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.crd.generator.annotation;
+
+import java.lang.annotation.*;
+
+/*
+ * Used to tweak the behavior of the crd-generator
+ */
+@Target(ElementType.FIELD)
+@Retention(RetentionPolicy.RUNTIME)
+public @interface PreserveUnknownFields {
+}

crd-generator/api/src/main/java/io/fabric8/crd/generator/v1/JsonSchema.java

@@ -66,6 +66,10 @@ public void addProperty(Property property, JSONSchemaPropsBuilder builder,
         schema.setNullable(true);
       }
 
+      if (options.isPreserveUnknownFields()) {
+        schema.setXKubernetesPreserveUnknownFields(true);
+      }
+
       builder.addToProperties(property.getName(), schema);
     }
   }

crd-generator/api/src/main/java/io/fabric8/crd/generator/v1beta1/JsonSchema.java

@@ -67,6 +67,10 @@ public void addProperty(Property property, JSONSchemaPropsBuilder builder,
         schema.setNullable(true);
       }
 
+      if (options.isPreserveUnknownFields()) {
+        schema.setXKubernetesPreserveUnknownFields(true);
+      }
+
       builder.addToProperties(property.getName(), schema);
     }
   }

crd-generator/api/src/test/java/io/fabric8/crd/example/extraction/ExtractionSpec.java

@@ -15,13 +15,15 @@
  */
 package io.fabric8.crd.example.extraction;
 
+import io.fabric8.crd.generator.annotation.PreserveUnknownFields;
 import io.fabric8.crd.generator.annotation.SchemaFrom;
 
 public class ExtractionSpec {
 
   @SchemaFrom(type = FooExtractor.class)
   private Foo foo;
 
+  @PreserveUnknownFields
   private Foo bar;
 
 }

crd-generator/api/src/test/java/io/fabric8/crd/generator/v1/JsonSchemaTest.java

@@ -190,6 +190,7 @@ void shouldExtractPropertiesSchemaFromExtractValueAnnotation() {
     JSONSchemaProps bar = spec.get("bar");
     Map<String, JSONSchemaProps> barProps = bar.getProperties();
     assertNotNull(barProps);
+    assertTrue(bar.getXKubernetesPreserveUnknownFields());
 
     // you can change everything
     assertEquals("integer", barProps.get("BAZ").getType());