defaulting_test.go 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253
  1. /*
  2. Copyright 2016 The Kubernetes Authors.
  3. Licensed under the Apache License, Version 2.0 (the "License");
  4. you may not use this file except in compliance with the License.
  5. You may obtain a copy of the License at
  6. http://www.apache.org/licenses/LICENSE-2.0
  7. Unless required by applicable law or agreed to in writing, software
  8. distributed under the License is distributed on an "AS IS" BASIS,
  9. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  10. See the License for the specific language governing permissions and
  11. limitations under the License.
  12. */
  13. package testing
  14. import (
  15. "math/rand"
  16. "reflect"
  17. "sort"
  18. "testing"
  19. fuzz "github.com/google/gofuzz"
  20. apiv1 "k8s.io/api/core/v1"
  21. extensionsv1beta1 "k8s.io/api/extensions/v1beta1"
  22. "k8s.io/apimachinery/pkg/api/apitesting/roundtrip"
  23. metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  24. "k8s.io/apimachinery/pkg/runtime"
  25. "k8s.io/apimachinery/pkg/runtime/schema"
  26. "k8s.io/apimachinery/pkg/util/diff"
  27. "k8s.io/kubernetes/pkg/api/legacyscheme"
  28. )
  29. type orderedGroupVersionKinds []schema.GroupVersionKind
  30. func (o orderedGroupVersionKinds) Len() int { return len(o) }
  31. func (o orderedGroupVersionKinds) Swap(i, j int) { o[i], o[j] = o[j], o[i] }
  32. func (o orderedGroupVersionKinds) Less(i, j int) bool {
  33. return o[i].String() < o[j].String()
  34. }
  35. // TODO: add a reflexive test that verifies that all SetDefaults functions are registered
  36. func TestDefaulting(t *testing.T) {
  37. // these are the known types with defaulters - you must add to this list if you add a top level defaulter
  38. typesWithDefaulting := map[schema.GroupVersionKind]struct{}{
  39. {Group: "", Version: "v1", Kind: "ConfigMap"}: {},
  40. {Group: "", Version: "v1", Kind: "ConfigMapList"}: {},
  41. {Group: "", Version: "v1", Kind: "Endpoints"}: {},
  42. {Group: "", Version: "v1", Kind: "EndpointsList"}: {},
  43. {Group: "", Version: "v1", Kind: "EphemeralContainers"}: {},
  44. {Group: "", Version: "v1", Kind: "Namespace"}: {},
  45. {Group: "", Version: "v1", Kind: "NamespaceList"}: {},
  46. {Group: "", Version: "v1", Kind: "Node"}: {},
  47. {Group: "", Version: "v1", Kind: "NodeList"}: {},
  48. {Group: "", Version: "v1", Kind: "PersistentVolume"}: {},
  49. {Group: "", Version: "v1", Kind: "PersistentVolumeList"}: {},
  50. {Group: "", Version: "v1", Kind: "PersistentVolumeClaim"}: {},
  51. {Group: "", Version: "v1", Kind: "PersistentVolumeClaimList"}: {},
  52. {Group: "", Version: "v1", Kind: "Pod"}: {},
  53. {Group: "", Version: "v1", Kind: "PodList"}: {},
  54. {Group: "", Version: "v1", Kind: "PodTemplate"}: {},
  55. {Group: "", Version: "v1", Kind: "PodTemplateList"}: {},
  56. {Group: "", Version: "v1", Kind: "ReplicationController"}: {},
  57. {Group: "", Version: "v1", Kind: "ReplicationControllerList"}: {},
  58. {Group: "", Version: "v1", Kind: "Secret"}: {},
  59. {Group: "", Version: "v1", Kind: "SecretList"}: {},
  60. {Group: "", Version: "v1", Kind: "Service"}: {},
  61. {Group: "", Version: "v1", Kind: "ServiceList"}: {},
  62. {Group: "apps", Version: "v1beta1", Kind: "StatefulSet"}: {},
  63. {Group: "apps", Version: "v1beta1", Kind: "StatefulSetList"}: {},
  64. {Group: "apps", Version: "v1beta2", Kind: "StatefulSet"}: {},
  65. {Group: "apps", Version: "v1beta2", Kind: "StatefulSetList"}: {},
  66. {Group: "apps", Version: "v1", Kind: "StatefulSet"}: {},
  67. {Group: "apps", Version: "v1", Kind: "StatefulSetList"}: {},
  68. {Group: "autoscaling", Version: "v1", Kind: "HorizontalPodAutoscaler"}: {},
  69. {Group: "autoscaling", Version: "v1", Kind: "HorizontalPodAutoscalerList"}: {},
  70. {Group: "autoscaling", Version: "v2beta1", Kind: "HorizontalPodAutoscaler"}: {},
  71. {Group: "autoscaling", Version: "v2beta1", Kind: "HorizontalPodAutoscalerList"}: {},
  72. {Group: "autoscaling", Version: "v2beta2", Kind: "HorizontalPodAutoscaler"}: {},
  73. {Group: "autoscaling", Version: "v2beta2", Kind: "HorizontalPodAutoscalerList"}: {},
  74. {Group: "batch", Version: "v1", Kind: "Job"}: {},
  75. {Group: "batch", Version: "v1", Kind: "JobList"}: {},
  76. {Group: "batch", Version: "v1beta1", Kind: "CronJob"}: {},
  77. {Group: "batch", Version: "v1beta1", Kind: "CronJobList"}: {},
  78. {Group: "batch", Version: "v1beta1", Kind: "JobTemplate"}: {},
  79. {Group: "batch", Version: "v2alpha1", Kind: "CronJob"}: {},
  80. {Group: "batch", Version: "v2alpha1", Kind: "CronJobList"}: {},
  81. {Group: "batch", Version: "v2alpha1", Kind: "JobTemplate"}: {},
  82. {Group: "certificates.k8s.io", Version: "v1beta1", Kind: "CertificateSigningRequest"}: {},
  83. {Group: "certificates.k8s.io", Version: "v1beta1", Kind: "CertificateSigningRequestList"}: {},
  84. {Group: "discovery.k8s.io", Version: "v1alpha1", Kind: "EndpointSlice"}: {},
  85. {Group: "discovery.k8s.io", Version: "v1alpha1", Kind: "EndpointSliceList"}: {},
  86. {Group: "discovery.k8s.io", Version: "v1beta1", Kind: "EndpointSlice"}: {},
  87. {Group: "discovery.k8s.io", Version: "v1beta1", Kind: "EndpointSliceList"}: {},
  88. {Group: "kubeadm.k8s.io", Version: "v1alpha1", Kind: "MasterConfiguration"}: {},
  89. // This object contains only int fields which currently breaks the defaulting test because
  90. // it's pretty stupid. Once we add non integer fields, we should uncomment this.
  91. // {Group: "kubeadm.k8s.io", Version: "v1alpha1", Kind: "NodeConfiguration"}: {},
  92. {Group: "extensions", Version: "v1beta1", Kind: "DaemonSet"}: {},
  93. {Group: "extensions", Version: "v1beta1", Kind: "DaemonSetList"}: {},
  94. {Group: "apps", Version: "v1beta2", Kind: "DaemonSet"}: {},
  95. {Group: "apps", Version: "v1beta2", Kind: "DaemonSetList"}: {},
  96. {Group: "apps", Version: "v1", Kind: "DaemonSet"}: {},
  97. {Group: "apps", Version: "v1", Kind: "DaemonSetList"}: {},
  98. {Group: "extensions", Version: "v1beta1", Kind: "Deployment"}: {},
  99. {Group: "extensions", Version: "v1beta1", Kind: "DeploymentList"}: {},
  100. {Group: "apps", Version: "v1beta1", Kind: "Deployment"}: {},
  101. {Group: "apps", Version: "v1beta1", Kind: "DeploymentList"}: {},
  102. {Group: "apps", Version: "v1beta2", Kind: "Deployment"}: {},
  103. {Group: "apps", Version: "v1beta2", Kind: "DeploymentList"}: {},
  104. {Group: "apps", Version: "v1", Kind: "Deployment"}: {},
  105. {Group: "apps", Version: "v1", Kind: "DeploymentList"}: {},
  106. {Group: "extensions", Version: "v1beta1", Kind: "PodSecurityPolicy"}: {},
  107. {Group: "extensions", Version: "v1beta1", Kind: "PodSecurityPolicyList"}: {},
  108. {Group: "apps", Version: "v1beta2", Kind: "ReplicaSet"}: {},
  109. {Group: "apps", Version: "v1beta2", Kind: "ReplicaSetList"}: {},
  110. {Group: "apps", Version: "v1", Kind: "ReplicaSet"}: {},
  111. {Group: "apps", Version: "v1", Kind: "ReplicaSetList"}: {},
  112. {Group: "extensions", Version: "v1beta1", Kind: "ReplicaSet"}: {},
  113. {Group: "extensions", Version: "v1beta1", Kind: "ReplicaSetList"}: {},
  114. {Group: "extensions", Version: "v1beta1", Kind: "NetworkPolicy"}: {},
  115. {Group: "extensions", Version: "v1beta1", Kind: "NetworkPolicyList"}: {},
  116. {Group: "policy", Version: "v1beta1", Kind: "PodSecurityPolicy"}: {},
  117. {Group: "policy", Version: "v1beta1", Kind: "PodSecurityPolicyList"}: {},
  118. {Group: "rbac.authorization.k8s.io", Version: "v1alpha1", Kind: "ClusterRoleBinding"}: {},
  119. {Group: "rbac.authorization.k8s.io", Version: "v1alpha1", Kind: "ClusterRoleBindingList"}: {},
  120. {Group: "rbac.authorization.k8s.io", Version: "v1alpha1", Kind: "RoleBinding"}: {},
  121. {Group: "rbac.authorization.k8s.io", Version: "v1alpha1", Kind: "RoleBindingList"}: {},
  122. {Group: "rbac.authorization.k8s.io", Version: "v1beta1", Kind: "ClusterRoleBinding"}: {},
  123. {Group: "rbac.authorization.k8s.io", Version: "v1beta1", Kind: "ClusterRoleBindingList"}: {},
  124. {Group: "rbac.authorization.k8s.io", Version: "v1beta1", Kind: "RoleBinding"}: {},
  125. {Group: "rbac.authorization.k8s.io", Version: "v1beta1", Kind: "RoleBindingList"}: {},
  126. {Group: "rbac.authorization.k8s.io", Version: "v1", Kind: "ClusterRoleBinding"}: {},
  127. {Group: "rbac.authorization.k8s.io", Version: "v1", Kind: "ClusterRoleBindingList"}: {},
  128. {Group: "rbac.authorization.k8s.io", Version: "v1", Kind: "RoleBinding"}: {},
  129. {Group: "rbac.authorization.k8s.io", Version: "v1", Kind: "RoleBindingList"}: {},
  130. {Group: "settings.k8s.io", Version: "v1alpha1", Kind: "PodPreset"}: {},
  131. {Group: "settings.k8s.io", Version: "v1alpha1", Kind: "PodPresetList"}: {},
  132. {Group: "admissionregistration.k8s.io", Version: "v1beta1", Kind: "ValidatingWebhookConfiguration"}: {},
  133. {Group: "admissionregistration.k8s.io", Version: "v1beta1", Kind: "ValidatingWebhookConfigurationList"}: {},
  134. {Group: "admissionregistration.k8s.io", Version: "v1beta1", Kind: "MutatingWebhookConfiguration"}: {},
  135. {Group: "admissionregistration.k8s.io", Version: "v1beta1", Kind: "MutatingWebhookConfigurationList"}: {},
  136. {Group: "admissionregistration.k8s.io", Version: "v1", Kind: "ValidatingWebhookConfiguration"}: {},
  137. {Group: "admissionregistration.k8s.io", Version: "v1", Kind: "ValidatingWebhookConfigurationList"}: {},
  138. {Group: "admissionregistration.k8s.io", Version: "v1", Kind: "MutatingWebhookConfiguration"}: {},
  139. {Group: "admissionregistration.k8s.io", Version: "v1", Kind: "MutatingWebhookConfigurationList"}: {},
  140. {Group: "auditregistration.k8s.io", Version: "v1alpha1", Kind: "AuditSink"}: {},
  141. {Group: "auditregistration.k8s.io", Version: "v1alpha1", Kind: "AuditSinkList"}: {},
  142. {Group: "networking.k8s.io", Version: "v1", Kind: "NetworkPolicy"}: {},
  143. {Group: "networking.k8s.io", Version: "v1", Kind: "NetworkPolicyList"}: {},
  144. {Group: "storage.k8s.io", Version: "v1beta1", Kind: "StorageClass"}: {},
  145. {Group: "storage.k8s.io", Version: "v1beta1", Kind: "StorageClassList"}: {},
  146. {Group: "storage.k8s.io", Version: "v1beta1", Kind: "CSIDriver"}: {},
  147. {Group: "storage.k8s.io", Version: "v1beta1", Kind: "CSIDriverList"}: {},
  148. {Group: "storage.k8s.io", Version: "v1", Kind: "StorageClass"}: {},
  149. {Group: "storage.k8s.io", Version: "v1", Kind: "StorageClassList"}: {},
  150. {Group: "storage.k8s.io", Version: "v1", Kind: "VolumeAttachment"}: {},
  151. {Group: "storage.k8s.io", Version: "v1", Kind: "VolumeAttachmentList"}: {},
  152. {Group: "storage.k8s.io", Version: "v1beta1", Kind: "VolumeAttachment"}: {},
  153. {Group: "storage.k8s.io", Version: "v1beta1", Kind: "VolumeAttachmentList"}: {},
  154. {Group: "authentication.k8s.io", Version: "v1", Kind: "TokenRequest"}: {},
  155. }
  156. f := fuzz.New().NilChance(.5).NumElements(1, 1).RandSource(rand.NewSource(1))
  157. f.Funcs(
  158. func(s *runtime.RawExtension, c fuzz.Continue) {},
  159. func(s *metav1.LabelSelector, c fuzz.Continue) {
  160. c.FuzzNoCustom(s)
  161. s.MatchExpressions = nil // need to fuzz this specially
  162. },
  163. func(s *metav1.ListOptions, c fuzz.Continue) {
  164. c.FuzzNoCustom(s)
  165. s.LabelSelector = "" // need to fuzz requirement strings specially
  166. s.FieldSelector = "" // need to fuzz requirement strings specially
  167. },
  168. func(s *extensionsv1beta1.ScaleStatus, c fuzz.Continue) {
  169. c.FuzzNoCustom(s)
  170. s.TargetSelector = "" // need to fuzz requirement strings specially
  171. },
  172. )
  173. scheme := legacyscheme.Scheme
  174. var testTypes orderedGroupVersionKinds
  175. for gvk := range scheme.AllKnownTypes() {
  176. if gvk.Version == runtime.APIVersionInternal {
  177. continue
  178. }
  179. testTypes = append(testTypes, gvk)
  180. }
  181. sort.Sort(testTypes)
  182. for _, gvk := range testTypes {
  183. _, expectedChanged := typesWithDefaulting[gvk]
  184. iter := 0
  185. changedOnce := false
  186. for {
  187. if iter > *roundtrip.FuzzIters {
  188. if !expectedChanged || changedOnce {
  189. break
  190. }
  191. if iter > 300 {
  192. t.Errorf("expected %s to trigger defaulting due to fuzzing", gvk)
  193. break
  194. }
  195. // if we expected defaulting, continue looping until the fuzzer gives us one
  196. // at worst, we will timeout
  197. }
  198. iter++
  199. src, err := scheme.New(gvk)
  200. if err != nil {
  201. t.Fatal(err)
  202. }
  203. f.Fuzz(src)
  204. src.GetObjectKind().SetGroupVersionKind(schema.GroupVersionKind{})
  205. original := src.DeepCopyObject()
  206. // get internal
  207. withDefaults := src.DeepCopyObject()
  208. scheme.Default(withDefaults.(runtime.Object))
  209. if !reflect.DeepEqual(original, withDefaults) {
  210. changedOnce = true
  211. if !expectedChanged {
  212. t.Errorf("{Group: \"%s\", Version: \"%s\", Kind: \"%s\"} did not expect defaults to be set - update expected or check defaulter registering: %s", gvk.Group, gvk.Version, gvk.Kind, diff.ObjectReflectDiff(original, withDefaults))
  213. }
  214. }
  215. }
  216. }
  217. }
  218. func BenchmarkPodDefaulting(b *testing.B) {
  219. f := fuzz.New().NilChance(.5).NumElements(1, 1).RandSource(rand.NewSource(1))
  220. items := make([]apiv1.Pod, 100)
  221. for i := range items {
  222. f.Fuzz(&items[i])
  223. }
  224. scheme := legacyscheme.Scheme
  225. b.ResetTimer()
  226. for i := 0; i < b.N; i++ {
  227. pod := &items[i%len(items)]
  228. scheme.Default(pod)
  229. }
  230. b.StopTimer()
  231. }