handle unconventional cases in kubernetes schema

Author: russgold

docs/domains/k8s1.9.0.md

@@ -9,16 +9,16 @@ ObjectMeta is metadata that all persisted resources must have, which includes al
 
 | Name | Type | Description |
 | --- | --- | --- |
-| annotations |  | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations |
+| annotations | object | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations |
 | clusterName | string | The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request. |
 | creationTimestamp | [Time](#time) | CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.<br/><br/>Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
-| deletionGracePeriodSeconds |  | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. |
+| deletionGracePeriodSeconds | integer | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. |
 | deletionTimestamp | [Time](#time) | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.<br/><br/>Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
 | finalizers | array of string | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. |
 | generateName | string | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.<br/><br/>If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).<br/><br/>Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
-| generation |  | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. |
+| generation | integer | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. |
 | initializers | [Initializers](#initializers) | An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven't explicitly asked to observe uninitialized objects.<br/><br/>When an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user. |
-| labels |  | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels |
+| labels | object | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels |
 | name | string | Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
 | namespace | string | Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.<br/><br/>Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces |
 | ownerReferences | array of [Owner Reference](#owner-reference) | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. |
@@ -54,7 +54,7 @@ SecurityContext holds security configuration that will be applied to a container
 | privileged | boolean | Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. |
 | readOnlyRootFilesystem | boolean | Whether this container has a read-only root filesystem. Default is false. |
 | runAsNonRoot | boolean | Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext.  If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
-| runAsUser |  | The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext.  If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
+| runAsUser | integer | The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext.  If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
 | seLinuxOptions | [SE Linux Options](#se-linux-options) | The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container.  May also be set in PodSecurityContext.  If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
 
 ### Env Var
@@ -73,20 +73,20 @@ PodSecurityContext holds pod-level security attributes and common container sett
 
 | Name | Type | Description |
 | --- | --- | --- |
-| fsGroup |  | A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:<br/><br/>1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----<br/><br/>If unset, the Kubelet will not modify the ownership and permissions of any volume. |
+| fsGroup | integer | A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:<br/><br/>1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----<br/><br/>If unset, the Kubelet will not modify the ownership and permissions of any volume. |
 | runAsNonRoot | boolean | Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext.  If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
-| runAsUser |  | The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext.  If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. |
+| runAsUser | integer | The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext.  If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. |
 | seLinuxOptions | [SE Linux Options](#se-linux-options) | The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container.  May also be set in SecurityContext.  If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. |
-| supplementalGroups | array of  | A list of groups applied to the first process run in each container, in addition to the container's primary GID.  If unspecified, no groups will be added to any container. |
+| supplementalGroups | array of integer | A list of groups applied to the first process run in each container, in addition to the container's primary GID.  If unspecified, no groups will be added to any container. |
 
 ### Resource Requirements
 
 ResourceRequirements describes the compute resource requirements.
 
 | Name | Type | Description |
 | --- | --- | --- |
-| limits |  | Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |
-| requests |  | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |
+| limits | object | Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |
+| requests | object | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |
 
 ### Volume Mount
 

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

@@ -150,24 +150,21 @@ String getString() {
           Type subType = getItems();
           return "array of " + subType.getString();
         default:
-          return getReference();
+          return Optional.ofNullable(getReference()).orElse(specifiedType);
       }
     }
 
+    @SuppressWarnings("unchecked")
     private Type getItems() {
       return new Type((Map<String, Object>) fieldMap.get("items"));
     }
 
     private String getReference() {
-      Reference reference = createReference(getReferenceString());
-      return reference.getString();
+      return createReference(getReferenceString()).getString();
     }
 
     private String getReferenceString() {
-      String reference = (String) fieldMap.get("$ref");
-      if (reference != null) return reference;
-      else if (fieldMap.get("items") == null) return null;
-      else return (String) subMap(fieldMap, "items").get("$ref");
+      return (String) fieldMap.get("$ref");
     }
   }
 
@@ -207,23 +204,16 @@ String getLink() {
     private String getStructureName() {
       return toStructureName(typeName);
     }
-
-    abstract boolean isLocal();
   }
 
   private class NullReference extends Reference {
     NullReference() {
       super(null);
     }
 
-    @Override
-    boolean isLocal() {
-      return false;
-    }
-
     @Override
     String getString() {
-      return "";
+      return null;
     }
   }
 
@@ -241,15 +231,9 @@ private class LocalReference extends Reference {
       if (isReferenceType()) addReferenceIfNeeded(getTypeName());
     }
 
-    @Override
-    boolean isLocal() {
-      return true;
-    }
-
     @Override
     String getString() {
-      if (isReferenceType()) return super.getString();
-      else return getTypeName();
+      return isReferenceType() ? super.getString() : getTypeName();
     }
 
     private boolean isReferenceType() {
@@ -270,11 +254,6 @@ private String toK8sName(String ref) {
       return ref.substring(ref.lastIndexOf("/") + 1);
     }
 
-    @Override
-    boolean isLocal() {
-      return false;
-    }
-
     @Override
     String getLink() {
       return getKubernetesSchemaLink() + super.getLink();

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

@@ -4,11 +4,13 @@
 
 package oracle.kubernetes.json;
 
+import static com.google.common.collect.ImmutableMap.of;
 import static org.hamcrest.Matchers.containsString;
 import static org.hamcrest.Matchers.equalTo;
 import static org.hamcrest.Matchers.nullValue;
 import static org.hamcrest.junit.MatcherAssert.assertThat;
 
+import com.google.common.collect.ImmutableMap;
 import java.io.IOException;
 import java.lang.reflect.Field;
 import java.util.HashMap;
@@ -48,6 +50,15 @@ private Map<String, Object> generateSchemaForField(Field field) {
   @Description("An annotated field")
   private Double annotatedDouble;
 
+  @Test
+  public void whenSchemaHasUknownTypeAndNoReference_useAsSpecified() throws NoSuchFieldException {
+    Map<String, Object> schema = ImmutableMap.of("anInt", of("type", "integer"));
+
+    String markdown = new YamlDocGenerator(schema).generateForProperty("anInt", schema);
+
+    assertThat(markdown, containsString(tableEntry("anInt", "integer", "")));
+  }
+
   @Test
   public void whenPropertyTypeIsDateTime_doNotGenerateReference() throws NoSuchFieldException {
     String markdown = generateForProperty(getClass().getDeclaredField("dateTime"));