fix: make getPlural return Optional to show whether plural is known

Signed-off-by: Chris Laprun <[email protected]>

Author: metacosm

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

@@ -1,6 +1,7 @@
 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;
@@ -22,7 +23,7 @@ public GroupVersionKind(String apiVersion, String kind) {
       this.group = groupAndVersion[0];
       this.version = groupAndVersion[1];
     }
-    this.plural = Pluralize.toPlural(kind);
+    this.plural = null;
     this.apiVersion = apiVersion;
   }
 
@@ -34,7 +35,7 @@ public GroupVersionKind(String group, String version, String kind, String plural
     this.group = group;
     this.version = version;
     this.kind = kind;
-    this.plural = plural != null ? plural : Pluralize.toPlural(kind);
+    this.plural = plural;
     this.apiVersion = (group == null || group.isBlank()) ? version : group + "/" + version;
   }
 
@@ -56,8 +57,16 @@ public String getKind() {
     return kind;
   }
 
-  public String getPlural() {
-    return plural;
+  /**
+   * 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() {

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

@@ -2,6 +2,9 @@
 
 import org.junit.jupiter.api.Test;
 
+import io.fabric8.kubernetes.api.model.ConfigMap;
+import io.fabric8.kubernetes.api.model.HasMetadata;
+
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.jupiter.api.Assertions.*;
 
@@ -18,4 +21,13 @@ void testInitFromApiVersion() {
     assertThat(gvk.getVersion()).isEqualTo("v1");
   }
 
+  @Test
+  void pluralShouldOnlyBeProvidedIfExplicitlySet() {
+    var gvk = new GroupVersionKind("v1", "ConfigMap");
+    assertThat(gvk.getPlural()).isEmpty();
+
+    gvk = GroupVersionKind.gvkFor(ConfigMap.class);
+    assertThat(gvk.getPlural()).hasValue(HasMetadata.getPlural(ConfigMap.class));
+  }
+
 }