/* Copyright 2022 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 validation import ( "fmt" "strings" "testing" metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" "k8s.io/apimachinery/pkg/runtime" "k8s.io/apimachinery/pkg/types" "k8s.io/apimachinery/pkg/util/validation/field" utilfeature "k8s.io/apiserver/pkg/util/feature" featuregatetesting "k8s.io/component-base/featuregate/testing" "k8s.io/dynamic-resource-allocation/structured" "k8s.io/kubernetes/pkg/apis/core" "k8s.io/kubernetes/pkg/apis/resource" "k8s.io/kubernetes/pkg/features" "k8s.io/utils/pointer" "k8s.io/utils/ptr" ) func testClaim(name, namespace string, spec resource.ResourceClaimSpec) *resource.ResourceClaim { return &resource.ResourceClaim{ ObjectMeta: metav1.ObjectMeta{ Name: name, Namespace: namespace, }, Spec: *spec.DeepCopy(), } } const ( goodName = "foo" badName = "!@#$%^" goodNS = "ns" ) var ( validClaimSpec = resource.ResourceClaimSpec{ Devices: resource.DeviceClaim{ Requests: []resource.DeviceRequest{{ Name: goodName, DeviceClassName: goodName, AllocationMode: resource.DeviceAllocationModeExactCount, Count: 1, }}, }, } validClaim = testClaim(goodName, goodNS, validClaimSpec) ) func TestValidateClaim(t *testing.T) { now := metav1.Now() badValue := "spaces not allowed" scenarios := map[string]struct { claim *resource.ResourceClaim wantFailures field.ErrorList }{ "good-claim": { claim: testClaim(goodName, goodNS, validClaimSpec), }, "missing-name": { wantFailures: field.ErrorList{field.Required(field.NewPath("metadata", "name"), "name or generateName is required")}, claim: testClaim("", goodNS, validClaimSpec), }, "bad-name": { wantFailures: field.ErrorList{field.Invalid(field.NewPath("metadata", "name"), badName, "a lowercase RFC 1123 subdomain must consist of lower case alphanumeric characters, '-' or '.', and must start and end with an alphanumeric character (e.g. 'example.com', regex used for validation is '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*')")}, claim: testClaim(badName, goodNS, validClaimSpec), }, "missing-namespace": { wantFailures: field.ErrorList{field.Required(field.NewPath("metadata", "namespace"), "")}, claim: testClaim(goodName, "", validClaimSpec), }, "generate-name": { claim: func() *resource.ResourceClaim { claim := testClaim(goodName, goodNS, validClaimSpec) claim.GenerateName = "pvc-" return claim }(), }, "uid": { claim: func() *resource.ResourceClaim { claim := testClaim(goodName, goodNS, validClaimSpec) claim.UID = "ac051fac-2ead-46d9-b8b4-4e0fbeb7455d" return claim }(), }, "resource-version": { claim: func() *resource.ResourceClaim { claim := testClaim(goodName, goodNS, validClaimSpec) claim.ResourceVersion = "1" return claim }(), }, "generation": { claim: func() *resource.ResourceClaim { claim := testClaim(goodName, goodNS, validClaimSpec) claim.Generation = 100 return claim }(), }, "creation-timestamp": { claim: func() *resource.ResourceClaim { claim := testClaim(goodName, goodNS, validClaimSpec) claim.CreationTimestamp = now return claim }(), }, "deletion-grace-period-seconds": { claim: func() *resource.ResourceClaim { claim := testClaim(goodName, goodNS, validClaimSpec) claim.DeletionGracePeriodSeconds = pointer.Int64(10) return claim }(), }, "owner-references": { claim: func() *resource.ResourceClaim { claim := testClaim(goodName, goodNS, validClaimSpec) claim.OwnerReferences = []metav1.OwnerReference{ { APIVersion: "v1", Kind: "pod", Name: "foo", UID: "ac051fac-2ead-46d9-b8b4-4e0fbeb7455d", }, } return claim }(), }, "finalizers": { claim: func() *resource.ResourceClaim { claim := testClaim(goodName, goodNS, validClaimSpec) claim.Finalizers = []string{ "example.com/foo", } return claim }(), }, "managed-fields": { claim: func() *resource.ResourceClaim { claim := testClaim(goodName, goodNS, validClaimSpec) claim.ManagedFields = []metav1.ManagedFieldsEntry{ { FieldsType: "FieldsV1", Operation: "Apply", APIVersion: "apps/v1", Manager: "foo", }, } return claim }(), }, "good-labels": { claim: func() *resource.ResourceClaim { claim := testClaim(goodName, goodNS, validClaimSpec) claim.Labels = map[string]string{ "apps.kubernetes.io/name": "test", } return claim }(), }, "bad-labels": { wantFailures: field.ErrorList{field.Invalid(field.NewPath("metadata", "labels"), badValue, "a valid label must be an empty string or consist of alphanumeric characters, '-', '_' or '.', and must start and end with an alphanumeric character (e.g. 'MyValue', or 'my_value', or '12345', regex used for validation is '(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?')")}, claim: func() *resource.ResourceClaim { claim := testClaim(goodName, goodNS, validClaimSpec) claim.Labels = map[string]string{ "hello-world": badValue, } return claim }(), }, "good-annotations": { claim: func() *resource.ResourceClaim { claim := testClaim(goodName, goodNS, validClaimSpec) claim.Annotations = map[string]string{ "foo": "bar", } return claim }(), }, "bad-annotations": { wantFailures: field.ErrorList{field.Invalid(field.NewPath("metadata", "annotations"), badName, "name part must consist of alphanumeric characters, '-', '_' or '.', and must start and end with an alphanumeric character (e.g. 'MyName', or 'my.name', or '123-abc', regex used for validation is '([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]')")}, claim: func() *resource.ResourceClaim { claim := testClaim(goodName, goodNS, validClaimSpec) claim.Annotations = map[string]string{ badName: "hello world", } return claim }(), }, "bad-classname": { wantFailures: field.ErrorList{field.Invalid(field.NewPath("spec", "devices", "requests").Index(0).Child("deviceClassName"), badName, "a lowercase RFC 1123 subdomain must consist of lower case alphanumeric characters, '-' or '.', and must start and end with an alphanumeric character (e.g. 'example.com', regex used for validation is '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*')")}, claim: func() *resource.ResourceClaim { claim := testClaim(goodName, goodNS, validClaimSpec) claim.Spec.Devices.Requests[0].DeviceClassName = badName return claim }(), }, "missing-classname": { wantFailures: field.ErrorList{field.Required(field.NewPath("spec", "devices", "requests").Index(0).Child("deviceClassName"), "")}, claim: func() *resource.ResourceClaim { claim := testClaim(goodName, goodNS, validClaimSpec) claim.Spec.Devices.Requests[0].DeviceClassName = "" return claim }(), }, "invalid-request": { wantFailures: field.ErrorList{ field.TooMany(field.NewPath("spec", "devices", "requests"), resource.DeviceRequestsMaxSize+1, resource.DeviceRequestsMaxSize), field.Invalid(field.NewPath("spec", "devices", "constraints").Index(0).Child("requests").Index(1), badName, "a lowercase RFC 1123 label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character (e.g. 'my-name', or '123-abc', regex used for validation is '[a-z0-9]([-a-z0-9]*[a-z0-9])?')"), field.Invalid(field.NewPath("spec", "devices", "constraints").Index(0).Child("requests").Index(1), badName, "must be the name of a request in the claim"), field.TypeInvalid(field.NewPath("spec", "devices", "constraints").Index(0).Child("matchAttribute"), "missing-domain", "a valid C identifier must start with alphabetic character or '_', followed by a string of alphanumeric characters or '_' (e.g. 'my_name', or 'MY_NAME', or 'MyName', regex used for validation is '[A-Za-z_][A-Za-z0-9_]*')"), field.Invalid(field.NewPath("spec", "devices", "constraints").Index(0).Child("matchAttribute"), resource.FullyQualifiedName("missing-domain"), "must include a domain"), field.Required(field.NewPath("spec", "devices", "constraints").Index(1).Child("matchAttribute"), "name required"), field.Required(field.NewPath("spec", "devices", "constraints").Index(2).Child("matchAttribute"), ""), field.TooMany(field.NewPath("spec", "devices", "constraints"), resource.DeviceConstraintsMaxSize+1, resource.DeviceConstraintsMaxSize), field.Invalid(field.NewPath("spec", "devices", "config").Index(0).Child("requests").Index(1), badName, "a lowercase RFC 1123 label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character (e.g. 'my-name', or '123-abc', regex used for validation is '[a-z0-9]([-a-z0-9]*[a-z0-9])?')"), field.Invalid(field.NewPath("spec", "devices", "config").Index(0).Child("requests").Index(1), badName, "must be the name of a request in the claim"), field.TooMany(field.NewPath("spec", "devices", "config"), resource.DeviceConfigMaxSize+1, resource.DeviceConfigMaxSize), }, claim: func() *resource.ResourceClaim { claim := testClaim(goodName, goodNS, validClaimSpec) claim.Spec.Devices.Constraints = []resource.DeviceConstraint{ { Requests: []string{claim.Spec.Devices.Requests[0].Name, badName}, MatchAttribute: ptr.To(resource.FullyQualifiedName("missing-domain")), }, { MatchAttribute: ptr.To(resource.FullyQualifiedName("")), }, { MatchAttribute: nil, }, } for i := len(claim.Spec.Devices.Constraints); i < resource.DeviceConstraintsMaxSize+1; i++ { claim.Spec.Devices.Constraints = append(claim.Spec.Devices.Constraints, resource.DeviceConstraint{MatchAttribute: ptr.To(resource.FullyQualifiedName("foo/bar"))}) } claim.Spec.Devices.Config = []resource.DeviceClaimConfiguration{{ Requests: []string{claim.Spec.Devices.Requests[0].Name, badName}, DeviceConfiguration: resource.DeviceConfiguration{ Opaque: &resource.OpaqueDeviceConfiguration{ Driver: "dra.example.com", Parameters: runtime.RawExtension{ Raw: []byte(`{"kind": "foo", "apiVersion": "dra.example.com/v1"}`), }, }, }, }} for i := len(claim.Spec.Devices.Config); i < resource.DeviceConfigMaxSize+1; i++ { claim.Spec.Devices.Config = append(claim.Spec.Devices.Config, resource.DeviceClaimConfiguration{ DeviceConfiguration: resource.DeviceConfiguration{ Opaque: &resource.OpaqueDeviceConfiguration{ Driver: "dra.example.com", Parameters: runtime.RawExtension{ Raw: []byte(`{"kind": "foo", "apiVersion": "dra.example.com/v1"}`), }, }, }, }) } for i := len(claim.Spec.Devices.Requests); i < resource.DeviceRequestsMaxSize+1; i++ { req := claim.Spec.Devices.Requests[0].DeepCopy() req.Name += fmt.Sprintf("%d", i) claim.Spec.Devices.Requests = append(claim.Spec.Devices.Requests, *req) } return claim }(), }, "valid-request": { claim: func() *resource.ResourceClaim { claim := testClaim(goodName, goodNS, validClaimSpec) for i := len(claim.Spec.Devices.Constraints); i < resource.DeviceConstraintsMaxSize; i++ { claim.Spec.Devices.Constraints = append(claim.Spec.Devices.Constraints, resource.DeviceConstraint{MatchAttribute: ptr.To(resource.FullyQualifiedName("foo/bar"))}) } for i := len(claim.Spec.Devices.Config); i < resource.DeviceConfigMaxSize; i++ { claim.Spec.Devices.Config = append(claim.Spec.Devices.Config, resource.DeviceClaimConfiguration{ DeviceConfiguration: resource.DeviceConfiguration{ Opaque: &resource.OpaqueDeviceConfiguration{ Driver: "dra.example.com", Parameters: runtime.RawExtension{ Raw: []byte(`{"kind": "foo", "apiVersion": "dra.example.com/v1"}`), }, }, }, }) } for i := len(claim.Spec.Devices.Requests); i < resource.DeviceRequestsMaxSize; i++ { req := claim.Spec.Devices.Requests[0].DeepCopy() req.Name += fmt.Sprintf("%d", i) claim.Spec.Devices.Requests = append(claim.Spec.Devices.Requests, *req) } return claim }(), }, "invalid-spec": { wantFailures: field.ErrorList{ field.Invalid(field.NewPath("spec", "devices", "constraints").Index(0).Child("requests").Index(1), badName, "a lowercase RFC 1123 label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character (e.g. 'my-name', or '123-abc', regex used for validation is '[a-z0-9]([-a-z0-9]*[a-z0-9])?')"), field.Invalid(field.NewPath("spec", "devices", "constraints").Index(0).Child("requests").Index(1), badName, "must be the name of a request in the claim"), field.TypeInvalid(field.NewPath("spec", "devices", "constraints").Index(0).Child("matchAttribute"), "missing-domain", "a valid C identifier must start with alphabetic character or '_', followed by a string of alphanumeric characters or '_' (e.g. 'my_name', or 'MY_NAME', or 'MyName', regex used for validation is '[A-Za-z_][A-Za-z0-9_]*')"), field.Invalid(field.NewPath("spec", "devices", "constraints").Index(0).Child("matchAttribute"), resource.FullyQualifiedName("missing-domain"), "must include a domain"), field.Required(field.NewPath("spec", "devices", "constraints").Index(1).Child("matchAttribute"), "name required"), field.Required(field.NewPath("spec", "devices", "constraints").Index(2).Child("matchAttribute"), ""), field.Invalid(field.NewPath("spec", "devices", "config").Index(0).Child("requests").Index(1), badName, "a lowercase RFC 1123 label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character (e.g. 'my-name', or '123-abc', regex used for validation is '[a-z0-9]([-a-z0-9]*[a-z0-9])?')"), field.Invalid(field.NewPath("spec", "devices", "config").Index(0).Child("requests").Index(1), badName, "must be the name of a request in the claim"), }, claim: func() *resource.ResourceClaim { claim := testClaim(goodName, goodNS, validClaimSpec) claim.Spec.Devices.Constraints = []resource.DeviceConstraint{ { Requests: []string{claim.Spec.Devices.Requests[0].Name, badName}, MatchAttribute: ptr.To(resource.FullyQualifiedName("missing-domain")), }, { MatchAttribute: ptr.To(resource.FullyQualifiedName("")), }, { MatchAttribute: nil, }, } claim.Spec.Devices.Config = []resource.DeviceClaimConfiguration{{ Requests: []string{claim.Spec.Devices.Requests[0].Name, badName}, DeviceConfiguration: resource.DeviceConfiguration{ Opaque: &resource.OpaqueDeviceConfiguration{ Driver: "dra.example.com", Parameters: runtime.RawExtension{ Raw: []byte(`{"kind": "foo", "apiVersion": "dra.example.com/v1"}`), }, }, }, }} return claim }(), }, "allocation-mode": { wantFailures: field.ErrorList{ field.Invalid(field.NewPath("spec", "devices", "requests").Index(2).Child("count"), int64(-1), "must be greater than zero"), field.NotSupported(field.NewPath("spec", "devices", "requests").Index(3).Child("allocationMode"), resource.DeviceAllocationMode("other"), []resource.DeviceAllocationMode{resource.DeviceAllocationModeAll, resource.DeviceAllocationModeExactCount}), field.Invalid(field.NewPath("spec", "devices", "requests").Index(4).Child("count"), int64(2), "must not be specified when allocationMode is 'All'"), field.Duplicate(field.NewPath("spec", "devices", "requests").Index(5).Child("name"), "foo"), }, claim: func() *resource.ResourceClaim { claim := testClaim(goodName, goodNS, validClaimSpec) goodReq := &claim.Spec.Devices.Requests[0] goodReq.Name = "foo" goodReq.AllocationMode = resource.DeviceAllocationModeExactCount goodReq.Count = 1 req := goodReq.DeepCopy() req.Name += "2" req.AllocationMode = resource.DeviceAllocationModeAll req.Count = 0 claim.Spec.Devices.Requests = append(claim.Spec.Devices.Requests, *req) req = goodReq.DeepCopy() req.Name += "3" req.AllocationMode = resource.DeviceAllocationModeExactCount req.Count = -1 claim.Spec.Devices.Requests = append(claim.Spec.Devices.Requests, *req) req = goodReq.DeepCopy() req.Name += "4" req.AllocationMode = resource.DeviceAllocationMode("other") claim.Spec.Devices.Requests = append(claim.Spec.Devices.Requests, *req) req = goodReq.DeepCopy() req.Name += "5" req.AllocationMode = resource.DeviceAllocationModeAll req.Count = 2 claim.Spec.Devices.Requests = append(claim.Spec.Devices.Requests, *req) req = goodReq.DeepCopy() // Same name -> duplicate. goodReq.Name = "foo" claim.Spec.Devices.Requests = append(claim.Spec.Devices.Requests, *req) return claim }(), }, "configuration": { wantFailures: field.ErrorList{ field.Required(field.NewPath("spec", "devices", "config").Index(0).Child("opaque", "parameters"), ""), field.Invalid(field.NewPath("spec", "devices", "config").Index(1).Child("opaque", "parameters"), "", "error parsing data as JSON: unexpected end of JSON input"), field.Invalid(field.NewPath("spec", "devices", "config").Index(2).Child("opaque", "parameters"), "", "parameters must be a valid JSON object"), field.Required(field.NewPath("spec", "devices", "config").Index(3).Child("opaque", "parameters"), ""), field.TooLong(field.NewPath("spec", "devices", "config").Index(5).Child("opaque", "parameters"), "" /* unused */, resource.OpaqueParametersMaxLength), }, claim: func() *resource.ResourceClaim { claim := testClaim(goodName, goodNS, validClaimSpec) claim.Spec.Devices.Config = []resource.DeviceClaimConfiguration{ { DeviceConfiguration: resource.DeviceConfiguration{ Opaque: &resource.OpaqueDeviceConfiguration{ Driver: "dra.example.com", Parameters: runtime.RawExtension{ Raw: []byte(``), }, }, }, }, { DeviceConfiguration: resource.DeviceConfiguration{ Opaque: &resource.OpaqueDeviceConfiguration{ Driver: "dra.example.com", Parameters: runtime.RawExtension{ Raw: []byte(`{`), }, }, }, }, { DeviceConfiguration: resource.DeviceConfiguration{ Opaque: &resource.OpaqueDeviceConfiguration{ Driver: "dra.example.com", Parameters: runtime.RawExtension{ Raw: []byte(`"hello-world"`), }, }, }, }, { DeviceConfiguration: resource.DeviceConfiguration{ Opaque: &resource.OpaqueDeviceConfiguration{ Driver: "dra.example.com", Parameters: runtime.RawExtension{ Raw: []byte(`null`), }, }, }, }, { DeviceConfiguration: resource.DeviceConfiguration{ Opaque: &resource.OpaqueDeviceConfiguration{ Driver: "dra.example.com", Parameters: runtime.RawExtension{ Raw: []byte(`{"str": "` + strings.Repeat("x", resource.OpaqueParametersMaxLength-9-2) + `"}`), }, }, }, }, { DeviceConfiguration: resource.DeviceConfiguration{ Opaque: &resource.OpaqueDeviceConfiguration{ Driver: "dra.example.com", Parameters: runtime.RawExtension{ Raw: []byte(`{"str": "` + strings.Repeat("x", resource.OpaqueParametersMaxLength-9-2+1 /* too large by one */) + `"}`), }, }, }, }, } return claim }(), }, "CEL-compile-errors": { wantFailures: field.ErrorList{ field.Invalid(field.NewPath("spec", "devices", "requests").Index(1).Child("selectors").Index(1).Child("cel", "expression"), `device.attributes[true].someBoolean`, "compilation failed: ERROR: :1:18: found no matching overload for '_[_]' applied to '(map(string, map(string, any)), bool)'\n | device.attributes[true].someBoolean\n | .................^"), }, claim: func() *resource.ResourceClaim { claim := testClaim(goodName, goodNS, validClaimSpec) claim.Spec.Devices.Requests = append(claim.Spec.Devices.Requests, claim.Spec.Devices.Requests[0]) claim.Spec.Devices.Requests[1].Name += "-2" claim.Spec.Devices.Requests[1].Selectors = []resource.DeviceSelector{ { // Good selector. CEL: &resource.CELDeviceSelector{ Expression: `device.driver == "dra.example.com"`, }, }, { // Bad selector. CEL: &resource.CELDeviceSelector{ Expression: `device.attributes[true].someBoolean`, }, }, } return claim }(), }, "CEL-length": { wantFailures: field.ErrorList{ field.TooLong(field.NewPath("spec", "devices", "requests").Index(1).Child("selectors").Index(1).Child("cel", "expression"), "" /*unused*/, resource.CELSelectorExpressionMaxLength), }, claim: func() *resource.ResourceClaim { claim := testClaim(goodName, goodNS, validClaimSpec) claim.Spec.Devices.Requests = append(claim.Spec.Devices.Requests, claim.Spec.Devices.Requests[0]) claim.Spec.Devices.Requests[1].Name += "-2" expression := `device.driver == ""` claim.Spec.Devices.Requests[1].Selectors = []resource.DeviceSelector{ { // Good selector. CEL: &resource.CELDeviceSelector{ Expression: strings.ReplaceAll(expression, `""`, `"`+strings.Repeat("x", resource.CELSelectorExpressionMaxLength-len(expression))+`"`), }, }, { // Too long by one selector. CEL: &resource.CELDeviceSelector{ Expression: strings.ReplaceAll(expression, `""`, `"`+strings.Repeat("x", resource.CELSelectorExpressionMaxLength-len(expression)+1)+`"`), }, }, } return claim }(), }, "CEL-cost": { wantFailures: field.ErrorList{ field.Forbidden(field.NewPath("spec", "devices", "requests").Index(0).Child("selectors").Index(0).Child("cel", "expression"), "too complex, exceeds cost limit"), }, claim: func() *resource.ResourceClaim { claim := testClaim(goodName, goodNS, validClaimSpec) claim.Spec.Devices.Requests[0].Selectors = []resource.DeviceSelector{ { CEL: &resource.CELDeviceSelector{ Expression: `device.attributes["dra.example.com"].map(s, s.lowerAscii()).map(s, s.size()).sum() == 0`, }, }, } return claim }(), }, } for name, scenario := range scenarios { t.Run(name, func(t *testing.T) { errs := ValidateResourceClaim(scenario.claim) assertFailures(t, scenario.wantFailures, errs) }) } } func TestValidateClaimUpdate(t *testing.T) { scenarios := map[string]struct { oldClaim *resource.ResourceClaim update func(claim *resource.ResourceClaim) *resource.ResourceClaim wantFailures field.ErrorList }{ "valid-no-op-update": { oldClaim: validClaim, update: func(claim *resource.ResourceClaim) *resource.ResourceClaim { return claim }, }, "invalid-update": { wantFailures: field.ErrorList{field.Invalid(field.NewPath("spec"), func() resource.ResourceClaimSpec { spec := validClaim.Spec.DeepCopy() spec.Devices.Requests[0].DeviceClassName += "2" return *spec }(), "field is immutable")}, oldClaim: validClaim, update: func(claim *resource.ResourceClaim) *resource.ResourceClaim { claim.Spec.Devices.Requests[0].DeviceClassName += "2" return claim }, }, "too-large-config-valid-if-stored": { oldClaim: func() *resource.ResourceClaim { claim := validClaim.DeepCopy() claim.Spec.Devices.Config = []resource.DeviceClaimConfiguration{{ DeviceConfiguration: resource.DeviceConfiguration{ Opaque: &resource.OpaqueDeviceConfiguration{ Driver: goodName, Parameters: runtime.RawExtension{Raw: []byte(`{"str": "` + strings.Repeat("x", resource.OpaqueParametersMaxLength-9-2+1 /* too large by one */) + `"}`)}, }, }, }} return claim }(), update: func(claim *resource.ResourceClaim) *resource.ResourceClaim { // No changes -> remains valid. return claim }, }, } for name, scenario := range scenarios { t.Run(name, func(t *testing.T) { scenario.oldClaim.ResourceVersion = "1" errs := ValidateResourceClaimUpdate(scenario.update(scenario.oldClaim.DeepCopy()), scenario.oldClaim) assertFailures(t, scenario.wantFailures, errs) }) } } func TestValidateClaimStatusUpdate(t *testing.T) { validAllocatedClaim := validClaim.DeepCopy() validAllocatedClaim.Status = resource.ResourceClaimStatus{ Allocation: &resource.AllocationResult{ Devices: resource.DeviceAllocationResult{ Results: []resource.DeviceRequestAllocationResult{{ Request: goodName, Driver: goodName, Pool: goodName, Device: goodName, AdminAccess: ptr.To(false), // Required for new allocations. }}, }, }, } validAllocatedClaimOld := validAllocatedClaim.DeepCopy() validAllocatedClaimOld.Status.Allocation.Devices.Results[0].AdminAccess = nil // Not required in 1.31. scenarios := map[string]struct { adminAccess bool deviceStatusFeatureGate bool oldClaim *resource.ResourceClaim update func(claim *resource.ResourceClaim) *resource.ResourceClaim wantFailures field.ErrorList }{ "valid-no-op-update": { oldClaim: validClaim, update: func(claim *resource.ResourceClaim) *resource.ResourceClaim { return claim }, }, "valid-add-allocation-empty": { oldClaim: validClaim, update: func(claim *resource.ResourceClaim) *resource.ResourceClaim { claim.Status.Allocation = &resource.AllocationResult{} return claim }, }, "valid-add-allocation-non-empty": { oldClaim: validClaim, update: func(claim *resource.ResourceClaim) *resource.ResourceClaim { claim.Status.Allocation = &resource.AllocationResult{ Devices: resource.DeviceAllocationResult{ Results: []resource.DeviceRequestAllocationResult{{ Request: goodName, Driver: goodName, Pool: goodName, Device: goodName, AdminAccess: ptr.To(false), }}, }, } return claim }, }, "invalid-add-allocation-bad-request": { wantFailures: field.ErrorList{ field.Invalid(field.NewPath("status", "allocation", "devices", "results").Index(0).Child("request"), badName, "a lowercase RFC 1123 label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character (e.g. 'my-name', or '123-abc', regex used for validation is '[a-z0-9]([-a-z0-9]*[a-z0-9])?')"), field.Invalid(field.NewPath("status", "allocation", "devices", "results").Index(0).Child("request"), badName, "must be the name of a request in the claim"), }, oldClaim: validClaim, update: func(claim *resource.ResourceClaim) *resource.ResourceClaim { claim.Status.Allocation = &resource.AllocationResult{ Devices: resource.DeviceAllocationResult{ Results: []resource.DeviceRequestAllocationResult{{ Request: badName, Driver: goodName, Pool: goodName, Device: goodName, AdminAccess: ptr.To(false), }}, }, } return claim }, }, "okay-add-allocation-missing-admin-access": { adminAccess: false, oldClaim: validClaim, update: func(claim *resource.ResourceClaim) *resource.ResourceClaim { claim.Status.Allocation = &resource.AllocationResult{ Devices: resource.DeviceAllocationResult{ Results: []resource.DeviceRequestAllocationResult{{ Request: goodName, Driver: goodName, Pool: goodName, Device: goodName, AdminAccess: nil, // Intentionally not set. }}, }, } return claim }, }, "invalid-node-selector": { wantFailures: field.ErrorList{field.Required(field.NewPath("status", "allocation", "nodeSelector", "nodeSelectorTerms"), "must have at least one node selector term")}, oldClaim: validClaim, update: func(claim *resource.ResourceClaim) *resource.ResourceClaim { claim.Status.Allocation = &resource.AllocationResult{ NodeSelector: &core.NodeSelector{ // Must not be empty. }, } return claim }, }, "add-reservation": { oldClaim: validAllocatedClaim, update: func(claim *resource.ResourceClaim) *resource.ResourceClaim { for i := 0; i < resource.ResourceClaimReservedForMaxSize; i++ { claim.Status.ReservedFor = append(claim.Status.ReservedFor, resource.ResourceClaimConsumerReference{ Resource: "pods", Name: fmt.Sprintf("foo-%d", i), UID: types.UID(fmt.Sprintf("%d", i)), }) } return claim }, }, "add-reservation-old-claim": { oldClaim: validAllocatedClaimOld, update: func(claim *resource.ResourceClaim) *resource.ResourceClaim { for i := 0; i < resource.ResourceClaimReservedForMaxSize; i++ { claim.Status.ReservedFor = append(claim.Status.ReservedFor, resource.ResourceClaimConsumerReference{ Resource: "pods", Name: fmt.Sprintf("foo-%d", i), UID: types.UID(fmt.Sprintf("%d", i)), }) } return claim }, }, "add-reservation-and-allocation": { oldClaim: validClaim, update: func(claim *resource.ResourceClaim) *resource.ResourceClaim { claim.Status = *validAllocatedClaim.Status.DeepCopy() for i := 0; i < resource.ResourceClaimReservedForMaxSize; i++ { claim.Status.ReservedFor = append(claim.Status.ReservedFor, resource.ResourceClaimConsumerReference{ Resource: "pods", Name: fmt.Sprintf("foo-%d", i), UID: types.UID(fmt.Sprintf("%d", i)), }) } return claim }, }, "invalid-reserved-for-too-large": { wantFailures: field.ErrorList{field.TooMany(field.NewPath("status", "reservedFor"), resource.ResourceClaimReservedForMaxSize+1, resource.ResourceClaimReservedForMaxSize)}, oldClaim: validAllocatedClaim, update: func(claim *resource.ResourceClaim) *resource.ResourceClaim { for i := 0; i < resource.ResourceClaimReservedForMaxSize+1; i++ { claim.Status.ReservedFor = append(claim.Status.ReservedFor, resource.ResourceClaimConsumerReference{ Resource: "pods", Name: fmt.Sprintf("foo-%d", i), UID: types.UID(fmt.Sprintf("%d", i)), }) } return claim }, }, "invalid-reserved-for-duplicate": { wantFailures: field.ErrorList{field.Duplicate(field.NewPath("status", "reservedFor").Index(1).Child("uid"), types.UID("1"))}, oldClaim: validAllocatedClaim, update: func(claim *resource.ResourceClaim) *resource.ResourceClaim { for i := 0; i < 2; i++ { claim.Status.ReservedFor = append(claim.Status.ReservedFor, resource.ResourceClaimConsumerReference{ Resource: "pods", Name: "foo", UID: "1", }) } return claim }, }, "invalid-reserved-for-no-allocation": { wantFailures: field.ErrorList{field.Forbidden(field.NewPath("status", "reservedFor"), "may not be specified when `allocated` is not set")}, oldClaim: validClaim, update: func(claim *resource.ResourceClaim) *resource.ResourceClaim { claim.Status.ReservedFor = []resource.ResourceClaimConsumerReference{ { Resource: "pods", Name: "foo", UID: "1", }, } return claim }, }, "invalid-reserved-for-no-resource": { wantFailures: field.ErrorList{field.Required(field.NewPath("status", "reservedFor").Index(0).Child("resource"), "")}, oldClaim: validAllocatedClaim, update: func(claim *resource.ResourceClaim) *resource.ResourceClaim { claim.Status.ReservedFor = []resource.ResourceClaimConsumerReference{ { Name: "foo", UID: "1", }, } return claim }, }, "invalid-reserved-for-no-name": { wantFailures: field.ErrorList{field.Required(field.NewPath("status", "reservedFor").Index(0).Child("name"), "")}, oldClaim: validAllocatedClaim, update: func(claim *resource.ResourceClaim) *resource.ResourceClaim { claim.Status.ReservedFor = []resource.ResourceClaimConsumerReference{ { Resource: "pods", UID: "1", }, } return claim }, }, "invalid-reserved-for-no-uid": { wantFailures: field.ErrorList{field.Required(field.NewPath("status", "reservedFor").Index(0).Child("uid"), "")}, oldClaim: validAllocatedClaim, update: func(claim *resource.ResourceClaim) *resource.ResourceClaim { claim.Status.ReservedFor = []resource.ResourceClaimConsumerReference{ { Resource: "pods", Name: "foo", }, } return claim }, }, "invalid-reserved-deleted": { wantFailures: field.ErrorList{field.Forbidden(field.NewPath("status", "reservedFor"), "new entries may not be added while `deallocationRequested` or `deletionTimestamp` are set")}, oldClaim: func() *resource.ResourceClaim { claim := validAllocatedClaim.DeepCopy() var deletionTimestamp metav1.Time claim.DeletionTimestamp = &deletionTimestamp return claim }(), update: func(claim *resource.ResourceClaim) *resource.ResourceClaim { claim.Status.ReservedFor = []resource.ResourceClaimConsumerReference{ { Resource: "pods", Name: "foo", UID: "1", }, } return claim }, }, "invalid-allocation-modification": { wantFailures: field.ErrorList{field.Invalid(field.NewPath("status.allocation"), func() *resource.AllocationResult { claim := validAllocatedClaim.DeepCopy() claim.Status.Allocation.Devices.Results[0].Driver += "-2" return claim.Status.Allocation }(), "field is immutable")}, oldClaim: validAllocatedClaim, update: func(claim *resource.ResourceClaim) *resource.ResourceClaim { claim.Status.Allocation.Devices.Results[0].Driver += "-2" return claim }, }, "invalid-request-name": { wantFailures: field.ErrorList{ field.Invalid(field.NewPath("status", "allocation", "devices", "config").Index(0).Child("requests").Index(1), badName, "a lowercase RFC 1123 label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character (e.g. 'my-name', or '123-abc', regex used for validation is '[a-z0-9]([-a-z0-9]*[a-z0-9])?')"), field.Invalid(field.NewPath("status", "allocation", "devices", "config").Index(0).Child("requests").Index(1), badName, "must be the name of a request in the claim"), }, oldClaim: validClaim, update: func(claim *resource.ResourceClaim) *resource.ResourceClaim { claim = claim.DeepCopy() claim.Status.Allocation = validAllocatedClaim.Status.Allocation.DeepCopy() claim.Status.Allocation.Devices.Config = []resource.DeviceAllocationConfiguration{{ Source: resource.AllocationConfigSourceClaim, Requests: []string{claim.Spec.Devices.Requests[0].Name, badName}, DeviceConfiguration: resource.DeviceConfiguration{ Opaque: &resource.OpaqueDeviceConfiguration{ Driver: "dra.example.com", Parameters: runtime.RawExtension{ Raw: []byte(`{"kind": "foo", "apiVersion": "dra.example.com/v1"}`), }, }, }, }} return claim }, }, "configuration": { wantFailures: field.ErrorList{ field.Required(field.NewPath("status", "allocation", "devices", "config").Index(1).Child("source"), ""), field.NotSupported(field.NewPath("status", "allocation", "devices", "config").Index(2).Child("source"), resource.AllocationConfigSource("no-such-source"), []resource.AllocationConfigSource{resource.AllocationConfigSourceClaim, resource.AllocationConfigSourceClass}), field.Required(field.NewPath("status", "allocation", "devices", "config").Index(3).Child("opaque"), ""), field.Required(field.NewPath("status", "allocation", "devices", "config").Index(4).Child("opaque", "driver"), ""), field.Invalid(field.NewPath("status", "allocation", "devices", "config").Index(4).Child("opaque", "driver"), "", "a lowercase RFC 1123 subdomain must consist of lower case alphanumeric characters, '-' or '.', and must start and end with an alphanumeric character (e.g. 'example.com', regex used for validation is '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*')"), field.Required(field.NewPath("status", "allocation", "devices", "config").Index(4).Child("opaque", "parameters"), ""), field.TooLong(field.NewPath("status", "allocation", "devices", "config").Index(6).Child("opaque", "parameters"), "" /* unused */, resource.OpaqueParametersMaxLength), }, oldClaim: validClaim, update: func(claim *resource.ResourceClaim) *resource.ResourceClaim { claim = claim.DeepCopy() claim.Status.Allocation = validAllocatedClaim.Status.Allocation.DeepCopy() claim.Status.Allocation.Devices.Config = []resource.DeviceAllocationConfiguration{ { Source: resource.AllocationConfigSourceClaim, DeviceConfiguration: resource.DeviceConfiguration{ Opaque: &resource.OpaqueDeviceConfiguration{ Driver: "dra.example.com", Parameters: runtime.RawExtension{ Raw: []byte(`{"kind": "foo", "apiVersion": "dra.example.com/v1"}`), }, }, }, }, { Source: "", /* Empty! */ DeviceConfiguration: resource.DeviceConfiguration{ Opaque: &resource.OpaqueDeviceConfiguration{ Driver: "dra.example.com", Parameters: runtime.RawExtension{ Raw: []byte(`{"kind": "foo", "apiVersion": "dra.example.com/v1"}`), }, }, }, }, { Source: resource.AllocationConfigSource("no-such-source"), DeviceConfiguration: resource.DeviceConfiguration{ Opaque: &resource.OpaqueDeviceConfiguration{ Driver: "dra.example.com", Parameters: runtime.RawExtension{ Raw: []byte(`{"kind": "foo", "apiVersion": "dra.example.com/v1"}`), }, }, }, }, { Source: resource.AllocationConfigSourceClaim, DeviceConfiguration: resource.DeviceConfiguration{ /* Empty! */ }, }, { Source: resource.AllocationConfigSourceClaim, DeviceConfiguration: resource.DeviceConfiguration{ Opaque: &resource.OpaqueDeviceConfiguration{ /* Empty! */ }, }, }, { Source: resource.AllocationConfigSourceClaim, DeviceConfiguration: resource.DeviceConfiguration{ Opaque: &resource.OpaqueDeviceConfiguration{ Driver: goodName, Parameters: runtime.RawExtension{Raw: []byte(`{"str": "` + strings.Repeat("x", resource.OpaqueParametersMaxLength-9-2) + `"}`)}, }, }, }, { Source: resource.AllocationConfigSourceClaim, DeviceConfiguration: resource.DeviceConfiguration{ Opaque: &resource.OpaqueDeviceConfiguration{ Driver: goodName, Parameters: runtime.RawExtension{Raw: []byte(`{"str": "` + strings.Repeat("x", resource.OpaqueParametersMaxLength-9-2+1 /* too large by one */) + `"}`)}, }, }, }, // Other invalid resource.DeviceConfiguration are covered elsewhere. */ } return claim }, }, "valid-configuration-update": { oldClaim: func() *resource.ResourceClaim { claim := validClaim.DeepCopy() claim.Status.Allocation = validAllocatedClaim.Status.Allocation.DeepCopy() claim.Status.Allocation.Devices.Config = []resource.DeviceAllocationConfiguration{ { Source: resource.AllocationConfigSourceClaim, DeviceConfiguration: resource.DeviceConfiguration{ Opaque: &resource.OpaqueDeviceConfiguration{ Driver: goodName, Parameters: runtime.RawExtension{Raw: []byte(`{"str": "` + strings.Repeat("x", resource.OpaqueParametersMaxLength-9-2+1 /* too large by one */) + `"}`)}, }, }, }, } return claim }(), update: func(claim *resource.ResourceClaim) *resource.ResourceClaim { // No change -> remains valid. return claim }, }, "valid-network-device-status": { oldClaim: func() *resource.ResourceClaim { return validAllocatedClaim }(), update: func(claim *resource.ResourceClaim) *resource.ResourceClaim { claim.Status.Devices = []resource.AllocatedDeviceStatus{ { Driver: goodName, Pool: goodName, Device: goodName, Conditions: []metav1.Condition{ { Type: "test", Status: metav1.ConditionTrue, Reason: "test_reason", LastTransitionTime: metav1.Now(), ObservedGeneration: 0, }, }, Data: runtime.RawExtension{ Raw: []byte(`{"kind": "foo", "apiVersion": "dra.example.com/v1"}`), }, NetworkData: &resource.NetworkDeviceData{ InterfaceName: strings.Repeat("x", 256), HardwareAddress: strings.Repeat("x", 128), Addresses: []string{ "10.9.8.0/24", "2001:db8::/64", "10.9.8.1/24", "2001:db8::1/64", }, }, }, } return claim }, deviceStatusFeatureGate: true, }, "invalid-device-status-duplicate": { wantFailures: field.ErrorList{ field.Duplicate(field.NewPath("status", "devices").Index(0).Child("networkData", "addresses").Index(1), "2001:db8::1/64"), field.Duplicate(field.NewPath("status", "devices").Index(1).Child("deviceID"), structured.DeviceID{Driver: goodName, Pool: goodName, Device: goodName}), }, oldClaim: func() *resource.ResourceClaim { return validAllocatedClaim }(), update: func(claim *resource.ResourceClaim) *resource.ResourceClaim { claim.Status.Devices = []resource.AllocatedDeviceStatus{ { Driver: goodName, Pool: goodName, Device: goodName, NetworkData: &resource.NetworkDeviceData{ Addresses: []string{ "2001:db8::1/64", "2001:0db8::1/64", }, }, }, { Driver: goodName, Pool: goodName, Device: goodName, }, } return claim }, deviceStatusFeatureGate: true, }, "invalid-network-device-status": { wantFailures: field.ErrorList{ field.TooLong(field.NewPath("status", "devices").Index(0).Child("networkData", "interfaceName"), "", interfaceNameMaxLength), field.TooLong(field.NewPath("status", "devices").Index(0).Child("networkData", "hardwareAddress"), "", hardwareAddressMaxLength), field.Invalid(field.NewPath("status", "devices").Index(0).Child("networkData", "addresses").Index(0), "300.9.8.0/24", "must be a valid CIDR value, (e.g. 10.9.8.0/24 or 2001:db8::/64)"), }, oldClaim: func() *resource.ResourceClaim { return validAllocatedClaim }(), update: func(claim *resource.ResourceClaim) *resource.ResourceClaim { claim.Status.Devices = []resource.AllocatedDeviceStatus{ { Driver: goodName, Pool: goodName, Device: goodName, NetworkData: &resource.NetworkDeviceData{ InterfaceName: strings.Repeat("x", interfaceNameMaxLength+1), HardwareAddress: strings.Repeat("x", hardwareAddressMaxLength+1), Addresses: []string{ "300.9.8.0/24", }, }, }, } return claim }, deviceStatusFeatureGate: true, }, "invalid-data-device-status": { wantFailures: field.ErrorList{ field.Invalid(field.NewPath("status", "devices").Index(0).Child("data"), "", "error parsing data as JSON: invalid character 'o' in literal false (expecting 'a')"), }, oldClaim: func() *resource.ResourceClaim { return validAllocatedClaim }(), update: func(claim *resource.ResourceClaim) *resource.ResourceClaim { claim.Status.Devices = []resource.AllocatedDeviceStatus{ { Driver: goodName, Pool: goodName, Device: goodName, Data: runtime.RawExtension{ Raw: []byte(`foo`), }, }, } return claim }, deviceStatusFeatureGate: true, }, "invalid-device-status-no-device": { wantFailures: field.ErrorList{ field.Invalid(field.NewPath("status", "devices").Index(0), structured.DeviceID{Driver: "b", Pool: "a", Device: "r"}, "must be an allocated device in the claim"), }, oldClaim: func() *resource.ResourceClaim { return validAllocatedClaim }(), update: func(claim *resource.ResourceClaim) *resource.ResourceClaim { claim.Status.Devices = []resource.AllocatedDeviceStatus{ { Driver: "b", Pool: "a", Device: "r", }, } return claim }, deviceStatusFeatureGate: true, }, "invalid-device-status-duplicate-disabled-feature-gate": { wantFailures: field.ErrorList{ field.Duplicate(field.NewPath("status", "devices").Index(0).Child("networkData", "addresses").Index(1), "2001:db8::1/64"), field.Duplicate(field.NewPath("status", "devices").Index(1).Child("deviceID"), structured.DeviceID{Driver: goodName, Pool: goodName, Device: goodName}), }, oldClaim: func() *resource.ResourceClaim { return validAllocatedClaim }(), update: func(claim *resource.ResourceClaim) *resource.ResourceClaim { claim.Status.Devices = []resource.AllocatedDeviceStatus{ { Driver: goodName, Pool: goodName, Device: goodName, NetworkData: &resource.NetworkDeviceData{ Addresses: []string{ "2001:db8::1/64", "2001:0db8::1/64", }, }, }, { Driver: goodName, Pool: goodName, Device: goodName, }, } return claim }, deviceStatusFeatureGate: false, }, "invalid-network-device-status-disabled-feature-gate": { wantFailures: field.ErrorList{ field.TooLong(field.NewPath("status", "devices").Index(0).Child("networkData", "interfaceName"), "", interfaceNameMaxLength), field.TooLong(field.NewPath("status", "devices").Index(0).Child("networkData", "hardwareAddress"), "", hardwareAddressMaxLength), field.Invalid(field.NewPath("status", "devices").Index(0).Child("networkData", "addresses").Index(0), "300.9.8.0/24", "must be a valid CIDR value, (e.g. 10.9.8.0/24 or 2001:db8::/64)"), }, oldClaim: func() *resource.ResourceClaim { return validAllocatedClaim }(), update: func(claim *resource.ResourceClaim) *resource.ResourceClaim { claim.Status.Devices = []resource.AllocatedDeviceStatus{ { Driver: goodName, Pool: goodName, Device: goodName, NetworkData: &resource.NetworkDeviceData{ InterfaceName: strings.Repeat("x", interfaceNameMaxLength+1), HardwareAddress: strings.Repeat("x", hardwareAddressMaxLength+1), Addresses: []string{ "300.9.8.0/24", }, }, }, } return claim }, deviceStatusFeatureGate: false, }, "invalid-data-device-status-disabled-feature-gate": { wantFailures: field.ErrorList{ field.Invalid(field.NewPath("status", "devices").Index(0).Child("data"), "", "error parsing data as JSON: invalid character 'o' in literal false (expecting 'a')"), }, oldClaim: func() *resource.ResourceClaim { return validAllocatedClaim }(), update: func(claim *resource.ResourceClaim) *resource.ResourceClaim { claim.Status.Devices = []resource.AllocatedDeviceStatus{ { Driver: goodName, Pool: goodName, Device: goodName, Data: runtime.RawExtension{ Raw: []byte(`foo`), }, }, } return claim }, deviceStatusFeatureGate: false, }, "invalid-device-status-no-device-disabled-feature-gate": { wantFailures: field.ErrorList{ field.Invalid(field.NewPath("status", "devices").Index(0), structured.DeviceID{Driver: "b", Pool: "a", Device: "r"}, "must be an allocated device in the claim"), }, oldClaim: func() *resource.ResourceClaim { return validAllocatedClaim }(), update: func(claim *resource.ResourceClaim) *resource.ResourceClaim { claim.Status.Devices = []resource.AllocatedDeviceStatus{ { Driver: "b", Pool: "a", Device: "r", }, } return claim }, deviceStatusFeatureGate: false, }, } for name, scenario := range scenarios { t.Run(name, func(t *testing.T) { featuregatetesting.SetFeatureGateDuringTest(t, utilfeature.DefaultFeatureGate, features.DRAAdminAccess, scenario.adminAccess) featuregatetesting.SetFeatureGateDuringTest(t, utilfeature.DefaultFeatureGate, features.DRAResourceClaimDeviceStatus, scenario.deviceStatusFeatureGate) scenario.oldClaim.ResourceVersion = "1" errs := ValidateResourceClaimStatusUpdate(scenario.update(scenario.oldClaim.DeepCopy()), scenario.oldClaim) assertFailures(t, scenario.wantFailures, errs) }) } }