Create cluster-api-tests-ext command for origin e2e

Author: sunzhaohua2

.golangci.yml

@@ -134,3 +134,16 @@ issues:
         - gochecknoglobals
         - err113
         - wrapcheck
+
+    # Exclude some linters from running on tests files.
+    - path: e2e/.*|e2e/framework/.*
+      linters:
+        - gocyclo
+        - dupl 
+        - gosec
+        - gochecknoglobals
+        - err113
+        - wrapcheck
+        - funlen
+        - prealloc
+        - revive

Dockerfile.rhel

@@ -1,11 +1,17 @@
 FROM registry.ci.openshift.org/ocp/builder:rhel-9-golang-1.24-openshift-4.20 AS builder
 WORKDIR /go/src/github.com/openshift/cluster-capi-operator
 COPY . .
-RUN make build
+RUN make build && \
+    mkdir -p /tmp/build && \
+    cp /go/src/github.com/openshift/cluster-capi-operator/bin/cluster-api-tests-ext /tmp/build/cluster-api-tests-ext && \
+    gzip /tmp/build/cluster-api-tests-ext
 
 FROM registry.ci.openshift.org/ocp/4.20:base-rhel9
 COPY --from=builder /go/src/github.com/openshift/cluster-capi-operator/bin/cluster-capi-operator .
 COPY --from=builder /go/src/github.com/openshift/cluster-capi-operator/bin/machine-api-migration .
 COPY --from=builder /go/src/github.com/openshift/cluster-capi-operator/manifests /manifests
+COPY --from=builder /tmp/build/cluster-api-tests-ext.gz .
 
-LABEL io.openshift.release.operator true
+LABEL io.k8s.display-name="OpenShift Cluster CAPI Operator" \
+    io.openshift.release.operator=true \
+    io.openshift.tags="openshift,tests,e2e,e2e-extension"

Makefile

@@ -24,7 +24,7 @@ verify: fmt lint
 test: verify unit
 
 # Build binaries
-build: operator migration manifests-gen
+build: operator migration manifests-gen cluster-api-tests-ext 
 
 .PHONY: manifests-gen
 manifests-gen:
@@ -39,6 +39,10 @@ migration:
 	# building migration
 	go build -o bin/machine-api-migration cmd/machine-api-migration/main.go
 
+cluster-api-tests-ext:
+	# building cluster-api-tests-ext
+	go build -o bin/cluster-api-tests-ext ./cmd/cluster-api-tests-ext
+
 .PHONY: localtestenv
 localtestenv: .localtestenv
 
@@ -52,7 +56,7 @@ unit: .localtestenv
 
 .PHONY: e2e
 e2e:
-	./hack/test.sh "./e2e/..." 30m
+	./hack/test.sh "./e2e/..." 60m
 
 # Run against the configured Kubernetes cluster in ~/.kube/config
 run:

cmd/cluster-api-tests-ext/main.go

@@ -0,0 +1,68 @@
+// Copyright 2024 Red Hat, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/openshift-eng/openshift-tests-extension/pkg/cmd"
+	e "github.com/openshift-eng/openshift-tests-extension/pkg/extension"
+	g "github.com/openshift-eng/openshift-tests-extension/pkg/ginkgo"
+	"github.com/spf13/cobra"
+
+	// If using ginkgo, import your tests here.
+	_ "github.com/openshift/cluster-capi-operator/e2e"
+)
+
+func main() {
+	extensionRegistry := e.NewRegistry()
+	capiExtension := e.NewExtension("openshift", "payload", "cluster-capi-operator")
+	extensionRegistry.Register(capiExtension)
+
+	capiExtension.AddSuite(e.Suite{
+		Name: "capio/conformance/parallel",
+		Parents: []string{
+			"openshift/conformance/parallel",
+		},
+		Qualifiers: []string{`!labels.exists(l, l == "Serial") && labels.exists(l, l == "Conformance")`},
+	})
+
+	capiExtension.AddSuite(e.Suite{
+		Name: "capio/conformance/serial",
+		Parents: []string{
+			"openshift/conformance/serial",
+		},
+		Qualifiers: []string{`labels.exists(l, l == "Serial") && labels.exists(l, l == "Conformance")`},
+	})
+
+	specs, err := g.BuildExtensionTestSpecsFromOpenShiftGinkgoSuite()
+	if err != nil {
+		panic(fmt.Sprintf("couldn't build extension test specs from ginkgo: %+v", err.Error()))
+	}
+
+	capiExtension.AddSpecs(specs)
+
+	root := &cobra.Command{
+		Long: "Cluster CAPI Operator tests extension for OpenShift",
+	}
+
+	root.AddCommand(cmd.DefaultExtensionCommands(extensionRegistry)...)
+
+	if err := func() error {
+		return root.Execute()
+	}(); err != nil {
+		os.Exit(1)
+	}
+}

e2e/aws_test.go e2e/aws.goe2e/aws_test.go renamed to e2e/aws.go

@@ -1,3 +1,17 @@
+// Copyright 2024 Red Hat, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package e2e
 
 import (
@@ -28,7 +42,7 @@ const (
 	machineSetOpenshiftLabelKey = "machine.openshift.io/cluster-api-machineset"
 )
 
-var _ = Describe("Cluster API AWS MachineSet", Ordered, func() {
+var _ = Describe("Cluster API AWS MachineSet", Ordered, Label("Conformance"), Label("Serial"), func() {
 	var (
 		awsMachineTemplate      *awsv1.AWSMachineTemplate
 		machineSet              *clusterv1.MachineSet
@@ -38,11 +52,12 @@ var _ = Describe("Cluster API AWS MachineSet", Ordered, func() {
 	)
 
 	BeforeAll(func() {
+		InitCommonVariables()
 		if platform != configv1.AWSPlatformType {
 			Skip("Skipping AWS E2E tests")
 		}
-		mapiDefaultMS, mapiDefaultProviderSpec = getDefaultAWSMAPIProviderSpec(cl)
-		awsClient = createAWSClient(mapiDefaultProviderSpec.Placement.Region)
+		mapiDefaultMS, mapiDefaultProviderSpec = getDefaultAWSMAPIProviderSpec(cl, ctx)
+		awsClient = createAWSClient(ctx, mapiDefaultProviderSpec.Placement.Region)
 	})
 
 	AfterEach(func() {
@@ -51,8 +66,8 @@ var _ = Describe("Cluster API AWS MachineSet", Ordered, func() {
 			// explicitly skip it here for other platforms.
 			Skip("Skipping AWS E2E tests")
 		}
-		framework.DeleteMachineSets(cl, machineSet)
-		framework.WaitForMachineSetsDeleted(cl, machineSet)
+		framework.DeleteMachineSets(cl, ctx, machineSet)
+		framework.WaitForMachineSetsDeleted(cl, ctx, machineSet)
 		framework.DeleteObjects(cl, awsMachineTemplate)
 	})
 
@@ -62,7 +77,7 @@ var _ = Describe("Cluster API AWS MachineSet", Ordered, func() {
 			Expect(err).ToNot(HaveOccurred())
 		}
 
-		machineSet = framework.CreateMachineSet(cl, framework.NewMachineSetParams(
+		machineSet = framework.CreateMachineSet(cl, ctx, framework.NewMachineSetParams(
 			"aws-machineset",
 			clusterName,
 			"",
@@ -75,13 +90,13 @@ var _ = Describe("Cluster API AWS MachineSet", Ordered, func() {
 			"worker-user-data",
 		))
 
-		framework.WaitForMachineSet(cl, machineSet.Name, machineSet.Namespace)
+		framework.WaitForMachineSet(cl, ctx, machineSet.Name, machineSet.Namespace)
 
 		compareInstances(awsClient, mapiDefaultMS.Name, "aws-machineset")
 	})
 })
 
-func getDefaultAWSMAPIProviderSpec(cl client.Client) (*mapiv1.MachineSet, *mapiv1.AWSMachineProviderConfig) {
+func getDefaultAWSMAPIProviderSpec(cl client.Client, ctx context.Context) (*mapiv1.MachineSet, *mapiv1.AWSMachineProviderConfig) {
 	machineSetList := &mapiv1.MachineSetList{}
 	Expect(cl.List(ctx, machineSetList, client.InNamespace(framework.MAPINamespace))).To(Succeed())
 
@@ -158,15 +173,17 @@ func newAWSMachineTemplate(mapiProviderSpec *mapiv1.AWSMachineProviderConfig) *a
 	return awsMachineTemplate
 }
 
-func createAWSClient(region string) *ec2.EC2 {
+func createAWSClient(ctx context.Context, region string) *ec2.EC2 {
 	var secret corev1.Secret
-	Expect(cl.Get(context.Background(), client.ObjectKey{
+
+	Expect(cl.Get(ctx, client.ObjectKey{
 		Namespace: framework.CAPINamespace,
 		Name:      "capa-manager-bootstrap-credentials",
 	}, &secret)).To(Succeed())
 
 	accessKey := secret.Data["aws_access_key_id"]
 	Expect(accessKey).ToNot(BeNil())
+
 	secretAccessKey := secret.Data["aws_secret_access_key"]
 	Expect(secretAccessKey).ToNot(BeNil())
 
@@ -188,6 +205,7 @@ func createAWSClient(region string) *ec2.EC2 {
 func getMAPICreatedInstance(awsClient *ec2.EC2, msName string) ec2.Instance {
 	Expect(awsClient).ToNot(BeNil())
 	Expect(msName).ToNot(BeEmpty())
+
 	mapiMachineList := &mapiv1.MachineList{}
 	Expect(cl.List(ctx, mapiMachineList, client.InNamespace(framework.MAPINamespace), client.MatchingLabels{
 		machineSetOpenshiftLabelKey: msName,
@@ -219,6 +237,7 @@ func getMAPICreatedInstance(awsClient *ec2.EC2, msName string) ec2.Instance {
 func getCAPICreatedInstance(awsClient *ec2.EC2, msName string) ec2.Instance {
 	Expect(awsClient).ToNot(BeNil())
 	Expect(msName).ToNot(BeEmpty())
+
 	capiMachineList := &awsv1.AWSMachineList{}
 
 	Expect(cl.List(ctx, capiMachineList, client.InNamespace(framework.CAPINamespace), client.MatchingLabels{
@@ -244,6 +263,7 @@ func getCAPICreatedInstance(awsClient *ec2.EC2, msName string) ec2.Instance {
 
 func compareInstances(awsClient *ec2.EC2, mapiMsName, capiMsName string) {
 	By("Comparing instances created by MAPI and CAPI")
+
 	mapiEC2Instance := getMAPICreatedInstance(awsClient, mapiMsName)
 	capiEC2Instance := getCAPICreatedInstance(awsClient, capiMsName)
 
@@ -272,7 +292,7 @@ func compareInstances(awsClient *ec2.EC2, mapiMsName, capiMsName string) {
 		"PrivateIpAddress",
 	)
 
-	ignorePrivateIpFields := cmpopts.IgnoreFields(ec2.InstancePrivateIpAddress{},
+	ignorePrivateIPFields := cmpopts.IgnoreFields(ec2.InstancePrivateIpAddress{},
 		"PrivateDnsName",
 		"PrivateIpAddress",
 	)
@@ -284,7 +304,7 @@ func compareInstances(awsClient *ec2.EC2, mapiMsName, capiMsName string) {
 		ignoreInstanceFields,
 		ignoreBlockDeviceFields,
 		ignoreNicFields,
-		ignorePrivateIpFields,
+		ignorePrivateIPFields,
 		ignoreTags,
 	}
 

e2e/azure_test.go e2e/azure.goe2e/azure_test.go renamed to e2e/azure.go

@@ -1,3 +1,17 @@
+// Copyright 2024 Red Hat, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package e2e
 
 import (
@@ -27,12 +41,13 @@ const (
 	capzManagerBootstrapCredentials = "capz-manager-bootstrap-credentials"
 )
 
-var _ = Describe("Cluster API Azure MachineSet", Ordered, func() {
+var _ = Describe("Cluster API Azure MachineSet", Ordered, Label("Conformance"), Label("Serial"), func() {
 	var azureMachineTemplate *azurev1.AzureMachineTemplate
 	var machineSet *clusterv1.MachineSet
 	var mapiMachineSpec *mapiv1.AzureMachineProviderSpec
 
 	BeforeAll(func() {
+		InitCommonVariables()
 		if platform != configv1.AzurePlatformType {
 			Skip("Skipping Azure E2E tests")
 		}
@@ -45,15 +60,15 @@ var _ = Describe("Cluster API Azure MachineSet", Ordered, func() {
 			// explicitly skip it here for other platforms.
 			Skip("Skipping Azure E2E tests")
 		}
-		framework.DeleteMachineSets(cl, machineSet)
-		framework.WaitForMachineSetsDeleted(cl, machineSet)
+		framework.DeleteMachineSets(cl, ctx, machineSet)
+		framework.WaitForMachineSetsDeleted(cl, ctx, machineSet)
 		framework.DeleteObjects(cl, azureMachineTemplate)
 	})
 
 	It("should be able to run a machine", func() {
 		azureMachineTemplate = createAzureMachineTemplate(cl, mapiMachineSpec)
 
-		machineSet = framework.CreateMachineSet(cl, framework.NewMachineSetParams(
+		machineSet = framework.CreateMachineSet(cl, ctx, framework.NewMachineSetParams(
 			"azure-machineset",
 			clusterName,
 			"",
@@ -66,7 +81,7 @@ var _ = Describe("Cluster API Azure MachineSet", Ordered, func() {
 			"worker-user-data",
 		))
 
-		framework.WaitForMachineSet(cl, machineSet.Name, machineSet.Namespace)
+		framework.WaitForMachineSet(cl, ctx, machineSet.Name, machineSet.Namespace)
 	})
 
 })
@@ -97,15 +112,16 @@ func createAzureMachineTemplate(cl client.Client, mapiProviderSpec *mapiv1.Azure
 	Expect(mapiProviderSpec.OSDisk.OSType).ToNot(BeEmpty())
 	Expect(mapiProviderSpec.VMSize).ToNot(BeEmpty())
 
-	azure_credentials_secret := corev1.Secret{}
-	azure_credentials_secret_key := types.NamespacedName{Name: "capz-manager-bootstrap-credentials", Namespace: "openshift-cluster-api"}
-	err := cl.Get(context.Background(), azure_credentials_secret_key, &azure_credentials_secret)
+	azureCredentialsSecret := corev1.Secret{}
+	azureCredentialsSecretKey := types.NamespacedName{Name: "capz-manager-bootstrap-credentials", Namespace: "openshift-cluster-api"}
+	err := cl.Get(context.Background(), azureCredentialsSecretKey, &azureCredentialsSecret)
 	Expect(err).To(BeNil(), "capz-manager-bootstrap-credentials secret should exist")
-	subscriptionID := azure_credentials_secret.Data["azure_subscription_id"]
+
+	subscriptionID := azureCredentialsSecret.Data["azure_subscription_id"]
 	azureImageID := fmt.Sprintf("/subscriptions/%s%s", subscriptionID, mapiProviderSpec.Image.ResourceID)
 
 	var (
-		identity               azurev1.VMIdentity = azurev1.VMIdentityNone
+		identity               = azurev1.VMIdentityNone
 		userAssignedIdentities []azurev1.UserAssignedIdentity
 	)
 
@@ -114,6 +130,7 @@ func createAzureMachineTemplate(cl client.Client, mapiProviderSpec *mapiv1.Azure
 		if !strings.HasPrefix(mi, "/subscriptions/") {
 			providerID = fmt.Sprintf("azure:///subscriptions/%s/resourcegroups/%s/providers/Microsoft.ManagedIdentity/userAssignedIdentities/%s", subscriptionID, mapiProviderSpec.ResourceGroup, mi)
 		}
+
 		userAssignedIdentities = []azurev1.UserAssignedIdentity{{ProviderID: providerID}}
 		identity = azurev1.VMIdentityUserAssigned
 	}