Add types for validation of CustomResources

Remove protobuf generation because of the interface type

Add custom fuzzer funcs

Add custom marshalling

Add custom conversion functions

move jsonschema types to separate file

Kubernetes-commit: 6133d84835c59f157a8fb4596f98d2d3cf828bef

pkg/apis/apiextensions/BUILD

@@ -9,10 +9,12 @@ load(
 go_library(
     name = "go_default_library",
     srcs = [
+        "deepcopy.go",
         "doc.go",
         "helpers.go",
         "register.go",
         "types.go",
+        "types_jsonschema.go",
         "zz_generated.deepcopy.go",
     ],
     deps = [

pkg/apis/apiextensions/deepcopy.go

@@ -0,0 +1,279 @@
+/*
+Copyright 2017 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package apiextensions
+
+// TODO: Update this after a tag is created for interface fields in DeepCopy
+func (in *JSONSchemaProps) DeepCopy() *JSONSchemaProps {
+	if in == nil {
+		return nil
+	}
+	out := new(JSONSchemaProps)
+
+	*out = *in
+
+	if in.Default != nil {
+		defaultJSON := JSON(deepCopyJSON(*(in.Default)))
+		out.Default = &(defaultJSON)
+	} else {
+		out.Default = nil
+	}
+
+	if in.Example != nil {
+		exampleJSON := JSON(deepCopyJSON(*(in.Example)))
+		out.Example = &(exampleJSON)
+	} else {
+		out.Example = nil
+	}
+
+	if in.Ref != nil {
+		in, out := &in.Ref, &out.Ref
+		if *in == nil {
+			*out = nil
+		} else {
+			*out = new(string)
+			**out = **in
+		}
+	}
+
+	if in.Maximum != nil {
+		in, out := &in.Maximum, &out.Maximum
+		if *in == nil {
+			*out = nil
+		} else {
+			*out = new(float64)
+			**out = **in
+		}
+	}
+
+	if in.Minimum != nil {
+		in, out := &in.Minimum, &out.Minimum
+		if *in == nil {
+			*out = nil
+		} else {
+			*out = new(float64)
+			**out = **in
+		}
+	}
+
+	if in.MaxLength != nil {
+		in, out := &in.MaxLength, &out.MaxLength
+		if *in == nil {
+			*out = nil
+		} else {
+			*out = new(int64)
+			**out = **in
+		}
+	}
+
+	if in.MinLength != nil {
+		in, out := &in.MinLength, &out.MinLength
+		if *in == nil {
+			*out = nil
+		} else {
+			*out = new(int64)
+			**out = **in
+		}
+	}
+	if in.MaxItems != nil {
+		in, out := &in.MaxItems, &out.MaxItems
+		if *in == nil {
+			*out = nil
+		} else {
+			*out = new(int64)
+			**out = **in
+		}
+	}
+
+	if in.MinItems != nil {
+		in, out := &in.MinItems, &out.MinItems
+		if *in == nil {
+			*out = nil
+		} else {
+			*out = new(int64)
+			**out = **in
+		}
+	}
+
+	if in.MultipleOf != nil {
+		in, out := &in.MultipleOf, &out.MultipleOf
+		if *in == nil {
+			*out = nil
+		} else {
+			*out = new(float64)
+			**out = **in
+		}
+	}
+
+	if in.Enum != nil {
+		out.Enum = make([]JSON, len(in.Enum))
+		for i := range in.Enum {
+			out.Enum[i] = deepCopyJSON(in.Enum[i])
+		}
+	}
+
+	if in.MaxProperties != nil {
+		in, out := &in.MaxProperties, &out.MaxProperties
+		if *in == nil {
+			*out = nil
+		} else {
+			*out = new(int64)
+			**out = **in
+		}
+	}
+
+	if in.MinProperties != nil {
+		in, out := &in.MinProperties, &out.MinProperties
+		if *in == nil {
+			*out = nil
+		} else {
+			*out = new(int64)
+			**out = **in
+		}
+	}
+
+	if in.Required != nil {
+		in, out := &in.Required, &out.Required
+		*out = make([]string, len(*in))
+		copy(*out, *in)
+	}
+
+	if in.Items != nil {
+		in, out := &in.Items, &out.Items
+		if *in == nil {
+			*out = nil
+		} else {
+			*out = new(JSONSchemaPropsOrArray)
+			(*in).DeepCopyInto(*out)
+		}
+	}
+
+	if in.AllOf != nil {
+		in, out := &in.AllOf, &out.AllOf
+		*out = make([]JSONSchemaProps, len(*in))
+		for i := range *in {
+			(*in)[i].DeepCopyInto(&(*out)[i])
+		}
+	}
+
+	if in.OneOf != nil {
+		in, out := &in.OneOf, &out.OneOf
+		*out = make([]JSONSchemaProps, len(*in))
+		for i := range *in {
+			(*in)[i].DeepCopyInto(&(*out)[i])
+		}
+	}
+	if in.AnyOf != nil {
+		in, out := &in.AnyOf, &out.AnyOf
+		*out = make([]JSONSchemaProps, len(*in))
+		for i := range *in {
+			(*in)[i].DeepCopyInto(&(*out)[i])
+		}
+	}
+
+	if in.Not != nil {
+		in, out := &in.Not, &out.Not
+		if *in == nil {
+			*out = nil
+		} else {
+			*out = new(JSONSchemaProps)
+			(*in).DeepCopyInto(*out)
+		}
+	}
+
+	if in.Properties != nil {
+		in, out := &in.Properties, &out.Properties
+		*out = make(map[string]JSONSchemaProps, len(*in))
+		for key, val := range *in {
+			(*out)[key] = *val.DeepCopy()
+		}
+	}
+
+	if in.AdditionalProperties != nil {
+		in, out := &in.AdditionalProperties, &out.AdditionalProperties
+		if *in == nil {
+			*out = nil
+		} else {
+			*out = new(JSONSchemaPropsOrBool)
+			(*in).DeepCopyInto(*out)
+		}
+	}
+
+	if in.PatternProperties != nil {
+		in, out := &in.PatternProperties, &out.PatternProperties
+		*out = make(map[string]JSONSchemaProps, len(*in))
+		for key, val := range *in {
+			(*out)[key] = *val.DeepCopy()
+		}
+	}
+
+	if in.Dependencies != nil {
+		in, out := &in.Dependencies, &out.Dependencies
+		*out = make(JSONSchemaDependencies, len(*in))
+		for key, val := range *in {
+			(*out)[key] = *val.DeepCopy()
+		}
+	}
+
+	if in.AdditionalItems != nil {
+		in, out := &in.AdditionalItems, &out.AdditionalItems
+		if *in == nil {
+			*out = nil
+		} else {
+			*out = new(JSONSchemaPropsOrBool)
+			(*in).DeepCopyInto(*out)
+		}
+	}
+
+	if in.Definitions != nil {
+		in, out := &in.Definitions, &out.Definitions
+		*out = make(JSONSchemaDefinitions, len(*in))
+		for key, val := range *in {
+			(*out)[key] = *val.DeepCopy()
+		}
+	}
+
+	if in.ExternalDocs != nil {
+		in, out := &in.ExternalDocs, &out.ExternalDocs
+		if *in == nil {
+			*out = nil
+		} else {
+			*out = new(ExternalDocumentation)
+			(*in).DeepCopyInto(*out)
+		}
+	}
+
+	return out
+}
+
+func deepCopyJSON(x interface{}) interface{} {
+	switch x := x.(type) {
+	case map[string]interface{}:
+		clone := make(map[string]interface{}, len(x))
+		for k, v := range x {
+			clone[k] = deepCopyJSON(v)
+		}
+		return clone
+	case []interface{}:
+		clone := make([]interface{}, len(x))
+		for i := range x {
+			clone[i] = deepCopyJSON(x[i])
+		}
+		return clone
+	default:
+		return x
+	}
+}

pkg/apis/apiextensions/fuzzer/fuzzer.go

@@ -17,6 +17,7 @@ limitations under the License.
 package fuzzer
 
 import (
+	"reflect"
 	"strings"
 
 	"github.com/google/gofuzz"
@@ -42,5 +43,65 @@ func Funcs(codecs runtimeserializer.CodecFactory) []interface{} {
 				obj.Names.ListKind = obj.Names.Kind + "List"
 			}
 		},
+		func(obj *apiextensions.JSONSchemaProps, c fuzz.Continue) {
+			// we cannot use c.FuzzNoCustom because of the interface{} fields. So let's loop with reflection.
+			vobj := reflect.ValueOf(obj).Elem()
+			tobj := reflect.TypeOf(obj).Elem()
+			for i := 0; i < tobj.NumField(); i++ {
+				field := tobj.Field(i)
+				switch field.Name {
+				case "Default", "Enum", "Example":
+					continue
+				default:
+					isValue := true
+					switch field.Type.Kind() {
+					case reflect.Interface, reflect.Map, reflect.Slice, reflect.Ptr:
+						isValue = false
+					}
+					if isValue || c.Intn(5) == 0 {
+						c.Fuzz(vobj.Field(i).Addr().Interface())
+					}
+				}
+			}
+			if c.RandBool() {
+				validJSON := apiextensions.JSON(`{"some": {"json": "test"}, "string": 42}`)
+				obj.Default = &validJSON
+			}
+			if c.RandBool() {
+				obj.Enum = []apiextensions.JSON{c.Float64(), c.RandString(), c.RandBool()}
+			}
+			if c.RandBool() {
+				validJSON := apiextensions.JSON(`"foobarbaz"`)
+				obj.Example = &validJSON
+			}
+		},
+		func(obj *apiextensions.JSONSchemaPropsOrBool, c fuzz.Continue) {
+			if c.RandBool() {
+				obj.Schema = &apiextensions.JSONSchemaProps{}
+				c.Fuzz(obj.Schema)
+			} else {
+				obj.Allows = c.RandBool()
+			}
+		},
+		func(obj *apiextensions.JSONSchemaPropsOrArray, c fuzz.Continue) {
+			// disallow both Schema and JSONSchemas to be nil.
+			if c.RandBool() {
+				obj.Schema = &apiextensions.JSONSchemaProps{}
+				c.Fuzz(obj.Schema)
+			} else {
+				obj.JSONSchemas = make([]apiextensions.JSONSchemaProps, c.Intn(3)+1)
+				for i := range obj.JSONSchemas {
+					c.Fuzz(&obj.JSONSchemas[i])
+				}
+			}
+		},
+		func(obj *apiextensions.JSONSchemaPropsOrStringArray, c fuzz.Continue) {
+			if c.RandBool() {
+				obj.Schema = &apiextensions.JSONSchemaProps{}
+				c.Fuzz(obj.Schema)
+			} else {
+				c.Fuzz(&obj.Property)
+			}
+		},
 	}
 }

pkg/apis/apiextensions/types.go

@@ -26,9 +26,10 @@ type CustomResourceDefinitionSpec struct {
 	Version string
 	// Names are the names used to describe this custom resource
 	Names CustomResourceDefinitionNames
-
 	// Scope indicates whether this resource is cluster or namespace scoped.  Default is namespaced
 	Scope ResourceScope
+	// Validation describes the validation methods for CustomResources
+	Validation *CustomResourceValidation
 }
 
 // CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition
@@ -139,3 +140,9 @@ type CustomResourceDefinitionList struct {
 	// Items individual CustomResourceDefinitions
 	Items []CustomResourceDefinition
 }
+
+// CustomResourceValidation is a list of validation methods for CustomResources.
+type CustomResourceValidation struct {
+	// OpenAPIV3Schema is the OpenAPI v3 schema to be validated against.
+	OpenAPIV3Schema *JSONSchemaProps
+}