Merge branch 'russ_owls_109616' into 'main'

Use getClusterResourceName to access the name of the resource

See merge request weblogic-cloud/weblogic-kubernetes-operator!4309

Author: rjeberhard

operator/src/main/java/oracle/kubernetes/operator/http/rest/RestBackendImpl.java

@@ -1,4 +1,4 @@
-// Copyright (c) 2017, 2022, Oracle and/or its affiliates.
+// Copyright (c) 2017, 2023, Oracle and/or its affiliates.
 // Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 
 package oracle.kubernetes.operator.http.rest;
@@ -288,18 +288,18 @@ private Optional<ClusterResource> getClusterResource(DomainResource domain, Stri
         .findFirst();
   }
 
-  private boolean isInSameNamespace(ClusterResource c, DomainResource domain) {
-    return Objects.equals(c.getNamespace(), domain.getNamespace());
+  private boolean isInSameNamespace(ClusterResource clusterResource, DomainResource domain) {
+    return Objects.equals(clusterResource.getNamespace(), domain.getNamespace());
   }
 
-  private boolean isReferencedByDomain(ClusterResource c, List<String> referencedClusterResources) {
+  private boolean isReferencedByDomain(ClusterResource clusterResource, List<String> referencedClusterResources) {
     return Optional.ofNullable(referencedClusterResources)
-        .map(l -> l.contains(c.getMetadata().getName()))
+        .map(l -> l.contains(clusterResource.getClusterResourceName()))
         .orElse(false);
   }
 
-  private boolean isMatchingClusterResource(String clusterName, ClusterResource c) {
-    return clusterName.equals(c.getClusterName());
+  private boolean isMatchingClusterResource(String clusterName, ClusterResource clusterResource) {
+    return clusterName.equals(clusterResource.getClusterName());
   }
 
   @Override
@@ -370,7 +370,7 @@ private void patchCluster(ClusterResource cluster, JsonPatchBuilder patchBuilder
     try {
       callBuilder
               .patchCluster(
-                      cluster.getMetadata().getName(), cluster.getMetadata().getNamespace(),
+                      cluster.getClusterResourceName(), cluster.getNamespace(),
                       new V1Patch(patchBuilder.build().toString()));
     } catch (ApiException e) {
       throw handleApiException(e);

operator/src/main/java/oracle/kubernetes/weblogic/domain/model/ClusterResource.java

@@ -19,12 +19,14 @@
 import org.apache.commons.lang3.builder.HashCodeBuilder;
 import org.apache.commons.lang3.builder.ToStringBuilder;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 /**
  * An element representing a cluster in the domain configuration.
  *
  * @since 4.0
  */
+@SuppressWarnings("JavadocLinkAsPlainText")
 @Description(
     "A Cluster resource describes the lifecycle options for all "
     + "of the Managed Server members of a WebLogic cluster, including Java "
@@ -80,8 +82,30 @@ public class ClusterResource implements KubernetesObject {
   @Description("The current status of the operation of the WebLogic cluster. Updated automatically by the operator.")
   private ClusterStatus status;
 
+  public ClusterResource() {
+  }
+
+  /**
+   * Returns the Kubernetes name of this cluster resource. This must be unique within a namespace and should not be
+   * confused with {@link #getClusterName()}.
+   */
+  @Nullable
+  public String getClusterResourceName() {
+    return getMetadata().getName();
+  }
+
+  /**
+   * Returns the WebLogic name of the cluster represented by this resource. It should not be confused with
+   * {@link #getClusterResourceName()}.
+   */
+  @Nonnull
   public String getClusterName() {
-    return Optional.ofNullable(spec.getClusterName()).orElse(getMetadata().getName());
+    return spec.getClusterName();
+  }
+
+  ClusterResource withClusterName(String clusterName) {
+    spec.withClusterName(clusterName);
+    return this;
   }
 
   Integer getReplicas() {

operator/src/main/java/oracle/kubernetes/weblogic/domain/model/DomainResource.java

@@ -1407,9 +1407,9 @@ private void verifyClusterResourcesNotInUse(
     private void verifyClusterNotInUseByAnotherDomain(KubernetesResourceLookup kubernetesResources,
                                                       ClusterResource cluster) {
       String domainAlreadyReferenceCluster =
-          getReferencingDomains(kubernetesResources, cluster.getNamespace(), cluster.getMetadata().getName());
+          getReferencingDomains(kubernetesResources, cluster.getNamespace(), cluster.getClusterResourceName());
       if (domainAlreadyReferenceCluster != null) {
-        failures.add(clusterInUse(cluster.getMetadata().getName(), domainAlreadyReferenceCluster));
+        failures.add(clusterInUse(cluster.getClusterResourceName(), domainAlreadyReferenceCluster));
       }
     }
 

operator/src/test/java/oracle/kubernetes/operator/http/rest/RestBackendImplTest.java

@@ -1,4 +1,4 @@
-// Copyright (c) 2018, 2022, Oracle and/or its affiliates.
+// Copyright (c) 2018, 2023, Oracle and/or its affiliates.
 // Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 
 package oracle.kubernetes.operator.http.rest;
@@ -328,7 +328,7 @@ void whenPerClusterResourceReplicaSetting_scaleClusterUpdatesClusterResource() {
             .withReplicas(1);
     testSupport.defineResources(clusterResource);
 
-    configureDomain().withClusterReference(clusterResource.getMetadata().getName());
+    configureDomain().withClusterReference(clusterResource.getClusterResourceName());
     restBackend.scaleCluster(DOMAIN1, CLUSTER_1, 5);
 
     assertThat(getUpdatedClusterResource().getSpec().getReplicas(), equalTo(5));
@@ -340,7 +340,7 @@ void whenPerClusterResourceReplicaSetting_NullReplica_scaleClusterUpdatesCluster
     clusterResource.getSpec().setReplicas(null);
     testSupport.defineResources(clusterResource);
 
-    configureDomain().withClusterReference(clusterResource.getMetadata().getName());
+    configureDomain().withClusterReference(clusterResource.getClusterResourceName());
     restBackend.scaleCluster(DOMAIN1, CLUSTER_1, 5);
 
     assertThat(getUpdatedClusterResource().getSpec().getReplicas(), equalTo(5));
@@ -351,7 +351,7 @@ void whenMultipleClusterResourceWithSameClusterName_scaleClusterUpdatesClusterIn
     defineClusterResources(new String[] {DOMAIN2, DOMAIN1, DOMAIN3}, new String[] {NS, NS, NS});
     restBackend.scaleCluster(DOMAIN1, CLUSTER_1, 5);
 
-    assertThat(getUpdatedClusterResource().getMetadata().getName(), equalTo(DOMAIN1 + '-' + CLUSTER_1));
+    assertThat(getUpdatedClusterResource().getClusterResourceName(), equalTo(DOMAIN1 + '-' + CLUSTER_1));
     assertThat(getUpdatedClusterResource().getSpec().getReplicas(), equalTo(5));
   }
 

operator/src/test/java/oracle/kubernetes/weblogic/domain/model/ClusterResourceTest.java

@@ -1,4 +1,4 @@
-// Copyright (c) 2022, Oracle and/or its affiliates.
+// Copyright (c) 2022, 2023, Oracle and/or its affiliates.
 // Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 
 package oracle.kubernetes.weblogic.domain.model;
@@ -41,16 +41,9 @@ void canReadClusterNameFromSpec() {
   }
 
   @Test
-  void canReadClusterNameFromMetadata() {
+  void canReadClusterResourceNameFromMetadata() {
     resource.setMetadata(new V1ObjectMeta().name("cluster-2"));
 
-    assertThat(resource.getClusterName(), equalTo("cluster-2"));
-  }
-
-  @Test
-  void whenNameInBothMetadataAndSpec_useNameFromSpec() {
-    resource.withMetadata(new V1ObjectMeta().name("cluster-2")).spec(new ClusterSpec().withClusterName("cluster-1"));
-
-    assertThat(resource.getClusterName(), equalTo("cluster-1"));
+    assertThat(resource.getClusterResourceName(), equalTo("cluster-2"));
   }
 }

operator/src/test/java/oracle/kubernetes/weblogic/domain/model/DomainValidationTestBase.java

@@ -65,7 +65,7 @@ <T extends KubernetesObject> T getPlaceholder(String name,
         return (T) new V1Secret().metadata(meta);
       }
       if (ClusterResource.class.equals(type)) {
-        return (T) new ClusterResource().withMetadata(meta);
+        return (T) new ClusterResource().withMetadata(meta).withClusterName(name);
       }
       if (DomainResource.class.equals(type)) {
         return (T) new DomainResource().withMetadata(meta);