Merge pull request #544 from oracle/service_label_and_annotation

OWLS-68701 -- Support for additional service labels and annotations

Author: rjeberhard

model/src/main/java/oracle/kubernetes/weblogic/domain/AdminServerConfigurator.java

@@ -16,4 +16,8 @@ public interface AdminServerConfigurator extends ServerConfigurator {
   AdminServerConfigurator withExportedNetworkAccessPoints(String... names);
 
   ExportedNetworkAccessPoint configureExportedNetworkAccessPoint(String channelName);
+
+  AdminServerConfigurator withNodePortLabel(String name, String value);
+
+  AdminServerConfigurator withNodePortAnnotation(String name, String value);
 }

model/src/main/java/oracle/kubernetes/weblogic/domain/ClusterConfigurator.java

@@ -43,4 +43,8 @@ ClusterConfigurator withLivenessProbeSettings(
   ClusterConfigurator withPodLabel(String name, String value);
 
   ClusterConfigurator withPodAnnotation(String name, String value);
+
+  ClusterConfigurator withServiceLabel(String name, String value);
+
+  ClusterConfigurator withServiceAnnotation(String name, String value);
 }

model/src/main/java/oracle/kubernetes/weblogic/domain/ServerConfigurator.java

@@ -41,4 +41,8 @@ ServerConfigurator withReadinessProbeSettings(
   ServerConfigurator withPodLabel(String name, String value);
 
   ServerConfigurator withPodAnnotation(String name, String value);
+
+  ServerConfigurator withServiceLabel(String name, String value);
+
+  ServerConfigurator withServiceAnnotation(String name, String value);
 }

model/src/main/java/oracle/kubernetes/weblogic/domain/v2/AdminServer.java

@@ -52,6 +52,8 @@ public String toString() {
     return new ToStringBuilder(this)
         .appendSuper(super.toString())
         .append("exportedNetworkAccessPoints", exportedNetworkAccessPoints)
+        .append("nodePortLabels", nodePortLabels)
+        .append("nodePortAnnotations", nodePortAnnotations)
         .toString();
   }
 
@@ -66,6 +68,8 @@ public boolean equals(Object o) {
     return new EqualsBuilder()
         .appendSuper(super.equals(o))
         .append(exportedNetworkAccessPoints, that.exportedNetworkAccessPoints)
+        .append(nodePortLabels, that.nodePortLabels)
+        .append(nodePortAnnotations, that.nodePortAnnotations)
         .isEquals();
   }
 
@@ -74,6 +78,20 @@ public int hashCode() {
     return new HashCodeBuilder(17, 37)
         .appendSuper(super.hashCode())
         .append(exportedNetworkAccessPoints)
+        .append(nodePortLabels)
+        .append(nodePortAnnotations)
         .toHashCode();
   }
+
+  private Map<String, String> nodePortLabels = new HashMap<>();
+
+  private Map<String, String> nodePortAnnotations = new HashMap<>();
+
+  void addNodePortLabels(String name, String value) {
+    nodePortLabels.put(name, value);
+  }
+
+  void addNodePortAnnotations(String name, String value) {
+    nodePortAnnotations.put(name, value);
+  }
 }

model/src/main/java/oracle/kubernetes/weblogic/domain/v2/BaseConfiguration.java

@@ -194,6 +194,22 @@ void addPodAnnotations(String name, String value) {
     serverPod.addPodAnnotations(name, value);
   }
 
+  public Map<String, String> getServiceLabels() {
+    return serverPod.getServiceLabels();
+  }
+
+  void addServiceLabels(String name, String value) {
+    serverPod.addServiceLabel(name, value);
+  }
+
+  public Map<String, String> getServiceAnnotations() {
+    return serverPod.getServiceAnnotations();
+  }
+
+  void addServiceAnnotations(String name, String value) {
+    serverPod.addServiceAnnotations(name, value);
+  }
+
   @Override
   public String toString() {
     return new ToStringBuilder(this)

model/src/main/java/oracle/kubernetes/weblogic/domain/v2/DomainV2Configurator.java

@@ -136,6 +136,18 @@ public AdminServerConfigurator withNodePort(int nodePort) {
       return this;
     }
 
+    @Override
+    public AdminServerConfigurator withNodePortLabel(String name, String value) {
+      adminServer.addNodePortLabels(name, value);
+      return this;
+    }
+
+    @Override
+    public AdminServerConfigurator withNodePortAnnotation(String name, String value) {
+      adminServer.addNodePortAnnotations(name, value);
+      return this;
+    }
+
     @Override
     public AdminServerConfigurator withExportedNetworkAccessPoints(String... names) {
       for (String name : names) {
@@ -304,6 +316,18 @@ public ServerConfigurator withPodAnnotation(String name, String value) {
       server.addPodAnnotations(name, value);
       return this;
     }
+
+    @Override
+    public ServerConfigurator withServiceLabel(String name, String value) {
+      server.addServiceLabels(name, value);
+      return this;
+    }
+
+    @Override
+    public ServerConfigurator withServiceAnnotation(String name, String value) {
+      server.addServiceAnnotations(name, value);
+      return this;
+    }
   }
 
   @Override
@@ -436,5 +460,17 @@ public ClusterConfigurator withPodAnnotation(String name, String value) {
       cluster.addPodAnnotations(name, value);
       return this;
     }
+
+    @Override
+    public ClusterConfigurator withServiceLabel(String name, String value) {
+      cluster.addServiceLabels(name, value);
+      return this;
+    }
+
+    @Override
+    public ClusterConfigurator withServiceAnnotation(String name, String value) {
+      cluster.addServiceAnnotations(name, value);
+      return this;
+    }
   }
 }

model/src/main/java/oracle/kubernetes/weblogic/domain/v2/ServerPod.java

@@ -155,6 +155,26 @@ class ServerPod {
   @Description("Annotations applied to pods")
   private Map<String, String> podAnnotations = new HashMap<String, String>();
 
+  /**
+   * The labels to be attached to Service.
+   *
+   * @since 2.0
+   */
+  @SerializedName("serviceLabels")
+  @Expose
+  @Description("Labels applied to services")
+  private Map<String, String> serviceLabels = new HashMap<String, String>();
+
+  /**
+   * The annotations to be attached to Service.
+   *
+   * @since 2.0
+   */
+  @SerializedName("serviceAnnotations")
+  @Expose
+  @Description("Annotations applied to services")
+  private Map<String, String> serviceAnnotations = new HashMap<String, String>();
+
   ProbeTuning getReadinessProbeTuning() {
     return this.readinessProbeTuning;
   }
@@ -185,6 +205,8 @@ void fillInFrom(ServerPod serverPod1) {
     for (V1VolumeMount var : serverPod1.getAdditionalVolumeMounts()) addIfMissing(var);
     serverPod1.getPodLabels().forEach((k, v) -> addPodLabelIfMissing(k, v));
     serverPod1.getPodAnnotations().forEach((k, v) -> addPodAnnotationIfMissing(k, v));
+    serverPod1.getServiceAnnotations().forEach((k, v) -> addServiceAnnotationIfMissing(k, v));
+    serverPod1.getServiceLabels().forEach((k, v) -> addServiceLabelIfMissing(k, v));
     serverPod1.nodeSelectorMap.forEach(nodeSelectorMap::putIfAbsent);
     copyValues(resourceRequirements, serverPod1.resourceRequirements);
     copyValues(podSecurityContext, serverPod1.podSecurityContext);
@@ -293,6 +315,14 @@ private void addPodAnnotationIfMissing(String name, String value) {
     if (!podAnnotations.containsKey(name)) podAnnotations.put(name, value);
   }
 
+  private void addServiceLabelIfMissing(String name, String value) {
+    if (!serviceLabels.containsKey(name)) serviceLabels.put(name, value);
+  }
+
+  private void addServiceAnnotationIfMissing(String name, String value) {
+    if (!serviceAnnotations.containsKey(name)) serviceAnnotations.put(name, value);
+  }
+
   List<V1EnvVar> getEnv() {
     return this.env;
   }
@@ -391,6 +421,22 @@ public Map<String, String> getPodAnnotations() {
     return podAnnotations;
   }
 
+  void addServiceLabel(String name, String value) {
+    serviceLabels.put(name, value);
+  }
+
+  void addServiceAnnotations(String name, String value) {
+    serviceAnnotations.put(name, value);
+  }
+
+  public Map<String, String> getServiceLabels() {
+    return serviceLabels;
+  }
+
+  public Map<String, String> getServiceAnnotations() {
+    return serviceAnnotations;
+  }
+
   @Override
   public String toString() {
     return new ToStringBuilder(this)
@@ -401,6 +447,8 @@ public String toString() {
         .append("additionalVolumeMounts", additionalVolumeMounts)
         .append("podLabels", podLabels)
         .append("podAnnotations", podAnnotations)
+        .append("serviceLabels", serviceLabels)
+        .append("serviceAnnotations", serviceAnnotations)
         .append("nodeSelector", nodeSelectorMap)
         .append("resourceRequirements", resourceRequirements)
         .append("podSecurityContext", podSecurityContext)
@@ -424,6 +472,8 @@ public boolean equals(Object o) {
         .append(additionalVolumeMounts, that.additionalVolumeMounts)
         .append(podLabels, that.podLabels)
         .append(podAnnotations, that.podAnnotations)
+        .append(serviceLabels, that.serviceLabels)
+        .append(serviceAnnotations, that.serviceAnnotations)
         .append(nodeSelectorMap, that.nodeSelectorMap)
         .append(resourceRequirements, that.resourceRequirements)
         .append(podSecurityContext, that.podSecurityContext)
@@ -441,6 +491,8 @@ public int hashCode() {
         .append(additionalVolumeMounts)
         .append(podLabels)
         .append(podAnnotations)
+        .append(serviceLabels)
+        .append(serviceAnnotations)
         .append(nodeSelectorMap)
         .append(resourceRequirements)
         .append(podSecurityContext)

model/src/main/java/oracle/kubernetes/weblogic/domain/v2/ServerSpec.java

@@ -179,6 +179,22 @@ public ProbeTuning getReadinessProbe() {
   @Nonnull
   public abstract Map<String, String> getPodAnnotations();
 
+  /**
+   * Returns the labels applied to the service.
+   *
+   * @return a map of labels
+   */
+  @Nonnull
+  public abstract Map<String, String> getServiceLabels();
+
+  /**
+   * Returns the annotations applied to the service.
+   *
+   * @return a map of annotations
+   */
+  @Nonnull
+  public abstract Map<String, String> getServiceAnnotations();
+
   @Nonnull
   public Map<String, String> getListenAddressServiceLabels() {
     return Collections.emptyMap();

model/src/main/java/oracle/kubernetes/weblogic/domain/v2/ServerSpecV2Impl.java

@@ -73,6 +73,16 @@ public Map<String, String> getPodAnnotations() {
     return server.getPodAnnotations();
   }
 
+  @Override
+  public Map<String, String> getServiceLabels() {
+    return server.getServiceLabels();
+  }
+
+  @Override
+  public Map<String, String> getServiceAnnotations() {
+    return server.getServiceAnnotations();
+  }
+
   @Override
   public String getDesiredState() {
     return Optional.ofNullable(getConfiguredDesiredState()).orElse("RUNNING");

model/src/test/java/oracle/kubernetes/weblogic/domain/v2/AdminServerTest.java

@@ -33,7 +33,7 @@ public void whenExportedAccessPointsAreTheSame_objectsAreEqual() {
         .addAnnotation("annotation1", "value2")
         .addLabel("label1", "value1");
 
-    assertThat(server1, equalTo(server1));
+    assertThat(server1, equalTo(server2));
   }
 
   @Test
@@ -59,4 +59,30 @@ public void whenExportedAccessPointsDifferByAnnotation_objectsAreNotEqual() {
 
     assertThat(server1, not(equalTo(server2)));
   }
+
+  @Test
+  public void whenNodePortAnnotationsDiffer_objectsAreNotEqual() {
+    server1.addNodePortAnnotations("key", "value");
+    assertThat(server1, not(equalTo(server2)));
+  }
+
+  @Test
+  public void whenNodePortAnnotationsAreSame_objectsAreEqual() {
+    server1.addNodePortAnnotations("key", "value");
+    server2.addNodePortAnnotations("key", "value");
+    assertThat(server1, equalTo(server2));
+  }
+
+  @Test
+  public void whenNodePortLabelsDiffer_hashCodesAreNotEqual() {
+    server1.addNodePortLabels("key", "value");
+    assertThat(server1.hashCode(), not(equalTo(server2.hashCode())));
+  }
+
+  @Test
+  public void whenNodePortLabelsAreSame_hashCodesAreEqual() {
+    server1.addNodePortLabels("key", "value");
+    server2.addNodePortLabels("key", "value");
+    assertThat(server1.hashCode(), equalTo(server2.hashCode()));
+  }
 }