Add more helper functions in topologymutation variables.go

kubernetes-sigs · Nov 3, 2023 · d263ca5 · d263ca5
1 parent 8bef2f3
commit d263ca5
Show file tree

Hide file tree

Showing 2 changed files with 192 additions and 1 deletion.
diff --git a/exp/runtime/topologymutation/variables.go b/exp/runtime/topologymutation/variables.go
@@ -17,8 +17,11 @@ limitations under the License.
 package topologymutation
 
 import (
+	"encoding/json"
 	"strconv"
+	"strings"
 
+	"github.com/pkg/errors"
 	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 
 	patchvariables "sigs.k8s.io/cluster-api/internal/controllers/topology/cluster/patches/variables"
@@ -53,3 +56,45 @@ func GetStringVariable(templateVariables map[string]apiextensionsv1.JSON, variab
 	}
 	return stringValue, true, nil
 }
+
+// GetBoolVariable get the value as a bool.
+func GetBoolVariable(templateVariables map[string]apiextensionsv1.JSON, variableName string) (bool, bool, error) {
+	value, found, err := GetVariable(templateVariables, variableName)
+	if !found || err != nil {
+		return false, found, err
+	}
+
+	// Unquote the JSON string.
+	stringValue, err := strconv.Unquote(string(value.Raw))
+	if err != nil {
+		return false, true, err
+	}
+	// Parse the JSON bool.
+	boolValue, err := strconv.ParseBool(stringValue)
+	if err != nil {
+		return false, true, err
+	}
+	return boolValue, true, nil
+}
+
+// GetVariableObject returns unmarshaled object with type passed in v interface{}
+func GetVariableObject(templateVariables map[string]apiextensionsv1.JSON, variableName string, v interface{}) (bool, error) {
+	value, found, err := GetVariable(templateVariables, variableName)
+	if err != nil {
+		return false, err
+	}
+	if !found {
+		return false, nil
+	}
+
+	if err := json.Unmarshal(sanitizeJson(value.Raw), v); err != nil {
+		return false, errors.Wrapf(err, "failed to unmarshal variable json %q into %q", string(value.Raw), v)
+	}
+
+	return true, nil
+}
+
+func sanitizeJson(input []byte) (output []byte) {
+	output = []byte(strings.ReplaceAll(string(input), "\\", ""))
+	return output
+}
diff --git a/exp/runtime/topologymutation/variables_test.go b/exp/runtime/topologymutation/variables_test.go
@@ -21,6 +21,7 @@ import (
 
 	. "github.com/onsi/gomega"
 	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
+	"k8s.io/utils/pointer"
 )
 
 func Test_GetRawTemplateVariable(t *testing.T) {
@@ -106,7 +107,7 @@ func Test_GetStringTemplateVariable(t *testing.T) {
 			expectedErr:   false,
 		},
 		{
-			name: "variable not found",
+			name: "valid variable",
 			variables: map[string]apiextensionsv1.JSON{
 				"a": varA,
 			},
@@ -130,3 +131,148 @@ func Test_GetStringTemplateVariable(t *testing.T) {
 		})
 	}
 }
+
+func Test_GetBoolVariable(t *testing.T) {
+	g := NewWithT(t)
+
+	varA := apiextensionsv1.JSON{Raw: toJSON("true")}
+	tests := []struct {
+		name          string
+		variables     map[string]apiextensionsv1.JSON
+		variableName  string
+		expectedValue bool
+		expectedFound bool
+		expectedErr   bool
+	}{
+		{
+			name:          "Fails for invalid variable reference",
+			variables:     nil,
+			variableName:  "invalid[",
+			expectedValue: false,
+			expectedFound: false,
+			expectedErr:   true,
+		},
+		{
+			name:          "variable not found",
+			variables:     nil,
+			variableName:  "notEsists",
+			expectedValue: false,
+			expectedFound: false,
+			expectedErr:   false,
+		},
+		{
+			name: "valid variable",
+			variables: map[string]apiextensionsv1.JSON{
+				"a": varA,
+			},
+			variableName:  "a",
+			expectedValue: true,
+			expectedFound: true,
+			expectedErr:   false,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			value, found, err := GetBoolVariable(tt.variables, tt.variableName)
+			if tt.expectedErr {
+				g.Expect(err).To(HaveOccurred())
+			} else {
+				g.Expect(err).ToNot(HaveOccurred())
+			}
+			g.Expect(value).To(Equal(tt.expectedValue))
+			g.Expect(found).To(Equal(tt.expectedFound))
+
+		})
+	}
+}
+
+func Test_GetVariableObjectWithNestedType(t *testing.T) {
+	type AddressesFromPool struct {
+		ApiGroup string `json:"apiGroup"`
+		Kind     string `json:"kind"`
+		Name     string `json:"name"`
+	}
+	type Network struct {
+		AddressesFromPools *[]AddressesFromPool `json:"addressesFromPools,omitempty"`
+		Ipv6Primary        *bool                `json:"ipv6Primary,omitempty"`
+	}
+
+	g := NewWithT(t)
+
+	tests := []struct {
+		name                    string
+		variables               map[string]apiextensionsv1.JSON
+		variableName            string
+		expectedValue           bool
+		expectedFound           bool
+		expectedErr             bool
+		object                  Network
+		expepctedVariableObject interface{}
+	}{
+		{
+			name:                    "Fails for invalid variable reference",
+			variables:               nil,
+			variableName:            "invalid[",
+			expectedValue:           false,
+			expectedFound:           false,
+			object:                  Network{},
+			expepctedVariableObject: Network{},
+			expectedErr:             true,
+		},
+		{
+			name:                    "variable not found",
+			variables:               nil,
+			variableName:            "notEsists",
+			expectedValue:           false,
+			expectedFound:           false,
+			object:                  Network{},
+			expepctedVariableObject: Network{},
+			expectedErr:             false,
+		},
+		{
+			name: "unmarshal error",
+			variables: map[string]apiextensionsv1.JSON{
+				"node":    {Raw: []byte(`{"name": "aadfasdfasd`)},
+				"network": {Raw: []byte(`{"ipv6Primary": true, "addressesFromPools":[{"name":"name"}]asdfasdf`)},
+			},
+			variableName:            "network",
+			expectedValue:           false,
+			expectedFound:           false,
+			object:                  Network{},
+			expepctedVariableObject: Network{},
+			expectedErr:             true,
+		},
+		{
+			name: "valid variable",
+			variables: map[string]apiextensionsv1.JSON{
+				"node":    {Raw: []byte(`{"name": "a"}`)},
+				"network": {Raw: []byte(`{"ipv6Primary": true, "addressesFromPools":[{"name":"name"}]}`)},
+			},
+			variableName:  "network",
+			expectedValue: true,
+			expectedFound: true,
+			expectedErr:   false,
+			object:        Network{},
+			expepctedVariableObject: Network{
+				Ipv6Primary: pointer.Bool(true),
+				AddressesFromPools: &[]AddressesFromPool{
+					{
+						Name: "name",
+					},
+				},
+			},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			found, err := GetVariableObject(tt.variables, tt.variableName, &tt.object)
+			if tt.expectedErr {
+				g.Expect(err).To(HaveOccurred())
+			} else {
+				g.Expect(err).ToNot(HaveOccurred())
+			}
+			g.Expect(tt.object).To(Equal(tt.expepctedVariableObject))
+			g.Expect(found).To(Equal(tt.expectedFound))
+		})
+	}
+}