diff --git a/pkg/data/values.go b/pkg/data/values.go index 1942ec24..2cd49e83 100644 --- a/pkg/data/values.go +++ b/pkg/data/values.go @@ -1,9 +1,14 @@ +// Package data contains functions for working with unstructured values like interfaces or map[string]interface{} +// allows reading/writing to these values without having to convert to structured items. package data import ( "strconv" ) +// RemoveValue removes a value from data. Keys should be in order of precedence (i.e. "metadata", "annotations") means +// remove the "annotations" key from the "metadata" sub-map. Returns the removed value (if any) and a bool indicating +// if the value was found. func RemoveValue(data map[string]interface{}, keys ...string) (interface{}, bool) { for i, key := range keys { if i == len(keys)-1 { @@ -22,6 +27,9 @@ func GetValueN(data map[string]interface{}, keys ...string) interface{} { return val } +// GetValue gets a value from the provided data field, which must be a map[string]interface or a []interface. Keys can +// be the string keys (in order of precedence) or can be the index (as a string) of the item to be retrieved. Returns +// the retrieved value (if any) and a bool indicating if they value was found. func GetValue(data interface{}, keys ...string) (interface{}, bool) { for i, key := range keys { if i == len(keys)-1 { @@ -54,6 +62,8 @@ func itemByIndex(dataSlice []interface{}, key string) (interface{}, bool) { return dataSlice[keyInt], true } +// PutValue puts val into data (in place) at the index specified by keys (specified in order of precedence). If there +// is no current entry at a key, a new map is created for that value. func PutValue(data map[string]interface{}, val interface{}, keys ...string) { if data == nil { return diff --git a/pkg/data/values_test.go b/pkg/data/values_test.go index 6b01f6b7..10c1f8f9 100644 --- a/pkg/data/values_test.go +++ b/pkg/data/values_test.go @@ -82,7 +82,7 @@ func TestGetValue(t *testing.T) { wantSuccess: true, }, { - name: "get index of top levelslice", + name: "get index of top level slice", data: []interface{}{ "alice", "bob", @@ -92,6 +92,26 @@ func TestGetValue(t *testing.T) { wantValue: "eve", wantSuccess: true, }, + { + name: "slice of maps", + data: []interface{}{ + map[string]interface{}{ + "notthisone": "val", + }, + map[string]interface{}{ + "parent": map[string]interface{}{ + "children": []interface{}{ + "alice", + "bob", + "eve", + }, + }, + }, + }, + keys: []string{"1", "parent", "children", "0"}, + wantValue: "alice", + wantSuccess: true, + }, { name: "index is too big", data: map[string]interface{}{ @@ -122,6 +142,21 @@ func TestGetValue(t *testing.T) { wantValue: nil, wantSuccess: false, }, + { + name: "index not parseable to int", + data: map[string]interface{}{ + "parent": map[string]interface{}{ + "children": []interface{}{ + "alice", + "bob", + "eve", + }, + }, + }, + keys: []string{"parent", "children", "notanint"}, + wantValue: nil, + wantSuccess: false, + }, } for _, test := range tests { test := test