Skip to content

Add more test coverage for searialization and deserialization #303

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 23, 2025
+251 −3
Merged

Add more test coverage for searialization and deserialization #303

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion fieldpath/serialize-pe_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ limitations under the License.

package fieldpath

import "testing"
import (
"testing"
)

func TestPathElementRoundTrip(t *testing.T) {
tests := []string{
Expand All @@ -25,8 +27,10 @@ func TestPathElementRoundTrip(t *testing.T) {
`f:`,
`f:spec`,
`f:more-complicated-string`,
`f: string-with-spaces `,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't remember, do field-name encodings support any escaping or unescaping we need to exercise? (special characters, newlines, backslashes, non-ascii characters, etc)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think that is allowed for field names, but these values can exists for map keys.

`f:abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789`,
`k:{"name":"my-container"}`,
`k:{"name":" name with spaces "}`,
`k:{"port":"8080","protocol":"TCP"}`,
`k:{"optionalField":null}`,
`k:{"jsonField":{"A":1,"B":null,"C":"D","E":{"F":"G"}}}`,
Expand All @@ -35,6 +39,7 @@ func TestPathElementRoundTrip(t *testing.T) {
`v:"some-string"`,
`v:1234`,
`v:{"some":"json"}`,
`v:{"some":" some with spaces "}`,
`k:{"name":"app-🚀"}`,
`k:{"name":"app-💻"}`,
`k:{"name":"app with-unicøde"}`,
Expand Down Expand Up @@ -79,6 +84,7 @@ func TestDeserializePathElementError(t *testing.T) {
`v:`,
`k:invalid json`,
`k:{"name":invalid}`,
`v:{"some":" \x41"}`, // This is an invalid JSON string because \x41 is not a valid escape sequence.
}

for _, test := range tests {
Expand Down
244 changes: 243 additions & 1 deletion fieldpath/serialize_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ import (
"fmt"
"strings"
"testing"

"github.com/google/go-cmp/cmp"
)

func TestSerializeV1(t *testing.T) {
Expand Down Expand Up @@ -51,7 +53,7 @@ func TestSerializeV1GoldenData(t *testing.T) {
examples := []string{
`{"f:aaa":{},"f:aab":{},"f:aac":{},"f:aad":{},"f:aae":{},"f:aaf":{},"k:{\"name\":\"first\"}":{},"k:{\"name\":\"second\"}":{},"k:{\"port\":443,\"protocol\":\"tcp\"}":{},"k:{\"port\":443,\"protocol\":\"udp\"}":{},"v:1":{},"v:2":{},"v:3":{},"v:\"aa\"":{},"v:\"ab\"":{},"v:true":{},"i:1":{},"i:2":{},"i:3":{},"i:4":{}}`,
`{"f:aaa":{"k:{\"name\":\"second\"}":{"v:3":{"f:aab":{}}},"v:3":{},"v:true":{}},"f:aab":{"f:aaa":{},"f:aaf":{"k:{\"port\":443,\"protocol\":\"udp\"}":{"k:{\"port\":443,\"protocol\":\"tcp\"}":{}}},"k:{\"name\":\"first\"}":{}},"f:aac":{"f:aaa":{"v:1":{}},"f:aac":{},"v:3":{"k:{\"name\":\"second\"}":{}}},"f:aad":{"f:aac":{"v:1":{}},"f:aaf":{"k:{\"name\":\"first\"}":{"k:{\"name\":\"first\"}":{}}},"i:1":{"i:1":{},"i:3":{"v:true":{}}}},"f:aae":{"f:aae":{},"k:{\"port\":443,\"protocol\":\"tcp\"}":{"k:{\"port\":443,\"protocol\":\"udp\"}":{}},"i:4":{"f:aaf":{}}},"f:aaf":{"i:1":{"f:aac":{}},"i:2":{},"i:3":{}},"k:{\"name\":\"first\"}":{"f:aad":{"f:aaf":{}}},"k:{\"port\":443,\"protocol\":\"tcp\"}":{"f:aaa":{"f:aad":{}}},"k:{\"port\":443,\"protocol\":\"udp\"}":{"f:aac":{},"k:{\"name\":\"first\"}":{"i:3":{}},"k:{\"port\":443,\"protocol\":\"udp\"}":{"i:4":{}}},"v:1":{"f:aac":{"i:4":{}},"f:aaf":{},"k:{\"port\":443,\"protocol\":\"tcp\"}":{}},"v:2":{"f:aad":{"f:aaf":{}},"i:1":{}},"v:3":{"f:aaa":{},"k:{\"name\":\"first\"}":{},"i:2":{}},"v:\"aa\"":{"f:aab":{"f:aaf":{}},"f:aae":{},"k:{\"name\":\"first\"}":{"f:aad":{}},"i:2":{}},"v:\"ab\"":{"f:aaf":{"i:4":{}},"k:{\"port\":443,\"protocol\":\"tcp\"}":{},"k:{\"port\":443,\"protocol\":\"udp\"}":{},"v:1":{"k:{\"port\":443,\"protocol\":\"udp\"}":{}},"i:1":{"f:aae":{"i:4":{}}}},"v:true":{"k:{\"name\":\"second\"}":{"f:aaa":{}},"i:2":{"k:{\"port\":443,\"protocol\":\"tcp\"}":{}}},"i:1":{"i:3":{"f:aaf":{}}},"i:2":{"f:aae":{},"k:{\"port\":443,\"protocol\":\"tcp\"}":{"v:1":{}}},"i:3":{"f:aab":{"v:true":{"v:\"aa\"":{}}},"f:aaf":{},"i:1":{}},"i:4":{"v:\"aa\"":{"f:aab":{"k:{\"name\":\"second\"}":{}}}}}`,
`{"f:spec":{".":{},"f:apps":{".":{},"k:{\"name\":\"app-💻\"}":{".":{},"f:container":{".":{},"f:image":{},"f:name":{},"f:ports":{".":{},"k:{\"name\":\"port-🔑\"}":{".":{},"f:containerPort":{},"f:name":{}}}},"f:name":{}},"k:{\"name\":\"app-🚀\"}":{".":{},"f:container":{".":{},"f:image":{},"f:name":{},"f:ports":{".":{},"k:{\"name\":\"port-✅\"}":{".":{},"f:containerPort":{},"f:name":{}}}},"f:name":{}}}}}`,
`{"f:spec":{".":{},"f:apps":{".":{},"k:{\"name\":\" app-💻\"}":{".":{},"f:container":{".":{},"f:image":{},"f:name":{},"f:ports":{".":{},"k:{\"name\":\"port 🔑\"}":{".":{},"f:containerPort":{},"f:name":{}}}},"f:name":{}},"k:{\"name\":\" app-🚀\"}":{".":{},"f:container":{".":{},"f:image":{},"f:name":{},"f:ports":{".":{},"k:{\"name\":\"port-✅ \"}":{".":{},"f:containerPort":{},"f:name":{}}}},"f:name":{}}}}}`,
}
for i, str := range examples {
t.Run(fmt.Sprintf("%v", i), func(t *testing.T) {
Expand All @@ -71,6 +73,246 @@ func TestSerializeV1GoldenData(t *testing.T) {
}
}

func TestDeserializeForValidNonNormalized(t *testing.T) {
testCases := []struct {
nonNormalizedString string
normalizedString string
}{
{
nonNormalizedString: `{
"f:aad": {},
"f:aaa": {},
"f:aab": {},
"f:aac": {},
"f:aae": {},
"f:aaf": {},


"k:{\"name\":\"first\"}": {},
"k:{\"name\":\"second\"}": {},
"k:{\"port\":443,\"protocol\":\"tcp\"}": {},
"k:{ \"protocol\":\"udp\",\"port\":443}": {},
"v:1": {},

"v:2": {},
"v: 3": {},
"v:\"aa\"": {},

"v:\"ab\"": {},
"v:true": {},
"i:1": {},
"i:2": {},
"i:3": {} ,
"i:4": {}
}`,
normalizedString: `{"f:aaa":{},"f:aab":{},"f:aac":{},"f:aad":{},"f:aae":{},"f:aaf":{},"k:{\"name\":\"first\"}":{},"k:{\"name\":\"second\"}":{},"k:{\"port\":443,\"protocol\":\"tcp\"}":{},"k:{\"port\":443,\"protocol\":\"udp\"}":{},"v:1":{},"v:2":{},"v:3":{},"v:\"aa\"":{},"v:\"ab\"":{},"v:true":{},"i:1":{},"i:2":{},"i:3":{},"i:4":{}}`,
}, {
nonNormalizedString: `{
"f:aaa": {
"k:{\"name\":\"second\"}": {
"v:3": {
"f:aab": {}
}
},
"v:3": {},
"v:true": {}
},
"f:aab": {
"f:aaa": {},
"f:aaf": {
"k:{\"port\":443,\"protocol\":\"udp\"}": {
"k:{\"port\":443,\"protocol\":\"tcp\"}": {}
}
},
"k:{\"name\":\"first\"}": {}
},
"f:aac": {
"f:aaa": {
"v:1": {}
},
"f:aac": {},
"v:3": {
"k:{\"name\":\"second\"}": {}
}
},
"f:aad": {
"f:aac": {
"v:1": {}
},
"f:aaf": {
"k:{\"name\":\"first\"}": {
"k:{\"name\":\"first\"}": {}
}
},
"i:1": {
"i:1": {},
"i:3": {
"v:true": {}
}
}
},
"f:aae": {
"f:aae": {},
"k:{\"port\":443,\"protocol\":\"tcp\"}": {
"k:{\"port\":443,\"protocol\":\"udp\"}": {}
},
"i:4": {
"f:aaf": {}
}
},
"f:aaf": {
"i:1": {
"f:aac": {}
},
"i:3": {},
"i:2": {}
},
"k:{\"name\":\"first\"}": {
"f:aad": {
"f:aaf": {}
}
},
"k:{\"port\":443,\"protocol\":\"tcp\"}": {
"f:aaa": {
"f:aad": {}
}
},
"k:{\"port\":443,\"protocol\":\"udp\"}": {
"f:aac": {},
"k:{\"name\":\"first\"}": {
"i:3": {}
},
"k:{\"port\":443,\"protocol\":\"udp\"}": {
"i:4": {}
}
},
"v:2": {
"f:aad": {
"f:aaf": {}
},
"i:1": {}
},
"v:1": {
"f:aac": {
"i:4": {}
},
"f:aaf": {},
"k:{\"port\":443,\"protocol\":\"tcp\"}": {}
},
"v:3": {
"f:aaa": {},
"k:{\"name\":\"first\"}": {},
"i:2": {}
},
"v:\"aa\"": {
"f:aab": {
"f:aaf": {}
},
"f:aae": {},
"k:{\"name\":\"first\"}": {
"f:aad": {}
},
"i:2": {}
},
"v:\"ab\"": {
"f:aaf": {
"i:4": {}
},
"k:{\"port\":443,\"protocol\":\"tcp\"}": {},
"k:{\"port\":443,\"protocol\":\"udp\"}": {},
"v:1": {
"k:{\"port\":443,\"protocol\":\"udp\"}": {}
},
"i:1": {
"f:aae": {
"i:4": {}
}
}
},

"v:true": {
"k:{\"name\":\"second\"}": {
"f:aaa": {}
},
"i:2": {
"k:{\"port\":443,\"protocol\":\"tcp\"}": {}
}
},


"i:1": {
"i:3": {
"f:aaf": {}
}
},

"i:3": {
"f:aab": {
"v:true": {
"v:\"aa\"": {}
}
},
"f:aaf": {},
"i:1": {}
},

"i:2": {
"f:aae": {},
"k:{\"port\":443,\"protocol\":\"tcp\"}": {
"v:1": {}
}
},

"i:4": {
"v:\"aa\"": {
"f:aab": {
"k:{\"name\":\"second\"}": {}
}
}
}
}`,
normalizedString: `{"f:aaa":{"k:{\"name\":\"second\"}":{"v:3":{"f:aab":{}}},"v:3":{},"v:true":{}},"f:aab":{"f:aaa":{},"f:aaf":{"k:{\"port\":443,\"protocol\":\"udp\"}":{"k:{\"port\":443,\"protocol\":\"tcp\"}":{}}},"k:{\"name\":\"first\"}":{}},"f:aac":{"f:aaa":{"v:1":{}},"f:aac":{},"v:3":{"k:{\"name\":\"second\"}":{}}},"f:aad":{"f:aac":{"v:1":{}},"f:aaf":{"k:{\"name\":\"first\"}":{"k:{\"name\":\"first\"}":{}}},"i:1":{"i:1":{},"i:3":{"v:true":{}}}},"f:aae":{"f:aae":{},"k:{\"port\":443,\"protocol\":\"tcp\"}":{"k:{\"port\":443,\"protocol\":\"udp\"}":{}},"i:4":{"f:aaf":{}}},"f:aaf":{"i:1":{"f:aac":{}},"i:2":{},"i:3":{}},"k:{\"name\":\"first\"}":{"f:aad":{"f:aaf":{}}},"k:{\"port\":443,\"protocol\":\"tcp\"}":{"f:aaa":{"f:aad":{}}},"k:{\"port\":443,\"protocol\":\"udp\"}":{"f:aac":{},"k:{\"name\":\"first\"}":{"i:3":{}},"k:{\"port\":443,\"protocol\":\"udp\"}":{"i:4":{}}},"v:1":{"f:aac":{"i:4":{}},"f:aaf":{},"k:{\"port\":443,\"protocol\":\"tcp\"}":{}},"v:2":{"f:aad":{"f:aaf":{}},"i:1":{}},"v:3":{"f:aaa":{},"k:{\"name\":\"first\"}":{},"i:2":{}},"v:\"aa\"":{"f:aab":{"f:aaf":{}},"f:aae":{},"k:{\"name\":\"first\"}":{"f:aad":{}},"i:2":{}},"v:\"ab\"":{"f:aaf":{"i:4":{}},"k:{\"port\":443,\"protocol\":\"tcp\"}":{},"k:{\"port\":443,\"protocol\":\"udp\"}":{},"v:1":{"k:{\"port\":443,\"protocol\":\"udp\"}":{}},"i:1":{"f:aae":{"i:4":{}}}},"v:true":{"k:{\"name\":\"second\"}":{"f:aaa":{}},"i:2":{"k:{\"port\":443,\"protocol\":\"tcp\"}":{}}},"i:1":{"i:3":{"f:aaf":{}}},"i:2":{"f:aae":{},"k:{\"port\":443,\"protocol\":\"tcp\"}":{"v:1":{}}},"i:3":{"f:aab":{"v:true":{"v:\"aa\"":{}}},"f:aaf":{},"i:1":{}},"i:4":{"v:\"aa\"":{"f:aab":{"k:{\"name\":\"second\"}":{}}}}}`,
},
}

for i, tc := range testCases {
t.Run(fmt.Sprintf("%v", i), func(t *testing.T) {
nonNormSet := NewSet()
err := nonNormSet.FromJSON(strings.NewReader(tc.nonNormalizedString))
if err != nil {
t.Fatalf("Failed to deserialize non normalized string %s : %v\n%#v", tc.nonNormalizedString, err, nonNormSet)
}

normSet := NewSet()
err = normSet.FromJSON(strings.NewReader(tc.normalizedString))
if err != nil {
t.Fatalf("Failed to deserialize non normalized string %s : %v\n%#v", tc.normalizedString, err, normSet)
}

nonNormSetJson, err := nonNormSet.ToJSON()
if err != nil {
t.Fatalf("Failed to serialize non-normalized set: %v\n%#v", err, nonNormSet)

}

normSetJson, err := normSet.ToJSON()
if err != nil {
t.Fatalf("Failed to serialize normalized set: %v\n%#v", err, normSet)

}

if diff := cmp.Diff(nonNormSetJson, normSetJson); diff != "" {
t.Errorf("diff should be non empty, diff %s", diff)
}

// this should exceeds if the diff was "".
if !normSet.Equals(nonNormSet) {
t.Errorf("expected both set to be equal.")
}

})
}
}
func TestDropUnknown(t *testing.T) {
input := `{"f:aaa":{},"r:aab":{}}`
expect := `{"f:aaa":{}}`
Expand Down
2 changes: 1 addition & 1 deletion fieldpath/set_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ var randomPathMaker = randomPathAlphabet(MakePathOrDie(
KeyByFields("name", "second"),
KeyByFields("port", 443, "protocol", "tcp"),
KeyByFields("port", 443, "protocol", "udp"),
KeyByFields("key", "value"),
KeyByFields("key", " value with spaces "),
KeyByFields("lang", "en-US"),
KeyByFields("unicode-key", "unicode-value-🔥"),
// Values
Expand Down