support integration 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

Makefile

@@ -58,7 +58,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
@@ -77,15 +77,25 @@ SETUP_ENVTEST_VER := v0.0.0-20211110210527-619e6b92dab9
 SETUP_ENVTEST := $(LOCALBIN)/setup-envtest
 
 .PHONY: test
-test: manifests generate fmt $(SETUP_ENVTEST)
+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 ./... $(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 ./... --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
+
 ##@ Build
 
 .PHONY: build

README.md

@@ -102,6 +102,22 @@ 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
+```
+
 ## 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,52 +34,46 @@ 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)
-	}
-}
-
-func TestMergeUsers(t *testing.T) {
+var _ = Describe("MergeUserDatas", Label("unit", "cloudinit"), func() {
 	a := infrav1.UserData{
 		User:   "override-user",
 		RunCmd: []string{"command A", "command B"},
@@ -80,11 +86,8 @@ func TestMergeUsers(t *testing.T) {
 		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)
-	}
-}
+	Expect(err).NotTo(HaveOccurred())
+	Expect(*c).To(Equal(expected))
+})

cloud/providerid/providerid_test.go

@@ -1,39 +1,68 @@
-package providerid
+package providerid_test
 
 import (
 	"testing"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+
+	"github.com/sp-yduck/cluster-api-provider-proxmox/cloud/providerid"
 )
 
-func TestNew(t *testing.T) {
-	uuid := ""
-	providerID, err := New(uuid)
-	if err == nil {
-		t.Errorf("err should not be nil. providerID=%s", providerID)
-	}
-
-	uuid = "asdf"
-	providerID, err = New(uuid)
-	if err != nil || providerID.String() != "proxmox://asdf" {
-		t.Errorf("failed to create providerID: %v", err)
-	}
+func TestProviderID(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "ProviderID Suite")
 }
 
-func TestUUID(t *testing.T) {
-	pid := providerID{
-		uuid: "asdf",
-	}
-	uuid := pid.UUID()
-	if uuid != "asdf" {
-		t.Errorf("should be asdf")
-	}
-}
+var _ = Describe("New", Label("unit", "providerid"), func() {
+	BeforeEach(func() {})
+	AfterEach(func() {})
 
-func TestString(t *testing.T) {
-	pid := providerID{
-		uuid: "asdf",
-	}
-	uuid := pid.String()
-	if uuid != Prefix+"asdf" {
-		t.Errorf("should be %sasdf", Prefix)
-	}
-}
+	Context("empty uuid", func() {
+		It("should error", func() {
+			uuid := ""
+			_, err := providerid.New(uuid)
+			Expect(err).To(HaveOccurred())
+		})
+	})
+
+	Context("non empty uuid", func() {
+		It("should not error", func() {
+			uuid := "asdf"
+			providerID, err := providerid.New(uuid)
+			Expect(err).NotTo(HaveOccurred())
+			Expect(providerID.UUID()).To(Equal("asdf"))
+			Expect(providerID.String()).To(Equal("proxmox://asdf"))
+		})
+	})
+})
+
+var _ = Describe("UUID method", Label("unit", "providerid"), func() {
+	pid, err := providerid.New("asdf")
+	Expect(err).ToNot(HaveOccurred())
+
+	BeforeEach(func() {})
+	AfterEach(func() {})
+
+	Context("uuid", func() {
+		It("should not error", func() {
+			uuid := pid.UUID()
+			Expect(uuid).To(Equal("asdf"))
+		})
+	})
+})
+
+var _ = Describe("String method", Label("unit", "providerid"), func() {
+	pid, err := providerid.New("asdf")
+	Expect(err).ToNot(HaveOccurred())
+
+	BeforeEach(func() {})
+	AfterEach(func() {})
+
+	Context("string", func() {
+		It("should not error", func() {
+			providerID := pid.String()
+			Expect(providerID).To(Equal("proxmox://asdf"))
+		})
+	})
+})

cloud/scope/clients_test.go

@@ -12,10 +12,8 @@ import (
 	infrav1 "github.com/sp-yduck/cluster-api-provider-proxmox/api/v1beta1"
 )
 
-var _ = Describe("newComputeService", func() {
-	var (
-		cluster *infrav1.ProxmoxCluster
-	)
+var _ = Describe("newComputeService", Label("unit", "scope"), func() {
+	var cluster *infrav1.ProxmoxCluster
 
 	Context("When SecretRef is not present in ProxmoxCluster", func() {
 		BeforeEach(func() {

cloud/scope/suite_test.go

@@ -1,7 +1,6 @@
 package scope
 
 import (
-	// "os"
 	"path/filepath"
 	"testing"
 

cloud/services/compute/instance/cloudinit.go

@@ -46,6 +46,8 @@ func (s *Service) deleteCloudConfig(ctx context.Context) error {
 	return storage.DeleteVolume(ctx, volumeID)
 }
 
+// get cloud-config user datas from Secret and ProxmoxMachine
+// then merge them and set merged user data file to Proxmox Storage
 func (s *Service) reconcileCloudInitUser(ctx context.Context) error {
 	log := log.FromContext(ctx)
 

cloud/services/compute/storage/export_test.go

@@ -0,0 +1,9 @@
+package storage
+
+import (
+	"github.com/sp-yduck/proxmox-go/api"
+)
+
+func GenerateVMStorageOptions(scope Scope) api.StorageCreateOptions {
+	return generateVMStorageOptions(scope)
+}

cloud/services/compute/storage/reconcile.go

@@ -30,17 +30,19 @@ func (s *Service) Reconcile(ctx context.Context) error {
 }
 
 func (s *Service) Delete(ctx context.Context) error {
+	log := log.FromContext(ctx)
+	log.Info("Deleteing storage")
 	return s.deleteStorage(ctx)
 }
 
 // createOrGetStorage gets Proxmox Storage for VMs
 func (s *Service) createOrGetStorage(ctx context.Context) error {
+	log := log.FromContext(ctx)
 	opts := generateVMStorageOptions(s.scope)
 	if err := s.getStorage(ctx, opts.Storage); err != nil {
 		if rest.IsNotFound(err) {
-			if err := s.createStorage(ctx, opts); err != nil {
-				return err
-			}
+			log.Info("storage %s not found. it will be created")
+			return s.createStorage(ctx, opts)
 		}
 		return err
 	}
@@ -65,18 +67,22 @@ func (s *Service) createStorage(ctx context.Context, options api.StorageCreateOp
 
 func (s *Service) deleteStorage(ctx context.Context) error {
 	log := log.FromContext(ctx)
-	nodes, err := s.client.Nodes(ctx)
+
+	var storage *proxmox.Storage
+	storage, err := s.client.Storage(ctx, s.scope.Storage().Name)
 	if err != nil {
+		if rest.IsNotFound(err) {
+			log.Info("storage not found or already deleted")
+			return nil
+		}
 		return err
 	}
 
-	var storage *proxmox.Storage
+	nodes, err := s.client.Nodes(ctx)
+	if err != nil {
+		return err
+	}
 	for _, node := range nodes {
-		storage, err = s.client.Storage(ctx, s.scope.Storage().Name)
-		if err != nil {
-			log.Info(err.Error())
-			continue
-		}
 		storage.Node = node.Node
 
 		// check if storage is empty
@@ -91,7 +97,6 @@ func (s *Service) deleteStorage(ctx context.Context) error {
 
 	// delete
 	if err := storage.Delete(ctx); err != nil {
-		log.Info(err.Error())
 		return err
 	}
 	return nil