add integration tests for controller

Author: NikhilSharmaWe

pkg/plugins/golang/deploy-image/v1alpha1/scaffolds/api.go

@@ -111,6 +111,12 @@ func (s *apiScaffolder) Scaffold() error {
 		return fmt.Errorf("error updating config/samples: %v", err)
 	}
 
+	if err := scaffold.Execute(
+		&controllers.ControllerTest{},
+	); err != nil {
+		return fmt.Errorf("error creating controllers/**_controller_test.go: %v", err)
+	}
+
 	return nil
 }
 
@@ -140,9 +146,13 @@ func (s *apiScaffolder) scafffoldControllerWithImage(scaffold *machinery.Scaffol
 		// users can change the values
 		var res string
 		for _, value := range strings.Split(s.command, ",") {
-			res += fmt.Sprintf("\"%s\",", strings.TrimSpace(value))
+			res += fmt.Sprintf(" \"%s\",", strings.TrimSpace(value))
 		}
+		// remove the latest ,
 		res = res[:len(res)-1]
+		// remove the first space to not fail in the go fmt ./...
+		res = strings.TrimLeft(res, " ")
+
 		err := util.InsertCode(controllerPath, `SecurityContext: &corev1.SecurityContext{
 							RunAsNonRoot:             &[]bool{true}[0],
 							AllowPrivilegeEscalation: &[]bool{false}[0],
@@ -208,8 +218,8 @@ func (s *apiScaffolder) scaffoldCreateAPIFromGolang() error {
 }
 
 const containerTemplate = `Containers: []corev1.Container{{
-						Image: "%s",
-						Name:  "%s",
+						Image:           "%s",
+						Name:            "%s",
 						ImagePullPolicy: corev1.PullIfNotPresent,
 						// Ensure restrictive context for the container
 						// More info: https://kubernetes.io/docs/concepts/security/pod-security-standards/#restricted
@@ -225,10 +235,10 @@ const containerTemplate = `Containers: []corev1.Container{{
 					}}`
 
 const runAsUserTemplate = `
-							RunAsUser: &[]int64{%s}[0],`
+							RunAsUser:                &[]int64{%s}[0],`
 
 const commandTemplate = `
-						Command:         []string{%s},`
+						Command: []string{%s},`
 
 const portTemplate = `
 						Ports: []corev1.ContainerPort{{

pkg/plugins/golang/deploy-image/v1alpha1/scaffolds/internal/templates/controllers/controller-test.go

@@ -0,0 +1,128 @@
+/*
+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 controllers
+
+import (
+	"fmt"
+	"path/filepath"
+
+	"sigs.k8s.io/kubebuilder/v3/pkg/machinery"
+)
+
+var _ machinery.Template = &ControllerTest{}
+
+// ControllerTest scaffolds the file that defines tests for the controller for a CRD or a builtin resource
+// nolint:maligned
+type ControllerTest struct {
+	machinery.TemplateMixin
+	machinery.MultiGroupMixin
+	machinery.BoilerplateMixin
+	machinery.ResourceMixin
+
+	Image string
+}
+
+// SetTemplateDefaults implements file.Template
+func (f *ControllerTest) SetTemplateDefaults() error {
+	if f.Path == "" {
+		if f.MultiGroup && f.Resource.Group != "" {
+			f.Path = filepath.Join("controllers", "%[group]", "%[kind]_controller_test.go")
+		} else {
+			f.Path = filepath.Join("controllers", "%[kind]_controller_test.go")
+		}
+	}
+	f.Path = f.Resource.Replacer().Replace(f.Path)
+
+	fmt.Println("creating import for %", f.Resource.Path)
+	f.TemplateBody = controllerTestTemplate
+
+	return nil
+}
+
+//nolint:lll
+const controllerTestTemplate = `{{ .Boilerplate }}
+
+package {{ if and .MultiGroup .Resource.Group }}{{ .Resource.PackageName }}{{ else }}controllers{{ end }}
+
+import (
+	"fmt"
+	"k8s.io/apimachinery/pkg/api/errors"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/types"
+
+	"time"
+	"context"
+
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+	
+	{{ if not (isEmptyStr .Resource.Path) -}}
+	{{ .Resource.ImportAlias }} "{{ .Resource.Path }}"
+	{{- end }}
+)
+
+var _ = Describe("{{ .Resource.Kind }} controller", func() {
+
+	// Define utility constants for object names and testing timeouts/durations and intervals.
+	const (
+		{{ .Resource.Kind }}Name      = "test-{{ lower .Resource.Kind }}"
+		{{ .Resource.Kind }}Namespace = "test-{{ lower .Resource.Kind }}"
+	)
+
+	Context("{{ .Resource.Kind }} controller test", func() {
+		It("should create successfully the custom resource for the {{ .Resource.Kind }}", func() {
+			ctx := context.Background()
+
+			By("Creating the custom resource for the Kind {{ .Resource.Kind }}")
+			{{ lower .Resource.Kind }} := &{{ .Resource.ImportAlias }}.{{ .Resource.Kind }}{}
+			err := k8sClient.Get(ctx, types.NamespacedName{Name: {{ .Resource.Kind }}Name, Namespace: {{ .Resource.Kind }}Namespace}, {{ lower .Resource.Kind }})
+			if err != nil && errors.IsNotFound(err) {
+				// Define a new custom resource
+				{{ lower .Resource.Kind }} := &{{ .Resource.ImportAlias }}.{{ .Resource.Kind }}{
+					TypeMeta: metav1.TypeMeta{
+						APIVersion: "{{ .Resource.Group }}.{{ .Resource.Domain }}/{{ .Resource.Version }}",
+						Kind:       "{{ .Resource.Kind }}",
+					},
+					ObjectMeta: metav1.ObjectMeta{
+						Name:      {{ .Resource.Kind }}Name,
+						Namespace: {{ .Resource.Kind }}Namespace,
+					},
+					Spec: {{ .Resource.ImportAlias }}.{{ .Resource.Kind }}Spec{
+						Size: 1,
+					},
+				}
+				fmt.Fprintf(GinkgoWriter, fmt.Sprintf("Creating a new custom resource in the namespace: %s with the name %s\n", {{ lower .Resource.Kind }}.Namespace, {{ lower .Resource.Kind }}.Name))
+				err = k8sClient.Create(ctx, {{ lower .Resource.Kind }})
+				if err != nil {
+					Expect(err).To(Not(HaveOccurred()))
+				}
+			} 
+
+			By("Checking with {{ .Resource.Kind }} Kind exist")
+			Eventually(func() error {
+				found := &{{ .Resource.ImportAlias }}.{{ .Resource.Kind }}{}
+				err = k8sClient.Get(ctx, types.NamespacedName{Name: {{ .Resource.Kind }}Name, Namespace: {{ .Resource.Kind }}Namespace}, found)
+				if err != nil {
+					return err
+				}
+				return nil
+			}, time.Minute, time.Second).Should(Succeed())
+		})
+	})
+
+})
+`

pkg/plugins/golang/v3/scaffolds/internal/templates/controllers/controller_suitetest.go

@@ -130,8 +130,10 @@ package controllers
 import (
 	"path/filepath"
 	"testing"
+
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
+
 	"k8s.io/client-go/kubernetes/scheme"
 	"k8s.io/client-go/rest"
 	"sigs.k8s.io/controller-runtime/pkg/client"

test/e2e/deployimage/plugin_cluster_test.go

@@ -189,15 +189,16 @@ func Run(kbc *utils.TestContext, imageCR string) {
 	ExpectWithOffset(1, err).NotTo(HaveOccurred())
 
 	By("building the controller image")
-	err = kbc.Make("docker-build", "IMG="+kbc.ImageName)
+	cmd := exec.Command("docker", "build", "-t", kbc.ImageName, ".")
+	_, err = kbc.Run(cmd)
 	ExpectWithOffset(1, err).NotTo(HaveOccurred())
 
 	By("loading the controller docker image into the kind cluster")
 	err = kbc.LoadImageToKindCluster()
 	ExpectWithOffset(1, err).NotTo(HaveOccurred())
 
 	By("deploying the controller-manager")
-	cmd := exec.Command("make", "deploy", "IMG="+kbc.ImageName)
+	cmd = exec.Command("make", "deploy", "IMG="+kbc.ImageName)
 	outputMake, err := kbc.Run(cmd)
 	ExpectWithOffset(1, err).NotTo(HaveOccurred())
 

testdata/project-v3-addon/controllers/suite_test.go

@@ -22,6 +22,7 @@ import (
 
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
+
 	"k8s.io/client-go/kubernetes/scheme"
 	"k8s.io/client-go/rest"
 	"sigs.k8s.io/controller-runtime/pkg/client"

testdata/project-v3-config/controllers/suite_test.go

@@ -22,6 +22,7 @@ import (
 
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
+
 	"k8s.io/client-go/kubernetes/scheme"
 	"k8s.io/client-go/rest"
 	"sigs.k8s.io/controller-runtime/pkg/client"

testdata/project-v3-multigroup/controllers/apps/suite_test.go

@@ -22,6 +22,7 @@ import (
 
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
+
 	appsv1 "k8s.io/api/apps/v1"
 	"k8s.io/client-go/kubernetes/scheme"
 	"k8s.io/client-go/rest"

testdata/project-v3-multigroup/controllers/crew/suite_test.go

@@ -22,6 +22,7 @@ import (
 
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
+
 	"k8s.io/client-go/kubernetes/scheme"
 	"k8s.io/client-go/rest"
 	"sigs.k8s.io/controller-runtime/pkg/client"

testdata/project-v3-multigroup/controllers/fiz/suite_test.go

@@ -22,6 +22,7 @@ import (
 
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
+
 	"k8s.io/client-go/kubernetes/scheme"
 	"k8s.io/client-go/rest"
 	"sigs.k8s.io/controller-runtime/pkg/client"

testdata/project-v3-multigroup/controllers/foo.policy/suite_test.go

@@ -22,6 +22,7 @@ import (
 
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
+
 	"k8s.io/client-go/kubernetes/scheme"
 	"k8s.io/client-go/rest"
 	"sigs.k8s.io/controller-runtime/pkg/client"