fixup! refactor: Move meta variable name to module where it is used

jimmidyson · jimmidyson · commit 8e321faaf482 · 2023-09-19T11:27:05.000+01:00
diff --git a/common/pkg/capi/clustertopology/handlers/mutation/meta.go b/common/pkg/capi/clustertopology/handlers/mutation/meta.go
@@ -12,11 +12,6 @@ import (
 	"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/handlers"
 )
 
-const (
-	// MetaVariableName is the meta cluster config patch variable name.
-	MetaVariableName = "clusterConfig"
-)
-
 type metaGeneratePatches struct {
 	name            string
 	wrappedHandlers []GeneratePatches
diff --git a/pkg/handlers/clusterconfig/variables.go b/pkg/handlers/clusterconfig/variables.go
@@ -10,12 +10,13 @@ import (
 	runtimehooksv1 "sigs.k8s.io/cluster-api/exp/runtime/hooks/api/v1alpha1"
 
 	"github.com/d2iq-labs/capi-runtime-extensions/api/v1alpha1"
-	"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/handlers"
+	commonhandlers "github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/handlers"
 	"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/handlers/mutation"
+	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers"
 )
 
 var (
-	_ handlers.Named             = &clusterConfigVariableHandler{}
+	_ commonhandlers.Named       = &clusterConfigVariableHandler{}
 	_ mutation.DiscoverVariables = &clusterConfigVariableHandler{}
 )
 
@@ -40,7 +41,7 @@ func (h *clusterConfigVariableHandler) DiscoverVariables(
 	resp *runtimehooksv1.DiscoverVariablesResponse,
 ) {
 	resp.Variables = append(resp.Variables, clusterv1.ClusterClassVariable{
-		Name:     mutation.MetaVariableName,
+		Name:     handlers.MetaVariableName,
 		Required: false,
 		Schema:   v1alpha1.ClusterConfigSpec{}.VariableSchema(),
 	})
diff --git a/pkg/handlers/clusterconfig/variables_test.go b/pkg/handlers/clusterconfig/variables_test.go
@@ -9,14 +9,14 @@ import (
 	"k8s.io/utils/ptr"
 
 	"github.com/d2iq-labs/capi-runtime-extensions/api/v1alpha1"
-	"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/handlers/mutation"
 	"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/testutils/capitest"
+	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers"
 )
 
 func TestVariableValidation(t *testing.T) {
 	capitest.ValidateDiscoverVariables(
 		t,
-		mutation.MetaVariableName,
+		handlers.MetaVariableName,
 		ptr.To(v1alpha1.ClusterConfigSpec{}.VariableSchema()),
 		NewVariable,
 		capitest.VariableTestDef{
diff --git a/pkg/handlers/cni/calico/handler.go b/pkg/handlers/cni/calico/handler.go
@@ -24,12 +24,12 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
 
 	"github.com/d2iq-labs/capi-runtime-extensions/api/v1alpha1"
-	"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/handlers"
+	commonhandlers "github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/handlers"
 	"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/handlers/lifecycle"
-	"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/handlers/mutation"
 	"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/variables"
 	"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/k8s/client"
 	"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/k8s/parser"
+	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers"
 	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/cni"
 )
 
@@ -77,7 +77,7 @@ type CalicoCNI struct {
 }
 
 var (
-	_ handlers.Named                         = &CalicoCNI{}
+	_ commonhandlers.Named                   = &CalicoCNI{}
 	_ lifecycle.AfterControlPlaneInitialized = &CalicoCNI{}
 
 	calicoInstallationGK = schema.GroupKind{Group: "operator.tigera.io", Kind: "Installation"}
@@ -90,7 +90,7 @@ func NewMetaHandler(
 	return &CalicoCNI{
 		client:       c,
 		config:       cfg,
-		variableName: mutation.MetaVariableName,
+		variableName: handlers.MetaVariableName,
 		variablePath: []string{variableName},
 	}
 }
diff --git a/pkg/handlers/etcd/inject.go b/pkg/handlers/etcd/inject.go
@@ -18,11 +18,12 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
 	"github.com/d2iq-labs/capi-runtime-extensions/api/v1alpha1"
-	"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/handlers"
+	commonhandlers "github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/handlers"
 	"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/handlers/mutation"
 	"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/patches"
 	"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/patches/selectors"
 	"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/variables"
+	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers"
 )
 
 const (
@@ -37,7 +38,7 @@ type etcdPatchHandler struct {
 }
 
 var (
-	_ handlers.Named           = &etcdPatchHandler{}
+	_ commonhandlers.Named     = &etcdPatchHandler{}
 	_ mutation.GeneratePatches = &etcdPatchHandler{}
 )
 
@@ -46,7 +47,7 @@ func NewPatch() *etcdPatchHandler {
 }
 
 func NewMetaPatch() *etcdPatchHandler {
-	return newEtcdPatchHandler(mutation.MetaVariableName, variableName)
+	return newEtcdPatchHandler(handlers.MetaVariableName, variableName)
 }
 
 func newEtcdPatchHandler(
diff --git a/pkg/handlers/extraapiservercertsans/inject.go b/pkg/handlers/extraapiservercertsans/inject.go
@@ -18,11 +18,12 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
 	"github.com/d2iq-labs/capi-runtime-extensions/api/v1alpha1"
-	"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/handlers"
+	commonhandlers "github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/handlers"
 	"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/handlers/mutation"
 	"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/patches"
 	"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/patches/selectors"
 	"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/variables"
+	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers"
 )
 
 const (
@@ -37,7 +38,7 @@ type extraAPIServerCertSANsPatchHandler struct {
 }
 
 var (
-	_ handlers.Named           = &extraAPIServerCertSANsPatchHandler{}
+	_ commonhandlers.Named     = &extraAPIServerCertSANsPatchHandler{}
 	_ mutation.GeneratePatches = &extraAPIServerCertSANsPatchHandler{}
 )
 
@@ -46,7 +47,7 @@ func NewPatch() *extraAPIServerCertSANsPatchHandler {
 }
 
 func NewMetaPatch() *extraAPIServerCertSANsPatchHandler {
-	return newExtraAPIServerCertSANsPatchHandler(mutation.MetaVariableName, variableName)
+	return newExtraAPIServerCertSANsPatchHandler(handlers.MetaVariableName, variableName)
 }
 
 func newExtraAPIServerCertSANsPatchHandler(
diff --git a/pkg/handlers/httpproxy/inject.go b/pkg/handlers/httpproxy/inject.go
@@ -22,11 +22,12 @@ import (
 	ctrlclient "sigs.k8s.io/controller-runtime/pkg/client"
 
 	"github.com/d2iq-labs/capi-runtime-extensions/api/v1alpha1"
-	"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/handlers"
+	commonhandlers "github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/handlers"
 	"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/handlers/mutation"
 	"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/patches"
 	"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/patches/selectors"
 	"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/variables"
+	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers"
 )
 
 const (
@@ -47,7 +48,7 @@ type httpProxyPatchHandler struct {
 }
 
 var (
-	_ handlers.Named           = &httpProxyPatchHandler{}
+	_ commonhandlers.Named     = &httpProxyPatchHandler{}
 	_ mutation.GeneratePatches = &httpProxyPatchHandler{}
 )
 
@@ -60,7 +61,7 @@ func NewPatch(
 func NewMetaPatch(
 	cl ctrlclient.Reader,
 ) *httpProxyPatchHandler {
-	return newHTTPProxyPatchHandler(cl, mutation.MetaVariableName, variableName)
+	return newHTTPProxyPatchHandler(cl, handlers.MetaVariableName, variableName)
 }
 
 func newHTTPProxyPatchHandler(
diff --git a/pkg/handlers/kubernetesimagerepository/inject.go b/pkg/handlers/kubernetesimagerepository/inject.go
@@ -18,11 +18,12 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
 	"github.com/d2iq-labs/capi-runtime-extensions/api/v1alpha1"
-	"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/handlers"
+	commonhandlers "github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/handlers"
 	"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/handlers/mutation"
 	"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/patches"
 	"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/patches/selectors"
 	"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/variables"
+	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers"
 )
 
 const (
@@ -37,7 +38,7 @@ type imageRepositoryPatchHandler struct {
 }
 
 var (
-	_ handlers.Named           = &imageRepositoryPatchHandler{}
+	_ commonhandlers.Named     = &imageRepositoryPatchHandler{}
 	_ mutation.GeneratePatches = &imageRepositoryPatchHandler{}
 )
 
@@ -46,7 +47,7 @@ func NewPatch() *imageRepositoryPatchHandler {
 }
 
 func NewMetaPatch() *imageRepositoryPatchHandler {
-	return newImageRegistryPatchHandler(mutation.MetaVariableName, variableName)
+	return newImageRegistryPatchHandler(handlers.MetaVariableName, variableName)
 }
 
 func newImageRegistryPatchHandler(
diff --git a/pkg/handlers/metadata.go b/pkg/handlers/metadata.go
@@ -7,4 +7,7 @@ import "github.com/d2iq-labs/capi-runtime-extensions/api/v1alpha1"
 
 const (
 	MetadataDomain = v1alpha1.APIGroup
+
+	// MetaVariableName is the meta cluster config patch variable name.
+	MetaVariableName = "clusterConfig"
 )

Original file line number	Diff line number	Diff line change
`@@ -18,11 +18,12 @@ import (`
`18`	`18`	`"sigs.k8s.io/controller-runtime/pkg/client"`
`19`	`19`
`20`	`20`	`"github.com/d2iq-labs/capi-runtime-extensions/api/v1alpha1"`
`21`		`- "github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/handlers"`
	`21`	`+ commonhandlers "github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/handlers"`
`22`	`22`	`"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/handlers/mutation"`
`23`	`23`	`"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/patches"`
`24`	`24`	`"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/patches/selectors"`
`25`	`25`	`"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/variables"`
	`26`	`+ "github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers"`
`26`	`27`	`)`
`27`	`28`
`28`	`29`	`const (`
`@@ -37,7 +38,7 @@ type etcdPatchHandler struct {`
`37`	`38`	`}`
`38`	`39`
`39`	`40`	`var (`
`40`		`- _ handlers.Named = &etcdPatchHandler{}`
	`41`	`+ _ commonhandlers.Named = &etcdPatchHandler{}`
`41`	`42`	`_ mutation.GeneratePatches = &etcdPatchHandler{}`
`42`	`43`	`)`
`43`	`44`
`@@ -46,7 +47,7 @@ func NewPatch() *etcdPatchHandler {`
`46`	`47`	`}`
`47`	`48`
`48`	`49`	`func NewMetaPatch() *etcdPatchHandler {`
`49`		`- return newEtcdPatchHandler(mutation.MetaVariableName, variableName)`
	`50`	`+ return newEtcdPatchHandler(handlers.MetaVariableName, variableName)`
`50`	`51`	`}`
`51`	`52`
`52`	`53`	`func newEtcdPatchHandler(`
Original file line number	Diff line number	Diff line change
`@@ -7,4 +7,7 @@ import "github.com/d2iq-labs/capi-runtime-extensions/api/v1alpha1"`
`7`	`7`
`8`	`8`	`const (`
`9`	`9`	`MetadataDomain = v1alpha1.APIGroup`
	`10`	`+`
	`11`	`+ // MetaVariableName is the meta cluster config patch variable name.`
	`12`	`+ MetaVariableName = "clusterConfig"`
`10`	`13`	`)`