Merge pull request #87 from sp-yduck/refactor/testing

Support integration test and e2e test

Author: sp-yduck

.github/workflows/cover.yaml

@@ -8,5 +8,5 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@master
-    - run: "make test-cover"
+    - run: "make unit-test-cover"
     - uses: codecov/codecov-action@v2

.gitignore

@@ -27,4 +27,11 @@ coverage.*
 *~
 
 # release
-out
+out
+
+# test artifact
+ginkgo-log.txt
+internal/test/e2e/clusters
+internal/test/e2e/kind
+internal/test/e2e/repository
+internal/test/e2e/data/infrastructure-proxmox/*/cluster-template.yaml

Makefile

@@ -1,9 +1,16 @@
 
 # Image URL to use all building/pushing image targets
-IMG ?= controller:latest
+REGISTRY := ghcr.io
+PROJECT := sp-yduck/cluster-api-provider-proxmox
+RELEASE_TAG := latest
+IMG ?= $(REGISTRY)/$(PROJECT):$(RELEASE_TAG)
 # ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
 ENVTEST_K8S_VERSION = 1.26.1
 
+# add localbin to PATH
+LOCALBIN ?= $(shell pwd)/bin
+export PATH := $(abspath $(LOCALBIN)):$(PATH)
+
 # Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
 ifeq (,$(shell go env GOBIN))
 GOBIN=$(shell go env GOPATH)/bin
@@ -58,7 +65,7 @@ vet: ## Run go vet against code.
 	go vet ./...
 
 .PHONY: lint
-lint: ## Run golangci-lint
+lint: golangci-lint ## Run golangci-lint
 	$(GOLANGCI_LINT) run
 
 CLUSTER_NAME := cappx-test
@@ -75,17 +82,51 @@ delete-workload-cluster: $(KUBECTL)
 
 SETUP_ENVTEST_VER := v0.0.0-20211110210527-619e6b92dab9
 SETUP_ENVTEST := $(LOCALBIN)/setup-envtest
+GINKGO_TIMEOUT ?= 30m
 
 .PHONY: test
-test: manifests generate fmt $(SETUP_ENVTEST)
-	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test ./... $(TEST_ARGS)
+test: generate manifests fmt $(SETUP_ENVTEST)  ## Run unit and integration test
+	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test ./api/... ./cloud/... ./controllers/... $(TEST_ARGS)
+
+.PHONY: unit-test  ## Run unit tests
+unit-test: generate manifests fmt $(SETUP_ENVTEST)
+	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test ./api/... ./cloud/... ./controllers/... --ginkgo.label-filter=unit $(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 coverage.txt
 	go tool cover -html=coverage.out -o coverage.html
 
+.PHONY: unit-test-cover
+unit-test-cover: ## Run unit tests and generate coverage report
+	$(MAKE) unit-test TEST_ARGS="$(TEST_ARGS) -coverprofile=coverage.out"
+	go tool cover -func=coverage.out -o coverage.txt
+	go tool cover -html=coverage.out -o coverage.html
+
+E2E_DIR = $(shell pwd)/internal/test/e2e
+E2E_IMG := ghcr.io/sp-yduck/cluster-api-provider-proxmox:e2e
+.PHONY: generate-e2e-templates
+generate-e2e-templates: $(KUSTOMIZE) ## Generate cluster-templates for e2e
+	cp templates/cluster-template* $(E2E_DIR)/data/infrastructure-proxmox/templates
+	$(KUSTOMIZE) build $(E2E_DIR)/data/infrastructure-proxmox/templates > $(E2E_DIR)/data/infrastructure-proxmox/main/cluster-template.yaml
+
+.PHONY: build-e2e-image
+build-e2e-image: ## Build cappx image to be used for e2e test
+	IMG=${E2E_IMG} $(MAKE) docker-build
+
+.PHONY: e2e
+e2e: generate-e2e-templates build-e2e-image cleanup-e2e-artifacts ## Run e2e test
+	go test $(E2E_DIR)/... -v \
+	-timeout=$(GINKGO_TIMEOUT) \
+	--e2e.artifacts-folder=$(E2E_DIR) \
+	--e2e.use-existing-cluster="$(USE_EXISTING_CLUSTER)"
+
+.PHONY: cleanup-e2e-artifacts
+cleanup-e2e-artifacts: ## delete some e2e artifacts 
+	rm -rf $(E2E_DIR)/clusters
+	rm -rf $(E2E_DIR)/kind
+
 ##@ Build
 
 .PHONY: build
@@ -140,7 +181,6 @@ uninstall: manifests kustomize ## Uninstall CRDs from the K8s cluster specified
 
 .PHONY: deploy
 deploy: manifests kustomize ## Deploy controller to the K8s cluster specified in ~/.kube/config.
-	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
 	$(KUSTOMIZE) build config/default | kubectl apply -f -
 
 .PHONY: undeploy
@@ -150,16 +190,20 @@ undeploy: ## Undeploy controller from the K8s cluster specified in ~/.kube/confi
 ##@ Release
 
 ## Location to output for release
-RELEASE_DIR := out
+RELEASE_DIR := $(shell pwd)/out
 $(RELEASE_DIR):
 	mkdir -p $(RELEASE_DIR)
 
-# RELEASE_TAG := $(shell git describe --abbrev=0 2>/dev/null)
+RELEASE_TAG := $(shell git describe --abbrev=0 2>/dev/null)
 
-# .PHONY: release
+.PHONY: release ## Builds all the manifests/config files to publish with a release
+	$(MAKE) release-manifests
+	$(MAKE) release-metadata
+	$(MAKE) release-templates
 
 .PHONY: release-manifests
 release-manifests: $(KUSTOMIZE) $(RELEASE_DIR) ## Builds the manifests to publish with a release
+	cd config/manager && $(KUSTOMIZE) edit set image controller=${REGISTRY}/${PROJECT}:${RELEASE_TAG}
 	$(KUSTOMIZE) build config/default > $(RELEASE_DIR)/infrastructure-components.yaml
 
 .PHONY: release-metadata
@@ -174,7 +218,6 @@ release-templates: $(RELEASE_DIR)
 ##@ Build Dependencies
 
 ## Location to install dependencies to
-LOCALBIN ?= $(shell pwd)/bin
 $(LOCALBIN):
 	mkdir -p $(LOCALBIN)
 

README.md

@@ -102,6 +102,33 @@ Because Proxmox-VE does not provide LBaaS solution, CAPPX does not follow the [t
 
 ProxmoxMachine controller follows the [typical infra-machine logic](https://cluster-api.sigs.k8s.io/developer/providers/machine-infrastructure.html#behavior). To bootstrap your machine, CAPPX supports only `cloud-config` type bootstrap data secret. CAPPX is mainly tested with [KubeadmControlPlane](https://github.com/kubernetes-sigs/cluster-api/tree/main/controlplane/kubeadm) and [KubeadmBootstrap](https://github.com/kubernetes-sigs/cluster-api/tree/main/bootstrap/kubeadm).
 
+## Development
+
+### Testing
+#### Unit Testing
+```
+make unit-test
+```
+
+#### Unit and Integration Testing
+```
+export PROXMOX_URL=https://X.X.X.X:8006/api2/json
+export PROXMOX_PASSWORD=password
+export PROXMOX_USER=user@pam
+
+make test
+```
+
+### E2E Testing
+```
+export CONTROLPLANE_HOST=X.X.X.X
+export PROXMOX_URL=https://X.X.X.X:8006/api2/json
+export PROXMOX_PASSWORD=password
+export PROXMOX_USER=user@pam
+
+make e2e
+```
+
 ## Contributing
 
 Are you interested in contributing to cluster-api-provider-proxmox? Do not hesitate to open GitHub issues.

cloud/cloudinit/user_test.go

@@ -1,15 +1,27 @@
 package cloudinit_test
 
 import (
-	"reflect"
 	"testing"
 
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+
 	infrav1 "github.com/sp-yduck/cluster-api-provider-proxmox/api/v1beta1"
 	"github.com/sp-yduck/cluster-api-provider-proxmox/cloud/cloudinit"
 )
 
-func TestParseUser(t *testing.T) {
-	testYaml := `
+func TestCloudInit(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "CloudInit Suite")
+}
+
+var _ = Describe("ParseUserDatas", Label("unit", "cloudinit"), func() {
+	BeforeEach(func() {})
+	AfterEach(func() {})
+
+	Context("correct format", func() {
+		It("should no error", func() {
+			testYaml := `
 write_files:
   - path: /run/kubeadm/kubeadm.yaml
     owner: root:root
@@ -22,69 +34,64 @@ runcmd:
   - "chmod +x /usr/local/bin/kubectl"
   - "reboot now"
   `
-	_, err := cloudinit.ParseUserData(testYaml)
-	if err != nil {
-		t.Errorf("failed to parse user: %v", err)
-	}
+			userData, err := cloudinit.ParseUserData(testYaml)
+			Expect(err).NotTo(HaveOccurred())
+			Expect(userData).NotTo(BeNil())
+		})
+	})
 
-	testYaml = `
+	Context("incorrect format", func() {
+		It("should error", func() {
+			testYaml := `
 write_files:
   - path: /run/kubeadm/kubeadm.yaml
 owner: root:root
     permissions: '0640'
     content: |
       asdfasdfasdf
   `
-	user, err := cloudinit.ParseUserData(testYaml)
-	if err == nil {
-		t.Errorf("should returns an error. user=%v", *user)
-	}
-}
+			userData, err := cloudinit.ParseUserData(testYaml)
+			Expect(err).To(HaveOccurred())
+			Expect(userData).To(BeNil())
+		})
+	})
+})
 
-func TestGenerateUserYaml(t *testing.T) {
-	testYaml := `
-write_files:
-  - path: /run/kubeadm/kubeadm.yaml
-    owner: root:root
-    permissions: '0640'
-    content: |
-      asdfasdfasdf
-runcmd:
-  - 'kubeadm init --config /run/kubeadm/kubeadm.yaml  && echo success > /run/cluster-api/bootstrap-success.complete'
-  - "curl -L https://dl.k8s.io/release/v1.27.3/bin/linux/amd64/kubectl -o /usr/local/bin/kubectl"
-  - "chmod +x /usr/local/bin/kubectl"
-  - "reboot now"
-  `
+var _ = Describe("GenerateUserDataYaml", Label("unit", "cloudinit"), func() {
+	BeforeEach(func() {})
+	AfterEach(func() {})
 
-	uc, err := cloudinit.ParseUserData(testYaml)
-	if err != nil {
-		t.Fatalf("failed to parse user: %v", err)
-	}
+	Context("generate user-data yaml string", func() {
+		It("should no error", func() {
+			userData := infrav1.UserData{
+				RunCmd: []string{"echo", "pwd"},
+			}
+			yaml, err := cloudinit.GenerateUserDataYaml(userData)
+			Expect(err).NotTo(HaveOccurred())
+			Expect(yaml).NotTo(BeNil())
+		})
+	})
+})
 
-	_, err = cloudinit.GenerateUserDataYaml(*uc)
-	if err != nil {
-		t.Fatalf("generate : %v", err)
-	}
-}
+var _ = Describe("MergeUserDatas", Label("unit", "cloudinit"), func() {
+	var _ = Context("merge 2 user datas", func() {
+		var _ = It("should no error", func() {
+			a := infrav1.UserData{
+				User:   "override-user",
+				RunCmd: []string{"command A", "command B"},
+			}
+			b := infrav1.UserData{
+				User:   "test-user",
+				RunCmd: []string{"command C"},
+			}
+			expected := infrav1.UserData{
+				User:   "override-user",
+				RunCmd: []string{"command A", "command B", "command C"},
+			}
 
-func TestMergeUsers(t *testing.T) {
-	a := infrav1.UserData{
-		User:   "override-user",
-		RunCmd: []string{"command A", "command B"},
-	}
-	b := infrav1.UserData{
-		User:   "test-user",
-		RunCmd: []string{"command C"},
-	}
-	expected := infrav1.UserData{
-		User:   "override-user",
-		RunCmd: []string{"command A", "command B", "command C"},
-	}
-	c, err := cloudinit.MergeUserDatas(&a, &b)
-	if err != nil {
-		t.Errorf("failed to merge cloud init user data: %v", err)
-	}
-	if !reflect.DeepEqual(*c, expected) {
-		t.Errorf("%v is expected to same as %v", *c, expected)
-	}
-}
+			c, err := cloudinit.MergeUserDatas(&a, &b)
+			Expect(err).NotTo(HaveOccurred())
+			Expect(*c).To(Equal(expected))
+		})
+	})
+})