Migrating Fuzz testing to Go built-in testing

This also sets up CI to regularly perform Fuzz testing. This first step with fuzzing migrated just the existing Fuzz tests to the new setup. In the future additional tests can be added. Signed-off-by: Matt Farina <[email protected]>
Masterminds · Apr 7, 2023 · e485a0d · e485a0d
1 parent cc17577
commit e485a0d
Show file tree

Hide file tree

Showing 5 changed files with 82 additions and 34 deletions.
diff --git a/.github/workflows/fuzz.yaml b/.github/workflows/fuzz.yaml
@@ -0,0 +1,20 @@
+name: Fuzz Testing
+on:
+  # Perform Fuzz testing on PRs and on a daily basis. Daily will continue to
+  # look for problems. Doing this on PRs will look for issues introduced in
+  # a change.
+  pull_request:
+  schedule:
+    - cron: '33 23 * * *' # Run at 11:33 every day
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Install Go
+      uses: actions/setup-go@v3
+      with:
+        go-version: "1.20"
+    - name: Checkout code
+      uses: actions/checkout@v3
+    - name: Fuzz
+      run: make fuzz
diff --git a/Makefile b/Makefile
@@ -1,7 +1,5 @@
 GOPATH=$(shell go env GOPATH)
 GOLANGCI_LINT=$(GOPATH)/bin/golangci-lint
-GOFUZZBUILD = $(GOPATH)/bin/go-fuzz-build
-GOFUZZ = $(GOPATH)/bin/go-fuzz
 
 .PHONY: lint
 lint: $(GOLANGCI_LINT)
@@ -19,19 +17,14 @@ test-cover:
 	GO111MODULE=on go test -cover .
 
 .PHONY: fuzz
-fuzz: $(GOFUZZBUILD) $(GOFUZZ)
-	@echo "==> Fuzz testing"
-	$(GOFUZZBUILD)
-	$(GOFUZZ) -workdir=_fuzz
+fuzz:
+	@echo "==> Running Fuzz Tests"
+	go test -fuzz=FuzzNewVersion -fuzztime=15s .
+	go test -fuzz=FuzzStrictNewVersion -fuzztime=15s .
+	go test -fuzz=FuzzNewConstraint -fuzztime=15s .
 
 $(GOLANGCI_LINT):
 	# Install golangci-lint. The configuration for it is in the .golangci.yml
 	# file in the root of the repository
 	echo ${GOPATH}
 	curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | sh -s -- -b $(GOPATH)/bin v1.17.1
-
-$(GOFUZZBUILD):
-	cd / && go get -u github.com/dvyukov/go-fuzz/go-fuzz-build
-
-$(GOFUZZ):
-	cd / && go get -u github.com/dvyukov/go-fuzz/go-fuzz github.com/dvyukov/go-fuzz/go-fuzz-dep
diff --git a/constraints_test.go b/constraints_test.go
@@ -776,3 +776,36 @@ func TestTextUnmarshalConstraints(t *testing.T) {
 		}
 	}
 }
+
+func FuzzNewConstraint(f *testing.F) {
+	testcases := []string{
+		"v1.2.3",
+		" ",
+		"......",
+		"1",
+		"1.2.3-beta.1",
+		"1.2.3+foo",
+		"2.3.4-alpha.1+bar",
+		"lorem ipsum",
+		"*",
+		"!=1.2.3",
+		"^4.5",
+		"1.0.0 - 2",
+		"1.2.3.4.5.6",
+		">= 1",
+		"~9.8.7",
+		"<= 12.13.14",
+		"987654321.123456789.654123789",
+		"1.x",
+		"2.3.x",
+		"9.2-beta.0",
+	}
+
+	for _, tc := range testcases {
+		f.Add(tc)
+	}
+
+	f.Fuzz(func(t *testing.T, a string) {
+		_, _ = NewConstraint(a)
+	})
+}
diff --git a/fuzz.go b/fuzz.go
diff --git a/version_test.go b/version_test.go
@@ -681,3 +681,27 @@ func TestValidateMetadata(t *testing.T) {
 		}
 	}
 }
+
+func FuzzNewVersion(f *testing.F) {
+	testcases := []string{"v1.2.3", " ", "......", "1", "1.2.3-beta.1", "1.2.3+foo", "2.3.4-alpha.1+bar", "lorem ipsum"}
+
+	for _, tc := range testcases {
+		f.Add(tc)
+	}
+
+	f.Fuzz(func(t *testing.T, a string) {
+		_, _ = NewVersion(a)
+	})
+}
+
+func FuzzStrictNewVersion(f *testing.F) {
+	testcases := []string{"v1.2.3", " ", "......", "1", "1.2.3-beta.1", "1.2.3+foo", "2.3.4-alpha.1+bar", "lorem ipsum"}
+
+	for _, tc := range testcases {
+		f.Add(tc)
+	}
+
+	f.Fuzz(func(t *testing.T, a string) {
+		_, _ = StrictNewVersion(a)
+	})
+}