Merge pull request #718 from dmvolod/fix-e2e-linter

🌱 Fix linter for the e2e test packages

Author: k8s-ci-robot

.github/workflows/golangci-lint.yml

@@ -23,5 +23,11 @@ jobs:
       - name: golangci-lint
         uses: golangci/golangci-lint-action@971e284b6050e8a5849b72094c50ab08da042db8 # tag=v6.1.1
         with:
-          version: v1.60.2
+          version: v1.63.3
           args: --timeout 15m
+      - name: golangci-lint-test
+        uses: golangci/golangci-lint-action@971e284b6050e8a5849b72094c50ab08da042db8 # tag=v6.1.1
+        with:
+          version: v1.63.3
+          args: --build-tags e2e --timeout 15m
+          working-directory: test

.gitignore

@@ -7,6 +7,7 @@ cmd/clusterctl/clusterctl
 bin
 hack/tools/bin
 hack/tools/_out
+/vendor
 
 # go.work files
 go.work

Makefile

@@ -70,7 +70,7 @@ CONTROLLER_GEN_VER := v0.16.1
 CONTROLLER_GEN_BIN := controller-gen
 CONTROLLER_GEN := $(TOOLS_BIN_DIR)/$(CONTROLLER_GEN_BIN)-$(CONTROLLER_GEN_VER)
 
-GOLANGCI_LINT_VER := v1.60.2
+GOLANGCI_LINT_VER := v1.63.3
 GOLANGCI_LINT_BIN := golangci-lint
 GOLANGCI_LINT := $(TOOLS_BIN_DIR)/$(GOLANGCI_LINT_BIN)-$(GOLANGCI_LINT_VER)
 
@@ -290,7 +290,7 @@ plugin: ## Build plugin binary
 .PHONY: lint
 lint: $(GOLANGCI_LINT) ## Lint the codebase
 	$(GOLANGCI_LINT) run -v $(GOLANGCI_LINT_EXTRA_ARGS) --timeout=10m
-	cd $(TEST_DIR); $(GOLANGCI_LINT) run --path-prefix $(TEST_DIR) -v $(GOLANGCI_LINT_EXTRA_ARGS) --timeout=10m
+	cd $(TEST_DIR); $(GOLANGCI_LINT) run --path-prefix $(TEST_DIR) --build-tags e2e -v $(GOLANGCI_LINT_EXTRA_ARGS) --timeout=10m
 
 .PHONY: lint-fix
 lint-fix: $(GOLANGCI_LINT) ## Lint the codebase and run auto-fixers if supported by the linter

cmd/plugin/cmd/init.go

@@ -128,7 +128,7 @@ func init() {
 		"Context to be used within the kubeconfig file. If empty, current context will be used.")
 	initCmd.PersistentFlags().StringVar(&initOpts.operatorVersion, "operator-version", latestVersion,
 		"CAPI Operator version (e.g. v0.7.0) to install on the management cluster. If unspecified, the latest release is used.")
-	initCmd.PersistentFlags().StringVar(&initOpts.coreProvider, "core", "cluster-api",
+	initCmd.PersistentFlags().StringVar(&initOpts.coreProvider, "core", configclient.ClusterAPIProviderName,
 		"Core provider version (e.g. cluster-api:v1.1.5) to add to the management cluster. If unspecified, Cluster API's latest release is used.")
 	initCmd.PersistentFlags().StringSliceVarP(&initOpts.infrastructureProviders, "infrastructure", "i", []string{},
 		"Infrastructure providers and versions (e.g. aws:v0.5.0) to add to the management cluster.")

cmd/plugin/cmd/utils.go

@@ -51,8 +51,8 @@ const (
 )
 
 var capiOperatorLabels = map[string]string{
-	"clusterctl.cluster.x-k8s.io/core": "capi-operator",
-	"control-plane":                    "controller-manager",
+	clusterctlv1.ClusterctlCoreLabel: capiOperatorProviderName,
+	"control-plane":                  "controller-manager",
 }
 
 var (

test/e2e/air_gapped_test.go

@@ -1,5 +1,4 @@
 //go:build e2e
-// +build e2e
 
 /*
 Copyright 2023 The Kubernetes Authors.
@@ -85,7 +84,7 @@ var _ = Describe("Install Core Provider in an air-gapped environment", func() {
 							},
 						},
 					},
-					Version: "v1.7.7",
+					Version: previousCAPIVersion,
 				},
 			},
 		}

test/e2e/compressed_manifests_test.go

@@ -1,5 +1,4 @@
 //go:build e2e
-// +build e2e
 
 /*
 Copyright 2023 The Kubernetes Authors.
@@ -45,7 +44,7 @@ const (
 )
 
 var _ = Describe("Create and delete a provider with manifests that don't fit the configmap", func() {
-	var ociInfrastructureConfigMap = &corev1.ConfigMap{}
+	ociInfrastructureConfigMap := &corev1.ConfigMap{}
 
 	It("should successfully create a CoreProvider", func() {
 		bootstrapCluster := bootstrapClusterProxy.GetClient()
@@ -152,7 +151,8 @@ var _ = Describe("Create and delete a provider with manifests that don't fit the
 						},
 					},
 				},
-			}}
+			},
+		}
 
 		// Re-use configmap created on the previous step.
 		ociInfrastructureConfigMap.ObjectMeta.UID = ""

test/e2e/doc.go

@@ -1,5 +1,4 @@
 //go:build e2e
-// +build e2e
 
 /*
 Copyright 2023 The Kubernetes Authors.

test/e2e/e2e_suite_test.go

@@ -1,5 +1,4 @@
 //go:build e2e
-// +build e2e
 
 /*
 Copyright 2022 The Kubernetes Authors.
@@ -32,6 +31,7 @@ import (
 	appsv1 "k8s.io/api/apps/v1"
 	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	configclient "sigs.k8s.io/cluster-api/cmd/clusterctl/client/config"
 
 	"k8s.io/apimachinery/pkg/labels"
 	"k8s.io/apimachinery/pkg/runtime"
@@ -147,7 +147,7 @@ var _ = SynchronizedBeforeSuite(func() []byte {
 
 	Expect(componentsPath).To(BeAnExistingFile(), "Invalid test suite argument. e2e.components should be an existing file.")
 	Expect(configPath).To(BeAnExistingFile(), "Invalid test suite argument. e2e.config should be an existing file.")
-	Expect(os.MkdirAll(artifactFolder, 0755)).To(Succeed(), "Invalid test suite argument. Can't create e2e.artifacts-folder %q", artifactFolder)
+	Expect(os.MkdirAll(artifactFolder, 0o755)).To(Succeed(), "Invalid test suite argument. Can't create e2e.artifacts-folder %q", artifactFolder)
 	Expect(helmBinaryPath).To(BeAnExistingFile(), "Invalid test suite argument. helm-binary-path should be an existing file.")
 	Expect(chartPath).To(BeAnExistingFile(), "Invalid test suite argument. chart-path should be an existing file.")
 
@@ -212,6 +212,7 @@ func initScheme() *runtime.Scheme {
 	framework.TryAddDefaultSchemes(scheme)
 	Expect(operatorv1.AddToScheme(scheme)).To(Succeed())
 	Expect(operatorv1alpha1.AddToScheme(scheme)).To(Succeed())
+
 	return scheme
 }
 
@@ -238,12 +239,15 @@ func createClusterctlLocalRepository(config *clusterctl.E2EConfig, repositoryFol
 
 	clusterctlConfig := clusterctl.CreateRepository(ctx, createRepositoryInput)
 	Expect(clusterctlConfig).To(BeAnExistingFile(), "The clusterctl config file does not exists in the local repository %s", repositoryFolder)
+
 	return clusterctlConfig
 }
 
 func setupCluster(config *clusterctl.E2EConfig, scheme *runtime.Scheme, useExistingCluster bool, clusterProxyName string) (bootstrap.ClusterProvider, framework.ClusterProxy) {
 	var clusterProvider bootstrap.ClusterProvider
+
 	kubeconfigPath := ""
+
 	if !useExistingCluster {
 		clusterProvider = bootstrap.CreateKindBootstrapClusterAndLoadImages(ctx, bootstrap.CreateKindBootstrapClusterAndLoadImagesInput{
 			Name:               config.ManagementClusterName,
@@ -264,8 +268,9 @@ func setupCluster(config *clusterctl.E2EConfig, scheme *runtime.Scheme, useExist
 func initBootstrapCluster(bootstrapClusterProxy framework.ClusterProxy, config *clusterctl.E2EConfig, clusterctlConfigPath, artifactFolder string) {
 	Expect(bootstrapClusterProxy).ToNot(BeNil(), "Invalid argument. bootstrapClusterProxy can't be nil when calling initBootstrapCluster")
 	Expect(clusterctlConfigPath).To(BeAnExistingFile(), "Invalid argument. clusterctlConfigPath must be an existing file when calling initBootstrapCluster")
+
 	logFolder := filepath.Join(artifactFolder, "clusters", bootstrapClusterProxy.GetName())
-	Expect(os.MkdirAll(logFolder, 0750)).To(Succeed(), "Invalid argument. Log folder can't be created for initBootstrapCluster")
+	Expect(os.MkdirAll(logFolder, 0o750)).To(Succeed(), "Invalid argument. Log folder can't be created for initBootstrapCluster")
 
 	ensureCertManager(bootstrapClusterProxy, config)
 
@@ -295,13 +300,15 @@ func initBootstrapCluster(bootstrapClusterProxy framework.ClusterProxy, config *
 
 func initHelmCluster(clusterProxy framework.ClusterProxy, config *clusterctl.E2EConfig) {
 	Expect(clusterProxy).ToNot(BeNil(), "Invalid argument. bootstrapClusterProxy can't be nil when calling initHelmCluster")
+
 	logFolder := filepath.Join(artifactFolder, "clusters", helmClusterProxy.GetName())
-	Expect(os.MkdirAll(logFolder, 0750)).To(Succeed(), "Invalid argument. Log folder can't be created for initHelmCluster")
+	Expect(os.MkdirAll(logFolder, 0o750)).To(Succeed(), "Invalid argument. Log folder can't be created for initHelmCluster")
 	ensureCertManager(clusterProxy, config)
 }
 
 func ensureCertManager(clusterProxy framework.ClusterProxy, config *clusterctl.E2EConfig) {
 	By("Deploying cert-manager")
+
 	addCertChart := &HelmChart{
 		BinaryPath:      helmBinaryPath,
 		Name:            "jetstack",
@@ -336,6 +343,7 @@ func ensureCertManager(clusterProxy framework.ClusterProxy, config *clusterctl.E
 	_, err = certChart.Run(map[string]string{
 		"installCRDs": "true",
 	})
+	Expect(err).ToNot(HaveOccurred())
 }
 
 func deleteClusterAPICRDs(clusterProxy framework.ClusterProxy) {
@@ -346,7 +354,7 @@ func deleteClusterAPICRDs(clusterProxy framework.ClusterProxy) {
 	Expect(clusterProxy.GetClient().List(ctx, crds, &client.ListOptions{
 		LabelSelector: labels.SelectorFromSet(
 			map[string]string{
-				"cluster.x-k8s.io/provider":   "cluster-api",
+				clusterv1.ProviderNameLabel:   configclient.ClusterAPIProviderName,
 				"clusterctl.cluster.x-k8s.io": "",
 			},
 		),
@@ -361,7 +369,7 @@ func initHelmChart() {
 	helmChart = &HelmChart{
 		BinaryPath: helmBinaryPath,
 		Path:       chartPath,
-		Name:       "capi-operator",
+		Name:       capiOperatorRelease,
 		Kubeconfig: helmClusterProxy.GetKubeconfigPath(),
 		DryRun:     true,
 		Output:     Hooks,
@@ -389,6 +397,7 @@ func tearDown(clusterProvider bootstrap.ClusterProvider, clusterProxy framework.
 	if clusterProxy != nil {
 		clusterProxy.Dispose(ctx)
 	}
+
 	if clusterProvider != nil {
 		clusterProvider.Dispose(ctx)
 	}
@@ -412,7 +421,7 @@ func dumpClusterLogs(clusterProxy framework.ClusterProxy) {
 
 	for i := range nodes.Items {
 		nodeName := nodes.Items[i].GetName()
-		err = clusterLogCollector.CollectMachineLog(
+		if err = clusterLogCollector.CollectMachineLog(
 			ctx,
 			clusterProxy.GetClient(),
 			// The bootstrap cluster is not expected to be a CAPI cluster, so in order to re-use the logCollector,
@@ -424,8 +433,7 @@ func dumpClusterLogs(clusterProxy framework.ClusterProxy) {
 				ObjectMeta: metav1.ObjectMeta{Name: nodeName},
 			},
 			filepath.Join(artifactFolder, "clusters", bootstrapClusterProxy.GetName(), "machines", nodeName),
-		)
-		if err != nil {
+		); err != nil {
 			fmt.Printf("Failed to get logs for the bootstrap cluster node %s: %v\n", nodeName, err)
 		}
 	}

test/e2e/helm_test.go

@@ -1,5 +1,4 @@
 //go:build e2e
-// +build e2e
 
 /*
 Copyright 2023 The Kubernetes Authors.
@@ -31,6 +30,7 @@ import (
 	"k8s.io/utils/ptr"
 	operatorv1 "sigs.k8s.io/cluster-api-operator/api/v1alpha2"
 	. "sigs.k8s.io/cluster-api-operator/test/framework"
+	clusterctlv1 "sigs.k8s.io/cluster-api/cmd/clusterctl/api/v1alpha3"
 	"sigs.k8s.io/cluster-api/test/framework"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 )
@@ -42,7 +42,7 @@ var _ = Describe("Create a proper set of manifests when using helm charts", func
 		fullHelmChart := &HelmChart{
 			BinaryPath:      helmBinaryPath,
 			Path:            chartPath,
-			Name:            "capi-operator",
+			Name:            capiOperatorRelease,
 			Kubeconfig:      helmClusterProxy.GetKubeconfigPath(),
 			Wait:            true,
 			Output:          Full,
@@ -52,10 +52,11 @@ var _ = Describe("Create a proper set of manifests when using helm charts", func
 		defer func() {
 			fullHelmChart.Commands = Commands(Uninstall)
 			fullHelmChart.AdditionalFlags = Flags("--namespace", operatorNamespace)
-			fullHelmChart.Run(nil)
+			_, err := fullHelmChart.Run(nil)
+			Expect(err).ToNot(HaveOccurred())
 
-			err := clusterProxy.DeleteAllOf(ctx, &apiextensionsv1.CustomResourceDefinition{}, client.MatchingLabels{
-				"clusterctl.cluster.x-k8s.io/core": "capi-operator",
+			err = clusterProxy.DeleteAllOf(ctx, &apiextensionsv1.CustomResourceDefinition{}, client.MatchingLabels{
+				clusterctlv1.ClusterctlCoreLabel: capiOperatorRelease,
 			})
 			Expect(err).ToNot(HaveOccurred())
 		}()
@@ -82,7 +83,7 @@ var _ = Describe("Create a proper set of manifests when using helm charts", func
 			HaveStatusCondition(&coreProvider.Status.Conditions, operatorv1.ProviderInstalledCondition),
 		), e2eConfig.GetIntervals(helmClusterProxy.GetName(), "wait-controllers")...)
 
-		By("Waiting for status.IntalledVersion to be set")
+		By("Waiting for status.InstalledVersion to be set")
 		WaitFor(ctx, For(coreProvider).In(clusterProxy).ToSatisfy(func() bool {
 			return ptr.Equal(coreProvider.Status.InstalledVersion, ptr.To(coreProvider.Spec.Version))
 		}), e2eConfig.GetIntervals(helmClusterProxy.GetName(), "wait-controllers")...)
@@ -109,7 +110,7 @@ var _ = Describe("Create a proper set of manifests when using helm charts", func
 			HaveStatusCondition(&bootstrapProvider.Status.Conditions, operatorv1.ProviderInstalledCondition)),
 			e2eConfig.GetIntervals(helmClusterProxy.GetName(), "wait-controllers")...)
 
-		By("Waiting for status.IntalledVersion to be set")
+		By("Waiting for status.InstalledVersion to be set")
 		WaitFor(ctx, For(bootstrapProvider).In(clusterProxy).ToSatisfy(func() bool {
 			return ptr.Equal(bootstrapProvider.Status.InstalledVersion, &bootstrapProvider.Spec.Version)
 		}), e2eConfig.GetIntervals(helmClusterProxy.GetName(), "wait-controllers")...)
@@ -135,6 +136,7 @@ var _ = Describe("Create a proper set of manifests when using helm charts", func
 		manifests, err := fullRun.Run(nil)
 		Expect(err).ToNot(HaveOccurred())
 		fullChartInstall, err := os.ReadFile(filepath.Join(customManifestsFolder, "full-chart-install.yaml"))
+		Expect(err).ToNot(HaveOccurred())
 		Expect(manifests).To(Equal(string(fullChartInstall)))
 	})