Use schema validation for enum-valued strings

Author: russgold

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

@@ -10,6 +10,7 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+/** Supplies a description for a field to be inserted into the generated JSON schema. */
 @Retention(RetentionPolicy.RUNTIME)
 @Target(FIELD)
 public @interface Description {

json-schema/src/main/java/oracle/kubernetes/json/EnumClass.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;
+
+/** Specifies an enum class whose values match the permitted values for the field. */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(FIELD)
+public @interface EnumClass {
+  Class<? extends java.lang.Enum> value();
+}

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

@@ -14,15 +14,7 @@
 import java.lang.reflect.Modifier;
 import java.net.MalformedURLException;
 import java.net.URL;
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.Collection;
-import java.util.HashMap;
-import java.util.HashSet;
-import java.util.Iterator;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
+import java.util.*;
 import javax.annotation.Nonnull;
 
 @SuppressWarnings("WeakerAccess")
@@ -205,6 +197,8 @@ 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);
 
     return result;
   }
@@ -214,6 +208,16 @@ private String getDescription(Field field) {
     return description != null ? description.value() : null;
   }
 
+  private Class<? extends java.lang.Enum> getEnumClass(Field field) {
+    EnumClass annotation = field.getAnnotation(EnumClass.class);
+    return annotation != null ? annotation.value() : null;
+  }
+
+  private void addEnumValues(
+      Map<String, Object> result, Class<? extends java.lang.Enum> enumClass) {
+    result.put("enum", getEnumValues(enumClass));
+  }
+
   private class SubSchemaGenerator {
     Field field;
 

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

@@ -0,0 +1,13 @@
+// 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;
+
+@SuppressWarnings("unused")
+public enum Directions {
+  NORTH,
+  EAST,
+  SOUTH,
+  WEST
+}

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

@@ -6,10 +6,7 @@
 
 import static com.jayway.jsonpath.matchers.JsonPathMatchers.hasJsonPath;
 import static com.jayway.jsonpath.matchers.JsonPathMatchers.hasNoJsonPath;
-import static org.hamcrest.Matchers.arrayContaining;
-import static org.hamcrest.Matchers.arrayContainingInAnyOrder;
-import static org.hamcrest.Matchers.equalTo;
-import static org.hamcrest.Matchers.not;
+import static org.hamcrest.Matchers.*;
 import static org.junit.Assert.assertThat;
 
 import java.io.IOException;
@@ -112,6 +109,21 @@ private enum TrafficLightColors {
   @SuppressWarnings("unused")
   private TrafficLightColors colors;
 
+  @Test
+  public void generateSchemaForEnumAnnotatedString() throws NoSuchFieldException {
+    Object schema = generateForField(getClass().getDeclaredField("direction"));
+
+    assertThat(schema, hasJsonPath("$.direction.type", equalTo("string")));
+    assertThat(
+        schema,
+        hasJsonPath(
+            "$.direction.enum", arrayContainingInAnyOrder("NORTH", "SOUTH", "EAST", "WEST")));
+  }
+
+  @SuppressWarnings("unused")
+  @EnumClass(Directions.class)
+  private String direction;
+
   @Test
   public void generateSchemaForAnnotatedDouble() throws NoSuchFieldException {
     Object schema = generateForField(getClass().getDeclaredField("annotatedDouble"));

model/src/main/java/oracle/kubernetes/operator/ImagePullPolicy.java

@@ -0,0 +1,11 @@
+// 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.operator;
+
+public enum ImagePullPolicy {
+  Always,
+  Never,
+  IfNotPresent
+}

model/src/main/java/oracle/kubernetes/operator/KubernetesConstants.java

@@ -7,9 +7,8 @@
 /** Kubernetes constants. */
 public interface KubernetesConstants {
   String DEFAULT_IMAGE = "store/oracle/weblogic:12.2.1.3";
-  String ALWAYS_IMAGEPULLPOLICY = "Always";
-  String IFNOTPRESENT_IMAGEPULLPOLICY = "IfNotPresent";
-  String NEVER_IMAGEPULLPOLICY = "Never";
+  String ALWAYS_IMAGEPULLPOLICY = ImagePullPolicy.Always.name();
+  String IFNOTPRESENT_IMAGEPULLPOLICY = ImagePullPolicy.IfNotPresent.name();
   String LATEST_IMAGE_SUFFIX = ":latest";
 
   String EXTENSIONS_API_VERSION = "extensions/v1beta1";

model/src/main/java/oracle/kubernetes/operator/ServerStartPolicy.java

@@ -0,0 +1,16 @@
+// 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.operator;
+
+public enum ServerStartPolicy {
+  NEVER,
+  ALWAYS,
+  IF_NEEDED,
+  ADMIN_ONLY;
+
+  public static ServerStartPolicy getDefaultPolicy() {
+    return IF_NEEDED;
+  }
+}

model/src/main/java/oracle/kubernetes/operator/ServerStartState.java

@@ -0,0 +1,10 @@
+// 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.operator;
+
+public enum ServerStartState {
+  RUNNING,
+  ADMIN
+}

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

@@ -4,19 +4,15 @@
 
 package oracle.kubernetes.weblogic.domain.v2;
 
-import com.google.gson.annotations.Expose;
-import com.google.gson.annotations.SerializedName;
-import io.kubernetes.client.models.V1EnvVar;
-import io.kubernetes.client.models.V1PodSecurityContext;
-import io.kubernetes.client.models.V1ResourceRequirements;
-import io.kubernetes.client.models.V1SecurityContext;
-import io.kubernetes.client.models.V1Volume;
-import io.kubernetes.client.models.V1VolumeMount;
+import io.kubernetes.client.models.*;
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
 import javax.annotation.Nullable;
 import oracle.kubernetes.json.Description;
+import oracle.kubernetes.json.EnumClass;
+import oracle.kubernetes.operator.ServerStartPolicy;
+import oracle.kubernetes.operator.ServerStartState;
 import org.apache.commons.lang3.builder.EqualsBuilder;
 import org.apache.commons.lang3.builder.HashCodeBuilder;
 import org.apache.commons.lang3.builder.ToStringBuilder;
@@ -33,9 +29,9 @@ public abstract class BaseConfiguration {
   private ServerPod serverPod = new ServerPod();
 
   /** Desired startup state. Legal values are RUNNING or ADMIN. */
-  @SerializedName("serverStartState")
-  @Expose
-  @Description("The state in which the server is to be started")
+  @EnumClass(ServerStartState.class)
+  @Description(
+      "The state in which the server is to be started. Use ADMIN if server should start in admin state. Defaults to RUNNING.")
   private String serverStartState;
 
   /**
@@ -46,11 +42,10 @@ public abstract class BaseConfiguration {
    *
    * @since 2.0
    */
-  @SerializedName("serverStartPolicy")
-  @Expose
+  @EnumClass(ServerStartPolicy.class)
   @Description(
       "The strategy for deciding whether to start a server. "
-          + "Legal values are NEVER, ALWAYS, or IF_NEEDED.")
+          + "Legal values are ADMIN_ONLY, NEVER, ALWAYS, or IF_NEEDED.")
   private String serverStartPolicy;
 
   /**
@@ -72,7 +67,7 @@ private boolean overrideStartPolicyFrom(BaseConfiguration other) {
     return serverStartPolicy == null || other.isStartNever();
   }
 
-  public boolean isStartAdminServerOnly() {
+  boolean isStartAdminServerOnly() {
     return Objects.equals(getServerStartPolicy(), ConfigurationConstants.START_ADMIN_ONLY);
   }
 
@@ -146,47 +141,47 @@ void addLimitRequirement(String resource, String quantity) {
     serverPod.addLimitRequirement(resource, quantity);
   }
 
-  public V1PodSecurityContext getPodSecurityContext() {
+  V1PodSecurityContext getPodSecurityContext() {
     return serverPod.getPodSecurityContext();
   }
 
-  public V1SecurityContext getContainerSecurityContext() {
+  V1SecurityContext getContainerSecurityContext() {
     return serverPod.getContainerSecurityContext();
   }
 
-  public void setPodSecurityContext(V1PodSecurityContext podSecurityContext) {
+  void setPodSecurityContext(V1PodSecurityContext podSecurityContext) {
     serverPod.setPodSecurityContext(podSecurityContext);
   }
 
-  public void setContainerSecurityContext(V1SecurityContext containerSecurityContext) {
+  void setContainerSecurityContext(V1SecurityContext containerSecurityContext) {
     serverPod.setContainerSecurityContext(containerSecurityContext);
   }
 
-  public List<V1Volume> getAdditionalVolumes() {
+  List<V1Volume> getAdditionalVolumes() {
     return serverPod.getAdditionalVolumes();
   }
 
   void addAdditionalVolume(String name, String path) {
     serverPod.addAdditionalVolume(name, path);
   }
 
-  public List<V1VolumeMount> getAdditionalVolumeMounts() {
+  List<V1VolumeMount> getAdditionalVolumeMounts() {
     return serverPod.getAdditionalVolumeMounts();
   }
 
   void addAdditionalVolumeMount(String name, String path) {
     serverPod.addAdditionalVolumeMount(name, path);
   }
 
-  public Map<String, String> getPodLabels() {
+  Map<String, String> getPodLabels() {
     return serverPod.getPodLabels();
   }
 
   void addPodLabels(String name, String value) {
     serverPod.addPodLabel(name, value);
   }
 
-  public Map<String, String> getPodAnnotations() {
+  Map<String, String> getPodAnnotations() {
     return serverPod.getPodAnnotations();
   }