Add validations for string patterns and numeric ranges

Author: russgold

json-schema/src/main/java/oracle/kubernetes/json/Pattern.java

@@ -0,0 +1,18 @@
+// 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.json;
+
+import static java.lang.annotation.ElementType.FIELD;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/** Supplies an ECMA 262 regular expression that the field must match. */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(FIELD)
+public @interface Pattern {
+  String value();
+}

json-schema/src/main/java/oracle/kubernetes/json/Range.java

@@ -0,0 +1,20 @@
+// 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.json;
+
+import static java.lang.annotation.ElementType.FIELD;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/** Specifies minimum and/or maximum permitted values for the field. */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(FIELD)
+public @interface Range {
+  int minimum() default Integer.MIN_VALUE;
+
+  int maximum() default Integer.MAX_VALUE;
+}

json-schema/src/main/java/oracle/kubernetes/json/SchemaGenerator.java

@@ -197,17 +197,33 @@ private Object getSubSchema(Field field) {
     sub.generateTypeIn(result, field.getType());
     String description = getDescription(field);
     if (description != null) result.put("description", description);
-    Class<? extends java.lang.Enum> enumClass = getEnumClass(field);
-    if (enumClass != null) addEnumValues(result, enumClass);
+    if (isString(field.getType())) addStringRestrictions(result, field);
+    if (isNumeric(field.getType())) addRange(result, field);
 
     return result;
   }
 
+  private boolean isString(Class<?> type) {
+    return type.equals(String.class);
+  }
+
+  private boolean isNumeric(Class<?> type) {
+    return Number.class.isAssignableFrom(type) || PRIMITIVE_NUMBERS.contains(type);
+  }
+
   private String getDescription(Field field) {
     Description description = field.getAnnotation(Description.class);
     return description != null ? description.value() : null;
   }
 
+  private void addStringRestrictions(Map<String, Object> result, Field field) {
+    Class<? extends Enum> enumClass = getEnumClass(field);
+    if (enumClass != null) addEnumValues(result, enumClass);
+
+    String pattern = getPattern(field);
+    if (pattern != null) result.put("pattern", pattern);
+  }
+
   private Class<? extends java.lang.Enum> getEnumClass(Field field) {
     EnumClass annotation = field.getAnnotation(EnumClass.class);
     return annotation != null ? annotation.value() : null;
@@ -218,6 +234,19 @@ private void addEnumValues(
     result.put("enum", getEnumValues(enumClass));
   }
 
+  private String getPattern(Field field) {
+    Pattern pattern = field.getAnnotation(Pattern.class);
+    return pattern == null ? null : pattern.value();
+  }
+
+  private void addRange(Map<String, Object> result, Field field) {
+    Range annotation = field.getAnnotation(Range.class);
+    if (annotation == null) return;
+
+    if (annotation.minimum() > Integer.MIN_VALUE) result.put("minimum", annotation.minimum());
+    if (annotation.maximum() < Integer.MAX_VALUE) result.put("maximum", annotation.maximum());
+  }
+
   private class SubSchemaGenerator {
     Field field;
 
@@ -227,9 +256,8 @@ private class SubSchemaGenerator {
 
     private void generateTypeIn(Map<String, Object> result, Class<?> type) {
       if (type.equals(Boolean.class) || type.equals(Boolean.TYPE)) result.put("type", "boolean");
-      else if (Number.class.isAssignableFrom(type) || PRIMITIVE_NUMBERS.contains(type))
-        result.put("type", "number");
-      else if (type.equals(String.class)) result.put("type", "string");
+      else if (isNumeric(type)) result.put("type", "number");
+      else if (isString(type)) result.put("type", "string");
       else if (type.isEnum()) generateEnumTypeIn(result, type);
       else if (type.isArray()) this.generateArrayTypeIn(result, type);
       else if (Collection.class.isAssignableFrom(type)) generateCollectionTypeIn(result);

json-schema/src/test/java/oracle/kubernetes/json/Directions.java

@@ -111,18 +111,64 @@ private enum TrafficLightColors {
 
   @Test
   public void generateSchemaForEnumAnnotatedString() throws NoSuchFieldException {
-    Object schema = generateForField(getClass().getDeclaredField("direction"));
+    Object schema = generateForField(getClass().getDeclaredField("colorString"));
 
-    assertThat(schema, hasJsonPath("$.direction.type", equalTo("string")));
+    assertThat(schema, hasJsonPath("$.colorString.type", equalTo("string")));
     assertThat(
         schema,
-        hasJsonPath(
-            "$.direction.enum", arrayContainingInAnyOrder("NORTH", "SOUTH", "EAST", "WEST")));
+        hasJsonPath("$.colorString.enum", arrayContainingInAnyOrder("RED", "YELLOW", "GREEN")));
+  }
+
+  @SuppressWarnings("unused")
+  @EnumClass(TrafficLightColors.class)
+  private String colorString;
+
+  @Test
+  public void whenIntegerAnnotatedWithMinimumOnly_addToSchema() throws NoSuchFieldException {
+    Object schema = generateForField(getClass().getDeclaredField("valueWithMinimum"));
+
+    assertThat(schema, hasJsonPath("$.valueWithMinimum.minimum", equalTo(7)));
+    assertThat(schema, hasNoJsonPath("$.valueWithMinimum.maximum"));
+  }
+
+  @SuppressWarnings("unused")
+  @Range(minimum = 7)
+  private int valueWithMinimum;
+
+  @Test
+  public void whenIntegerAnnotatedWithMaximumOnly_addToSchema() throws NoSuchFieldException {
+    Object schema = generateForField(getClass().getDeclaredField("valueWithMaximum"));
+
+    assertThat(schema, hasNoJsonPath("$.valueWithMaximum.minimum"));
+    assertThat(schema, hasJsonPath("$.valueWithMaximum.maximum", equalTo(43)));
+  }
+
+  @SuppressWarnings("unused")
+  @Range(maximum = 43)
+  private int valueWithMaximum;
+
+  @Test
+  public void whenIntegerAnnotatedWithRange_addToSchema() throws NoSuchFieldException {
+    Object schema = generateForField(getClass().getDeclaredField("valueWithRange"));
+
+    assertThat(schema, hasJsonPath("$.valueWithRange.minimum", equalTo(12)));
+    assertThat(schema, hasJsonPath("$.valueWithRange.maximum", equalTo(85)));
+  }
+
+  @SuppressWarnings("unused")
+  @Range(minimum = 12, maximum = 85)
+  private int valueWithRange;
+
+  @Test
+  public void whenStringAnnotatedWithPatterne_addToSchema() throws NoSuchFieldException {
+    Object schema = generateForField(getClass().getDeclaredField("codeName"));
+
+    assertThat(schema, hasJsonPath("$.codeName.pattern", equalTo("[A-Z][a-zA-Z_]*")));
   }
 
   @SuppressWarnings("unused")
-  @EnumClass(Directions.class)
-  private String direction;
+  @Pattern("[A-Z][a-zA-Z_]*")
+  private String codeName;
 
   @Test
   public void generateSchemaForAnnotatedDouble() throws NoSuchFieldException {

json-schema/src/test/java/oracle/kubernetes/json/SchemaGeneratorTest.java

@@ -4,9 +4,9 @@
 
 package oracle.kubernetes.weblogic.domain.v2;
 
-import com.google.gson.annotations.Expose;
-import com.google.gson.annotations.SerializedName;
 import javax.annotation.Nonnull;
+import oracle.kubernetes.json.Description;
+import oracle.kubernetes.json.Range;
 import org.apache.commons.lang3.builder.EqualsBuilder;
 import org.apache.commons.lang3.builder.HashCodeBuilder;
 import org.apache.commons.lang3.builder.ToStringBuilder;
@@ -18,13 +18,13 @@
  */
 public class Cluster extends BaseConfiguration {
   /** The name of the cluster. Required. */
-  @SerializedName("clusterName")
-  @Expose
+  @Description("The name of this cluster. Required")
+  @Nonnull
   private String clusterName;
 
   /** The number of replicas to run in the cluster, if specified. */
-  @SerializedName("replicas")
-  @Expose
+  @Description("The number of managed servers to run in this cluster")
+  @Range(minimum = 0)
   private Integer replicas;
 
   public String getClusterName() {
@@ -35,7 +35,7 @@ public void setClusterName(@Nonnull String clusterName) {
     this.clusterName = clusterName;
   }
 
-  public Cluster withClusterName(@Nonnull String clusterName) {
+  Cluster withClusterName(@Nonnull String clusterName) {
     setClusterName(clusterName);
     return this;
   }

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

@@ -26,9 +26,6 @@
 @SuppressWarnings("deprecation")
 public class Domain {
 
-  /** The default number of replicas for a cluster. */
-  static final int DEFAULT_REPLICA_LIMIT = 2;
-
   /**
    * APIVersion defines the versioned schema of this representation of an object. Servers should
    * convert recognized schemas to the latest internal value, and may reject unrecognized values.
@@ -45,7 +42,7 @@ public class Domain {
    */
   @SerializedName("kind")
   @Expose
-  @Description("The type of resourced. Should be 'Domain'")
+  @Description("The type of resource. Should be 'Domain'")
   private String kind;
   /**
    * Standard object's metadata. More info:

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

@@ -6,8 +6,6 @@
 
 import static oracle.kubernetes.weblogic.domain.v2.ConfigurationConstants.START_IF_NEEDED;
 
-import com.google.gson.annotations.Expose;
-import com.google.gson.annotations.SerializedName;
 import io.kubernetes.client.models.V1LocalObjectReference;
 import io.kubernetes.client.models.V1SecretReference;
 import java.util.*;
@@ -17,6 +15,8 @@
 import javax.validation.constraints.NotNull;
 import oracle.kubernetes.json.Description;
 import oracle.kubernetes.json.EnumClass;
+import oracle.kubernetes.json.Pattern;
+import oracle.kubernetes.json.Range;
 import oracle.kubernetes.operator.ImagePullPolicy;
 import oracle.kubernetes.operator.KubernetesConstants;
 import oracle.kubernetes.weblogic.domain.EffectiveConfigurationFactory;
@@ -34,16 +34,12 @@ public class DomainSpec extends BaseConfiguration {
   private static final String LOG_HOME_DEFAULT_PATTERN = "/shared/logs/%s";
 
   /** Domain unique identifier. Must be unique across the Kubernetes cluster. (Required) */
-  @SerializedName("domainUID")
-  @Expose
   @NotNull
+  @Pattern("^[a-z0-9_.]{1,253}$")
   private String domainUID;
 
   /** Domain name (Required) */
-  @SerializedName("domainName")
-  @Expose
-  @NotNull
-  private String domainName;
+  @NotNull private String domainName;
 
   /**
    * Domain home
@@ -54,62 +50,48 @@ public class DomainSpec extends BaseConfiguration {
       "The folder for the Weblogic Domain. (Not required)"
           + "Defaults to /shared/domains/domains/domainUID if domainHomeInImage is false"
           + "Defaults to /shared/domains/domain if domainHomeInImage is true")
-  @SerializedName("domainHome")
-  @Expose
   private String domainHome;
 
   /**
    * Reference to secret containing domain administrator username and password. Secret must contain
    * keys names 'username' and 'password' (Required)
    */
-  @SerializedName("adminSecret")
-  @Expose
-  @Valid
-  @NotNull
-  private V1SecretReference adminSecret;
+  @Valid @NotNull private V1SecretReference adminSecret;
 
   /**
    * Admin server name. Note: Possibly temporary as we could find this value through domain home
    * inspection. (Required)
    */
-  @SerializedName("asName")
-  @Expose
-  @NotNull
-  private String asName;
+  @NotNull private String asName;
 
   /**
    * Administration server port. Note: Possibly temporary as we could find this value through domain
    * home inspection. (Required)
    */
-  @SerializedName("asPort")
-  @Expose
   @NotNull
+  @Range(minimum = 100)
   private Integer asPort;
 
   /**
    * The in-pod name of the directory to store the domain, node manager, server logs, and server
    * .out files in.
    */
-  @SerializedName("logHome")
-  @Expose
+  @Description(
+      "The in-pod name of the directory in which to store the domain, node manager, server logs, and server  *.out files")
   private String logHome;
 
   /**
    * Whether the log home is enabled.
    *
    * @since 2.0
    */
-  @SerializedName("logHomeEnabled")
-  @Expose
   @Description(
       "Specified whether the log home folder is enabled (Not required). "
           + "Defaults to true if domainHomeInImage is false. "
           + "Defaults to false if domainHomeInImage is true. ")
   private Boolean logHomeEnabled; // Boolean object, null if unspecified
 
   /** Whether to include the server .out file to the pod's stdout. Default is true. */
-  @SerializedName("includeServerOutInPodLog")
-  @Expose
   @Description("If true (the default), the server .out file will be included in the pod's stdout")
   private Boolean includeServerOutInPodLog;
 
@@ -121,8 +103,6 @@ public class DomainSpec extends BaseConfiguration {
   @Description(
       "The Weblogic Docker image; required when domainHomeInImage is true; "
           + "otherwise, defaults to store/oracle/weblogic:12.2.1.3")
-  @SerializedName("image")
-  @Expose
   private String image;
 
   /**
@@ -149,8 +129,6 @@ public class DomainSpec extends BaseConfiguration {
    * @since 2.0
    */
   @Description("A list of image pull secrets for the WebLogic Docker image.")
-  @SerializedName("imagePullSecrets")
-  @Expose
   private List<V1LocalObjectReference> imagePullSecrets;
 
   /**
@@ -159,6 +137,7 @@ public class DomainSpec extends BaseConfiguration {
    */
   @Description(
       "The number of managed servers to run in any cluster that does not specify a replica count")
+  @Range(minimum = 0)
   private Integer replicas;
 
   /**