Skip to content
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

Improve sjson package fuzzing #3071

Merged
merged 5 commits into from
Jul 19, 2023
Merged

Improve sjson package fuzzing #3071

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
06b4ad4
improve sjson package fuzzing
quasilyte Jul 18, 2023
ca2a381
Merge branch 'main' into quasilyte/improve_sjson_fuzzing
quasilyte Jul 18, 2023
4886d1a
apply linter suggestions
quasilyte Jul 18, 2023
ca5a8b2
follow the review comments
quasilyte Jul 19, 2023
bb89b5b
Merge branch 'main' into quasilyte/improve_sjson_fuzzing
mergify[bot] Jul 19, 2023
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: 5 additions & 3 deletions Taskfile.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,13 +263,15 @@ tasks:
- go test -count=0 ./...

fuzz:
desc: "Fuzz for about 2 minutes (with default FUZZ_TIME)"
desc: "Fuzz for about 3 minutes (with default FUZZ_TIME)"
cmds:
- go test -list='Fuzz.*' ./...
- go test -run=XXX -fuzz=FuzzArrayWithFixedSchemas -fuzztime={{.FUZZ_TIME}} ./internal/handlers/sjson/
- go test -run=XXX -fuzz=FuzzArrayWithFixedDocuments -fuzztime={{.FUZZ_TIME}} ./internal/handlers/sjson/
- go test -run=XXX -fuzz=FuzzDocumentWithFixedSchemas -fuzztime={{.FUZZ_TIME}} ./internal/handlers/sjson/
- go test -run=XXX -fuzz=FuzzDocumentWithFixedDocuments -fuzztime={{.FUZZ_TIME}} ./internal/handlers/sjson/
Copy link
Member

Choose a reason for hiding this comment

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

They were sorted alphabetically, please move them back

- go test -run=XXX -fuzz=FuzzArray -fuzztime={{.FUZZ_TIME}} ./internal/bson/
- go test -run=XXX -fuzz=FuzzDocument -fuzztime={{.FUZZ_TIME}} ./internal/bson/
- go test -run=XXX -fuzz=FuzzArray -fuzztime={{.FUZZ_TIME}} ./internal/handlers/sjson/
- go test -run=XXX -fuzz=FuzzDocument -fuzztime={{.FUZZ_TIME}} ./internal/handlers/sjson/
- go test -run=XXX -fuzz=FuzzMsg -fuzztime={{.FUZZ_TIME}} ./internal/wire/
- go test -run=XXX -fuzz=FuzzQuery -fuzztime={{.FUZZ_TIME}} ./internal/wire/
- go test -run=XXX -fuzz=FuzzReply -fuzztime={{.FUZZ_TIME}} ./internal/wire/
Expand Down
65 changes: 63 additions & 2 deletions internal/handlers/sjson/array_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,63 @@ var arrayTestCases = []testCase{
},
},
j: `[[],"Qg==",true,1627378542123,{},42.13,42,42,"foo",null]`,
}, {
// Unlike "array_all" case, this one passes the Fuzz checks successfully.
// Most notably, it doesn't have a nested array that is rejected by the data validation.
name: "array_without_nested",
v: convertArray(must.NotFail(types.NewArray(
"",
false,
must.NotFail(types.NewDocument("key", "value")),
-32589.300000101,
int32(349),
int64(-21424182),
types.Null,
"a string that is somewhat longer",
))),
sch: &elem{
Type: elemTypeArray,
Items: []*elem{
stringSchema,
boolSchema,
{
Type: elemTypeObject,
Schema: &schema{
Properties: map[string]*elem{
"key": stringSchema,
},
Keys: []string{"key"},
},
},
doubleSchema,
intSchema,
longSchema,
nullSchema,
stringSchema,
},
},
j: `["",false,{"key":"value"},-32589.300000101,349,-21424182,null,"a string that is somewhat longer"]`,
}, {
name: "schema_null_error",
v: convertArray(must.NotFail(types.NewArray("a"))),
sch: &elem{
Type: elemTypeArray,
Items: []*elem{nullSchema},
},
j: `["a"]`,
jErr: `sjson.unmarshalSingleValue: expected null, got "a"`,
}, {
name: "array10",
v: convertArray(must.NotFail(types.NewArray(0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0))),
sch: &elem{
Type: elemTypeArray,
Items: []*elem{
doubleSchema, doubleSchema, doubleSchema, doubleSchema, doubleSchema,
doubleSchema, doubleSchema, doubleSchema, doubleSchema, doubleSchema,
},
},
j: `[0,1.0,2,3.0,4.0,5.0,6,7,8,9]`,
canonJ: `[0,1,2,3,4,5,6,7,8,9]`,
}, {
name: "EOF",
sch: &elem{Type: elemTypeArray, Items: []*elem{}},
Expand Down Expand Up @@ -86,8 +143,12 @@ func TestArray(t *testing.T) {
testJSON(t, arrayTestCases, func() sjsontype { return new(arrayType) })
}

func FuzzArray(f *testing.F) {
fuzzJSON(f, arrayTestCases, func() sjsontype { return new(arrayType) })
func FuzzArrayWithFixedSchemas(f *testing.F) {
fuzzJSONWithFixedSchemas(f, arrayTestCases, func() sjsontype { return new(arrayType) })
}

func FuzzArrayWithFixedDocuments(f *testing.F) {
fuzzJSONWithFixedDocuments(f, arrayTestCases, func() sjsontype { return new(arrayType) })
}

func BenchmarkArray(b *testing.B) {
Expand Down
8 changes: 6 additions & 2 deletions internal/handlers/sjson/binary_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,12 @@ func TestBinary(t *testing.T) {
testJSON(t, binaryTestCases, func() sjsontype { return new(binaryType) })
}

func FuzzBinary(f *testing.F) {
fuzzJSON(f, binaryTestCases, func() sjsontype { return new(binaryType) })
func FuzzBinaryWithFixedSchemas(f *testing.F) {
fuzzJSONWithFixedSchemas(f, binaryTestCases, func() sjsontype { return new(binaryType) })
}

func FuzzBinaryWithFixedDocuments(f *testing.F) {
fuzzJSONWithFixedDocuments(f, binaryTestCases, func() sjsontype { return new(binaryType) })
}

func BenchmarkBinary(b *testing.B) {
Expand Down
8 changes: 6 additions & 2 deletions internal/handlers/sjson/bool_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,12 @@ func TestBool(t *testing.T) {
testJSON(t, boolTestCases, func() sjsontype { return new(boolType) })
}

func FuzzBool(f *testing.F) {
fuzzJSON(f, boolTestCases, func() sjsontype { return new(boolType) })
func FuzzBoolWithFixedSchemas(f *testing.F) {
fuzzJSONWithFixedSchemas(f, boolTestCases, func() sjsontype { return new(boolType) })
}

func FuzzBoolWithFixedDocuments(f *testing.F) {
fuzzJSONWithFixedDocuments(f, boolTestCases, func() sjsontype { return new(boolType) })
}

func BenchmarkBool(b *testing.B) {
Expand Down
8 changes: 6 additions & 2 deletions internal/handlers/sjson/datetime_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,12 @@ func TestDateTime(t *testing.T) {
testJSON(t, dateTimeTestCases, func() sjsontype { return new(dateTimeType) })
}

func FuzzDateTime(f *testing.F) {
fuzzJSON(f, dateTimeTestCases, func() sjsontype { return new(dateTimeType) })
func FuzzDateTimeWithFixedSchemas(f *testing.F) {
fuzzJSONWithFixedSchemas(f, dateTimeTestCases, func() sjsontype { return new(dateTimeType) })
}

func FuzzDateTimeWithFixedDocuments(f *testing.F) {
fuzzJSONWithFixedDocuments(f, dateTimeTestCases, func() sjsontype { return new(dateTimeType) })
}

func BenchmarkDateTime(b *testing.B) {
Expand Down
8 changes: 6 additions & 2 deletions internal/handlers/sjson/document_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -464,8 +464,12 @@ func TestDocument(t *testing.T) {
testJSON(t, documentTestCases, func() sjsontype { return new(documentType) })
}

func FuzzDocument(f *testing.F) {
fuzzJSON(f, documentTestCases, func() sjsontype { return new(documentType) })
func FuzzDocumentWithFixedSchemas(f *testing.F) {
fuzzJSONWithFixedSchemas(f, documentTestCases, func() sjsontype { return new(documentType) })
}

func FuzzDocumentWithFixedDocuments(f *testing.F) {
fuzzJSONWithFixedDocuments(f, documentTestCases, func() sjsontype { return new(documentType) })
}

func BenchmarkDocument(b *testing.B) {
Expand Down
8 changes: 6 additions & 2 deletions internal/handlers/sjson/double_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,12 @@ func TestDouble(t *testing.T) {
testJSON(t, doubleTestCases, func() sjsontype { return new(doubleType) })
}

func FuzzDouble(f *testing.F) {
fuzzJSON(f, doubleTestCases, func() sjsontype { return new(doubleType) })
func FuzzDoubleWithFixedSchemas(f *testing.F) {
fuzzJSONWithFixedSchemas(f, doubleTestCases, func() sjsontype { return new(doubleType) })
}

func FuzzDoubleWithFixedDocuments(f *testing.F) {
fuzzJSONWithFixedDocuments(f, doubleTestCases, func() sjsontype { return new(doubleType) })
}

func BenchmarkDouble(b *testing.B) {
Expand Down
8 changes: 6 additions & 2 deletions internal/handlers/sjson/int32_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,12 @@ func TestInt32(t *testing.T) {
testJSON(t, int32TestCases, func() sjsontype { return new(int32Type) })
}

func FuzzInt32(f *testing.F) {
fuzzJSON(f, int32TestCases, func() sjsontype { return new(int32Type) })
func FuzzInt32WithFixedSchemas(f *testing.F) {
fuzzJSONWithFixedSchemas(f, int32TestCases, func() sjsontype { return new(int32Type) })
}

func FuzzInt32WithFixedDocuments(f *testing.F) {
fuzzJSONWithFixedDocuments(f, int32TestCases, func() sjsontype { return new(int32Type) })
}

func BenchmarkInt32(b *testing.B) {
Expand Down
8 changes: 6 additions & 2 deletions internal/handlers/sjson/int64_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,12 @@ func TestInt64(t *testing.T) {
testJSON(t, int64TestCases, func() sjsontype { return new(int64Type) })
}

func FuzzInt64(f *testing.F) {
fuzzJSON(f, int64TestCases, func() sjsontype { return new(int64Type) })
func FuzzInt64WithFixedSchemas(f *testing.F) {
fuzzJSONWithFixedSchemas(f, int64TestCases, func() sjsontype { return new(int64Type) })
}

func FuzzInt64WithFixedDocuments(f *testing.F) {
fuzzJSONWithFixedDocuments(f, int64TestCases, func() sjsontype { return new(int64Type) })
}

func BenchmarkInt64(b *testing.B) {
Expand Down
8 changes: 6 additions & 2 deletions internal/handlers/sjson/object_id_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,12 @@ func TestObjectID(t *testing.T) {
testJSON(t, objectIDTestCases, func() sjsontype { return new(objectIDType) })
}

func FuzzObjectID(f *testing.F) {
fuzzJSON(f, objectIDTestCases, func() sjsontype { return new(objectIDType) })
func FuzzObjectIDWithFixedSchemas(f *testing.F) {
fuzzJSONWithFixedSchemas(f, objectIDTestCases, func() sjsontype { return new(objectIDType) })
}

func FuzzObjectIDWithFixedDocuments(f *testing.F) {
fuzzJSONWithFixedDocuments(f, objectIDTestCases, func() sjsontype { return new(objectIDType) })
}

func BenchmarkObjectID(b *testing.B) {
Expand Down
8 changes: 6 additions & 2 deletions internal/handlers/sjson/regex_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,12 @@ func TestRegex(t *testing.T) {
testJSON(t, regexTestCases, func() sjsontype { return new(regexType) })
}

func FuzzRegex(f *testing.F) {
fuzzJSON(f, regexTestCases, func() sjsontype { return new(regexType) })
func FuzzRegexWithFixedSchemas(f *testing.F) {
fuzzJSONWithFixedSchemas(f, regexTestCases, func() sjsontype { return new(regexType) })
}

func FuzzRegexWithFixedDocuments(f *testing.F) {
fuzzJSONWithFixedDocuments(f, regexTestCases, func() sjsontype { return new(regexType) })
}

func BenchmarkRegex(b *testing.B) {
Expand Down
2 changes: 1 addition & 1 deletion internal/handlers/sjson/sjson.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,7 @@ func unmarshalSingleValue(data json.RawMessage, sch *elem) (any, error) {
err = d.UnmarshalJSON(data)
res = &d
case elemTypeNull:
panic(fmt.Sprintf("must not be called, was called with %s", string(data)))
return nil, lazyerrors.Errorf("sjson.unmarshalSingleValue: expected null, got %s", data)
case elemTypeRegex:
var r regexType
err = r.UnmarshalJSONWithSchema(data, sch)
Expand Down
Loading