Return an error when receiving no provider or providerRef

kubernetes-sigs · Feb 2, 2023 · ce1dafe · ce1dafe
1 parent 9766dd1
commit ce1dafe
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 16 deletions.
diff --git a/hack/toolchain.sh b/hack/toolchain.sh
@@ -16,7 +16,7 @@ tools() {
     go install github.com/mikefarah/yq/v4@v4.24.5
     go install github.com/norwoodj/helm-docs/cmd/helm-docs@v1.8.1
     go install sigs.k8s.io/controller-runtime/tools/setup-envtest@v0.0.0-20220421205612-c162794a9b12
-    go install sigs.k8s.io/controller-tools/cmd/controller-gen@v0.8.0
+    go install sigs.k8s.io/controller-tools/cmd/controller-gen@v0.11.2
     go install github.com/sigstore/cosign/cmd/cosign@v1.10.0
     go install github.com/gohugoio/hugo@v0.97.3+extended
     go install golang.org/x/vuln/cmd/govulncheck@v0.0.0-20220902211423-27dd78d2ca39

diff --git a/pkg/apis/crds/karpenter.sh_machines.yaml b/pkg/apis/crds/karpenter.sh_machines.yaml
@@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.8.0
+    controller-gen.kubebuilder.io/version: v0.11.2
   creationTimestamp: null
   name: machines.karpenter.sh
 spec:
@@ -327,9 +327,3 @@ spec:
     storage: true
     subresources:
       status: {}
-status:
-  acceptedNames:
-    kind: ""
-    plural: ""
-  conditions: []
-  storedVersions: []
diff --git a/pkg/apis/crds/karpenter.sh_provisioners.yaml b/pkg/apis/crds/karpenter.sh_provisioners.yaml
@@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.8.0
+    controller-gen.kubebuilder.io/version: v0.11.2
   creationTimestamp: null
   name: provisioners.karpenter.sh
 spec:
@@ -370,9 +370,3 @@ spec:
     storage: true
     subresources:
       status: {}
-status:
-  acceptedNames:
-    kind: ""
-    plural: ""
-  conditions: []
-  storedVersions: []
diff --git a/pkg/apis/v1alpha5/machine.go b/pkg/apis/v1alpha5/machine.go
@@ -110,6 +110,7 @@ type ProviderRef struct {
 	// Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"
 	Kind string `json:"kind,omitempty"`
 	// Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
+	// +required
 	Name string `json:"name,omitempty"`
 	// API version of the referent
 	// +optional

diff --git a/pkg/apis/v1alpha5/provisioner_validation.go b/pkg/apis/v1alpha5/provisioner_validation.go
@@ -185,10 +185,14 @@ func (s *ProvisionerSpec) validateRequirements() (errs *apis.FieldError) {
 	return errs
 }
 
+// validateProvider checks if exactly one of provider and providerRef are set
 func (s *ProvisionerSpec) validateProvider() *apis.FieldError {
 	if s.Provider != nil && s.ProviderRef != nil {
 		return apis.ErrMultipleOneOf(providerPath, providerRefPath)
 	}
+	if s.Provider == nil && s.ProviderRef == nil {
+		return apis.ErrMissingOneOf(providerPath, providerRefPath)
+	}
 	return nil
 }
 

diff --git a/pkg/apis/v1alpha5/suite_test.go b/pkg/apis/v1alpha5/suite_test.go
@@ -47,7 +47,12 @@ var _ = Describe("Validation", func() {
 	BeforeEach(func() {
 		provisioner = &Provisioner{
 			ObjectMeta: metav1.ObjectMeta{Name: strings.ToLower(randomdata.SillyName())},
-			Spec:       ProvisionerSpec{},
+			Spec: ProvisionerSpec{
+				ProviderRef: &ProviderRef{
+					Kind: "NodeTemplate",
+					Name: "default",
+				},
+			},
 		}
 	})
 
@@ -104,6 +109,10 @@ var _ = Describe("Validation", func() {
 			provisioner.Spec.ProviderRef = &ProviderRef{Name: "providerRef"}
 			Expect(provisioner.Validate(ctx)).ToNot(Succeed())
 		})
+		It("should require at least one of provider and providerRef", func() {
+			provisioner.Spec.ProviderRef = nil
+			Expect(provisioner.Validate(ctx)).ToNot(Succeed())
+		})
 	})
 	Context("Labels", func() {
 		It("should allow unrecognized labels", func() {