Merge pull request #487 from oracle/owls-69904-nest_serverPod

Move env, livenessProbe and readinessProbe under serverPod

Author: rjeberhard

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

@@ -11,7 +11,6 @@
 import io.kubernetes.client.models.V1EnvVar;
 import io.kubernetes.client.models.V1LocalObjectReference;
 import io.kubernetes.client.models.V1PodSecurityContext;
-import io.kubernetes.client.models.V1Probe;
 import io.kubernetes.client.models.V1ResourceRequirements;
 import io.kubernetes.client.models.V1SecurityContext;
 import io.kubernetes.client.models.V1Volume;
@@ -23,6 +22,7 @@
 import java.util.Optional;
 import javax.annotation.Nonnull;
 import oracle.kubernetes.operator.KubernetesConstants;
+import oracle.kubernetes.weblogic.domain.v2.ProbeTuning;
 import org.apache.commons.lang3.builder.EqualsBuilder;
 import org.apache.commons.lang3.builder.HashCodeBuilder;
 import org.apache.commons.lang3.builder.ToStringBuilder;
@@ -142,13 +142,13 @@ public List<V1Volume> getAdditionalVolumes() {
   }
 
   @Nonnull
-  public V1Probe getLivenessProbe() {
-    return new V1Probe();
+  public ProbeTuning getLivenessProbe() {
+    return new ProbeTuning();
   }
 
   @Nonnull
-  public V1Probe getReadinessProbe() {
-    return new V1Probe();
+  public ProbeTuning getReadinessProbe() {
+    return new ProbeTuning();
   }
 
   @Nonnull

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

@@ -4,18 +4,12 @@
 
 package oracle.kubernetes.weblogic.domain.v2;
 
-import static java.util.Collections.emptyList;
-
 import com.google.gson.annotations.Expose;
 import com.google.gson.annotations.SerializedName;
 import io.kubernetes.client.models.V1EnvVar;
-import io.kubernetes.client.models.V1Probe;
-import java.util.ArrayList;
 import java.util.List;
 import java.util.Objects;
-import java.util.Optional;
 import javax.annotation.Nullable;
-import javax.validation.Valid;
 import oracle.kubernetes.json.Description;
 import org.apache.commons.lang3.builder.EqualsBuilder;
 import org.apache.commons.lang3.builder.HashCodeBuilder;
@@ -29,16 +23,8 @@
  */
 public abstract class BaseConfiguration {
 
-  /**
-   * Environment variables to pass while starting a server.
-   *
-   * @since 2.0
-   */
-  @SerializedName("env")
-  @Expose
-  @Valid
-  @Description("A list of environment variables to add to a server")
-  private List<V1EnvVar> env = new ArrayList<>();
+  @Description("Configuration affecting the server pod")
+  private ServerPod serverPod = new ServerPod();
 
   /** Desired startup state. Legal values are RUNNING or ADMIN. */
   @SerializedName("serverStartState")
@@ -61,28 +47,6 @@ public abstract class BaseConfiguration {
           + "Legal values are NEVER, ALWAYS, or IF_NEEDED.")
   private String serverStartPolicy;
 
-  /**
-   * Defines the settings for the liveness probe. Any that are not specified will default to the
-   * runtime liveness probe tuning settings.
-   *
-   * @since 2.0
-   */
-  @SerializedName("livenessProbe")
-  @Expose
-  @Description("Settings for the liveness probe associated with a server")
-  private V1Probe livenessProbe = new V1Probe();
-
-  /**
-   * Defines the settings for the readiness probe. Any that are not specified will default to the
-   * runtime readiness probe tuning settings.
-   *
-   * @since 2.0
-   */
-  @SerializedName("readinessProbe")
-  @Expose
-  @Description("Settings for the readiness probe associated with a server")
-  private V1Probe readinessProbe = new V1Probe();
-
   /**
    * Fills in any undefined settings in this configuration from another configuration.
    *
@@ -94,9 +58,7 @@ void fillInFrom(BaseConfiguration other) {
     if (serverStartState == null) serverStartState = other.getServerStartState();
     if (overrideStartPolicyFrom(other)) serverStartPolicy = other.getServerStartPolicy();
 
-    for (V1EnvVar var : getV1EnvVars(other)) addIfMissing(var);
-    copyValues(livenessProbe, other.livenessProbe);
-    copyValues(readinessProbe, other.readinessProbe);
+    serverPod.fillInFrom(other.serverPod);
   }
 
   private boolean overrideStartPolicyFrom(BaseConfiguration other) {
@@ -112,37 +74,13 @@ private boolean isStartNever() {
     return Objects.equals(getServerStartPolicy(), ConfigurationConstants.START_NEVER);
   }
 
-  private List<V1EnvVar> getV1EnvVars(BaseConfiguration configuration) {
-    return Optional.ofNullable(configuration.getEnv()).orElse(emptyList());
-  }
-
-  private void addIfMissing(V1EnvVar var) {
-    if (!hasEnvVar(var.getName())) addEnvVar(var);
-  }
-
-  private boolean hasEnvVar(String name) {
-    if (env == null) return false;
-    for (V1EnvVar var : env) {
-      if (var.getName().equals(name)) return true;
-    }
-    return false;
-  }
-
-  private void copyValues(V1Probe toProbe, V1Probe fromProbe) {
-    if (toProbe.getInitialDelaySeconds() == null)
-      toProbe.setInitialDelaySeconds(fromProbe.getInitialDelaySeconds());
-    if (toProbe.getTimeoutSeconds() == null)
-      toProbe.setTimeoutSeconds(fromProbe.getTimeoutSeconds());
-    if (toProbe.getPeriodSeconds() == null) toProbe.setPeriodSeconds(fromProbe.getPeriodSeconds());
-  }
-
   /**
    * Returns true if any version 2 configuration fields are specified.
    *
    * @return whether there is version 2 configuration field in this instance
    */
   protected boolean hasV2Fields() {
-    return serverStartState != null || serverStartPolicy != null || !env.isEmpty();
+    return serverStartState != null || serverStartPolicy != null || serverPod.hasV2Fields();
   }
 
   @Nullable
@@ -156,20 +94,15 @@ void setServerStartState(@Nullable String serverStartState) {
 
   @Nullable
   public List<V1EnvVar> getEnv() {
-    return env;
+    return serverPod.getEnv();
   }
 
   public void setEnv(@Nullable List<V1EnvVar> env) {
-    this.env = env;
+    serverPod.setEnv(env);
   }
 
   void addEnvironmentVariable(String name, String value) {
-    addEnvVar(new V1EnvVar().name(name).value(value));
-  }
-
-  private void addEnvVar(V1EnvVar var) {
-    if (env == null) setEnv(new ArrayList<>());
-    env.add(var);
+    serverPod.addEnvVar(new V1EnvVar().name(name).value(value));
   }
 
   void setServerStartPolicy(String serverStartPolicy) {
@@ -181,33 +114,27 @@ protected String getServerStartPolicy() {
   }
 
   void setLivenessProbe(Integer initialDelay, Integer timeout, Integer period) {
-    livenessProbe.initialDelaySeconds(initialDelay).timeoutSeconds(timeout).periodSeconds(period);
+    serverPod.setLivenessProbe(initialDelay, timeout, period);
   }
 
-  V1Probe getLivenessProbe() {
-    return livenessProbe;
+  ProbeTuning getLivenessProbe() {
+    return serverPod.getLivenessProbeTuning();
   }
 
   void setReadinessProbe(Integer initialDelay, Integer timeout, Integer period) {
-    readinessProbe.initialDelaySeconds(initialDelay).timeoutSeconds(timeout).periodSeconds(period);
+    serverPod.setReadinessProbeTuning(initialDelay, timeout, period);
   }
 
-  V1Probe getReadinessProbe() {
-    return readinessProbe;
+  ProbeTuning getReadinessProbe() {
+    return serverPod.getReadinessProbeTuning();
   }
 
   @Override
   public String toString() {
     return new ToStringBuilder(this)
         .append("serverStartState", serverStartState)
         .append("serverStartPolicy", serverStartPolicy)
-        .append("livenessProbe.initialDelaySeconds", livenessProbe.getInitialDelaySeconds())
-        .append("livenessProbe.timeoutSeconds", livenessProbe.getTimeoutSeconds())
-        .append("livenessProbe.periodSeconds", livenessProbe.getPeriodSeconds())
-        .append("readinessProbeProbe.initialDelaySeconds", readinessProbe.getInitialDelaySeconds())
-        .append("readinessProbe.timeoutSeconds", readinessProbe.getTimeoutSeconds())
-        .append("readinessProbe.periodSeconds", readinessProbe.getPeriodSeconds())
-        .append("env", env)
+        .append("serverPod", serverPod)
         .toString();
   }
 
@@ -220,22 +147,18 @@ public boolean equals(Object o) {
     BaseConfiguration that = (BaseConfiguration) o;
 
     return new EqualsBuilder()
-        .append(env, that.env)
+        .append(serverPod, that.serverPod)
         .append(serverStartState, that.serverStartState)
         .append(serverStartPolicy, that.serverStartPolicy)
-        .append(livenessProbe, that.livenessProbe)
-        .append(readinessProbe, that.readinessProbe)
         .isEquals();
   }
 
   @Override
   public int hashCode() {
     return new HashCodeBuilder(17, 37)
-        .append(env)
+        .append(serverPod)
         .append(serverStartState)
         .append(serverStartPolicy)
-        .append(livenessProbe)
-        .append(readinessProbe)
         .toHashCode();
   }
 }

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

@@ -0,0 +1,86 @@
+// Copyright 2018, Oracle Corporation and/or its affiliates.  All rights reserved.
+// Licensed under the Universal Permissive License v 1.0 as shown at
+// http://oss.oracle.com/licenses/upl.
+
+package oracle.kubernetes.weblogic.domain.v2;
+
+import com.google.gson.annotations.SerializedName;
+import oracle.kubernetes.json.Description;
+import org.apache.commons.lang3.builder.EqualsBuilder;
+import org.apache.commons.lang3.builder.HashCodeBuilder;
+import org.apache.commons.lang3.builder.ToStringBuilder;
+
+public class ProbeTuning {
+  @Description("The number of seconds before the first check is performed")
+  private Integer initialDelaySeconds = null;
+
+  @Description("The number of seconds between checks")
+  @SerializedName("periodSeconds")
+  private Integer periodSeconds = null;
+
+  @Description("The number of seconds with no response that indicates a failure")
+  @SerializedName("timeoutSeconds")
+  private Integer timeoutSeconds = null;
+
+  public ProbeTuning() {}
+
+  public Integer getInitialDelaySeconds() {
+    return initialDelaySeconds;
+  }
+
+  public ProbeTuning initialDelaySeconds(Integer initialDelaySeconds) {
+    this.initialDelaySeconds = initialDelaySeconds;
+    return this;
+  }
+
+  public Integer getPeriodSeconds() {
+    return periodSeconds;
+  }
+
+  public ProbeTuning periodSeconds(Integer periodSeconds) {
+    this.periodSeconds = periodSeconds;
+    return this;
+  }
+
+  public Integer getTimeoutSeconds() {
+    return timeoutSeconds;
+  }
+
+  public ProbeTuning timeoutSeconds(Integer timeoutSeconds) {
+    this.timeoutSeconds = timeoutSeconds;
+    return this;
+  }
+
+  @Override
+  public String toString() {
+    return new ToStringBuilder(this)
+        .append("initialDelaySeconds", initialDelaySeconds)
+        .append("periodSeconds", periodSeconds)
+        .append("timeoutSeconds", timeoutSeconds)
+        .toString();
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) return true;
+
+    if (o == null || getClass() != o.getClass()) return false;
+
+    ProbeTuning that = (ProbeTuning) o;
+
+    return new EqualsBuilder()
+        .append(initialDelaySeconds, that.initialDelaySeconds)
+        .append(periodSeconds, that.periodSeconds)
+        .append(timeoutSeconds, that.timeoutSeconds)
+        .isEquals();
+  }
+
+  @Override
+  public int hashCode() {
+    return new HashCodeBuilder(17, 37)
+        .append(initialDelaySeconds)
+        .append(periodSeconds)
+        .append(timeoutSeconds)
+        .toHashCode();
+  }
+}