Merge pull request kroxylicious#2032 from SamBarker/require-last-transition-time

Require last transition time

Author: SamBarker

kroxylicious-operator/src/main/java/io/kroxylicious/kubernetes/api/common/Condition.java

@@ -6,6 +6,12 @@
 
 package io.kroxylicious.kubernetes.api.common;
 
+import java.util.Objects;
+
+import com.fasterxml.jackson.annotation.Nulls;
+
+import edu.umd.cs.findbugs.annotations.NonNull;
+
 /**
  * A common Condition type, used in CR statuses.
  */
@@ -43,16 +49,17 @@ public ConditionBuilder edit() {
      */
     @com.fasterxml.jackson.annotation.JsonProperty("lastTransitionTime")
     @com.fasterxml.jackson.annotation.JsonPropertyDescription("lastTransitionTime is the last time the condition transitioned from one status to another. \nThis should be when the underlying condition changed. \nIf that is not known, then using the time when the API field changed is acceptable.\n")
-    @com.fasterxml.jackson.annotation.JsonSetter(nulls = com.fasterxml.jackson.annotation.Nulls.SKIP)
+    @com.fasterxml.jackson.annotation.JsonSetter(nulls = Nulls.FAIL)
     @com.fasterxml.jackson.annotation.JsonFormat(shape = com.fasterxml.jackson.annotation.JsonFormat.Shape.STRING)
+    @NonNull
     private java.time.Instant lastTransitionTime;
 
     public java.time.Instant getLastTransitionTime() {
         return lastTransitionTime;
     }
 
-    public void setLastTransitionTime(java.time.Instant lastTransitionTime) {
-        this.lastTransitionTime = lastTransitionTime;
+    public void setLastTransitionTime(@NonNull java.time.Instant lastTransitionTime) {
+        this.lastTransitionTime = Objects.requireNonNull(lastTransitionTime);
     }
 
     /**
@@ -80,15 +87,16 @@ public void setMessage(String message) {
      */
     @com.fasterxml.jackson.annotation.JsonProperty("observedGeneration")
     @com.fasterxml.jackson.annotation.JsonPropertyDescription("observedGeneration represents the .metadata.generation that the condition was set based upon. \nFor instance, if .metadata.generation is currently 12, but the \n.status.conditions[x].observedGeneration is 9, the condition is out of date with \nrespect to the current state of the instance.\n")
-    @com.fasterxml.jackson.annotation.JsonSetter(nulls = com.fasterxml.jackson.annotation.Nulls.SKIP)
+    @com.fasterxml.jackson.annotation.JsonSetter(nulls = Nulls.FAIL)
+    @NonNull
     private Long observedGeneration;
 
     public Long getObservedGeneration() {
         return observedGeneration;
     }
 
-    public void setObservedGeneration(Long observedGeneration) {
-        this.observedGeneration = observedGeneration;
+    public void setObservedGeneration(@NonNull Long observedGeneration) {
+        this.observedGeneration = Objects.requireNonNull(observedGeneration);
     }
 
     /**
@@ -191,4 +199,4 @@ public String getValue() {
             return value;
         }
     }
-}
+}

kroxylicious-operator/src/main/java/io/kroxylicious/kubernetes/operator/ProxyConfigConfigMap.java

@@ -273,4 +273,4 @@ private static VirtualCluster getVirtualCluster(VirtualKafkaCluster cluster,
                 filterNamesForCluster(cluster));
     }
 
-}
+}

kroxylicious-operator/src/main/java/io/kroxylicious/kubernetes/operator/ProxyConfigData.java

@@ -38,7 +38,9 @@ public class ProxyConfigData {
 
     private static String toYaml(Object filterDefs) {
         try {
-            return CONFIG_OBJECT_MAPPER.writeValueAsString(filterDefs);
+            // .stripTrailing() is required to standardise the trailing white space. Standardising ensures that we don't trigger Jackson/SnakeYaml magic for enabling
+            // or disabling the chomp operator when appending this string to a YAML document. stripTrailing in preference to strip as its fractionally cheaper.
+            return CONFIG_OBJECT_MAPPER.writeValueAsString(filterDefs).stripTrailing();
         }
         catch (IOException e) {
             throw new UncheckedIOException(e);

kroxylicious-operator/src/main/java/io/kroxylicious/kubernetes/operator/ResourcesUtil.java

@@ -21,6 +21,7 @@
 import java.util.stream.Stream;
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
+import io.fabric8.kubernetes.api.model.ObjectMeta;
 import io.fabric8.kubernetes.api.model.OwnerReference;
 import io.fabric8.kubernetes.api.model.OwnerReferenceBuilder;
 import io.javaoperatorsdk.operator.api.reconciler.Context;
@@ -102,8 +103,18 @@ public static String namespace(@NonNull HasMetadata resource) {
         return resource.getMetadata().getNamespace();
     }
 
-    public static Long generation(@NonNull HasMetadata resource) {
-        return resource.getMetadata().getGeneration();
+    /**
+     * Extract generation from a MetaData object.
+     *
+     * @param resource the object from which to extract the metadata generation.
+     * @return the metadata generation of <code>0</code> of te metadata or the generation itself is null in alignment with @see <a href="https://github.com/kubernetes/enhancements/tree/master/keps/sig-api-machinery/1623-standardize-conditions#kep-1623-standardize-conditions">KEP 1623</a>.
+     */
+    public static @NonNull Long generation(@NonNull HasMetadata resource) {
+        ObjectMeta metadata = resource.getMetadata();
+        if (metadata.getGeneration() == null) {
+            return 0L;
+        }
+        return metadata.getGeneration();
     }
 
     public static String uid(@NonNull HasMetadata resource) {

kroxylicious-operator/src/main/java/io/kroxylicious/kubernetes/operator/StatusFactory.java

@@ -26,7 +26,7 @@ ConditionBuilder newConditionBuilder(HasMetadata observedGenerationSource) {
         var now = clock.instant();
         return new ConditionBuilder()
                 .withLastTransitionTime(now)
-                .withObservedGeneration(observedGenerationSource.getMetadata().getGeneration());
+                .withObservedGeneration(ResourcesUtil.generation(observedGenerationSource));
     }
 
     Condition newTrueCondition(HasMetadata observedGenerationSource, Condition.Type type) {

kroxylicious-operator/src/main/resources/META-INF/fabric8/kafkaprotocolfilters.filter.kroxylicious.io-v1.yml

@@ -102,3 +102,6 @@ spec:
                       type:
                         description: type of condition in CamelCase or in foo.example.com/CamelCase.
                         type: string
+                    required:
+                      - lastTransitionTime
+                      - observedGeneration

kroxylicious-operator/src/main/resources/META-INF/fabric8/kafkaproxies.kroxylicious.io-v1.yml

@@ -99,6 +99,9 @@ spec:
                       type:
                         description: type of condition in CamelCase or in foo.example.com/CamelCase.
                         type: string
+                    required:
+                      - lastTransitionTime
+                      - observedGeneration
                 clusters:
                   type: array
                   x-kubernetes-list-type: map

kroxylicious-operator/src/main/resources/META-INF/fabric8/kafkaproxyingresses.kroxylicious.io-v1.yml

@@ -108,3 +108,6 @@ spec:
                       type:
                         description: type of condition in CamelCase or in foo.example.com/CamelCase.
                         type: string
+                    required:
+                      - lastTransitionTime
+                      - observedGeneration

kroxylicious-operator/src/main/resources/META-INF/fabric8/kafkaservices.kroxylicious.io-v1.yml

@@ -90,3 +90,6 @@ spec:
                       type:
                         description: type of condition in CamelCase or in foo.example.com/CamelCase.
                         type: string
+                    required:
+                      - lastTransitionTime
+                      - observedGeneration

kroxylicious-operator/src/main/resources/META-INF/fabric8/virtualkafkaclusters.kroxylicious.io-v1.yml

@@ -133,4 +133,7 @@ spec:
                         enum: [ "True", "False", "Unknown" ]
                       type:
                         description: type of condition in CamelCase or in foo.example.com/CamelCase.
-                        type: string
+                        type: string
+                    required:
+                      - lastTransitionTime
+                      - observedGeneration