Merge pull request #725 from dmvolod/export-controller-type

🌱 Add alias to GenericProviderReconciler type

Author: k8s-ci-robot

.golangci.yaml

@@ -1,8 +1,6 @@
 run:
   timeout: 5m
   go: "1.23"
-  skip-files:
-    - "zz_generated.*\\.go$"
   allow-parallel-runners: true
 
 linters:
@@ -145,6 +143,8 @@ issues:
     # supported will be caught by the default case in the switches.
     - "missing cases in switch of type v1.PlatformType: (\\.*)"
   exclude-use-default: false
+  exclude-files:
+    - "zz_generated.*\\.go$"
   exclude-rules:
     - linters:
       - staticcheck

Makefile

@@ -90,7 +90,7 @@ GOTESTSUM_VER := v1.11.0
 GOTESTSUM_BIN := gotestsum
 GOTESTSUM := $(TOOLS_BIN_DIR)/$(GOTESTSUM_BIN)-$(GOTESTSUM_VER)
 
-GINKGO_VER := v2.20.1
+GINKGO_VER := v2.22.2
 GINKGO_BIN := ginkgo
 GINKGO := $(TOOLS_BIN_DIR)/$(GINKGO_BIN)-$(GINKGO_VER)
 

api/v1alpha2/conditions_consts.go

@@ -29,13 +29,13 @@ const (
 	// IncorrectVersionFormatReason documents that the provider version is in the incorrect format.
 	IncorrectVersionFormatReason = "IncorrectVersionFormat"
 
-	// IncorrectCoreProviderNameReason documents that the provider name is incorrect.
+	// IncorrectCoreProviderNameReason documents that the Core provider name is incorrect.
 	IncorrectCoreProviderNameReason = "IncorrectCoreProviderNameReason"
 
 	// EmptyVersionReason documents that the provider version is in the incorrect format.
 	EmptyVersionReason = "EmptyVersionReason"
 
-	// FetchConfigValidationError documents that the FetchConfig is configured incorrectly.
+	// FetchConfigValidationErrorReason documents that the FetchConfig is configured incorrectly.
 	FetchConfigValidationErrorReason = "FetchConfigValidationError"
 
 	// UnknownProviderReason documents that the provider name is not the name of a known provider.

api/v1alpha2/provider_types.go

@@ -23,8 +23,11 @@ import (
 )
 
 const (
-	ProviderFinalizer         = "provider.cluster.x-k8s.io"
+	ProviderFinalizer = "provider.cluster.x-k8s.io"
+
 	ConfigMapVersionLabelName = "provider.cluster.x-k8s.io/version"
+	ConfigMapTypeLabel        = "provider.cluster.x-k8s.io/type"
+	ConfigMapNameLabel        = "provider.cluster.x-k8s.io/name"
 
 	CompressedAnnotation = "provider.cluster.x-k8s.io/compressed"
 

cmd/plugin/cmd/init_test.go

@@ -35,7 +35,7 @@ import (
 	"sigs.k8s.io/cluster-api-operator/util"
 )
 
-func TestCheckCAPIOpearatorAvailability(t *testing.T) {
+func TestCheckCAPIOperatorAvailability(t *testing.T) {
 	tests := []struct {
 		name    string
 		want    bool
@@ -425,7 +425,7 @@ func getGenericProvider(ctx context.Context, client ctrlclient.Client, providerK
 		}
 
 		return provider, nil
-	case "RuntimExtensionProvider":
+	case "RuntimeExtensionProvider":
 		provider := &operatorv1.RuntimeExtensionProvider{}
 		if err := client.Get(ctx, types.NamespacedName{Name: providerName, Namespace: providerNamespace}, provider); err != nil {
 			return nil, err

controller/alias.go

@@ -0,0 +1,21 @@
+/*
+Copyright 2025 The Kubernetes Authors.
+
+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 controller
+
+import providercontroller "sigs.k8s.io/cluster-api-operator/internal/controller"
+
+type GenericProviderReconciler = providercontroller.GenericProviderReconciler

internal/controller/manifests_downloader.go

@@ -38,9 +38,6 @@ import (
 )
 
 const (
-	configMapVersionLabel     = "provider.cluster.x-k8s.io/version"
-	configMapTypeLabel        = "provider.cluster.x-k8s.io/type"
-	configMapNameLabel        = "provider.cluster.x-k8s.io/name"
 	configMapSourceLabel      = "provider.cluster.x-k8s.io/source"
 	configMapSourceAnnotation = "provider.cluster.x-k8s.io/source"
 	operatorManagedLabel      = "managed-by.operator.cluster.x-k8s.io"
@@ -292,10 +289,10 @@ func providerLabelSelector(provider operatorv1.GenericProvider) *metav1.LabelSel
 // ProviderLabels returns default set of labels that identify a config map with downloaded manifests.
 func ProviderLabels(provider operatorv1.GenericProvider) map[string]string {
 	labels := map[string]string{
-		configMapVersionLabel: provider.GetSpec().Version,
-		configMapTypeLabel:    provider.GetType(),
-		configMapNameLabel:    provider.GetName(),
-		operatorManagedLabel:  "true",
+		operatorv1.ConfigMapVersionLabelName: provider.GetSpec().Version,
+		operatorv1.ConfigMapTypeLabel:        provider.GetType(),
+		operatorv1.ConfigMapNameLabel:        provider.GetName(),
+		operatorManagedLabel:                 "true",
 	}
 
 	if provider.GetSpec().FetchConfig != nil && provider.GetSpec().FetchConfig.OCI != "" {

internal/controller/phases_test.go

@@ -529,10 +529,10 @@ releaseSeries:
 						Name:      testCurrentVersion,
 						Namespace: "default",
 						Labels: map[string]string{
-							configMapVersionLabel: testCurrentVersion,
-							configMapTypeLabel:    core.GetType(),
-							configMapNameLabel:    core.GetName(),
-							operatorManagedLabel:  "true",
+							operatorv1.ConfigMapVersionLabelName: testCurrentVersion,
+							operatorv1.ConfigMapTypeLabel:        core.GetType(),
+							operatorv1.ConfigMapNameLabel:        core.GetName(),
+							operatorManagedLabel:                 "true",
 						},
 					},
 					Data: map[string]string{"metadata": metadata, "components": ""},

test/e2e/air_gapped_test.go

@@ -102,7 +102,7 @@ var _ = Describe("Install Core Provider in an air-gapped environment", func() {
 			HaveStatusCondition(&coreProvider.Status.Conditions, operatorv1.ProviderInstalledCondition),
 		), e2eConfig.GetIntervals(bootstrapClusterProxy.GetName(), "wait-controllers")...)
 
-		By("Waiting for status.IntalledVersion to be set")
+		By("Waiting for status.InstalledVersion to be set")
 		WaitFor(ctx, For(coreProvider).In(bootstrapCluster).ToSatisfy(func() bool {
 			return ptr.Equal(coreProvider.Status.InstalledVersion, ptr.To(coreProvider.Spec.Version))
 		}), e2eConfig.GetIntervals(bootstrapClusterProxy.GetName(), "wait-controllers")...)
@@ -129,7 +129,7 @@ var _ = Describe("Install Core Provider in an air-gapped environment", func() {
 			HaveStatusCondition(&coreProvider.Status.Conditions, operatorv1.ProviderInstalledCondition),
 		), e2eConfig.GetIntervals(bootstrapClusterProxy.GetName(), "wait-controllers")...)
 
-		By("Waiting for status.IntalledVersion to be set")
+		By("Waiting for status.InstalledVersion to be set")
 		WaitFor(ctx, For(coreProvider).In(bootstrapCluster).ToSatisfy(func() bool {
 			return ptr.Equal(coreProvider.Status.InstalledVersion, ptr.To(coreProvider.Spec.Version))
 		}), e2eConfig.GetIntervals(bootstrapClusterProxy.GetName(), "wait-controllers")...)

test/e2e/compressed_manifests_test.go

@@ -67,7 +67,7 @@ var _ = Describe("Create and delete a provider with manifests that don't fit the
 			HaveStatusCondition(&coreProvider.Status.Conditions, operatorv1.ProviderInstalledCondition),
 		), e2eConfig.GetIntervals(bootstrapClusterProxy.GetName(), "wait-controllers")...)
 
-		By("Waiting for status.IntalledVersion to be set")
+		By("Waiting for status.InstalledVersion to be set")
 		WaitFor(ctx, For(coreProvider).In(bootstrapCluster).ToSatisfy(func() bool {
 			return ptr.Equal(coreProvider.Status.InstalledVersion, ptr.To(coreProvider.Spec.Version))
 		}), e2eConfig.GetIntervals(bootstrapClusterProxy.GetName(), "wait-controllers")...)
@@ -94,7 +94,7 @@ var _ = Describe("Create and delete a provider with manifests that don't fit the
 			HaveStatusCondition(&infraProvider.Status.Conditions, operatorv1.ProviderInstalledCondition),
 		), e2eConfig.GetIntervals(bootstrapClusterProxy.GetName(), "wait-controllers")...)
 
-		By("Waiting for status.IntalledVersion to be set")
+		By("Waiting for status.InstalledVersion to be set")
 		WaitFor(ctx, For(infraProvider).In(bootstrapCluster).ToSatisfy(func() bool {
 			return ptr.Equal(infraProvider.Status.InstalledVersion, ptr.To(infraProvider.Spec.Version))
 		}), e2eConfig.GetIntervals(bootstrapClusterProxy.GetName(), "wait-controllers")...)
@@ -168,7 +168,7 @@ var _ = Describe("Create and delete a provider with manifests that don't fit the
 			HaveStatusCondition(&infraProvider.Status.Conditions, operatorv1.ProviderInstalledCondition)),
 			e2eConfig.GetIntervals(bootstrapClusterProxy.GetName(), "wait-controllers")...)
 
-		By("Waiting for status.IntalledVersion to be set")
+		By("Waiting for status.InstalledVersion to be set")
 		WaitFor(ctx, For(infraProvider).In(bootstrapCluster).ToSatisfy(func() bool {
 			return ptr.Equal(infraProvider.Status.InstalledVersion, ptr.To(infraProvider.Spec.Version))
 		}), e2eConfig.GetIntervals(bootstrapClusterProxy.GetName(), "wait-controllers")...)