refactor: Move generic handlers into generic directory (#171)

Author: jimmidyson

api/v1alpha1/clusterconfig_types.go

@@ -215,19 +215,14 @@ type CNI struct {
 func (CNI) VariableSchema() clusterv1.VariableSchema {
 	supportedCNIProviders := []string{CNIProviderCalico}
 
-	cniProviderEnumVals, err := variables.ValuesToEnumJSON(supportedCNIProviders...)
-	if err != nil {
-		panic(err)
-	}
-
 	return clusterv1.VariableSchema{
 		OpenAPIV3Schema: clusterv1.JSONSchemaProps{
 			Type: "object",
 			Properties: map[string]clusterv1.JSONSchemaProps{
 				"provider": {
 					Description: "CNI provider to deploy",
 					Type:        "string",
-					Enum:        cniProviderEnumVals,
+					Enum:        variables.MustMarshalValuesToEnumJSON(supportedCNIProviders...),
 				},
 			},
 			Required: []string{"provider"},

cmd/main.go

@@ -27,15 +27,15 @@ import (
 	"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/server"
-	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/auditpolicy"
-	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/clusterconfig"
-	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/cni/calico"
-	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/etcd"
-	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/extraapiservercertsans"
-	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/httpproxy"
-	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/kubernetesimagerepository"
-	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/nfd"
-	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/servicelbgc"
+	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/generic/clusterconfig"
+	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/generic/lifecycle/cni/calico"
+	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/generic/lifecycle/nfd"
+	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/generic/lifecycle/servicelbgc"
+	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/generic/mutation/auditpolicy"
+	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/generic/mutation/etcd"
+	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/generic/mutation/extraapiservercertsans"
+	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/generic/mutation/httpproxy"
+	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/generic/mutation/kubernetesimagerepository"
 )
 
 // Flags.

common/pkg/capi/clustertopology/variables/enums.go

@@ -4,22 +4,15 @@
 package variables
 
 import (
-	"encoding/json"
-	"fmt"
-
 	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 )
 
-func ValuesToEnumJSON[T any](vals ...T) ([]apiextensionsv1.JSON, error) {
+func MustMarshalValuesToEnumJSON[T any](vals ...T) []apiextensionsv1.JSON {
 	enumJSON := make([]apiextensionsv1.JSON, 0, len(vals))
 
 	for _, v := range vals {
-		enumVal, err := json.Marshal(v)
-		if err != nil {
-			return nil, fmt.Errorf("failed to marshal enum value: %v", v)
-		}
-		enumJSON = append(enumJSON, apiextensionsv1.JSON{Raw: enumVal})
+		enumJSON = append(enumJSON, *MustMarshal(v))
 	}
 
-	return enumJSON, nil
+	return enumJSON
 }

common/pkg/capi/clustertopology/variables/eums_test.go

@@ -58,8 +58,7 @@ func TestValuesToEnumJSON(t *testing.T) {
 			g := gomega.NewWithT(t)
 
 			// Call the function under test
-			jsonData, err := ValuesToEnumJSON(tt.input...)
-			g.Expect(err).NotTo(gomega.HaveOccurred())
+			jsonData := MustMarshalValuesToEnumJSON(tt.input...)
 
 			// Assert the result
 			g.Expect(jsonData).To(gomega.HaveLen(len(tt.expected)))

common/pkg/capi/clustertopology/variables/json.go

@@ -0,0 +1,20 @@
+// Copyright 2023 D2iQ, Inc. All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+package variables
+
+import (
+	"encoding/json"
+	"fmt"
+
+	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
+)
+
+func MustMarshal(val any) *apiextensionsv1.JSON {
+	marshaled, err := json.Marshal(val)
+	if err != nil {
+		panic(fmt.Errorf("failed to marshal enum value: %w", err))
+	}
+
+	return &apiextensionsv1.JSON{Raw: marshaled}
+}

pkg/handlers/clusterconfig/variables.go renamed to pkg/handlers/generic/clusterconfig/variables.go

@@ -30,7 +30,7 @@ import (
 	"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"
+	"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/generic/lifecycle/cni"
 )
 
 const (