-
Notifications
You must be signed in to change notification settings - Fork 19
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.
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
Add Fuzz Testing for WKT parsing #366
Draft
peterstace
wants to merge
1
commit into
master
Choose a base branch
from
fuzz_hack
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
testdata |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
// +build gofuzzbeta | ||
|
||
package geom_test | ||
|
||
import ( | ||
"strings" | ||
"testing" | ||
"time" | ||
|
||
"github.com/peterstace/simplefeatures/geom" | ||
"github.com/peterstace/simplefeatures/internal/extract" | ||
) | ||
|
||
func FuzzParseUnmarshalWKT(f *testing.F) { | ||
corpus, err := extract.StringsFromSource("..") | ||
if err != nil { | ||
f.Fatalf("could not build corpus: %v", err) | ||
} | ||
for _, str := range corpus { | ||
if allowInCorpus(str) { | ||
f.Add(str) | ||
f.Log(str) | ||
} | ||
} | ||
|
||
f.Fuzz(func(t *testing.T, wkt string) { | ||
done := make(chan struct{}) | ||
go func() { | ||
geom.UnmarshalWKT(wkt, geom.DisableAllValidations) | ||
close(done) | ||
}() | ||
select { | ||
case <-done: | ||
// do nothing | ||
case <-time.After(100 * time.Millisecond): | ||
t.Fatal("timed out") | ||
} | ||
}) | ||
} | ||
|
||
func allowInCorpus(s string) bool { | ||
for _, prefix := range []string{ | ||
"POINT", | ||
"MULTIPOINT", | ||
"LINESTRING", | ||
"MULTILINESTRING", | ||
"POLYGON", | ||
"MULTIPOLYGON", | ||
"GEOMETRYCOLLECTION", | ||
} { | ||
if strings.HasPrefix(s, prefix) { | ||
return true | ||
} | ||
} | ||
return false | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
package extract | ||
|
||
import ( | ||
"fmt" | ||
"go/ast" | ||
"go/parser" | ||
"go/token" | ||
"os" | ||
"path/filepath" | ||
"sort" | ||
"strconv" | ||
"strings" | ||
) | ||
|
||
// StringsFromSource parses the Go files (recursively) contained in the given | ||
// dir, and returns any string literals contained therein. | ||
func StringsFromSource(dir string) ([]string, error) { | ||
var strs []string | ||
if err := filepath.Walk(dir, func(path string, info os.FileInfo, err error) error { | ||
if err != nil { | ||
return err | ||
} | ||
if !info.IsDir() || strings.Contains(path, ".git") { | ||
return nil | ||
} | ||
pkgs, err := parser.ParseDir(new(token.FileSet), path, nil, 0) | ||
if err != nil { | ||
return err | ||
} | ||
for _, pkg := range pkgs { | ||
ast.Inspect(pkg, func(n ast.Node) bool { | ||
lit, ok := n.(*ast.BasicLit) | ||
if !ok || lit.Kind != token.STRING { | ||
return true | ||
} | ||
unquoted, err := strconv.Unquote(lit.Value) | ||
if !ok { | ||
// Shouldn't ever happen because we've validated that it's a string literal. | ||
panic(fmt.Sprintf("could not unquote string '%s' from AST: %v", lit.Value, err)) | ||
} | ||
strs = append(strs, unquoted) | ||
return true | ||
}) | ||
} | ||
return nil | ||
}); err != nil { | ||
return nil, err | ||
} | ||
|
||
strSet := map[string]struct{}{} | ||
for _, s := range strs { | ||
strSet[strings.TrimSpace(s)] = struct{}{} | ||
} | ||
strs = strs[:0] | ||
for s := range strSet { | ||
strs = append(strs, s) | ||
} | ||
sort.Strings(strs) | ||
return strs, nil | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
where is
testing.F
defined? I noticed there's a customgofuzzbeta
build tag here, maybe it's related somehow.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, that's right -- you need to use a custom branch of the Go toolchain to get this working (instructions here).