Code cleanup, including moving logic from DomainStatusUpdater into DomainStatus and DomainConditionCode

Author: russgold

docs/domains/Domain.json

@@ -146,8 +146,13 @@
           "type": "string"
         },
         "type": {
-          "description": "Type is the type of the condition. Currently, valid types are Progressing, Available, and Failure. Required",
-          "type": "string"
+          "description": "The type of the condition. Valid types are Progressing, Available, and Failed. Required",
+          "type": "string",
+          "enum": [
+            "Progressing",
+            "Available",
+            "Failed"
+          ]
         },
         "lastProbeTime": {
           "description": "Last time we probed the condition.",
@@ -297,6 +302,9 @@
           "type": "number",
           "minimum": 0
         },
+        "modified": {
+          "type": "boolean"
+        },
         "startTime": {
           "description": "RFC 3339 date and time at which the operator started the domain. This will be when the operator begins processing and will precede when the various servers or clusters are available.",
           "$ref": "#/definitions/DateTime"
@@ -312,7 +320,10 @@
           "description": "A human readable message indicating details about why the domain is in this condition.",
           "type": "string"
         }
-      }
+      },
+      "required": [
+        "modified"
+      ]
     },
     "KubernetesResource": {
       "type": "object",

docs/domains/Domain.md

@@ -46,6 +46,7 @@ DomainStatus represents information about the status of a domain. Status may tra
 | --- | --- | --- |
 | conditions | array of [Domain Condition](#domain-condition) | Current service state of domain. |
 | message | string | A human readable message indicating details about why the domain is in this condition. |
+| modified | boolean |  |
 | reason | string | A brief CamelCase message indicating details about why the domain is in this state. |
 | replicas | number | The number of running managed servers in the WebLogic cluster if there is only one cluster in the domain and where the cluster does not explicitly configure its replicas in a cluster specification. |
 | servers | array of [Server Status](#server-status) | Status of WebLogic servers in this domain. |
@@ -127,7 +128,7 @@ ServerPod describes the configuration for a Kubernetes pod for a server.
 | message | string | Human-readable message indicating details about last transition. |
 | reason | string | Unique, one-word, CamelCase reason for the condition's last transition. |
 | status | string | Status is the status of the condition. Can be True, False, Unknown. Required |
-| type | string | Type is the type of the condition. Currently, valid types are Progressing, Available, and Failure. Required |
+| type | string | The type of the condition. Valid types are Progressing, Available, and Failed. Required |
 
 ### Server Status
 

docs/domains/index.html

@@ -1066,8 +1066,13 @@
           "type": "string"
         },
         "type": {
-          "description": "Type is the type of the condition. Currently, valid types are Progressing, Available, and Failure. Required",
-          "type": "string"
+          "description": "The type of the condition. Valid types are Progressing, Available, and Failed. Required",
+          "type": "string",
+          "enum": [
+            "Progressing",
+            "Available",
+            "Failed"
+          ]
         },
         "lastProbeTime": {
           "description": "Last time we probed the condition.",
@@ -1217,6 +1222,9 @@
           "type": "number",
           "minimum": 0.0
         },
+        "modified": {
+          "type": "boolean"
+        },
         "startTime": {
           "description": "RFC 3339 date and time at which the operator started the domain. This will be when the operator begins processing and will precede when the various servers or clusters are available.",
           "$ref": "#/definitions/DateTime"
@@ -1232,7 +1240,10 @@
           "description": "A human readable message indicating details about why the domain is in this condition.",
           "type": "string"
         }
-      }
+      },
+      "required": [
+        "modified"
+      ]
     },
     "KubernetesResource": {
       "type": "object",

model/pom.xml

@@ -151,6 +151,11 @@
       <artifactId>junit</artifactId>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>com.meterware.simplestub</groupId>
+      <artifactId>simplestub</artifactId>
+      <scope>test</scope>
+    </dependency>
     <dependency>
       <groupId>com.fasterxml.jackson.core</groupId>
       <artifactId>jackson-databind</artifactId>

model/src/main/java/oracle/kubernetes/utils/SystemClock.java

@@ -0,0 +1,35 @@
+// Copyright 2019 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.utils;
+
+import org.joda.time.DateTime;
+
+/** A wrapper for the system clock that facilitates unit testing of time. */
+public abstract class SystemClock {
+
+  private static SystemClock DELEGATE =
+      new SystemClock() {
+        @Override
+        public DateTime getCurrentTime() {
+          return DateTime.now();
+        }
+      };
+
+  /**
+   * Returns the current time.
+   *
+   * @return a time instance
+   */
+  public static DateTime now() {
+    return DELEGATE.getCurrentTime();
+  }
+
+  /**
+   * Returns the delegate's current time.
+   *
+   * @return a time instance
+   */
+  public abstract DateTime getCurrentTime();
+}

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

@@ -287,6 +287,17 @@ public DomainStatus getStatus() {
     return status;
   }
 
+  /**
+   * DomainStatus represents information about the status of a domain. Status may trail the actual
+   * state of a system.
+   *
+   * @return Status
+   */
+  public DomainStatus getOrCreateStatus() {
+    if (status == null) status = new DomainStatus();
+    return status;
+  }
+
   /**
    * DomainStatus represents information about the status of a domain. Status may trail the actual
    * state of a system.

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

@@ -8,6 +8,7 @@
 import com.google.gson.annotations.SerializedName;
 import javax.validation.constraints.NotNull;
 import oracle.kubernetes.json.Description;
+import oracle.kubernetes.utils.SystemClock;
 import org.apache.commons.lang3.builder.EqualsBuilder;
 import org.apache.commons.lang3.builder.HashCodeBuilder;
 import org.apache.commons.lang3.builder.ToStringBuilder;
@@ -43,12 +44,15 @@ public class DomainCondition implements Comparable<DomainCondition> {
   private String status;
 
   @Description(
-      "Type is the type of the condition. Currently, valid types are Progressing, "
-          + "Available, and Failure. Required")
-  @SerializedName("type")
-  @Expose
+      "The type of the condition. Valid types are Progressing, "
+          + "Available, and Failed. Required")
   @NotNull
-  private String type;
+  private final DomainConditionType type;
+
+  public DomainCondition(DomainConditionType conditionType) {
+    lastTransitionTime = SystemClock.now();
+    type = conditionType;
+  }
 
   /**
    * Last time we probed the condition.
@@ -88,26 +92,6 @@ public DateTime getLastTransitionTime() {
     return lastTransitionTime;
   }
 
-  /**
-   * Last time the condition transitioned from one status to another.
-   *
-   * @param lastTransitionTime time
-   */
-  public void setLastTransitionTime(DateTime lastTransitionTime) {
-    this.lastTransitionTime = lastTransitionTime;
-  }
-
-  /**
-   * Last time the condition transitioned from one status to another.
-   *
-   * @param lastTransitionTime time
-   * @return this
-   */
-  public DomainCondition withLastTransitionTime(DateTime lastTransitionTime) {
-    this.lastTransitionTime = lastTransitionTime;
-    return this;
-  }
-
   /**
    * Human-readable message indicating details about last transition.
    *
@@ -117,22 +101,14 @@ public String getMessage() {
     return message;
   }
 
-  /**
-   * Human-readable message indicating details about last transition.
-   *
-   * @param message message
-   */
-  public void setMessage(String message) {
-    this.message = message;
-  }
-
   /**
    * Human-readable message indicating details about last transition.
    *
    * @param message message
    * @return this
    */
   public DomainCondition withMessage(String message) {
+    lastTransitionTime = SystemClock.now();
     this.message = message;
     return this;
   }
@@ -146,22 +122,14 @@ public String getReason() {
     return reason;
   }
 
-  /**
-   * Unique, one-word, CamelCase reason for the condition's last transition.
-   *
-   * @param reason reason
-   */
-  public void setReason(String reason) {
-    this.reason = reason;
-  }
-
   /**
    * Unique, one-word, CamelCase reason for the condition's last transition.
    *
    * @param reason reason
    * @return this
    */
   public DomainCondition withReason(String reason) {
+    lastTransitionTime = SystemClock.now();
     this.reason = reason;
     return this;
   }
@@ -175,22 +143,14 @@ public String getStatus() {
     return status;
   }
 
-  /**
-   * Status is the status of the condition. Can be True, False, Unknown. (Required)
-   *
-   * @param status status
-   */
-  public void setStatus(String status) {
-    this.status = status;
-  }
-
   /**
    * Status is the status of the condition. Can be True, False, Unknown. (Required)
    *
    * @param status status
    * @return this
    */
   public DomainCondition withStatus(String status) {
+    lastTransitionTime = SystemClock.now();
     this.status = status;
     return this;
   }
@@ -201,30 +161,12 @@ public DomainCondition withStatus(String status) {
    *
    * @return type
    */
-  public String getType() {
+  public DomainConditionType getType() {
     return type;
   }
 
-  /**
-   * Type is the type of the condition. Currently, valid types are Progressing, Available, and
-   * Failure. (Required)
-   *
-   * @param type type
-   */
-  public void setType(String type) {
-    this.type = type;
-  }
-
-  /**
-   * Type is the type of the condition. Currently, valid types are Progressing, Available, and
-   * Failure. (Required)
-   *
-   * @param type type
-   * @return this
-   */
-  public DomainCondition withType(String type) {
-    this.type = type;
-    return this;
+  public boolean hasType(DomainConditionType type) {
+    return type == this.type;
   }
 
   @Override
@@ -243,10 +185,8 @@ public String toString() {
   public int hashCode() {
     return new HashCodeBuilder()
         .append(reason)
-        .append(lastTransitionTime)
         .append(message)
         .append(type)
-        .append(lastProbeTime)
         .append(status)
         .toHashCode();
   }
@@ -256,16 +196,14 @@ public boolean equals(Object other) {
     if (other == this) {
       return true;
     }
-    if ((other instanceof DomainCondition) == false) {
+    if (!(other instanceof DomainCondition)) {
       return false;
     }
     DomainCondition rhs = ((DomainCondition) other);
     return new EqualsBuilder()
         .append(reason, rhs.reason)
-        .append(lastTransitionTime, rhs.lastTransitionTime)
         .append(message, rhs.message)
         .append(type, rhs.type)
-        .append(lastProbeTime, rhs.lastProbeTime)
         .append(status, rhs.status)
         .isEquals();
   }

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

@@ -0,0 +1,11 @@
+// Copyright 2019 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;
+
+public enum DomainConditionType {
+  Progressing,
+  Available,
+  Failed
+}