apiextensions: add structural schema validation if preserveUnknownFields=false

This commit is contained in:
Dr. Stefan Schimanski 2019-05-02 12:03:24 +02:00
parent 7484892009
commit 32d05973f5
2 changed files with 526 additions and 32 deletions

View File

@ -21,6 +21,7 @@ import (
"reflect" "reflect"
"strings" "strings"
structuralschema "k8s.io/apiextensions-apiserver/pkg/apiserver/schema"
apiequality "k8s.io/apimachinery/pkg/api/equality" apiequality "k8s.io/apimachinery/pkg/api/equality"
genericvalidation "k8s.io/apimachinery/pkg/api/validation" genericvalidation "k8s.io/apimachinery/pkg/api/validation"
"k8s.io/apimachinery/pkg/util/sets" "k8s.io/apimachinery/pkg/util/sets"
@ -102,9 +103,9 @@ func ValidateUpdateCustomResourceDefinitionStatus(obj, oldObj *apiextensions.Cus
} }
// ValidateCustomResourceDefinitionVersion statically validates. // ValidateCustomResourceDefinitionVersion statically validates.
func ValidateCustomResourceDefinitionVersion(version *apiextensions.CustomResourceDefinitionVersion, fldPath *field.Path, statusEnabled bool) field.ErrorList { func ValidateCustomResourceDefinitionVersion(version *apiextensions.CustomResourceDefinitionVersion, fldPath *field.Path, mustBeStructural, statusEnabled bool) field.ErrorList {
allErrs := field.ErrorList{} allErrs := field.ErrorList{}
allErrs = append(allErrs, ValidateCustomResourceDefinitionValidation(version.Schema, statusEnabled, fldPath.Child("schema"))...) allErrs = append(allErrs, ValidateCustomResourceDefinitionValidation(version.Schema, mustBeStructural, statusEnabled, fldPath.Child("schema"))...)
allErrs = append(allErrs, ValidateCustomResourceDefinitionSubresources(version.Subresources, fldPath.Child("subresources"))...) allErrs = append(allErrs, ValidateCustomResourceDefinitionSubresources(version.Subresources, fldPath.Child("subresources"))...)
for i := range version.AdditionalPrinterColumns { for i := range version.AdditionalPrinterColumns {
allErrs = append(allErrs, ValidateCustomResourceColumnDefinition(&version.AdditionalPrinterColumns[i], fldPath.Child("additionalPrinterColumns").Index(i))...) allErrs = append(allErrs, ValidateCustomResourceColumnDefinition(&version.AdditionalPrinterColumns[i], fldPath.Child("additionalPrinterColumns").Index(i))...)
@ -130,6 +131,20 @@ func validateCustomResourceDefinitionSpec(spec *apiextensions.CustomResourceDefi
allErrs = append(allErrs, validateEnumStrings(fldPath.Child("scope"), string(spec.Scope), []string{string(apiextensions.ClusterScoped), string(apiextensions.NamespaceScoped)}, true)...) allErrs = append(allErrs, validateEnumStrings(fldPath.Child("scope"), string(spec.Scope), []string{string(apiextensions.ClusterScoped), string(apiextensions.NamespaceScoped)}, true)...)
mustBeStructural := false
if spec.PreserveUnknownFields == nil || *spec.PreserveUnknownFields == false {
mustBeStructural = true
// check that either a global schema or versioned schemas are set
if spec.Validation == nil || spec.Validation.OpenAPIV3Schema == nil {
for i, v := range spec.Versions {
schemaPath := fldPath.Child("versions").Index(i).Child("schema", "openAPIV3Schema")
if v.Served && (v.Schema == nil || v.Schema.OpenAPIV3Schema == nil) {
allErrs = append(allErrs, field.Required(schemaPath, "because otherwise all fields are pruned"))
}
}
}
}
storageFlagCount := 0 storageFlagCount := 0
versionsMap := map[string]bool{} versionsMap := map[string]bool{}
uniqueNames := true uniqueNames := true
@ -146,7 +161,7 @@ func validateCustomResourceDefinitionSpec(spec *apiextensions.CustomResourceDefi
allErrs = append(allErrs, field.Invalid(fldPath.Child("versions").Index(i).Child("name"), spec.Versions[i].Name, strings.Join(errs, ","))) allErrs = append(allErrs, field.Invalid(fldPath.Child("versions").Index(i).Child("name"), spec.Versions[i].Name, strings.Join(errs, ",")))
} }
subresources := getSubresourcesForVersion(spec, version.Name) subresources := getSubresourcesForVersion(spec, version.Name)
allErrs = append(allErrs, ValidateCustomResourceDefinitionVersion(&version, fldPath.Child("versions").Index(i), hasStatusEnabled(subresources))...) allErrs = append(allErrs, ValidateCustomResourceDefinitionVersion(&version, fldPath.Child("versions").Index(i), mustBeStructural, hasStatusEnabled(subresources))...)
} }
// The top-level and per-version fields are mutual exclusive // The top-level and per-version fields are mutual exclusive
@ -201,7 +216,7 @@ func validateCustomResourceDefinitionSpec(spec *apiextensions.CustomResourceDefi
} }
allErrs = append(allErrs, ValidateCustomResourceDefinitionNames(&spec.Names, fldPath.Child("names"))...) allErrs = append(allErrs, ValidateCustomResourceDefinitionNames(&spec.Names, fldPath.Child("names"))...)
allErrs = append(allErrs, ValidateCustomResourceDefinitionValidation(spec.Validation, hasAnyStatusEnabled(spec), fldPath.Child("validation"))...) allErrs = append(allErrs, ValidateCustomResourceDefinitionValidation(spec.Validation, mustBeStructural, hasAnyStatusEnabled(spec), fldPath.Child("validation"))...)
allErrs = append(allErrs, ValidateCustomResourceDefinitionSubresources(spec.Subresources, fldPath.Child("subresources"))...) allErrs = append(allErrs, ValidateCustomResourceDefinitionSubresources(spec.Subresources, fldPath.Child("subresources"))...)
for i := range spec.AdditionalPrinterColumns { for i := range spec.AdditionalPrinterColumns {
@ -531,7 +546,7 @@ type specStandardValidator interface {
} }
// ValidateCustomResourceDefinitionValidation statically validates // ValidateCustomResourceDefinitionValidation statically validates
func ValidateCustomResourceDefinitionValidation(customResourceValidation *apiextensions.CustomResourceValidation, statusSubresourceEnabled bool, fldPath *field.Path) field.ErrorList { func ValidateCustomResourceDefinitionValidation(customResourceValidation *apiextensions.CustomResourceValidation, mustBeStructural, statusSubresourceEnabled bool, fldPath *field.Path) field.ErrorList {
allErrs := field.ErrorList{} allErrs := field.ErrorList{}
if customResourceValidation == nil { if customResourceValidation == nil {
@ -573,6 +588,17 @@ func ValidateCustomResourceDefinitionValidation(customResourceValidation *apiext
openAPIV3Schema := &specStandardValidatorV3{} openAPIV3Schema := &specStandardValidatorV3{}
allErrs = append(allErrs, ValidateCustomResourceDefinitionOpenAPISchema(schema, fldPath.Child("openAPIV3Schema"), openAPIV3Schema)...) allErrs = append(allErrs, ValidateCustomResourceDefinitionOpenAPISchema(schema, fldPath.Child("openAPIV3Schema"), openAPIV3Schema)...)
if mustBeStructural {
if ss, err := structuralschema.NewStructural(schema); err != nil {
// if the generic schema validation did its job, we should never get an error here. Hence, we hide it if there are validation errors already.
if len(allErrs) == 0 {
allErrs = append(allErrs, field.Invalid(fldPath.Child("openAPIV3Schema"), "", err.Error()))
}
} else {
allErrs = append(allErrs, structuralschema.ValidateStructural(ss, fldPath.Child("openAPIV3Schema"))...)
}
}
} }
// if validation passed otherwise, make sure we can actually construct a schema validator from this custom resource validation. // if validation passed otherwise, make sure we can actually construct a schema validator from this custom resource validation.

View File

@ -103,6 +103,7 @@ func TestValidateCustomResourceDefinition(t *testing.T) {
}, },
}, },
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"}, StoredVersions: []string{"version"},
@ -147,6 +148,7 @@ func TestValidateCustomResourceDefinition(t *testing.T) {
}, },
}, },
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"}, StoredVersions: []string{"version"},
@ -191,6 +193,7 @@ func TestValidateCustomResourceDefinition(t *testing.T) {
}, },
}, },
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"}, StoredVersions: []string{"version"},
@ -231,6 +234,7 @@ func TestValidateCustomResourceDefinition(t *testing.T) {
URL: strPtr(""), URL: strPtr(""),
}, },
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"}, StoredVersions: []string{"version"},
@ -272,6 +276,7 @@ func TestValidateCustomResourceDefinition(t *testing.T) {
URL: strPtr("https://example.com/webhook"), URL: strPtr("https://example.com/webhook"),
}, },
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"}, StoredVersions: []string{"version"},
@ -310,6 +315,7 @@ func TestValidateCustomResourceDefinition(t *testing.T) {
Strategy: apiextensions.ConversionStrategyType("None"), Strategy: apiextensions.ConversionStrategyType("None"),
ConversionReviewVersions: []string{"v1beta1"}, ConversionReviewVersions: []string{"v1beta1"},
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"}, StoredVersions: []string{"version"},
@ -351,6 +357,7 @@ func TestValidateCustomResourceDefinition(t *testing.T) {
}, },
ConversionReviewVersions: []string{"invalid-version"}, ConversionReviewVersions: []string{"invalid-version"},
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"}, StoredVersions: []string{"version"},
@ -392,6 +399,7 @@ func TestValidateCustomResourceDefinition(t *testing.T) {
}, },
ConversionReviewVersions: []string{"0v"}, ConversionReviewVersions: []string{"0v"},
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"}, StoredVersions: []string{"version"},
@ -434,6 +442,7 @@ func TestValidateCustomResourceDefinition(t *testing.T) {
}, },
ConversionReviewVersions: []string{"invalid-version", "v1beta1"}, ConversionReviewVersions: []string{"invalid-version", "v1beta1"},
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"}, StoredVersions: []string{"version"},
@ -473,6 +482,7 @@ func TestValidateCustomResourceDefinition(t *testing.T) {
}, },
ConversionReviewVersions: []string{"v1beta1", "v1beta1"}, ConversionReviewVersions: []string{"v1beta1", "v1beta1"},
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"}, StoredVersions: []string{"version"},
@ -510,6 +520,7 @@ func TestValidateCustomResourceDefinition(t *testing.T) {
Conversion: &apiextensions.CustomResourceConversion{ Conversion: &apiextensions.CustomResourceConversion{
Strategy: apiextensions.ConversionStrategyType("Webhook"), Strategy: apiextensions.ConversionStrategyType("Webhook"),
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"}, StoredVersions: []string{"version"},
@ -547,6 +558,7 @@ func TestValidateCustomResourceDefinition(t *testing.T) {
Conversion: &apiextensions.CustomResourceConversion{ Conversion: &apiextensions.CustomResourceConversion{
Strategy: apiextensions.ConversionStrategyType("non_existing_conversion"), Strategy: apiextensions.ConversionStrategyType("non_existing_conversion"),
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"}, StoredVersions: []string{"version"},
@ -584,6 +596,7 @@ func TestValidateCustomResourceDefinition(t *testing.T) {
Conversion: &apiextensions.CustomResourceConversion{ Conversion: &apiextensions.CustomResourceConversion{
Strategy: apiextensions.ConversionStrategyType("None"), Strategy: apiextensions.ConversionStrategyType("None"),
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"}, StoredVersions: []string{"version"},
@ -621,6 +634,7 @@ func TestValidateCustomResourceDefinition(t *testing.T) {
Conversion: &apiextensions.CustomResourceConversion{ Conversion: &apiextensions.CustomResourceConversion{
Strategy: apiextensions.ConversionStrategyType("None"), Strategy: apiextensions.ConversionStrategyType("None"),
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"}, StoredVersions: []string{"version"},
@ -659,6 +673,7 @@ func TestValidateCustomResourceDefinition(t *testing.T) {
Conversion: &apiextensions.CustomResourceConversion{ Conversion: &apiextensions.CustomResourceConversion{
Strategy: apiextensions.ConversionStrategyType("None"), Strategy: apiextensions.ConversionStrategyType("None"),
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"}, StoredVersions: []string{"version"},
@ -691,6 +706,7 @@ func TestValidateCustomResourceDefinition(t *testing.T) {
Conversion: &apiextensions.CustomResourceConversion{ Conversion: &apiextensions.CustomResourceConversion{
Strategy: apiextensions.ConversionStrategyType("None"), Strategy: apiextensions.ConversionStrategyType("None"),
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{}, StoredVersions: []string{},
@ -709,6 +725,7 @@ func TestValidateCustomResourceDefinition(t *testing.T) {
Names: apiextensions.CustomResourceDefinitionNames{ Names: apiextensions.CustomResourceDefinitionNames{
Plural: "plural", Plural: "plural",
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
}, },
errors: []validationMatch{ errors: []validationMatch{
@ -752,6 +769,7 @@ func TestValidateCustomResourceDefinition(t *testing.T) {
Kind: "value()*a", Kind: "value()*a",
ListKind: "value()*a", ListKind: "value()*a",
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
AcceptedNames: apiextensions.CustomResourceDefinitionNames{ AcceptedNames: apiextensions.CustomResourceDefinitionNames{
@ -798,6 +816,7 @@ func TestValidateCustomResourceDefinition(t *testing.T) {
Kind: "matching", Kind: "matching",
ListKind: "matching", ListKind: "matching",
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
AcceptedNames: apiextensions.CustomResourceDefinitionNames{ AcceptedNames: apiextensions.CustomResourceDefinitionNames{
@ -843,6 +862,7 @@ func TestValidateCustomResourceDefinition(t *testing.T) {
AdditionalProperties: &apiextensions.JSONSchemaPropsOrBool{Allows: false}, AdditionalProperties: &apiextensions.JSONSchemaPropsOrBool{Allows: false},
}, },
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"}, StoredVersions: []string{"version"},
@ -880,6 +900,7 @@ func TestValidateCustomResourceDefinition(t *testing.T) {
}, },
}, },
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"}, StoredVersions: []string{"version"},
@ -923,6 +944,7 @@ func TestValidateCustomResourceDefinition(t *testing.T) {
Kind: "Plural", Kind: "Plural",
ListKind: "PluralList", ListKind: "PluralList",
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"}, StoredVersions: []string{"version"},
@ -962,6 +984,7 @@ func TestValidateCustomResourceDefinition(t *testing.T) {
Kind: "Plural", Kind: "Plural",
ListKind: "PluralList", ListKind: "PluralList",
}, },
PreserveUnknownFields: pointer.BoolPtr(false),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"}, StoredVersions: []string{"version"},
@ -971,36 +994,206 @@ func TestValidateCustomResourceDefinition(t *testing.T) {
invalid("spec", "validation", "openAPIV3Schema", "x-kubernetes-preserve-unknown-fields"), invalid("spec", "validation", "openAPIV3Schema", "x-kubernetes-preserve-unknown-fields"),
}, },
}, },
{
name: "preserveUnknownFields with unstructural global schema",
resource: &apiextensions.CustomResourceDefinition{
ObjectMeta: metav1.ObjectMeta{Name: "plural.group.com"},
Spec: apiextensions.CustomResourceDefinitionSpec{
Group: "group.com",
Version: "version",
Validation: &apiextensions.CustomResourceValidation{
OpenAPIV3Schema: validUnstructuralValidationSchema,
},
Versions: []apiextensions.CustomResourceDefinitionVersion{
{
Name: "version",
Served: true,
Storage: true,
},
{
Name: "version2",
Served: true,
Storage: false,
},
},
Scope: apiextensions.NamespaceScoped,
Names: apiextensions.CustomResourceDefinitionNames{
Plural: "plural",
Singular: "singular",
Kind: "Plural",
ListKind: "PluralList",
},
PreserveUnknownFields: pointer.BoolPtr(false),
},
Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"},
},
},
errors: []validationMatch{
required("spec", "validation", "openAPIV3Schema", "properties[spec]", "type"),
required("spec", "validation", "openAPIV3Schema", "properties[status]", "type"),
required("spec", "validation", "openAPIV3Schema", "items", "type"),
},
},
{
name: "preserveUnknownFields with unstructural schema in one version",
resource: &apiextensions.CustomResourceDefinition{
ObjectMeta: metav1.ObjectMeta{Name: "plural.group.com"},
Spec: apiextensions.CustomResourceDefinitionSpec{
Group: "group.com",
Version: "version",
Versions: []apiextensions.CustomResourceDefinitionVersion{
{
Name: "version",
Served: true,
Storage: true,
Schema: &apiextensions.CustomResourceValidation{
OpenAPIV3Schema: validValidationSchema,
},
},
{
Name: "version2",
Served: true,
Storage: false,
Schema: &apiextensions.CustomResourceValidation{
OpenAPIV3Schema: validUnstructuralValidationSchema,
},
},
},
Scope: apiextensions.NamespaceScoped,
Names: apiextensions.CustomResourceDefinitionNames{
Plural: "plural",
Singular: "singular",
Kind: "Plural",
ListKind: "PluralList",
},
PreserveUnknownFields: pointer.BoolPtr(false),
},
Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"},
},
},
errors: []validationMatch{
required("spec", "versions[1]", "schema", "openAPIV3Schema", "properties[spec]", "type"),
required("spec", "versions[1]", "schema", "openAPIV3Schema", "properties[status]", "type"),
required("spec", "versions[1]", "schema", "openAPIV3Schema", "items", "type"),
},
},
{
name: "preserveUnknownFields with no schema in one version",
resource: &apiextensions.CustomResourceDefinition{
ObjectMeta: metav1.ObjectMeta{Name: "plural.group.com"},
Spec: apiextensions.CustomResourceDefinitionSpec{
Group: "group.com",
Version: "version",
Versions: []apiextensions.CustomResourceDefinitionVersion{
{
Name: "version",
Served: true,
Storage: true,
Schema: &apiextensions.CustomResourceValidation{
OpenAPIV3Schema: validValidationSchema,
},
},
{
Name: "version2",
Served: true,
Storage: false,
Schema: &apiextensions.CustomResourceValidation{
OpenAPIV3Schema: nil,
},
},
},
Scope: apiextensions.NamespaceScoped,
Names: apiextensions.CustomResourceDefinitionNames{
Plural: "plural",
Singular: "singular",
Kind: "Plural",
ListKind: "PluralList",
},
PreserveUnknownFields: pointer.BoolPtr(false),
},
Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"},
},
},
errors: []validationMatch{
required("spec", "versions[1]", "schema", "openAPIV3Schema"),
},
},
{
name: "preserveUnknownFields with no schema at all",
resource: &apiextensions.CustomResourceDefinition{
ObjectMeta: metav1.ObjectMeta{Name: "plural.group.com"},
Spec: apiextensions.CustomResourceDefinitionSpec{
Group: "group.com",
Version: "version",
Versions: []apiextensions.CustomResourceDefinitionVersion{
{
Name: "version",
Served: true,
Storage: true,
Schema: nil,
},
{
Name: "version2",
Served: true,
Storage: false,
Schema: &apiextensions.CustomResourceValidation{
OpenAPIV3Schema: nil,
},
},
},
Scope: apiextensions.NamespaceScoped,
Names: apiextensions.CustomResourceDefinitionNames{
Plural: "plural",
Singular: "singular",
Kind: "Plural",
ListKind: "PluralList",
},
PreserveUnknownFields: pointer.BoolPtr(false),
},
Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"},
},
},
errors: []validationMatch{
required("spec", "versions[0]", "schema", "openAPIV3Schema"),
required("spec", "versions[1]", "schema", "openAPIV3Schema"),
},
},
} }
for _, tc := range tests { for _, tc := range tests {
// duplicate defaulting behaviour t.Run(tc.name, func(t *testing.T) {
if tc.resource.Spec.Conversion != nil && tc.resource.Spec.Conversion.Strategy == apiextensions.WebhookConverter && len(tc.resource.Spec.Conversion.ConversionReviewVersions) == 0 { // duplicate defaulting behaviour
tc.resource.Spec.Conversion.ConversionReviewVersions = []string{"v1beta1"} if tc.resource.Spec.Conversion != nil && tc.resource.Spec.Conversion.Strategy == apiextensions.WebhookConverter && len(tc.resource.Spec.Conversion.ConversionReviewVersions) == 0 {
} tc.resource.Spec.Conversion.ConversionReviewVersions = []string{"v1beta1"}
errs := ValidateCustomResourceDefinition(tc.resource) }
seenErrs := make([]bool, len(errs)) errs := ValidateCustomResourceDefinition(tc.resource)
seenErrs := make([]bool, len(errs))
for _, expectedError := range tc.errors { for _, expectedError := range tc.errors {
found := false found := false
for i, err := range errs { for i, err := range errs {
if expectedError.matches(err) && !seenErrs[i] { if expectedError.matches(err) && !seenErrs[i] {
found = true found = true
seenErrs[i] = true seenErrs[i] = true
break break
}
}
if !found {
t.Errorf("expected %v at %v, got %v", expectedError.errorType, expectedError.path.String(), errs)
} }
} }
if !found { for i, seen := range seenErrs {
t.Errorf("%s: expected %v at %v, got %v", tc.name, expectedError.errorType, expectedError.path.String(), errs) if !seen {
t.Errorf("unexpected error: %v", errs[i])
}
} }
} })
for i, seen := range seenErrs {
if !seen {
t.Errorf("%s: unexpected error: %v", tc.name, errs[i])
}
}
} }
} }
@ -1043,6 +1236,7 @@ func TestValidateCustomResourceDefinitionUpdate(t *testing.T) {
}, },
ConversionReviewVersions: []string{"invalid-version"}, ConversionReviewVersions: []string{"invalid-version"},
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"}, StoredVersions: []string{"version"},
@ -1078,6 +1272,7 @@ func TestValidateCustomResourceDefinitionUpdate(t *testing.T) {
}, },
ConversionReviewVersions: []string{"invalid-version_0, invalid-version"}, ConversionReviewVersions: []string{"invalid-version_0, invalid-version"},
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"}, StoredVersions: []string{"version"},
@ -1117,6 +1312,7 @@ func TestValidateCustomResourceDefinitionUpdate(t *testing.T) {
}, },
ConversionReviewVersions: []string{"invalid-version"}, ConversionReviewVersions: []string{"invalid-version"},
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"}, StoredVersions: []string{"version"},
@ -1152,6 +1348,7 @@ func TestValidateCustomResourceDefinitionUpdate(t *testing.T) {
}, },
ConversionReviewVersions: []string{"v1beta1", "invalid-version"}, ConversionReviewVersions: []string{"v1beta1", "invalid-version"},
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"}, StoredVersions: []string{"version"},
@ -1193,6 +1390,7 @@ func TestValidateCustomResourceDefinitionUpdate(t *testing.T) {
}, },
ConversionReviewVersions: []string{"invalid-version"}, ConversionReviewVersions: []string{"invalid-version"},
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"}, StoredVersions: []string{"version"},
@ -1227,6 +1425,7 @@ func TestValidateCustomResourceDefinitionUpdate(t *testing.T) {
URL: strPtr("https://example.com/webhook"), URL: strPtr("https://example.com/webhook"),
}, },
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"}, StoredVersions: []string{"version"},
@ -1260,6 +1459,7 @@ func TestValidateCustomResourceDefinitionUpdate(t *testing.T) {
Kind: "kind", Kind: "kind",
ListKind: "listkind", ListKind: "listkind",
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
AcceptedNames: apiextensions.CustomResourceDefinitionNames{ AcceptedNames: apiextensions.CustomResourceDefinitionNames{
@ -1292,6 +1492,7 @@ func TestValidateCustomResourceDefinitionUpdate(t *testing.T) {
Kind: "kind", Kind: "kind",
ListKind: "listkind", ListKind: "listkind",
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
AcceptedNames: apiextensions.CustomResourceDefinitionNames{ AcceptedNames: apiextensions.CustomResourceDefinitionNames{
@ -1329,6 +1530,7 @@ func TestValidateCustomResourceDefinitionUpdate(t *testing.T) {
Kind: "kind", Kind: "kind",
ListKind: "listkind", ListKind: "listkind",
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
AcceptedNames: apiextensions.CustomResourceDefinitionNames{ AcceptedNames: apiextensions.CustomResourceDefinitionNames{
@ -1364,6 +1566,7 @@ func TestValidateCustomResourceDefinitionUpdate(t *testing.T) {
Kind: "kind", Kind: "kind",
ListKind: "listkind", ListKind: "listkind",
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
AcceptedNames: apiextensions.CustomResourceDefinitionNames{ AcceptedNames: apiextensions.CustomResourceDefinitionNames{
@ -1406,6 +1609,7 @@ func TestValidateCustomResourceDefinitionUpdate(t *testing.T) {
Kind: "kind", Kind: "kind",
ListKind: "listkind", ListKind: "listkind",
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
AcceptedNames: apiextensions.CustomResourceDefinitionNames{ AcceptedNames: apiextensions.CustomResourceDefinitionNames{
@ -1442,6 +1646,7 @@ func TestValidateCustomResourceDefinitionUpdate(t *testing.T) {
Kind: "kind", Kind: "kind",
ListKind: "listkind", ListKind: "listkind",
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
AcceptedNames: apiextensions.CustomResourceDefinitionNames{ AcceptedNames: apiextensions.CustomResourceDefinitionNames{
@ -1481,6 +1686,7 @@ func TestValidateCustomResourceDefinitionUpdate(t *testing.T) {
Kind: "kind", Kind: "kind",
ListKind: "listkind", ListKind: "listkind",
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
AcceptedNames: apiextensions.CustomResourceDefinitionNames{ AcceptedNames: apiextensions.CustomResourceDefinitionNames{
@ -1516,6 +1722,7 @@ func TestValidateCustomResourceDefinitionUpdate(t *testing.T) {
Kind: "kind2", Kind: "kind2",
ListKind: "listkind2", ListKind: "listkind2",
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
AcceptedNames: apiextensions.CustomResourceDefinitionNames{ AcceptedNames: apiextensions.CustomResourceDefinitionNames{
@ -1556,6 +1763,7 @@ func TestValidateCustomResourceDefinitionUpdate(t *testing.T) {
Kind: "kind", Kind: "kind",
ListKind: "listkind", ListKind: "listkind",
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
AcceptedNames: apiextensions.CustomResourceDefinitionNames{ AcceptedNames: apiextensions.CustomResourceDefinitionNames{
@ -1591,6 +1799,7 @@ func TestValidateCustomResourceDefinitionUpdate(t *testing.T) {
Kind: "kind2", Kind: "kind2",
ListKind: "listkind2", ListKind: "listkind2",
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
AcceptedNames: apiextensions.CustomResourceDefinitionNames{ AcceptedNames: apiextensions.CustomResourceDefinitionNames{
@ -1639,6 +1848,7 @@ func TestValidateCustomResourceDefinitionUpdate(t *testing.T) {
Kind: "Plural", Kind: "Plural",
ListKind: "PluralList", ListKind: "PluralList",
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"}, StoredVersions: []string{"version"},
@ -1680,6 +1890,7 @@ func TestValidateCustomResourceDefinitionUpdate(t *testing.T) {
Kind: "Plural", Kind: "Plural",
ListKind: "PluralList", ListKind: "PluralList",
}, },
PreserveUnknownFields: pointer.BoolPtr(true),
}, },
Status: apiextensions.CustomResourceDefinitionStatus{ Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"}, StoredVersions: []string{"version"},
@ -1690,6 +1901,208 @@ func TestValidateCustomResourceDefinitionUpdate(t *testing.T) {
forbidden("spec", "subresources"), forbidden("spec", "subresources"),
}, },
}, },
{
name: "switch off preserveUnknownFields with structural schema before and after",
old: &apiextensions.CustomResourceDefinition{
ObjectMeta: metav1.ObjectMeta{
Name: "plural.group.com",
ResourceVersion: "42",
},
Spec: apiextensions.CustomResourceDefinitionSpec{
Group: "group.com",
Version: "version",
Validation: &apiextensions.CustomResourceValidation{
OpenAPIV3Schema: validValidationSchema,
},
Versions: []apiextensions.CustomResourceDefinitionVersion{
{
Name: "version",
Served: true,
Storage: true,
},
},
Scope: apiextensions.NamespaceScoped,
Names: apiextensions.CustomResourceDefinitionNames{
Plural: "plural",
Singular: "singular",
Kind: "Plural",
ListKind: "PluralList",
},
PreserveUnknownFields: pointer.BoolPtr(true),
},
Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"},
},
},
resource: &apiextensions.CustomResourceDefinition{
ObjectMeta: metav1.ObjectMeta{
Name: "plural.group.com",
ResourceVersion: "42",
},
Spec: apiextensions.CustomResourceDefinitionSpec{
Group: "group.com",
Version: "version",
Validation: &apiextensions.CustomResourceValidation{
OpenAPIV3Schema: validUnstructuralValidationSchema,
},
Versions: []apiextensions.CustomResourceDefinitionVersion{
{
Name: "version",
Served: true,
Storage: true,
},
},
Scope: apiextensions.NamespaceScoped,
Names: apiextensions.CustomResourceDefinitionNames{
Plural: "plural",
Singular: "singular",
Kind: "Plural",
ListKind: "PluralList",
},
PreserveUnknownFields: pointer.BoolPtr(false),
},
Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"},
},
},
errors: []validationMatch{
required("spec", "validation", "openAPIV3Schema", "properties[spec]", "type"),
required("spec", "validation", "openAPIV3Schema", "properties[status]", "type"),
required("spec", "validation", "openAPIV3Schema", "items", "type"),
},
},
{
name: "switch off preserveUnknownFields without structural schema before, but with after",
old: &apiextensions.CustomResourceDefinition{
ObjectMeta: metav1.ObjectMeta{
Name: "plural.group.com",
ResourceVersion: "42",
},
Spec: apiextensions.CustomResourceDefinitionSpec{
Group: "group.com",
Version: "version",
Validation: &apiextensions.CustomResourceValidation{
OpenAPIV3Schema: validUnstructuralValidationSchema,
},
Versions: []apiextensions.CustomResourceDefinitionVersion{
{
Name: "version",
Served: true,
Storage: true,
},
},
Scope: apiextensions.NamespaceScoped,
Names: apiextensions.CustomResourceDefinitionNames{
Plural: "plural",
Singular: "singular",
Kind: "Plural",
ListKind: "PluralList",
},
PreserveUnknownFields: pointer.BoolPtr(true),
},
Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"},
},
},
resource: &apiextensions.CustomResourceDefinition{
ObjectMeta: metav1.ObjectMeta{
Name: "plural.group.com",
ResourceVersion: "42",
},
Spec: apiextensions.CustomResourceDefinitionSpec{
Group: "group.com",
Version: "version",
Validation: &apiextensions.CustomResourceValidation{
OpenAPIV3Schema: validValidationSchema,
},
Versions: []apiextensions.CustomResourceDefinitionVersion{
{
Name: "version",
Served: true,
Storage: true,
},
},
Scope: apiextensions.NamespaceScoped,
Names: apiextensions.CustomResourceDefinitionNames{
Plural: "plural",
Singular: "singular",
Kind: "Plural",
ListKind: "PluralList",
},
PreserveUnknownFields: pointer.BoolPtr(false),
},
Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"},
},
},
errors: []validationMatch{},
},
{
name: "switch on preserveUnknownFields without structural schema",
old: &apiextensions.CustomResourceDefinition{
ObjectMeta: metav1.ObjectMeta{
Name: "plural.group.com",
ResourceVersion: "42",
},
Spec: apiextensions.CustomResourceDefinitionSpec{
Group: "group.com",
Version: "version",
Validation: &apiextensions.CustomResourceValidation{
OpenAPIV3Schema: validValidationSchema,
},
Versions: []apiextensions.CustomResourceDefinitionVersion{
{
Name: "version",
Served: true,
Storage: true,
},
},
Scope: apiextensions.NamespaceScoped,
Names: apiextensions.CustomResourceDefinitionNames{
Plural: "plural",
Singular: "singular",
Kind: "Plural",
ListKind: "PluralList",
},
PreserveUnknownFields: pointer.BoolPtr(false),
},
Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"},
},
},
resource: &apiextensions.CustomResourceDefinition{
ObjectMeta: metav1.ObjectMeta{
Name: "plural.group.com",
ResourceVersion: "42",
},
Spec: apiextensions.CustomResourceDefinitionSpec{
Group: "group.com",
Version: "version",
Validation: &apiextensions.CustomResourceValidation{
OpenAPIV3Schema: validUnstructuralValidationSchema,
},
Versions: []apiextensions.CustomResourceDefinitionVersion{
{
Name: "version",
Served: true,
Storage: true,
},
},
Scope: apiextensions.NamespaceScoped,
Names: apiextensions.CustomResourceDefinitionNames{
Plural: "plural",
Singular: "singular",
Kind: "Plural",
ListKind: "PluralList",
},
PreserveUnknownFields: pointer.BoolPtr(true),
},
Status: apiextensions.CustomResourceDefinitionStatus{
StoredVersions: []string{"version"},
},
},
errors: []validationMatch{},
},
} }
for _, tc := range tests { for _, tc := range tests {
@ -1721,10 +2134,11 @@ func TestValidateCustomResourceDefinitionUpdate(t *testing.T) {
func TestValidateCustomResourceDefinitionValidation(t *testing.T) { func TestValidateCustomResourceDefinitionValidation(t *testing.T) {
tests := []struct { tests := []struct {
name string name string
input apiextensions.CustomResourceValidation input apiextensions.CustomResourceValidation
statusEnabled bool mustBeStructural bool
wantError bool statusEnabled bool
wantError bool
}{ }{
{ {
name: "empty", name: "empty",
@ -1844,10 +2258,28 @@ func TestValidateCustomResourceDefinitionValidation(t *testing.T) {
}, },
wantError: false, wantError: false,
}, },
{
name: "must be structural, but isn't",
input: apiextensions.CustomResourceValidation{
OpenAPIV3Schema: &apiextensions.JSONSchemaProps{},
},
mustBeStructural: true,
wantError: true,
},
{
name: "must be structural",
input: apiextensions.CustomResourceValidation{
OpenAPIV3Schema: &apiextensions.JSONSchemaProps{
Type: "object",
},
},
mustBeStructural: true,
wantError: false,
},
} }
for _, tt := range tests { for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) { t.Run(tt.name, func(t *testing.T) {
got := ValidateCustomResourceDefinitionValidation(&tt.input, tt.statusEnabled, field.NewPath("spec", "validation")) got := ValidateCustomResourceDefinitionValidation(&tt.input, tt.mustBeStructural, tt.statusEnabled, field.NewPath("spec", "validation"))
if !tt.wantError && len(got) > 0 { if !tt.wantError && len(got) > 0 {
t.Errorf("Expected no error, but got: %v", got) t.Errorf("Expected no error, but got: %v", got)
} else if tt.wantError && len(got) == 0 { } else if tt.wantError && len(got) == 0 {
@ -1860,6 +2292,42 @@ func TestValidateCustomResourceDefinitionValidation(t *testing.T) {
var example = apiextensions.JSON(`"This is an example"`) var example = apiextensions.JSON(`"This is an example"`)
var validValidationSchema = &apiextensions.JSONSchemaProps{ var validValidationSchema = &apiextensions.JSONSchemaProps{
Description: "This is a description",
Type: "object",
Format: "date-time",
Title: "This is a title",
Maximum: float64Ptr(10),
ExclusiveMaximum: true,
Minimum: float64Ptr(5),
ExclusiveMinimum: true,
MaxLength: int64Ptr(10),
MinLength: int64Ptr(5),
Pattern: "^[a-z]$",
MaxItems: int64Ptr(10),
MinItems: int64Ptr(5),
MultipleOf: float64Ptr(3),
Required: []string{"spec", "status"},
Properties: map[string]apiextensions.JSONSchemaProps{
"spec": {
Type: "object",
Items: &apiextensions.JSONSchemaPropsOrArray{
Schema: &apiextensions.JSONSchemaProps{
Description: "This is a schema nested under Items",
Type: "string",
},
},
},
"status": {
Type: "object",
},
},
ExternalDocs: &apiextensions.ExternalDocumentation{
Description: "This is an external documentation description",
},
Example: &example,
}
var validUnstructuralValidationSchema = &apiextensions.JSONSchemaProps{
Description: "This is a description", Description: "This is a description",
Type: "object", Type: "object",
Format: "date-time", Format: "date-time",