refactor: add GroupVersionKindPlural class, used by GenericKubernetesDependentResource

Author: metacosm

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/GroupVersionKind.java

@@ -1,18 +1,20 @@
 package io.javaoperatorsdk.operator.processing;
 
 import java.util.Objects;
-import java.util.Optional;
 
-import io.fabric8.kubernetes.api.Pluralize;
 import io.fabric8.kubernetes.api.model.HasMetadata;
+import io.javaoperatorsdk.operator.processing.dependent.kubernetes.GroupVersionKindPlural;
 
 public class GroupVersionKind {
   private final String group;
   private final String version;
   private final String kind;
-  private final String plural;
   private final String apiVersion;
 
+  /**
+   * @deprecated Use {@link GroupVersionKindPlural#gvkFor(String, String)} instead
+   */
+  @Deprecated(forRemoval = true)
   public GroupVersionKind(String apiVersion, String kind) {
     this.kind = kind;
     String[] groupAndVersion = apiVersion.split("/");
@@ -23,28 +25,24 @@ public GroupVersionKind(String apiVersion, String kind) {
       this.group = groupAndVersion[0];
       this.version = groupAndVersion[1];
     }
-    this.plural = null;
     this.apiVersion = apiVersion;
   }
 
-  public GroupVersionKind(String group, String version, String kind) {
-    this(group, version, kind, null);
+  public static GroupVersionKind gvkFor(Class<? extends HasMetadata> resourceClass) {
+    return GroupVersionKindPlural.gvkFor(resourceClass);
   }
 
-  public GroupVersionKind(String group, String version, String kind, String plural) {
+  /**
+   * @deprecated Use {@link GroupVersionKindPlural#gvkFor(String, String, String)} instead
+   */
+  @Deprecated(forRemoval = true)
+  public GroupVersionKind(String group, String version, String kind) {
     this.group = group;
     this.version = version;
     this.kind = kind;
-    this.plural = plural;
     this.apiVersion = (group == null || group.isBlank()) ? version : group + "/" + version;
   }
 
-  public static GroupVersionKind gvkFor(Class<? extends HasMetadata> resourceClass) {
-    return new GroupVersionKind(HasMetadata.getGroup(resourceClass),
-        HasMetadata.getVersion(resourceClass), HasMetadata.getKind(resourceClass),
-        HasMetadata.getPlural(resourceClass));
-  }
-
   public String getGroup() {
     return group;
   }
@@ -57,18 +55,6 @@ public String getKind() {
     return kind;
   }
 
-  /**
-   * Returns the plural form associated with the kind if it has been provided explicitly (either
-   * manually by the user, or determined from the associated resource class definition)
-   *
-   * @return {@link Optional#empty()} if the plural form was not provided explicitly (in which case,
-   *         it could be approximated by using {@link Pluralize#toPlural(String)} on the kind), or
-   *         the plural form if it was provided explicitly
-   */
-  public Optional<String> getPlural() {
-    return Optional.ofNullable(plural);
-  }
-
   public String apiVersion() {
     return apiVersion;
   }
@@ -91,8 +77,7 @@ public int hashCode() {
   @Override
   public String toString() {
     return "GroupVersionKind{" +
-        "group='" + group + '\'' +
-        ", version='" + version + '\'' +
+        "apiVersion='" + apiVersion + '\'' +
         ", kind='" + kind + '\'' +
         '}';
   }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/GenericKubernetesDependentResource.java

@@ -8,9 +8,13 @@
 public class GenericKubernetesDependentResource<P extends HasMetadata>
     extends KubernetesDependentResource<GenericKubernetesResource, P> {
 
-  private final GroupVersionKind groupVersionKind;
+  private final GroupVersionKindPlural groupVersionKind;
 
   public GenericKubernetesDependentResource(GroupVersionKind groupVersionKind) {
+    this(new GroupVersionKindPlural(groupVersionKind));
+  }
+
+  public GenericKubernetesDependentResource(GroupVersionKindPlural groupVersionKind) {
     super(GenericKubernetesResource.class);
     this.groupVersionKind = groupVersionKind;
   }
@@ -20,7 +24,7 @@ protected InformerConfiguration.InformerConfigurationBuilder<GenericKubernetesRe
   }
 
   @SuppressWarnings("unused")
-  public GroupVersionKind getGroupVersionKind() {
+  public GroupVersionKindPlural getGroupVersionKind() {
     return groupVersionKind;
   }
 }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/GroupVersionKindPlural.java

@@ -0,0 +1,58 @@
+package io.javaoperatorsdk.operator.processing.dependent.kubernetes;
+
+import java.util.Optional;
+
+import io.fabric8.kubernetes.api.Pluralize;
+import io.fabric8.kubernetes.api.model.HasMetadata;
+import io.javaoperatorsdk.operator.processing.GroupVersionKind;
+
+public class GroupVersionKindPlural extends GroupVersionKind {
+  private final String plural;
+
+  public GroupVersionKindPlural(String group, String version, String kind, String plural) {
+    super(group, version, kind);
+    this.plural = plural;
+  }
+
+  public GroupVersionKindPlural(GroupVersionKind gvk) {
+    this(gvk.getGroup(), gvk.getVersion(), gvk.getKind(),
+        gvk instanceof GroupVersionKindPlural ? ((GroupVersionKindPlural) gvk).plural : null);
+  }
+
+  public static GroupVersionKind gvkFor(String group, String version, String kind) {
+    return new GroupVersionKind(group, version, kind);
+  }
+
+  public static GroupVersionKind gvkFor(String apiVersion, String kind) {
+    return new GroupVersionKind(apiVersion, kind);
+  }
+
+  public static GroupVersionKindPlural gvkFor(Class<? extends HasMetadata> resourceClass) {
+    return new GroupVersionKindPlural(HasMetadata.getGroup(resourceClass),
+        HasMetadata.getVersion(resourceClass), HasMetadata.getKind(resourceClass),
+        HasMetadata.getPlural(resourceClass));
+  }
+
+  /**
+   * Returns the plural form associated with the kind if it has been provided explicitly (either
+   * manually by the user, or determined from the associated resource class definition)
+   *
+   * @return {@link Optional#empty()} if the plural form was not provided explicitly, or the plural
+   *         form if it was provided explicitly
+   */
+  public Optional<String> getPlural() {
+    return Optional.ofNullable(plural);
+  }
+
+  /**
+   * Returns the plural form associated with the kind if it was provided or a default, computed form
+   * via {@link Pluralize#toPlural(String)} (which should correspond to the actual plural form in
+   * most cases but might not always be correct, especially if the resource's creator defined an
+   * exotic plural form via the CRD.
+   *
+   * @return the plural form associated with the kind if provided or a default plural form otherwise
+   */
+  public String getPluralOrDefault() {
+    return getPlural().orElse(Pluralize.toPlural(getKind()));
+  }
+}

operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/GroupVersionKindTest.java

@@ -4,29 +4,26 @@
 
 import io.fabric8.kubernetes.api.model.ConfigMap;
 import io.fabric8.kubernetes.api.model.HasMetadata;
+import io.javaoperatorsdk.operator.processing.dependent.kubernetes.GroupVersionKindPlural;
 
 import static org.assertj.core.api.Assertions.assertThat;
-import static org.junit.jupiter.api.Assertions.*;
 
 class GroupVersionKindTest {
 
   @Test
   void testInitFromApiVersion() {
-    var gvk = new GroupVersionKind("v1", "ConfigMap");
+    var gvk = GroupVersionKindPlural.gvkFor("v1", "ConfigMap");
     assertThat(gvk.getGroup()).isNull();
     assertThat(gvk.getVersion()).isEqualTo("v1");
 
-    gvk = new GroupVersionKind("apps/v1", "Deployment");
+    gvk = GroupVersionKindPlural.gvkFor("apps/v1", "Deployment");
     assertThat(gvk.getGroup()).isEqualTo("apps");
     assertThat(gvk.getVersion()).isEqualTo("v1");
   }
 
   @Test
   void pluralShouldOnlyBeProvidedIfExplicitlySet() {
-    var gvk = new GroupVersionKind("v1", "ConfigMap");
-    assertThat(gvk.getPlural()).isEmpty();
-
-    gvk = GroupVersionKind.gvkFor(ConfigMap.class);
+    final var gvk = GroupVersionKindPlural.gvkFor(ConfigMap.class);
     assertThat(gvk.getPlural()).hasValue(HasMetadata.getPlural(ConfigMap.class));
   }