Create cluster-control-plane-machine-set-operator-tests-ext command for origin e2e

Author: sunzhaohua2

.golangci.yaml

@@ -110,3 +110,11 @@ issues:
         - gosec
         - gochecknoglobals
         - goerr113
+    #  Exclude some linters from running within the 'test/e2e/' directory.
+    - path: test/e2e/.*
+      linters:
+        - gocyclo
+        - dupl 
+        - gosec
+        - gochecknoglobals
+        - goerr113

Dockerfile

@@ -1,10 +1,16 @@
 FROM registry.ci.openshift.org/ocp/builder:rhel-9-golang-1.24-openshift-4.21 AS builder
 WORKDIR /go/src/github.com/openshift/cluster-control-plane-machine-set-operator
 COPY . .
-RUN make build
+RUN make build && \
+    mkdir -p /tmp/build && \
+    cp /go/src/github.com/openshift/cluster-control-plane-machine-set-operator/bin/control-plane-machine-set-tests-ext /tmp/build/control-plane-machine-set-tests-ext && \
+    gzip /tmp/build/control-plane-machine-set-tests-ext
 
 FROM registry.ci.openshift.org/ocp/4.21:base-rhel9
 COPY --from=builder /go/src/github.com/openshift/cluster-control-plane-machine-set-operator/bin/manager .
 COPY --from=builder /go/src/github.com/openshift/cluster-control-plane-machine-set-operator/manifests manifests
+COPY --from=builder /tmp/build/control-plane-machine-set-tests-ext.gz .
 
-LABEL io.openshift.release.operator true
+LABEL io.k8s.display-name="OpenShift Cluster Control Plane Machine Set Operator" \
+    io.openshift.release.operator=true \
+    io.openshift.tags="openshift,tests,e2e,e2e-extension"

Makefile

@@ -109,9 +109,14 @@ verify-%: ## Ensure no diff after running some other target
 ##@ Build
 
 .PHONY: build
-build: generate fmt vet ## Build manager binary.
+build: operator tests-ext  ## Build all binaries
+
+operator:  ## Build main operator binary
 	go build -o bin/manager ./cmd/control-plane-machine-set-operator
 
+tests-ext:  ## Build tests extension binary
+	go build -o bin/control-plane-machine-set-tests-ext ./cmd/control-plane-machine-set-tests-ext
+
 .PHONY: images
 images: ## Create images
 	$(ENGINE) build -t "$(IMAGE):$(VERSION)" -t "$(IMAGE):$(MUTABLE_TAG)" ./

cmd/control-plane-machine-set-tests-ext/main.go

@@ -0,0 +1,77 @@
+/*
+Copyright 2023 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"
+
+	"sigs.k8s.io/controller-runtime/pkg/envtest/komega"
+
+	// If using ginkgo, import your tests here.
+	_ "github.com/openshift/cluster-control-plane-machine-set-operator/test/e2e"
+	"github.com/openshift/cluster-control-plane-machine-set-operator/test/e2e/framework"
+)
+
+func main() {
+	extensionRegistry := e.NewRegistry()
+	ext := e.NewExtension("openshift", "payload", "cluster-control-plane-machine-set-operator")
+
+	ext.AddSuite(e.Suite{
+		Name:       "cpmso/periodic",
+		Qualifiers: []string{`!labels.exists(l, l == "Periodic")`},
+	})
+
+	ext.AddSuite(e.Suite{
+		Name:       "cpmso/presubmit",
+		Qualifiers: []string{`labels.exists(l, l == "PreSubmit") `},
+	})
+
+	specs, err := g.BuildExtensionTestSpecsFromOpenShiftGinkgoSuite()
+	if err != nil {
+		panic(fmt.Sprintf("couldn't build extension test specs from ginkgo: %+v", err.Error()))
+	}
+
+	// Initialize framework before running tests
+	specs.AddBeforeAll(func() {
+		if err := framework.InitFramework(); err != nil {
+			panic(fmt.Sprintf("failed to initialize framework: %v", err))
+		}
+		komega.SetClient(framework.GlobalFramework.GetClient())
+		komega.SetContext(framework.GlobalFramework.GetContext())
+	})
+
+	ext.AddSpecs(specs)
+	extensionRegistry.Register(ext)
+
+	root := &cobra.Command{
+		Long: "cluster control plane machine set Operator tests extension for OpenShift",
+	}
+
+	root.AddCommand(cmd.DefaultExtensionCommands(extensionRegistry)...)
+
+	if err := func() error {
+		return root.Execute()
+	}(); err != nil {
+		os.Exit(1)
+	}
+}

test/e2e/framework/framework.go

@@ -130,34 +130,40 @@ type framework struct {
 
 var _ Framework = &framework{}
 
-// NewFramework initialises a new test framework for the E2E suite.
-func NewFramework() (Framework, error) {
+// GlobalFramework is a global variable to share state across e2e tests.
+var GlobalFramework Framework
+
+// InitFramework initialises a new test framework for the E2E suite.
+func InitFramework() error {
 	sch, err := loadScheme()
 	if err != nil {
-		return nil, err
+		return err
 	}
 
 	client, err := loadClient(sch)
 	if err != nil {
-		return nil, err
+		return err
 	}
 
 	supportLevel, platform, err := getPlatformSupportLevel(client)
 	if err != nil {
-		return nil, err
+		return err
 	}
 
 	logger := textlogger.NewLogger(textlogger.NewConfig())
 	ctrl.SetLogger(logger)
 
-	return &framework{
+	fw := &framework{
 		client:       client,
 		logger:       logger,
 		platform:     platform,
 		supportLevel: supportLevel,
 		scheme:       sch,
 		namespace:    MachineAPINamespace,
-	}, nil
+	}
+	GlobalFramework = fw
+
+	return nil
 }
 
 // NewFrameworkWith initialises a new test framework for the E2E suite
@@ -787,7 +793,7 @@ func nextGCPMachineSize(current string) (string, error) {
 // setNextGCPMachineSize returns the new GCP machine size in the series
 // according to the family supported (e2, n1, n2).
 //
-//nolint:cyclop,funlen,gocognit,gocyclo
+//nolint:cyclop,funlen,gocognit
 func setNextGCPMachineSize(current, family, subfamily, subfamilyflavor string, multiplier float64, multiplier2 int) (string, error) {
 	switch {
 	case strings.HasPrefix(subfamily, "custom"):

test/e2e/periodic_test.go renamed to test/e2e/periodic.go

@@ -37,16 +37,16 @@ var _ = Describe("ControlPlaneMachineSet Operator", framework.Periodic(), func()
 
 	Context("With an active ControlPlaneMachineSet", func() {
 		BeforeEach(func() {
-			helpers.EnsureActiveControlPlaneMachineSet(testFramework)
+			helpers.EnsureActiveControlPlaneMachineSet(framework.GlobalFramework)
 		})
 
 		Context("and the provider spec is changed", func() {
 			BeforeEach(func() {
-				helpers.ModifyControlPlaneMachineSetToTriggerRollout(testFramework)
+				helpers.ModifyControlPlaneMachineSetToTriggerRollout(framework.GlobalFramework)
 			})
 
 			helpers.ItShouldPerformARollingUpdate(&helpers.RollingUpdatePeriodicTestOptions{
-				TestFramework: testFramework,
+				TestFramework: framework.GlobalFramework,
 			})
 		})
 
@@ -57,33 +57,33 @@ var _ = Describe("ControlPlaneMachineSet Operator", framework.Periodic(), func()
 			BeforeEach(func() {
 				// Check if CPMSMachineNamePrefix gate is enabled, skip otherwise.
 				// The TechPreview jobs should not skip the test.
-				featureGateFilter, err := helpers.NewFeatureGateFilter(context.TODO(), testFramework)
+				featureGateFilter, err := helpers.NewFeatureGateFilter(context.TODO(), framework.GlobalFramework)
 				if err != nil {
 					Fail(fmt.Sprintf("failed to get featuregate filter: %v", err))
 				}
 				if !featureGateFilter.IsEnabled(string(features.FeatureGateCPMSMachineNamePrefix)) {
 					Skip(fmt.Sprintf("Skipping test because %q featuregate is not enabled", features.FeatureGateCPMSMachineNamePrefix))
 				}
 
-				helpers.UpdateControlPlaneMachineSetMachineNamePrefix(testFramework, prefix)
+				helpers.UpdateControlPlaneMachineSetMachineNamePrefix(framework.GlobalFramework, prefix)
 			}, OncePerOrdered)
 
 			Context("and the provider spec of index 1 is not as expected", Ordered, func() {
 				BeforeAll(func() {
-					helpers.ModifyMachineProviderSpecToTriggerRollout(testFramework, 1)
+					helpers.ModifyMachineProviderSpecToTriggerRollout(framework.GlobalFramework, 1)
 				})
 
 				// Machine name should follow prefixed naming convention
-				helpers.ItShouldRollingUpdateReplaceTheOutdatedMachine(testFramework, 1)
+				helpers.ItShouldRollingUpdateReplaceTheOutdatedMachine(framework.GlobalFramework, 1)
 
 				Context("and again MachineNamePrefix is reset", Ordered, func() {
 					BeforeAll(func() {
-						helpers.UpdateControlPlaneMachineSetMachineNamePrefix(testFramework, resetPrefix)
-						helpers.ModifyMachineProviderSpecToTriggerRollout(testFramework, 1)
+						helpers.UpdateControlPlaneMachineSetMachineNamePrefix(framework.GlobalFramework, resetPrefix)
+						helpers.ModifyMachineProviderSpecToTriggerRollout(framework.GlobalFramework, 1)
 					})
 
 					// Machine name should follow general naming convention
-					helpers.ItShouldRollingUpdateReplaceTheOutdatedMachine(testFramework, 1)
+					helpers.ItShouldRollingUpdateReplaceTheOutdatedMachine(framework.GlobalFramework, 1)
 				})
 			})
 		})
@@ -92,11 +92,11 @@ var _ = Describe("ControlPlaneMachineSet Operator", framework.Periodic(), func()
 			var originalStrategy machinev1.ControlPlaneMachineSetStrategyType
 
 			BeforeEach(func() {
-				originalStrategy = helpers.EnsureControlPlaneMachineSetUpdateStrategy(testFramework, machinev1.OnDelete)
+				originalStrategy = helpers.EnsureControlPlaneMachineSetUpdateStrategy(framework.GlobalFramework, machinev1.OnDelete)
 			}, OncePerOrdered)
 
 			AfterEach(func() {
-				helpers.EnsureControlPlaneMachineSetUpdateStrategy(testFramework, originalStrategy)
+				helpers.EnsureControlPlaneMachineSetUpdateStrategy(framework.GlobalFramework, originalStrategy)
 			}, OncePerOrdered)
 
 			Context("and ControlPlaneMachineSet is updated to set MachineNamePrefix [OCPFeatureGate:CPMSMachineNamePrefix]", Ordered, func() {
@@ -106,43 +106,43 @@ var _ = Describe("ControlPlaneMachineSet Operator", framework.Periodic(), func()
 				BeforeEach(func() {
 					// Check if CPMSMachineNamePrefix gate is enabled, skip otherwise.
 					// The TechPreview jobs should not skip the test.
-					featureGateFilter, err := helpers.NewFeatureGateFilter(context.TODO(), testFramework)
+					featureGateFilter, err := helpers.NewFeatureGateFilter(context.TODO(), framework.GlobalFramework)
 					if err != nil {
 						Fail(fmt.Sprintf("failed to get featuregate filter: %v", err))
 					}
 					if !featureGateFilter.IsEnabled(string(features.FeatureGateCPMSMachineNamePrefix)) {
 						Skip(fmt.Sprintf("Skipping test because %q featuregate is not enabled", features.FeatureGateCPMSMachineNamePrefix))
 					}
 
-					helpers.UpdateControlPlaneMachineSetMachineNamePrefix(testFramework, prefix)
+					helpers.UpdateControlPlaneMachineSetMachineNamePrefix(framework.GlobalFramework, prefix)
 				}, OncePerOrdered)
 
 				Context("and the provider spec of index 2 is not as expected", Ordered, func() {
 					var originalProviderSpec machinev1beta1.ProviderSpec
 
 					BeforeAll(func() {
-						originalProviderSpec, _ = helpers.ModifyMachineProviderSpecToTriggerRollout(testFramework, 2)
+						originalProviderSpec, _ = helpers.ModifyMachineProviderSpecToTriggerRollout(framework.GlobalFramework, 2)
 					})
 
 					AfterAll(func() {
-						helpers.UpdateControlPlaneMachineProviderSpec(testFramework, 2, originalProviderSpec)
+						helpers.UpdateControlPlaneMachineProviderSpec(framework.GlobalFramework, 2, originalProviderSpec)
 					})
 
-					helpers.ItShouldNotOnDeleteReplaceTheOutdatedMachine(testFramework, 2)
+					helpers.ItShouldNotOnDeleteReplaceTheOutdatedMachine(framework.GlobalFramework, 2)
 
 					// Machine name should follow prefixed naming convention
-					helpers.ItShouldOnDeleteReplaceTheOutDatedMachineWhenDeleted(testFramework, 2)
+					helpers.ItShouldOnDeleteReplaceTheOutDatedMachineWhenDeleted(framework.GlobalFramework, 2)
 
 					Context("and again MachineNamePrefix is reset", Ordered, func() {
 						BeforeAll(func() {
-							helpers.UpdateControlPlaneMachineSetMachineNamePrefix(testFramework, resetPrefix)
-							helpers.ModifyMachineProviderSpecToTriggerRollout(testFramework, 2)
+							helpers.UpdateControlPlaneMachineSetMachineNamePrefix(framework.GlobalFramework, resetPrefix)
+							helpers.ModifyMachineProviderSpecToTriggerRollout(framework.GlobalFramework, 2)
 						})
 
-						helpers.ItShouldNotOnDeleteReplaceTheOutdatedMachine(testFramework, 2)
+						helpers.ItShouldNotOnDeleteReplaceTheOutdatedMachine(framework.GlobalFramework, 2)
 
 						// Machine name should follow general naming convention
-						helpers.ItShouldOnDeleteReplaceTheOutDatedMachineWhenDeleted(testFramework, 2)
+						helpers.ItShouldOnDeleteReplaceTheOutDatedMachineWhenDeleted(framework.GlobalFramework, 2)
 					})
 				})
 			})