From d5cf667f27927948e52ed4e28dc8970848057e71 Mon Sep 17 00:00:00 2001
From: Rickard von Essen <rickard.von.essen@gmail.com>
Date: Wed, 25 Sep 2024 19:17:50 +0200
Subject: [PATCH] Add paved.GetFloat function

This adds `paved.GetFloat()` function similar to `paved.GetString()` and
`paved.GetInteger()` but returning a `float64`.

Signed-off-by: Rickard von Essen <rickard.von.essen@gmail.com>
---
 pkg/fieldpath/paved.go      | 14 +++++++++
 pkg/fieldpath/paved_test.go | 61 +++++++++++++++++++++++++++++++++++++
 2 files changed, 75 insertions(+)

diff --git a/pkg/fieldpath/paved.go b/pkg/fieldpath/paved.go
index 37fc98371..460cade1f 100644
--- a/pkg/fieldpath/paved.go
+++ b/pkg/fieldpath/paved.go
@@ -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)
diff --git a/pkg/fieldpath/paved_test.go b/pkg/fieldpath/paved_test.go
index 3213ac59a..d303cfe1a 100644
--- a/pkg/fieldpath/paved_test.go
+++ b/pkg/fieldpath/paved_test.go
@@ -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