forked from knative/pkg
-
Notifications
You must be signed in to change notification settings - Fork 0
/
resource.go
147 lines (120 loc) · 4.5 KB
/
resource.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
/*
Copyright 2017 The Knative 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 testing
import (
"context"
"fmt"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/schema"
"knative.dev/pkg/apis"
)
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// Resource is a simple resource that's compatible with our webhook
type Resource struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec ResourceSpec `json:"spec,omitempty"`
}
// Check that Resource may be validated and defaulted.
var _ apis.Validatable = (*Resource)(nil)
var _ apis.Defaultable = (*Resource)(nil)
var _ apis.Listable = (*Resource)(nil)
// ResourceSpec represents test resource spec.
type ResourceSpec struct {
FieldWithDefault string `json:"fieldWithDefault,omitempty"`
FieldWithContextDefault string `json:"fieldWithContextDefault,omitempty"`
FieldWithValidation string `json:"fieldWithValidation,omitempty"`
FieldThatsImmutable string `json:"fieldThatsImmutable,omitempty"`
FieldThatsImmutableWithDefault string `json:"fieldThatsImmutableWithDefault,omitempty"`
}
// GetGroupVersionKind returns the GroupVersionKind.
func (r *Resource) GetGroupVersionKind() schema.GroupVersionKind {
return SchemeGroupVersion.WithKind("Resource")
}
// GetUntypedSpec returns the spec of the resource.
func (r *Resource) GetUntypedSpec() interface{} {
return r.Spec
}
// SetDefaults sets the defaults on the object.
func (c *Resource) SetDefaults(ctx context.Context) {
c.Spec.SetDefaults(ctx)
}
func (c *Resource) Validate(ctx context.Context) *apis.FieldError {
err := c.Spec.Validate(ctx).ViaField("spec")
if apis.IsInUpdate(ctx) {
original := apis.GetBaseline(ctx).(*Resource)
err = err.Also(c.CheckImmutableFields(ctx, original))
}
return err
}
type onContextKey struct{}
// WithValue returns a WithContext for attaching an OnContext with the given value.
func WithValue(ctx context.Context, val string) context.Context {
return context.WithValue(ctx, onContextKey{}, &OnContext{Value: val})
}
// OnContext is a struct for holding a value attached to a context.
type OnContext struct {
Value string
}
// SetDefaults sets the defaults on the spec.
func (cs *ResourceSpec) SetDefaults(ctx context.Context) {
if cs.FieldWithDefault == "" {
cs.FieldWithDefault = "I'm a default."
}
if cs.FieldWithContextDefault == "" {
oc, ok := ctx.Value(onContextKey{}).(*OnContext)
if ok {
cs.FieldWithContextDefault = oc.Value
}
}
if cs.FieldThatsImmutableWithDefault == "" {
cs.FieldThatsImmutableWithDefault = "this is another default value"
}
}
func (cs *ResourceSpec) Validate(ctx context.Context) *apis.FieldError {
if cs.FieldWithValidation != "magic value" {
return apis.ErrInvalidValue(cs.FieldWithValidation, "fieldWithValidation")
}
return nil
}
func (current *Resource) CheckImmutableFields(ctx context.Context, original *Resource) *apis.FieldError {
if original.Spec.FieldThatsImmutable != current.Spec.FieldThatsImmutable {
return &apis.FieldError{
Message: "Immutable field changed",
Paths: []string{"spec.fieldThatsImmutable"},
Details: fmt.Sprintf("got: %v, want: %v", current.Spec.FieldThatsImmutable,
original.Spec.FieldThatsImmutable),
}
}
if original.Spec.FieldThatsImmutableWithDefault != current.Spec.FieldThatsImmutableWithDefault {
return &apis.FieldError{
Message: "Immutable field changed",
Paths: []string{"spec.fieldThatsImmutableWithDefault"},
Details: fmt.Sprintf("got: %v, want: %v", current.Spec.FieldThatsImmutableWithDefault,
original.Spec.FieldThatsImmutableWithDefault),
}
}
return nil
}
// GetListType implements apis.Listable
func (r *Resource) GetListType() runtime.Object {
return &ResourceList{}
}
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// ResourceList is a list of Resource resources
type ResourceList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata"`
Items []Resource `json:"items"`
}