Add unit and integration test environment (#44)

* add test environment
add 1st unit test
add 1st integration test

* add license header

* Delete unnecessarily docu

* revert build.yaml

* add license header to counterfeiter generating

* add license header

* remove duplicate constants

* check metrics port

* remove netstat

* try metrics-port 8088

* disable test in dockerfile

* disable metrics for envtest

* revert removal of envtest in dockerfile

---------

Co-authored-by: TheBigElmo <50952498+TheBigElmo@users.noreply.github.com>
Co-authored-by: d039803 <ralf.hammer@sap.com>

Author: 3 people

.vscode/launch.json

@@ -17,6 +17,19 @@
                 "--cluster-resource-namespace=default",
                 "--sap-binding-metadata"
             ]
-        }
+        },
+        {
+          "name": "Run integration test",
+          "type": "go",
+          "request": "launch",
+          "mode": "test",
+          "program": "${workspaceFolder}/internal/controllers",
+          "console": "internalConsole",
+          "env": {
+            "KUBEBUILDER_ASSETS": "${workspaceFolder}/bin/k8s/current",
+          },
+          "args": [],
+          "showLog": true
+        },
     ]
 }

Makefile

@@ -44,8 +44,9 @@ manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and Cust
 	rm -rf crds && cp -r config/crd/bases crds
 
 .PHONY: generate
-generate: controller-gen client-gen informer-gen lister-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
+generate: controller-gen client-gen informer-gen lister-gen counterfeiter-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
 	$(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./api/..."
+	PATH="$(PATH):$(LOCALBIN)" go generate ./...
 	./hack/gen-typed-client
 
 .PHONY: fmt
@@ -60,6 +61,10 @@ vet: ## Run go vet against code.
 test: manifests generate fmt vet envtest ## Run tests.
 	KUBEBUILDER_ASSETS="$(LOCALBIN)/k8s/current" go test ./... -coverprofile cover.out
 
+.PHONY: test-fast ## Run tests without build.
+test-fast: envtest ## Run tests.
+	KUBEBUILDER_ASSETS="$(LOCALBIN)/k8s/current" go test ./... -coverprofile cover.out -ginkgo.v
+
 ##@ Build
 
 .PHONY: build
@@ -131,6 +136,7 @@ $(LOCALBIN):
 ## Tool Binaries
 KUSTOMIZE ?= $(LOCALBIN)/kustomize
 CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen
+COUNTERFEITER_GEN ?= $(LOCALBIN)/counterfeiter-gen
 ENVTEST ?= $(LOCALBIN)/setup-envtest
 CLIENT_GEN ?= $(shell pwd)/bin/client-gen
 INFORMER_GEN ?= $(shell pwd)/bin/informer-gen
@@ -140,6 +146,7 @@ LISTER_GEN ?= $(shell pwd)/bin/lister-gen
 KUSTOMIZE_VERSION ?= v3.8.7
 CONTROLLER_TOOLS_VERSION ?= v0.9.2
 CODE_GENERATOR_VERSION ?= v0.23.4
+COUNTERFEITER_VERSION ?= v6.8.1
 
 KUSTOMIZE_INSTALL_SCRIPT ?= "https://raw.githubusercontent.com/kubernetes-sigs/kustomize/master/hack/install_kustomize.sh"
 .PHONY: kustomize
@@ -152,6 +159,11 @@ controller-gen: $(CONTROLLER_GEN) ## Download controller-gen locally if necessar
 $(CONTROLLER_GEN): $(LOCALBIN)
 	test -s $(LOCALBIN)/controller-gen || GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-tools/cmd/controller-gen@$(CONTROLLER_TOOLS_VERSION)
 
+.PHONY: counterfeiter-gen
+counterfeiter-gen: $(COUNTERFEITER_GEN) ## Download controller-gen locally if necessary.
+$(COUNTERFEITER_GEN): $(LOCALBIN)
+	test -s $(COUNTERFEITER_GEN) || GOBIN=$(LOCALBIN) go install github.com/maxbrunsfeld/counterfeiter/v6@$(COUNTERFEITER_VERSION)
+
 .PHONY: envtest
 envtest: $(ENVTEST) ## Download envtest-setup locally if necessary.
 $(ENVTEST): $(LOCALBIN)

go.mod

@@ -4,6 +4,9 @@ go 1.21
 
 require (
 	github.com/cloudfoundry-community/go-cfclient/v3 v3.0.0-alpha.5
+	github.com/maxbrunsfeld/counterfeiter/v6 v6.8.1
+	github.com/onsi/ginkgo/v2 v2.15.0
+	github.com/onsi/gomega v1.31.1
 	github.com/pkg/errors v0.9.1
 	k8s.io/api v0.29.0
 	k8s.io/apiextensions-apiserver v0.29.0
@@ -27,19 +30,20 @@ require (
 	github.com/go-openapi/jsonpointer v0.19.6 // indirect
 	github.com/go-openapi/jsonreference v0.20.2 // indirect
 	github.com/go-openapi/swag v0.22.3 // indirect
+	github.com/go-task/slim-sprig v0.0.0-20230315185526-52ccab3ef572 // indirect
 	github.com/gogo/protobuf v1.3.2 // indirect
 	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
 	github.com/golang/protobuf v1.5.3 // indirect
 	github.com/google/gnostic-models v0.6.8 // indirect
 	github.com/google/go-cmp v0.6.0 // indirect
 	github.com/google/gofuzz v1.2.0 // indirect
+	github.com/google/pprof v0.0.0-20210720184732-4bb14d4b1be1 // indirect
 	github.com/google/uuid v1.3.0 // indirect
 	github.com/imdario/mergo v0.3.12 // indirect
 	github.com/josharian/intern v1.0.0 // indirect
 	github.com/json-iterator/go v1.1.12 // indirect
 	github.com/mailru/easyjson v0.7.7 // indirect
 	github.com/martini-contrib/render v0.0.0-20150707142108-ec18f8345a11 // indirect
-	github.com/matttproud/golang_protobuf_extensions v1.0.4 // indirect
 	github.com/matttproud/golang_protobuf_extensions/v2 v2.0.0 // indirect
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect
@@ -55,12 +59,14 @@ require (
 	go.uber.org/multierr v1.11.0 // indirect
 	go.uber.org/zap v1.26.0 // indirect
 	golang.org/x/exp v0.0.0-20220722155223-a9213eeb770e // indirect
-	golang.org/x/net v0.19.0 // indirect
+	golang.org/x/mod v0.14.0 // indirect
+	golang.org/x/net v0.20.0 // indirect
 	golang.org/x/oauth2 v0.12.0 // indirect
 	golang.org/x/sys v0.16.0 // indirect
-	golang.org/x/term v0.15.0 // indirect
+	golang.org/x/term v0.16.0 // indirect
 	golang.org/x/text v0.14.0 // indirect
 	golang.org/x/time v0.3.0 // indirect
+	golang.org/x/tools v0.17.0 // indirect
 	gomodules.xyz/jsonpatch/v2 v2.4.0 // indirect
 	google.golang.org/appengine v1.6.7 // indirect
 	google.golang.org/protobuf v1.31.0 // indirect