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.

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
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions geom/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
testdata
56 changes: 56 additions & 0 deletions geom/wkt_fuzz_test.go
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) {
Copy link
Collaborator

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 custom gofuzzbeta build tag here, maybe it's related somehow.

Copy link
Owner Author

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).

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
}
53 changes: 0 additions & 53 deletions internal/cmprefimpl/cmpgeos/extract_source.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,64 +2,11 @@ package main

import (
"errors"
"fmt"
"go/ast"
"go/parser"
"go/token"
"os"
"path/filepath"
"sort"
"strconv"
"strings"

"github.com/peterstace/simplefeatures/geom"
)

func extractStringsFromSource(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
}

func convertToGeometries(candidates []string) ([]geom.Geometry, error) {
var geoms []geom.Geometry
for _, c := range candidates {
Expand Down
3 changes: 2 additions & 1 deletion internal/cmprefimpl/cmpgeos/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import (
"strings"

"github.com/peterstace/simplefeatures/geom"
"github.com/peterstace/simplefeatures/internal/extract"
)

// TODO: These are additional geometries. Needs something a bit more robust...
Expand All @@ -24,7 +25,7 @@ func main() {
if err != nil {
log.Fatalf("could not get working dir: %v", err)
}
candidates, err := extractStringsFromSource(dir)
candidates, err := extract.StringsFromSource(dir)
if err != nil {
log.Fatalf("could not extract strings from src: %v", err)
}
Expand Down
59 changes: 5 additions & 54 deletions internal/cmprefimpl/cmppg/fuzz_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,19 @@ package main
import (
"database/sql"
"fmt"
"go/ast"
"go/parser"
"go/token"
"os"
"path/filepath"
"sort"
"strconv"
"strings"
"testing"

_ "github.com/lib/pq"
"github.com/peterstace/simplefeatures/geom"
"github.com/peterstace/simplefeatures/internal/extract"
)

func TestFuzz(t *testing.T) {
pg := setupDB(t)
candidates := extractStringsFromSource(t)
candidates, err := extract.StringsFromSource("../../..")
if err != nil {
t.Fatalf("could not extract strings from source: %v", err)
}

CheckWKTParse(t, pg, candidates)
CheckWKBParse(t, pg, candidates)
Expand Down Expand Up @@ -72,51 +68,6 @@ func setupDB(t *testing.T) PostGIS {
return PostGIS{db}
}

func extractStringsFromSource(t *testing.T) []string {
var strs []string
if err := filepath.Walk("../../..", 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 {
t.Fatal(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
}

func convertToGeometries(t *testing.T, candidates []string) []geom.Geometry {
var geoms []geom.Geometry
for _, c := range candidates {
Expand Down
60 changes: 60 additions & 0 deletions internal/extract/extract_strings_from_source.go
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
}