add tests to controllers package

Author: sp-yduck

.gitignore

@@ -14,6 +14,7 @@ Dockerfile.cross
 
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
+coverage.*
 
 # Kubernetes Generated files - skip generated files, except for vendored files
 
@@ -25,7 +26,5 @@ Dockerfile.cross
 *.swo
 *~
 
-*_test.go
-
 # release
 out

Makefile

@@ -57,10 +57,6 @@ fmt: ## Run go fmt against code.
 vet: ## Run go vet against code.
 	go vet ./...
 
-.PHONY: test
-test: manifests generate fmt vet envtest ## Run tests.
-	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test ./... -coverprofile cover.out
-
 CLUSTER_NAME := cappx-test
 
 .PHONY: create-workload-cluster
@@ -71,6 +67,21 @@ create-workload-cluster: $(KUSTOMIZE) $(ENVSUBST) $(KUBECTL)
 delete-workload-cluster: $(KUBECTL)
 	$(KUBECTL) delete cluster $(CLUSTER_NAME)
 
+##@ Testing
+
+SETUP_ENVTEST_VER := v0.0.0-20211110210527-619e6b92dab9
+SETUP_ENVTEST := $(LOCALBIN)/setup-envtest
+
+.PHONY: test
+test: manifests generate fmt $(SETUP_ENVTEST)
+	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test ./controllers $(TEST_ARGS)
+
+.PHONY: test-cover
+test-cover: ## Run unit and integration tests and generate coverage report
+	$(MAKE) test TEST_ARGS="$(TEST_ARGS) -coverprofile=coverage.out"
+	go tool cover -func=coverage.out -o coverate.txt
+	go tool cover -html=coverage.out -o coverage.html
+
 ##@ Build
 
 .PHONY: build
@@ -206,4 +217,9 @@ $(ENVSUBST): $(LOCALBIN)
 kubectl: $(KUBECTL)
 $(KUBECTL): $(LOCALBIN)
 	curl --retry 3 -fsL https://dl.k8s.io/release/$(KUBECTL_VER)/bin/$(GOOS)/$(GOARCH)/kubectl -o $(LOCALBIN)/kubectl
-	chmod +x $(KUBECTL)
+	chmod +x $(KUBECTL)
+
+.PHONY: setup-envtest
+setup-envtest: $(SETUP_ENVTEST)
+$(SETUP_ENVTEST): go.mod # Build setup-envtest from tools folder.
+	GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-runtime/tools/setup-envtest@$(SETUP_ENVTEST_VER)

controllers/proxmoxcluster_controller.go

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package controller
+package controllers
 
 import (
 	"context"

controllers/proxmoxcluster_controller_test.go

@@ -0,0 +1,55 @@
+package controllers
+
+import (
+	"context"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	ctrl "sigs.k8s.io/controller-runtime"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+
+	infrav1 "github.com/sp-yduck/cluster-api-provider-proxmox/api/v1beta1"
+)
+
+var _ = Describe("ProxmoxClusterReconciler", func() {
+	BeforeEach(func() {})
+	AfterEach(func() {})
+
+	Context("Reconcile ProxmoxCluster", func() {
+		It("should not error and requeue the request with insufficient set up", func() {
+			ctx := context.Background()
+
+			reconciler := &ProxmoxClusterReconciler{
+				Client: k8sClient,
+			}
+
+			instance := &infrav1.ProxmoxCluster{
+				ObjectMeta: metav1.ObjectMeta{Name: "foo", Namespace: "default"},
+				Spec: infrav1.ProxmoxClusterSpec{
+					ServerRef: infrav1.ServerRef{
+						Endpoint:  "a.b.c.d:8006",
+						SecretRef: &infrav1.ObjectReference{Name: "foo"},
+					},
+				},
+			}
+
+			// Create the ProxmoxCluster object and expect the Reconcile and Deployment to be created
+			Expect(k8sClient.Create(ctx, instance)).To(Succeed())
+			defer func() {
+				err := k8sClient.Delete(ctx, instance)
+				Expect(err).NotTo(HaveOccurred())
+			}()
+
+			result, err := reconciler.Reconcile(ctx, ctrl.Request{
+				NamespacedName: client.ObjectKey{
+					Namespace: instance.Namespace,
+					Name:      instance.Name,
+				},
+			})
+			Expect(err).NotTo(HaveOccurred())
+			Expect(result.RequeueAfter).To(BeZero())
+			Expect(result.Requeue).To(BeFalse())
+		})
+	})
+})

controllers/proxmoxmachine_controller.go

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package controller
+package controllers
 
 import (
 	"context"

controllers/proxmoxmachine_controller_test.go

@@ -0,0 +1,38 @@
+package controllers
+
+import (
+	"context"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	ctrl "sigs.k8s.io/controller-runtime"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+
+	infrav1 "github.com/sp-yduck/cluster-api-provider-proxmox/api/v1beta1"
+)
+
+var _ = Describe("ProxmoxMachineReconciler", func() {
+	BeforeEach(func() {})
+	AfterEach(func() {})
+
+	Context("Reconcile an ProxmoxMachine", func() {
+		It("should not error with minimal set up", func() {
+			reconciler := &ProxmoxMachineReconciler{
+				Client: k8sClient,
+			}
+			By("Calling reconcile")
+			ctx := context.Background()
+			instance := &infrav1.ProxmoxMachine{ObjectMeta: metav1.ObjectMeta{Name: "foo", Namespace: "default"}}
+			result, err := reconciler.Reconcile(ctx, ctrl.Request{
+				NamespacedName: client.ObjectKey{
+					Namespace: instance.Namespace,
+					Name:      instance.Name,
+				},
+			})
+			Expect(err).NotTo(HaveOccurred())
+			Expect(result.RequeueAfter).To(BeZero())
+			Expect(result.Requeue).To(BeFalse())
+		})
+	})
+})

controllers/suite_test.go

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package controller
+package controllers
 
 import (
 	"path/filepath"
@@ -25,12 +25,13 @@ import (
 
 	"k8s.io/client-go/kubernetes/scheme"
 	"k8s.io/client-go/rest"
+	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/envtest"
 	logf "sigs.k8s.io/controller-runtime/pkg/log"
 	"sigs.k8s.io/controller-runtime/pkg/log/zap"
 
-	infrastructurev1beta1 "github.com/sp-yduck/cluster-api-provider-proxmox/api/v1beta1"
+	infrav1 "github.com/sp-yduck/cluster-api-provider-proxmox/api/v1beta1"
 	//+kubebuilder:scaffold:imports
 )
 
@@ -52,7 +53,7 @@ var _ = BeforeSuite(func() {
 
 	By("bootstrapping test environment")
 	testEnv = &envtest.Environment{
-		CRDDirectoryPaths:     []string{filepath.Join("..", "..", "config", "crd", "bases")},
+		CRDDirectoryPaths:     []string{filepath.Join("..", "config", "crd", "bases")},
 		ErrorIfCRDPathMissing: true,
 	}
 
@@ -62,8 +63,8 @@ var _ = BeforeSuite(func() {
 	Expect(err).NotTo(HaveOccurred())
 	Expect(cfg).NotTo(BeNil())
 
-	err = infrastructurev1beta1.AddToScheme(scheme.Scheme)
-	Expect(err).NotTo(HaveOccurred())
+	Expect(clusterv1.AddToScheme(scheme.Scheme)).To(Succeed())
+	Expect(infrav1.AddToScheme(scheme.Scheme)).To(Succeed())
 
 	//+kubebuilder:scaffold:scheme