Skip to content

Commit

Permalink
Add paved.GetFloat function
Browse files Browse the repository at this point in the history
This adds `paved.GetFloat()` function similar to `paved.GetString()` and
`paved.GetInteger()` but returning a `float64`.

Signed-off-by: Rickard von Essen <[email protected]>
  • Loading branch information
rickard-von-essen committed Sep 26, 2024
1 parent 08da772 commit d5cf667
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 0 deletions.
14 changes: 14 additions & 0 deletions pkg/fieldpath/paved.go
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,20 @@ func (p *Paved) GetString(path string) (string, error) {
return s, nil
}

// GetFloat value of the supplied field path.
func (p *Paved) GetFloat(path string) (float64, error) {
v, err := p.GetValue(path)
if err != nil {
return 0, err
}

f, ok := v.(float64)
if !ok {
return 0, errors.Errorf("%s: not a number", path)
}
return f, nil
}

// GetStringArray value of the supplied field path.
func (p *Paved) GetStringArray(path string) ([]string, error) {
v, err := p.GetValue(path)
Expand Down
61 changes: 61 additions & 0 deletions pkg/fieldpath/paved_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -317,6 +317,67 @@ func TestGetString(t *testing.T) {
}
}

func TestGetFloat(t *testing.T) {
type want struct {
value float64
err error
}
cases := map[string]struct {
reason string
path string
data []byte
want want
}{
"Number": {
reason: "It should be possible to get a field a object",
path: "number",
data: []byte(`{"number":12.0}`),
want: want{
value: 12.0,
},
},
"MetadataNumber": {
reason: "It should be possible to get a field from a nested object",
path: "metadata.number",
data: []byte(`{"metadata":{"number":100.1}}`),
want: want{
value: 100.1,
},
},
"MalformedPath": {
reason: "Requesting an invalid field path should fail",
path: "spec[]",
want: want{
err: errors.Wrap(errors.New("unexpected ']' at position 5"), "cannot parse path \"spec[]\""),
},
},
"NotANumber": {
reason: "Requesting an non-number field path should fail",
path: "metadata.name",
data: []byte(`{"metadata":{"name":"foo"}}`),
want: want{
err: errors.New("metadata.name: not a number"),
},
},
}

for name, tc := range cases {
t.Run(name, func(t *testing.T) {
in := make(map[string]any)
_ = json.Unmarshal(tc.data, &in)
p := Pave(in)

got, err := p.GetFloat(tc.path)
if diff := cmp.Diff(tc.want.err, err, test.EquateErrors()); diff != "" {
t.Fatalf("\np.GetFloat(%s): %s: -want error, +got error:\n%s", tc.path, tc.reason, diff)
}
if diff := cmp.Diff(tc.want.value, got); diff != "" {
t.Errorf("\np.GetFloat(%s): %s: -want, +got:\n%s", tc.path, tc.reason, diff)
}
})
}
}

func TestGetStringArray(t *testing.T) {
type want struct {
value []string
Expand Down

0 comments on commit d5cf667

Please sign in to comment.