commit | 5dfa3b7056d4abdb26b76c43d012ebe151e8a33c | [log] [tgz] |
---|---|---|
author | Disconnect3d <dominik.b.czarnota@gmail.com> | Tue Oct 18 18:10:03 2022 |
committer | GitHub <noreply@github.com> | Tue Oct 18 18:10:03 2022 |
tree | 36d2e9755c41b28f788f792639f5250ca54251ea | |
parent | ea42da0d2a305939302870bc797428e836ef138a [diff] |
Update README.md (#54)
gofuzz is a library for populating go objects with random values.
This is useful for testing:
Import with import "github.com/google/gofuzz"
You can use it on single variables:
f := fuzz.New() var myInt int f.Fuzz(&myInt) // myInt gets a random value.
You can use it on maps:
f := fuzz.New().NilChance(0).NumElements(1, 1) var myMap map[ComplexKeyType]string f.Fuzz(&myMap) // myMap will have exactly one element.
Customize the chance of getting a nil pointer:
f := fuzz.New().NilChance(.5) var fancyStruct struct { A, B, C, D *string } f.Fuzz(&fancyStruct) // About half the pointers should be set.
You can even customize the randomization completely if needed:
type MyEnum string const ( A MyEnum = "A" B MyEnum = "B" ) type MyInfo struct { Type MyEnum AInfo *string BInfo *string } f := fuzz.New().NilChance(0).Funcs( func(e *MyInfo, c fuzz.Continue) { switch c.Intn(2) { case 0: e.Type = A c.Fuzz(&e.AInfo) case 1: e.Type = B c.Fuzz(&e.BInfo) } }, ) var myObject MyInfo f.Fuzz(&myObject) // Type will correspond to whether A or B info is set.
See more examples in example_test.go
.
You can use this library for easier go-fuzzing. go-fuzz provides the user a byte-slice, which should be converted to different inputs for the tested function. This library can help convert the byte slice. Consider for example a fuzz test for a the function mypackage.MyFunc
that takes an int arguments:
// +build gofuzz package mypackage import fuzz "github.com/google/gofuzz" func Fuzz(data []byte) int { var i int fuzz.NewFromGoFuzz(data).Fuzz(&i) MyFunc(i) return 0 }
Happy testing!