fixup! refactor: Use declared builtin variable name rather than string

jimmidyson · jimmidyson · commit 360962e93c15 · 2025-08-19T13:56:01.000+01:00
diff --git a/common/pkg/capi/clustertopology/handlers/mutation/meta.go b/common/pkg/capi/clustertopology/handlers/mutation/meta.go
@@ -101,7 +101,7 @@ func (mgp metaGeneratePatches) GeneratePatches(
 	globalVars := lo.FilterSliceToMap(
 		req.Variables,
 		func(v runtimehooksv1.Variable) (string, apiextensionsv1.JSON, bool) {
-			if v.Name == "builtin" {
+			if v.Name == runtimehooksv1.BuiltinsName {
 				return "", apiextensionsv1.JSON{}, false
 			}
 			return v.Name, v.Value, true
diff --git a/common/pkg/capi/clustertopology/patches/matchers/match_test.go b/common/pkg/capi/clustertopology/patches/matchers/match_test.go
@@ -225,7 +225,7 @@ func TestMatchesSelector(t *testing.T) {
 			FieldPath:  "spec.template.spec.bootstrap.configRef",
 		},
 		templateVariables: map[string]apiextensionsv1.JSON{
-			"builtin": {Raw: []byte(`{"machineDeployment":{"class":"classA"}}`)},
+			runtimehooksv1.BuiltinsName: {Raw: []byte(`{"machineDeployment":{"class":"classA"}}`)},
 		},
 		selector: clusterv1.PatchSelector{
 			APIVersion: "bootstrap.cluster.x-k8s.io/v1beta1",
@@ -253,7 +253,7 @@ func TestMatchesSelector(t *testing.T) {
 			FieldPath:  "spec.template.spec.bootstrap.configRef",
 		},
 		templateVariables: map[string]apiextensionsv1.JSON{
-			"builtin": {Raw: []byte(`{"machineDeployment":{"class":"classA"}}`)},
+			runtimehooksv1.BuiltinsName: {Raw: []byte(`{"machineDeployment":{"class":"classA"}}`)},
 		},
 		selector: clusterv1.PatchSelector{
 			APIVersion: "bootstrap.cluster.x-k8s.io/v1beta1",
@@ -281,7 +281,7 @@ func TestMatchesSelector(t *testing.T) {
 			FieldPath:  "spec.template.spec.bootstrap.configRef",
 		},
 		templateVariables: map[string]apiextensionsv1.JSON{
-			"builtin": {Raw: []byte(`{"machineDeployment":{"class":"class-A"}}`)},
+			runtimehooksv1.BuiltinsName: {Raw: []byte(`{"machineDeployment":{"class":"class-A"}}`)},
 		},
 		selector: clusterv1.PatchSelector{
 			APIVersion: "bootstrap.cluster.x-k8s.io/v1beta1",
@@ -309,7 +309,7 @@ func TestMatchesSelector(t *testing.T) {
 			FieldPath:  "spec.template.spec.bootstrap.configRef",
 		},
 		templateVariables: map[string]apiextensionsv1.JSON{
-			"builtin": {Raw: []byte(`{"machineDeployment":{"class":"class-A"}}`)},
+			runtimehooksv1.BuiltinsName: {Raw: []byte(`{"machineDeployment":{"class":"class-A"}}`)},
 		},
 		selector: clusterv1.PatchSelector{
 			APIVersion: "bootstrap.cluster.x-k8s.io/v1beta1",
@@ -337,7 +337,7 @@ func TestMatchesSelector(t *testing.T) {
 			FieldPath:  "spec.template.spec.bootstrap.configRef",
 		},
 		templateVariables: map[string]apiextensionsv1.JSON{
-			"builtin": {Raw: []byte(`{"machineDeployment":{"class":"classA"}}`)},
+			runtimehooksv1.BuiltinsName: {Raw: []byte(`{"machineDeployment":{"class":"classA"}}`)},
 		},
 		selector: clusterv1.PatchSelector{
 			APIVersion: "bootstrap.cluster.x-k8s.io/v1beta1",
@@ -365,7 +365,7 @@ func TestMatchesSelector(t *testing.T) {
 			FieldPath:  "spec.template.spec.bootstrap.configRef",
 		},
 		templateVariables: map[string]apiextensionsv1.JSON{
-			"builtin": {Raw: []byte(`{"machineDeployment":{"class":"classA"}}`)},
+			runtimehooksv1.BuiltinsName: {Raw: []byte(`{"machineDeployment":{"class":"classA"}}`)},
 		},
 		selector: clusterv1.PatchSelector{
 			APIVersion: "bootstrap.cluster.x-k8s.io/v1beta1",
@@ -391,7 +391,7 @@ func TestMatchesSelector(t *testing.T) {
 			FieldPath:  "spec.template.spec.bootstrap.configRef",
 		},
 		templateVariables: map[string]apiextensionsv1.JSON{
-			"builtin": {Raw: []byte(`{"machineDeployment":{"class":"classA"}}`)},
+			runtimehooksv1.BuiltinsName: {Raw: []byte(`{"machineDeployment":{"class":"classA"}}`)},
 		},
 		selector: clusterv1.PatchSelector{
 			APIVersion:     "bootstrap.cluster.x-k8s.io/v1beta1",
@@ -415,7 +415,7 @@ func TestMatchesSelector(t *testing.T) {
 			FieldPath:  "spec.template.spec.bootstrap.configRef",
 		},
 		templateVariables: map[string]apiextensionsv1.JSON{
-			"builtin": {Raw: []byte(`{"machineDeployment":{"class":"classA"}}`)},
+			runtimehooksv1.BuiltinsName: {Raw: []byte(`{"machineDeployment":{"class":"classA"}}`)},
 		},
 		selector: clusterv1.PatchSelector{
 			APIVersion: "bootstrap.cluster.x-k8s.io/v1beta1",
@@ -443,7 +443,7 @@ func TestMatchesSelector(t *testing.T) {
 			FieldPath:  "spec.template.spec.infrastructureRef",
 		},
 		templateVariables: map[string]apiextensionsv1.JSON{
-			"builtin": {Raw: []byte(`{"machineDeployment":{"class":"classA"}}`)},
+			runtimehooksv1.BuiltinsName: {Raw: []byte(`{"machineDeployment":{"class":"classA"}}`)},
 		},
 		selector: clusterv1.PatchSelector{
 			APIVersion: "infrastructure.cluster.x-k8s.io/v1beta1",
diff --git a/pkg/handlers/aws/mutation/ami/inject_worker_test.go b/pkg/handlers/aws/mutation/ami/inject_worker_test.go
@@ -32,7 +32,7 @@ var _ = Describe("Generate AMI patches for Worker", func() {
 					VariableName,
 				),
 				capitest.VariableWithValue(
-					"builtin",
+					runtimehooksv1.BuiltinsName,
 					apiextensionsv1.JSON{
 						Raw: []byte(`{"machineDeployment": {"class": "a-worker"}}`),
 					},
@@ -63,7 +63,7 @@ var _ = Describe("Generate AMI patches for Worker", func() {
 					VariableName,
 				),
 				capitest.VariableWithValue(
-					"builtin",
+					runtimehooksv1.BuiltinsName,
 					apiextensionsv1.JSON{
 						Raw: []byte(`{"machineDeployment": {"class": "a-worker"}}`),
 					},
diff --git a/pkg/handlers/aws/mutation/iaminstanceprofile/inject_worker_test.go b/pkg/handlers/aws/mutation/iaminstanceprofile/inject_worker_test.go
@@ -35,7 +35,7 @@ var _ = Describe("Generate IAMInstanceProfile patches for Worker", func() {
 					VariableName,
 				),
 				capitest.VariableWithValue(
-					"builtin",
+					runtimehooksv1.BuiltinsName,
 					apiextensionsv1.JSON{
 						Raw: []byte(`{"machineDeployment": {"class": "a-worker"}}`),
 					},
diff --git a/pkg/handlers/aws/mutation/instancetype/inject_worker_test.go b/pkg/handlers/aws/mutation/instancetype/inject_worker_test.go
@@ -35,7 +35,7 @@ var _ = Describe("Generate InstanceType patches for Worker", func() {
 					VariableName,
 				),
 				capitest.VariableWithValue(
-					"builtin",
+					runtimehooksv1.BuiltinsName,
 					apiextensionsv1.JSON{
 						Raw: []byte(`{"machineDeployment": {"class": "a-worker"}}`),
 					},
diff --git a/pkg/handlers/aws/mutation/placementgroup/inject_worker_test.go b/pkg/handlers/aws/mutation/placementgroup/inject_worker_test.go
@@ -35,7 +35,7 @@ var _ = Describe("Generate PlacementGroup patches for Worker", func() {
 					VariableName,
 				),
 				capitest.VariableWithValue(
-					"builtin",
+					runtimehooksv1.BuiltinsName,
 					apiextensionsv1.JSON{
 						Raw: []byte(`{"machineDeployment": {"class": "a-worker"}}`),
 					},
diff --git a/pkg/handlers/aws/mutation/securitygroups/inject_worker_test.go b/pkg/handlers/aws/mutation/securitygroups/inject_worker_test.go
@@ -39,7 +39,7 @@ var _ = Describe("Generate AWS SecurityGroups patches for Worker", func() {
 					VariableName,
 				),
 				capitest.VariableWithValue(
-					"builtin",
+					runtimehooksv1.BuiltinsName,
 					apiextensionsv1.JSON{
 						Raw: []byte(`{"machineDeployment": {"class": "a-worker"}}`),
 					},
diff --git a/pkg/handlers/docker/mutation/customimage/inject_control_plane.go b/pkg/handlers/docker/mutation/customimage/inject_control_plane.go
@@ -95,7 +95,7 @@ func (h *customImageControlPlanePatchHandler) Mutate(
 		),
 		log,
 		func(obj *capdv1.DockerMachineTemplate) error {
-			variablePath := []string{"builtin", "controlPlane", "version"}
+			variablePath := []string{runtimehooksv1.BuiltinsName, "controlPlane", "version"}
 
 			if customImageVar == "" {
 				kubernetesVersion, err := variables.Get[string](
diff --git a/pkg/handlers/docker/mutation/customimage/inject_control_plane_test.go b/pkg/handlers/docker/mutation/customimage/inject_control_plane_test.go
@@ -29,7 +29,7 @@ var _ = Describe("Docker CustomImage patches for ControlPlane", func() {
 			Name: "image unset for control plane",
 			Vars: []runtimehooksv1.Variable{
 				capitest.VariableWithValue(
-					"builtin",
+					runtimehooksv1.BuiltinsName,
 					apiextensionsv1.JSON{Raw: []byte(`{"controlPlane": {"version": "v1.2.3"}}`)},
 				),
 			},
@@ -51,7 +51,7 @@ var _ = Describe("Docker CustomImage patches for ControlPlane", func() {
 					VariableName,
 				),
 				capitest.VariableWithValue(
-					"builtin",
+					runtimehooksv1.BuiltinsName,
 					apiextensionsv1.JSON{
 						Raw: []byte(`{"machineDeployment": {"class": "a-worker"}}`),
 					},
diff --git a/pkg/handlers/docker/mutation/customimage/inject_worker.go b/pkg/handlers/docker/mutation/customimage/inject_worker.go
@@ -87,7 +87,7 @@ func (h *customImageWorkerPatchHandler) Mutate(
 		),
 		log,
 		func(obj *capdv1.DockerMachineTemplate) error {
-			fieldPath := []string{"builtin", "machineDeployment", "version"}
+			fieldPath := []string{runtimehooksv1.BuiltinsName, "machineDeployment", "version"}
 
 			if customImageVar == "" {
 				kubernetesVersion, err := variables.Get[string](
diff --git a/pkg/handlers/docker/mutation/customimage/inject_worker_test.go b/pkg/handlers/docker/mutation/customimage/inject_worker_test.go
@@ -26,7 +26,7 @@ var _ = Describe("Docker CustomImage patches for workers", func() {
 			Name: "image unset for workers",
 			Vars: []runtimehooksv1.Variable{
 				capitest.VariableWithValue(
-					"builtin",
+					runtimehooksv1.BuiltinsName,
 					apiextensionsv1.JSON{
 						Raw: []byte(
 							`{"machineDeployment": {"class": "a-worker", "version": "v1.2.3"}}`,
@@ -51,7 +51,7 @@ var _ = Describe("Docker CustomImage patches for workers", func() {
 					VariableName,
 				),
 				capitest.VariableWithValue(
-					"builtin",
+					runtimehooksv1.BuiltinsName,
 					apiextensionsv1.JSON{
 						Raw: []byte(`{"machineDeployment": {"class": "a-worker"}}`),
 					},
diff --git a/pkg/handlers/eks/mutation/ami/inject_worker_test.go b/pkg/handlers/eks/mutation/ami/inject_worker_test.go
@@ -33,7 +33,7 @@ var _ = Describe("Generate AMI patches for Worker", func() {
 					ami.VariableName,
 				),
 				capitest.VariableWithValue(
-					"builtin",
+					runtimehooksv1.BuiltinsName,
 					apiextensionsv1.JSON{
 						Raw: []byte(`{"machineDeployment": {"class": "a-worker"}}`),
 					},
@@ -64,7 +64,7 @@ var _ = Describe("Generate AMI patches for Worker", func() {
 					ami.VariableName,
 				),
 				capitest.VariableWithValue(
-					"builtin",
+					runtimehooksv1.BuiltinsName,
 					apiextensionsv1.JSON{
 						Raw: []byte(`{"machineDeployment": {"class": "a-worker"}}`),
 					},
diff --git a/pkg/handlers/eks/mutation/iaminstanceprofile/inject_worker_test.go b/pkg/handlers/eks/mutation/iaminstanceprofile/inject_worker_test.go
@@ -36,7 +36,7 @@ var _ = Describe("Generate IAMInstanceProfile patches for Worker", func() {
 					iaminstanceprofile.VariableName,
 				),
 				capitest.VariableWithValue(
-					"builtin",
+					runtimehooksv1.BuiltinsName,
 					apiextensionsv1.JSON{
 						Raw: []byte(`{"machineDeployment": {"class": "a-worker"}}`),
 					},
diff --git a/pkg/handlers/eks/mutation/instancetype/inject_worker_test.go b/pkg/handlers/eks/mutation/instancetype/inject_worker_test.go
@@ -36,7 +36,7 @@ var _ = Describe("Generate InstanceType patches for Worker", func() {
 					awsinstancetype.VariableName,
 				),
 				capitest.VariableWithValue(
-					"builtin",
+					runtimehooksv1.BuiltinsName,
 					apiextensionsv1.JSON{
 						Raw: []byte(`{"machineDeployment": {"class": "a-worker"}}`),
 					},
diff --git a/pkg/handlers/eks/mutation/placementgroup/inject_worker_test.go b/pkg/handlers/eks/mutation/placementgroup/inject_worker_test.go
@@ -36,7 +36,7 @@ var _ = Describe("Generate PlacementGroup patches for Worker", func() {
 					placementgroup.VariableName,
 				),
 				capitest.VariableWithValue(
-					"builtin",
+					runtimehooksv1.BuiltinsName,
 					apiextensionsv1.JSON{
 						Raw: []byte(`{"machineDeployment": {"class": "a-worker"}}`),
 					},
diff --git a/pkg/handlers/eks/mutation/securitygroups/inject_worker_test.go b/pkg/handlers/eks/mutation/securitygroups/inject_worker_test.go
@@ -40,7 +40,7 @@ var _ = Describe("Generate AWS SecurityGroups patches for Worker", func() {
 					securitygroups.VariableName,
 				),
 				capitest.VariableWithValue(
-					"builtin",
+					runtimehooksv1.BuiltinsName,
 					apiextensionsv1.JSON{
 						Raw: []byte(`{"machineDeployment": {"class": "a-worker"}}`),
 					},
diff --git a/pkg/handlers/generic/mutation/containerdapplypatchesandrestart/inject_test.go b/pkg/handlers/generic/mutation/containerdapplypatchesandrestart/inject_test.go
@@ -60,7 +60,7 @@ var _ = Describe("Generate Containerd apply patches and restart patches", func()
 			Name: "restart script and command added to worker node kubeadm config template",
 			Vars: []runtimehooksv1.Variable{
 				capitest.VariableWithValue(
-					"builtin",
+					runtimehooksv1.BuiltinsName,
 					map[string]any{
 						"machineDeployment": map[string]any{
 							"class": "*",
diff --git a/pkg/handlers/generic/mutation/containerdmetrics/inject_test.go b/pkg/handlers/generic/mutation/containerdmetrics/inject_test.go
@@ -47,7 +47,7 @@ var _ = Describe("Generate containerd metrics patches", func() {
 			Name: "containerd metrics config added to worker node kubeadm config template",
 			Vars: []runtimehooksv1.Variable{
 				capitest.VariableWithValue(
-					"builtin",
+					runtimehooksv1.BuiltinsName,
 					map[string]any{
 						"machineDeployment": map[string]any{
 							"class": "*",
diff --git a/pkg/handlers/generic/mutation/containerdunprivilegedports/inject_test.go b/pkg/handlers/generic/mutation/containerdunprivilegedports/inject_test.go
@@ -47,7 +47,7 @@ var _ = Describe("Generate containerd unprivileged ports patches", func() {
 			Name: "containerd unprivileged ports config added to worker node kubeadm config template",
 			Vars: []runtimehooksv1.Variable{
 				capitest.VariableWithValue(
-					"builtin",
+					runtimehooksv1.BuiltinsName,
 					map[string]any{
 						"machineDeployment": map[string]any{
 							"class": "*",
diff --git a/pkg/handlers/generic/mutation/httpproxy/inject_test.go b/pkg/handlers/generic/mutation/httpproxy/inject_test.go
@@ -62,7 +62,7 @@ var _ = Describe("Generate HTTPProxy Patches", func() {
 					VariableName,
 				),
 				capitest.VariableWithValue(
-					"builtin",
+					runtimehooksv1.BuiltinsName,
 					map[string]any{
 						"machineDeployment": map[string]any{
 							"class": names.SimpleNameGenerator.GenerateName("worker-"),
diff --git a/pkg/handlers/generic/mutation/imageregistries/credentials/inject_test.go b/pkg/handlers/generic/mutation/imageregistries/credentials/inject_test.go
@@ -343,7 +343,7 @@ var _ = Describe("Generate Image registry patches", func() {
 						v1alpha1.ImageRegistriesVariableName,
 					),
 					capitest.VariableWithValue(
-						"builtin",
+						runtimehooksv1.BuiltinsName,
 						map[string]any{
 							"machineDeployment": map[string]any{
 								"class": names.SimpleNameGenerator.GenerateName("worker-"),
@@ -400,7 +400,7 @@ var _ = Describe("Generate Image registry patches", func() {
 						v1alpha1.ImageRegistriesVariableName,
 					),
 					capitest.VariableWithValue(
-						"builtin",
+						runtimehooksv1.BuiltinsName,
 						map[string]any{
 							"machineDeployment": map[string]any{
 								"class": names.SimpleNameGenerator.GenerateName("worker-"),
diff --git a/pkg/handlers/generic/mutation/mirrors/inject_test.go b/pkg/handlers/generic/mutation/mirrors/inject_test.go
@@ -198,7 +198,7 @@ var _ = Describe("Generate Global mirror patches", func() {
 					v1alpha1.GlobalMirrorVariableName,
 				),
 				capitest.VariableWithValue(
-					"builtin",
+					runtimehooksv1.BuiltinsName,
 					map[string]any{
 						"machineDeployment": map[string]any{
 							"class": names.SimpleNameGenerator.GenerateName("worker-"),
@@ -238,7 +238,7 @@ var _ = Describe("Generate Global mirror patches", func() {
 					v1alpha1.GlobalMirrorVariableName,
 				),
 				capitest.VariableWithValue(
-					"builtin",
+					runtimehooksv1.BuiltinsName,
 					map[string]any{
 						"machineDeployment": map[string]any{
 							"class": names.SimpleNameGenerator.GenerateName("worker-"),
@@ -281,7 +281,7 @@ var _ = Describe("Generate Global mirror patches", func() {
 					v1alpha1.GlobalMirrorVariableName,
 				),
 				capitest.VariableWithValue(
-					"builtin",
+					runtimehooksv1.BuiltinsName,
 					map[string]any{
 						"machineDeployment": map[string]any{
 							"class": names.SimpleNameGenerator.GenerateName("worker-"),
@@ -321,7 +321,7 @@ var _ = Describe("Generate Global mirror patches", func() {
 					v1alpha1.ImageRegistriesVariableName,
 				),
 				capitest.VariableWithValue(
-					"builtin",
+					runtimehooksv1.BuiltinsName,
 					map[string]any{
 						"machineDeployment": map[string]any{
 							"class": names.SimpleNameGenerator.GenerateName("worker-"),
@@ -382,7 +382,7 @@ var _ = Describe("Generate Global mirror patches", func() {
 					[]string{"addons", v1alpha1.RegistryAddonVariableName}...,
 				),
 				capitest.VariableWithValue(
-					"builtin",
+					runtimehooksv1.BuiltinsName,
 					map[string]any{
 						"machineDeployment": map[string]any{
 							"class": names.SimpleNameGenerator.GenerateName("worker-"),
diff --git a/pkg/handlers/generic/mutation/noderegistration/inject_worker_test.go b/pkg/handlers/generic/mutation/noderegistration/inject_worker_test.go
@@ -36,7 +36,7 @@ var _ = Describe("Generate NodeRegistration patches for Worker", func() {
 					VariableName,
 				),
 				capitest.VariableWithValue(
-					"builtin",
+					runtimehooksv1.BuiltinsName,
 					apiextensionsv1.JSON{
 						Raw: []byte(`{"machineDeployment": {"class": "a-worker"}}`),
 					},
diff --git a/pkg/handlers/generic/mutation/ntp/inject_test.go b/pkg/handlers/generic/mutation/ntp/inject_test.go
@@ -100,7 +100,7 @@ var _ = Describe("Generate NTP patches", func() {
 					VariableName,
 				),
 				capitest.VariableWithValue(
-					"builtin",
+					runtimehooksv1.BuiltinsName,
 					map[string]any{
 						"machineDeployment": map[string]any{
 							"class": "worker-class",
@@ -131,7 +131,7 @@ var _ = Describe("Generate NTP patches", func() {
 					VariableName,
 				),
 				capitest.VariableWithValue(
-					"builtin",
+					runtimehooksv1.BuiltinsName,
 					map[string]any{
 						"machineDeployment": map[string]any{
 							"class": "worker-class",
@@ -181,7 +181,7 @@ var _ = Describe("Generate NTP patches", func() {
 					VariableName,
 				),
 				capitest.VariableWithValue(
-					"builtin",
+					runtimehooksv1.BuiltinsName,
 					map[string]any{
 						"machineDeployment": map[string]any{
 							"class": "worker-class",
diff --git a/pkg/handlers/generic/mutation/taints/inject_worker_test.go b/pkg/handlers/generic/mutation/taints/inject_worker_test.go
diff --git a/pkg/handlers/generic/mutation/users/inject_test.go b/pkg/handlers/generic/mutation/users/inject_test.go
diff --git a/pkg/handlers/nutanix/mutation/machinedetails/inject_worker_test.go b/pkg/handlers/nutanix/mutation/machinedetails/inject_worker_test.go

Original file line number	Diff line number	Diff line change
`@@ -101,7 +101,7 @@ func (mgp metaGeneratePatches) GeneratePatches(`
`101`	`101`	`globalVars := lo.FilterSliceToMap(`
`102`	`102`	`req.Variables,`
`103`	`103`	`func(v runtimehooksv1.Variable) (string, apiextensionsv1.JSON, bool) {`
`104`		`- if v.Name == "builtin" {`
	`104`	`+ if v.Name == runtimehooksv1.BuiltinsName {`
`105`	`105`	`return "", apiextensionsv1.JSON{}, false`
`106`	`106`	`}`
`107`	`107`	`return v.Name, v.Value, true`