Merge pull request #121 from rejoshed/tests/add-more-domain-account-tests

Tests/Account & Domain Isolation and More Domain/Account Tests

Author: k8s-ci-robot

.golangci.yml

@@ -33,3 +33,11 @@ run:
   skip-dirs:
     - pkg/mocks
     - test
+
+issues:
+  # Excluding configuration per-path, per-linter, per-text and per-source
+  exclude-rules:
+    # Exclude some linters from running on tests files.
+    - path: _test\.go
+      linters:
+        - gosec

Makefile

@@ -23,7 +23,7 @@ RELEASE_DIR ?= out
 export ACK_GINKGO_DEPRECATIONS := 1.16.5
 export ACK_GINKGO_RC=true
 
-PROJECT_DIR := $(shell dirname $(abspath $(lastword $(MAKEFILE_LIST))))
+export PROJECT_DIR := $(shell dirname $(realpath $(lastword $(MAKEFILE_LIST))))
 export PATH := $(PROJECT_DIR)/bin:$(PATH)
 
 all: build
@@ -177,9 +177,8 @@ export KUBEBUILDER_ASSETS=$(PROJECT_DIR)/bin
 
 .PHONY: test
 test: generate-mocks lint bin/ginkgo bin/kubectl bin/kube-apiserver bin/etcd ## Run tests. At the moment this is only unit tests.
-	@./hack/testing_ginkgo_recover_statements.sh --add # Add ginkgo.GinkgoRecover() statements to controllers.
 	@# The following is a slightly funky way to make sure the ginkgo statements are removed regardless the test results.
-	@ginkgo_v2 --cover -coverprofile cover.out --covermode=atomic -v ./api/... ./controllers/... ./pkg/...; EXIT_STATUS=$$?;\
+	@ginkgo_v2 --label-filter="!integ" --cover -coverprofile cover.out --covermode=atomic -v ./api/... ./controllers/... ./pkg/...; EXIT_STATUS=$$?;\
 		./hack/testing_ginkgo_recover_statements.sh --remove; exit $$EXIT_STATUS
 
 .PHONY: generate-mocks

api/v1beta1/cloudstackmachine_webhook_test.go

@@ -18,11 +18,12 @@ package v1beta1_test
 
 import (
 	"context"
+
 	"sigs.k8s.io/cluster-api-provider-cloudstack/api/v1beta1"
+	"sigs.k8s.io/cluster-api-provider-cloudstack/test/dummies"
 
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
-	"sigs.k8s.io/cluster-api-provider-cloudstack/test/dummies"
 )
 
 var _ = Describe("CloudStackMachine webhook", func() {

api/v1beta1/cloudstackmachinetemplate_webhook_test.go

@@ -18,11 +18,12 @@ package v1beta1_test
 
 import (
 	"context"
+
 	"sigs.k8s.io/cluster-api-provider-cloudstack/api/v1beta1"
+	"sigs.k8s.io/cluster-api-provider-cloudstack/test/dummies"
 
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
-	"sigs.k8s.io/cluster-api-provider-cloudstack/test/dummies"
 )
 
 var _ = Describe("CloudStackMachineTemplate webhook", func() {

api/v1beta1/webhook_suite_test.go

@@ -20,12 +20,13 @@ import (
 	"context"
 	"crypto/tls"
 	"fmt"
-	"k8s.io/client-go/rest"
 	"net"
 	"path/filepath"
 	"testing"
 	"time"
 
+	"k8s.io/client-go/rest"
+
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 
@@ -57,10 +58,10 @@ 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: false,
 		WebhookInstallOptions: envtest.WebhookInstallOptions{
-			Paths: []string{filepath.Join("..", "..", "config", "webhook")},
+			Paths: []string{filepath.Join("../../", "config", "webhook")},
 		},
 	}
 

controllers/controllers_suite_test.go

@@ -20,22 +20,22 @@ import (
 	"context"
 	"fmt"
 	"go/build"
-	"k8s.io/client-go/rest"
 	"os"
 	"os/exec"
-	"path"
 	"path/filepath"
 	"regexp"
-	goruntime "runtime"
 	"strings"
 	"testing"
 	"time"
 
+	"k8s.io/client-go/rest"
+
 	"github.com/apache/cloudstack-go/v2/cloudstack"
 	"github.com/go-logr/logr"
 	"github.com/golang/mock/gomock"
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
+	"github.com/pkg/errors"
 	"k8s.io/client-go/kubernetes/scheme"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
@@ -106,11 +106,13 @@ func TestAPIs(t *testing.T) {
 
 var _ = BeforeSuite(func() {
 
-	// Check for ginkgo recover statements.
-	cmd := exec.Command("../hack/testing_ginkgo_recover_statements.sh", "--contains")
+	projectDir := os.Getenv("PROJECT_DIR")
+
+	// Add ginkgo recover statements to controllers.
+	cmd := exec.Command(projectDir+"/hack/testing_ginkgo_recover_statements.sh", "--add")
 	cmd.Stdout = os.Stdout
 	if err := cmd.Run(); err != nil {
-		fmt.Println("Refusing to run tests without ginkgo recover set.")
+		fmt.Println(errors.Wrapf(err, "adding gingko statements"))
 		os.Exit(1)
 	}
 
@@ -121,17 +123,13 @@ var _ = BeforeSuite(func() {
 	CS = mocks.NewMockClient(mockCtrl)
 
 	By("bootstrapping test environment")
-	// Get the root of the current file to use in CRD paths.
-	_, filename, _, _ := goruntime.Caller(0) //nolint
-	root := path.Join(path.Dir(filename), "..")
-	fmt.Println(root)
 
 	crdPaths := []string{
-		filepath.Join(root, "config", "crd", "bases"),
+		filepath.Join(projectDir, "config", "crd", "bases"),
 	}
 
 	// Append CAPI CRDs path
-	if capiPath := getFilePathToCAPICRDs(root); capiPath != "" {
+	if capiPath := getFilePathToCAPICRDs(projectDir); capiPath != "" {
 		crdPaths = append(crdPaths, capiPath)
 	}
 
@@ -183,6 +181,14 @@ var _ = BeforeSuite(func() {
 })
 
 var _ = AfterSuite(func() {
+	projectDir := os.Getenv("PROJECT_DIR")
+	// Add ginkgo recover statements to controllers.
+	cmd := exec.Command(projectDir+"/hack/testing_ginkgo_recover_statements.sh", "--remove")
+	cmd.Stdout = os.Stdout
+	if err := cmd.Run(); err != nil {
+		fmt.Println(errors.Wrapf(err, "cleaning up gingko statements"))
+		os.Exit(1)
+	}
 	cancel()
 	By("tearing down the test environment")
 	Ω(testEnv.Stop()).Should(Succeed())

go.mod

@@ -10,6 +10,7 @@ require (
 	github.com/onsi/ginkgo/v2 v2.1.4
 	github.com/onsi/gomega v1.19.0
 	github.com/pkg/errors v0.9.1
+	github.com/smallfish/simpleyaml v0.1.0
 	github.com/spf13/pflag v1.0.5
 	gopkg.in/ini.v1 v1.63.2
 	k8s.io/api v0.23.0

go.sum

@@ -517,6 +517,8 @@ github.com/sirupsen/logrus v1.4.2/go.mod h1:tLMulIdttU9McNUspp0xgXVQah82FyeX6Mwd
 github.com/sirupsen/logrus v1.6.0/go.mod h1:7uNnSEd1DgxDLC74fIahvMZmmYsHGZGEOFrfsX/uA88=
 github.com/sirupsen/logrus v1.7.0/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0=
 github.com/sirupsen/logrus v1.8.1/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0=
+github.com/smallfish/simpleyaml v0.1.0 h1:5uAZdLAiHxS9cmzkOxg7lH0dILXKTD7uRZbAhyHmyU0=
+github.com/smallfish/simpleyaml v0.1.0/go.mod h1:gU3WdNn44dQVAbVHD2SrSqKKCvmzFApWD2UURhgEj1M=
 github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d/go.mod h1:OnSkiWE9lh6wB0YB77sQom3nweQdgAjqCqsofrRNTgc=
 github.com/smartystreets/goconvey v1.6.4/go.mod h1:syvi0/a8iFYH4r/RixwvyeAJjdLS9QV7WQ/tjFTllLA=
 github.com/soheilhy/cmux v0.1.4/go.mod h1:IM3LyeVVIOuxMH7sFAkER9+bJ4dT7Ms6E4xg4kGIyLM=

pkg/cloud/affinity_groups_test.go

@@ -66,32 +66,32 @@ var _ = Describe("AffinityGroup Unit Tests", func() {
 		Ω(client.GetOrCreateAffinityGroup(dummies.AffinityGroup)).Should(Succeed())
 	})
 
-	Context("AffinityGroup Integ Tests", func() {
-		client, connectionErr := cloud.NewClient("../../cloud-config")
+	Context("AffinityGroup Integ Tests", Label("integ"), func() {
 
 		BeforeEach(func() {
-			if connectionErr != nil { // Only do these tests if an actual ACS instance is available via cloud-config.
-				Skip("Could not connect to ACS instance.")
-			}
+			client = realCloudClient
 			dummies.AffinityGroup.ID = "" // Force name fetching.
 		})
-		AfterEach(func() {
-			mockCtrl.Finish()
-		})
 
-		It("Creates an affinity group.", func() {
-			Ω(client.GetOrCreateAffinityGroup(dummies.AffinityGroup)).Should(Succeed())
-		})
 		It("Associates an affinity group.", func() {
-			if err := client.GetOrCreateVMInstance(
+			Ω(client.ResolveZone(dummies.CSZone1)).Should(Succeed())
+			dummies.CSMachine1.Status.ZoneID = dummies.CSZone1.Spec.ID
+			dummies.CSMachine1.Spec.DiskOffering.Name = ""
+
+			Ω(client.GetOrCreateVMInstance(
 				dummies.CSMachine1, dummies.CAPIMachine, dummies.CSCluster, dummies.CSZone1, dummies.CSAffinityGroup, "",
-			); err != nil {
-				Skip("Could not create VM." + err.Error())
-			}
+			)).Should(Succeed())
+
 			Ω(client.GetOrCreateAffinityGroup(dummies.AffinityGroup)).Should(Succeed())
 			Ω(client.AssociateAffinityGroup(dummies.CSMachine1, *dummies.AffinityGroup)).Should(Succeed())
+
+			// Make the created VM go away quickly by force stopping it.
+			p := realCSClient.VirtualMachine.NewStopVirtualMachineParams(*dummies.CSMachine1.Spec.InstanceID)
+			p.SetForced(true)
+			Ω(realCSClient.VirtualMachine.StopVirtualMachine(p)).Should(Succeed())
 		})
-		It("Deletes an affinity group.", func() {
+
+		It("Creates and deletes an affinity group.", func() {
 			Ω(client.DeleteAffinityGroup(dummies.AffinityGroup)).Should(Succeed())
 			Ω(client.FetchAffinityGroup(dummies.AffinityGroup)).ShouldNot(Succeed())
 		})

pkg/cloud/client.go

@@ -26,6 +26,8 @@ import (
 
 //go:generate mockgen -destination=../mocks/mock_client.go -package=mocks sigs.k8s.io/cluster-api-provider-cloudstack/pkg/cloud Client
 
+const GLOBAL = "Global"
+
 type Client interface {
 	VMIface
 	NetworkIface
@@ -55,9 +57,9 @@ func NewClient(ccPath string) (Client, error) {
 	c := &client{config: Config{VerifySSL: true}}
 	if rawCfg, err := ini.Load(ccPath); err != nil {
 		return nil, errors.Wrapf(err, "reading config at path %s", ccPath)
-	} else if g := rawCfg.Section("Global"); len(g.Keys()) == 0 {
+	} else if g := rawCfg.Section(GLOBAL); len(g.Keys()) == 0 {
 		return nil, errors.New("section Global not found")
-	} else if err = rawCfg.Section("Global").StrictMapTo(&c.config); err != nil {
+	} else if err = rawCfg.Section(GLOBAL).StrictMapTo(&c.config); err != nil {
 		return nil, errors.Wrapf(err, "parsing [Global] section from config at path %s", ccPath)
 	}