Update fuzz tests to use go fuzz features #148

cameracker · 2024-05-14T01:38:10Z

This PR implements #147. Now, we use the fuzz test features built into go test.

This PR also replaces the go-fuzz tests and their accompanying corpus.

cameracker · 2024-05-14T01:51:48Z

generator_test.go

@@ -611,6 +611,7 @@ func testNewV7(t *testing.T) {
 	t.Run("FaultyRand", makeTestNewV7FaultyRand())
 	t.Run("FaultyRandWithOptions", makeTestNewV7FaultyRandWithOptions())
 	t.Run("ShortRandomRead", makeTestNewV7ShortRandomRead())
+	t.Run("ShortRandomReadWithOptions", makeTestNewV7ShortRandomReadWithOptions())


While I was here I noticed that one of the v7 test functions weren't being run, so I added it here.

cameracker · 2024-05-14T02:18:45Z

codec_test.go

 	}
+	f.Fuzz(func(t *testing.T, payload string) {
+		u, err := FromString(payload)
+		if err != nil {


the general logic for this pair is that if the function didn't return an error, we make sure the uuid matches a regex for uuids. Otherwise, we assume the error was correct for the input. This implicitly fails the fuzz test on a panic.

cameracker · 2024-05-14T02:20:59Z

codec_test.go

-		name := "seed_valid_" + fst.variant
-		if err := writeSeedFile(name, fst.input); err != nil {
-			t.Fatal(err)
+	f.Fuzz(func(t *testing.T, payload []byte) {


the general logic for this pair is that if the payload was not 16 bytes, we fail the fuzz if fan error was not returned (or put another way, we verify that the function returns an error when the payload is 16 bytes). Otherwise, if an error was not returned, we make sure it's not a Nil uuid, and we make sure it matched the uuid pattern

cameracker · 2024-05-14T02:45:21Z

.github/workflows/codeql.yml

@@ -40,11 +40,6 @@ jobs:
        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support

    steps:
-      - name: Harden Runner


Removed harden in places that I missed it.

codecov · 2024-05-14T04:02:08Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (22c52c2) to head (2206317).
Report is 26 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff            @@
##            master      #148   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            4         5    +1     
  Lines          513       447   -66     
=========================================
- Hits           513       447   -66

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

dylan-bourque · 2024-05-14T22:31:52Z

codec_test.go

@@ -403,28 +400,109 @@ func BenchmarkParseV4(b *testing.B) {
 	}
 }

-var seedFuzzCorpus = flag.Bool("seed_fuzz_corpus", false, "seed fuzz test corpus")
+const uuidPattern = "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"


Should this also include capital A-F in the match patterns since those would still be valid UUID strings?

Thanks, nice catch. Should be fixed now. Also added uppered uuids to the corpus

codec_test.go

…ec_tests.go file

dylan-bourque

Had a few questions/comments but I like the change. 👍

.github/workflows/go.yml

codec_test.go

.github/workflows/go.yml

dylan-bourque

LGTM

codec_test.go

This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [github.com/gofrs/uuid/v5](https://redirect.github.com/gofrs/uuid) | `v5.2.0` -> `v5.3.0` | [![age](https://developer.mend.io/api/mc/badges/age/go/github.com%2fgofrs%2fuuid%2fv5/v5.3.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/go/github.com%2fgofrs%2fuuid%2fv5/v5.3.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/go/github.com%2fgofrs%2fuuid%2fv5/v5.2.0/v5.3.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/go/github.com%2fgofrs%2fuuid%2fv5/v5.2.0/v5.3.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>gofrs/uuid (github.com/gofrs/uuid/v5)</summary> ### [`v5.3.0`](https://redirect.github.com/gofrs/uuid/releases/tag/v5.3.0) [Compare Source](https://redirect.github.com/gofrs/uuid/compare/v5.2.0...v5.3.0) #### Summary In this release, we updated the package to participate in OpenSSF Scorecard and tuned several development workflows and added some fuzz tests. Additionally, We added `AtTime` generators for V1, V6, and V7 so that users may generate UUIDs from time stamps. **NOTE** Technically, the additional of the `AtTime` generators is a breaking change to the `Generator` interface. We decided to go with a `minor` update because of the unlikelihood of this interface being implemented by a consumer, and to reduce the impact of releasing a major version for this feature. #### What's Changed - Add "AtTime" generators for V1, V6, and V7 by [@kohenkatz](https://redirect.github.com/kohenkatz) in [gofrs/uuid#142 - Fix typo in URL in README by [@kohenkatz](https://redirect.github.com/kohenkatz) in [gofrs/uuid#141 - Add OpenSSF Best Practices Badge to README by [@cameracker](https://redirect.github.com/cameracker) in [gofrs/uuid#144 - Create SECURITY.md by [@cameracker](https://redirect.github.com/cameracker) in [gofrs/uuid#143 - Add OpenSSF Scorecard badge to readme by [@cameracker](https://redirect.github.com/cameracker) in [gofrs/uuid#149 - Update fuzz tests to use go fuzz features by [@cameracker](https://redirect.github.com/cameracker) in [gofrs/uuid#148 #### New Contributors - [@ldez](https://redirect.github.com/ldez) made their first contribution in [gofrs/uuid#168 **Full Changelog**: gofrs/uuid@v5.2.0...v5.3.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "before 6am on Monday" in timezone Europe/Paris, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR was generated by [Mend Renovate](https://mend.io/renovate/). View the [repository job log](https://developer.mend.io/github/cozy/cozy-stack).

cameracker commented May 14, 2024

View reviewed changes

cameracker force-pushed the feature/update-fuzz-tests branch from 5178ff4 to fe908f1 Compare May 14, 2024 02:16

cameracker commented May 14, 2024

View reviewed changes

cameracker changed the title ~~Feature/update-fuzz-tests~~ Update fuzz tests to use go fuzz features May 14, 2024

cameracker commented May 14, 2024

View reviewed changes

dylan-bourque reviewed May 14, 2024

View reviewed changes

cameracker commented May 14, 2024

View reviewed changes

codec_test.go Outdated Show resolved Hide resolved

cameracker commented May 15, 2024

View reviewed changes

codec_test.go Outdated Show resolved Hide resolved

cameracker added 8 commits May 14, 2024 19:15

added two fuzz tests for parser functionality

5c470e8

ran test for v7 generation that was accidentally excluded

bdf7f55

added fuzz tests for FromBinary family of functions, moved to the cod…

4825e91

…ec_tests.go file

refined logic for FromX fuzz functions

223f01f

fixed logical errors with fuzz tests

26aacc5

removed harden from some other github actions workflows

f8b5c5b

fix missing codecov token

34e6f46

Apply suggestions from code review

007c5b0

cameracker force-pushed the feature/update-fuzz-tests branch from 045a083 to 007c5b0 Compare May 15, 2024 02:15

Merge branch 'master' into feature/update-fuzz-tests

c435a87

cameracker requested a review from dylan-bourque June 4, 2024 22:57

Merge branch 'master' into feature/update-fuzz-tests

343a276

dylan-bourque reviewed Jun 5, 2024

View reviewed changes

.github/workflows/go.yml Outdated Show resolved Hide resolved

codec_test.go Outdated Show resolved Hide resolved

codec_test.go Show resolved Hide resolved

cameracker added 2 commits June 16, 2024 15:05

fixed code review feedback

6fa51f6

Merge branch 'master' into feature/update-fuzz-tests

8641b02

cameracker requested a review from dylan-bourque June 16, 2024 15:10

cameracker commented Jun 17, 2024

View reviewed changes

.github/workflows/go.yml Outdated Show resolved Hide resolved

cameracker added 2 commits June 17, 2024 08:53

Update .github/workflows/go.yml

ecd8f50

Merge branch 'master' into feature/update-fuzz-tests

2206317

dylan-bourque approved these changes Jun 28, 2024

View reviewed changes

codec_test.go Show resolved Hide resolved

cameracker merged commit bb31fe5 into master Jun 28, 2024
7 checks passed

cameracker deleted the feature/update-fuzz-tests branch June 28, 2024 19:46

cameracker mentioned this pull request Jun 28, 2024

Tune up Fuzz test #147

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update fuzz tests to use go fuzz features #148

Update fuzz tests to use go fuzz features #148

cameracker commented May 14, 2024 •

edited

Loading

cameracker May 14, 2024

cameracker May 14, 2024

cameracker May 14, 2024

cameracker May 14, 2024

codecov bot commented May 14, 2024 •

edited

Loading

dylan-bourque May 14, 2024

cameracker May 15, 2024 •

edited

Loading

dylan-bourque left a comment

dylan-bourque left a comment

Update fuzz tests to use go fuzz features #148

Update fuzz tests to use go fuzz features #148

Conversation

cameracker commented May 14, 2024 • edited Loading

cameracker May 14, 2024

Choose a reason for hiding this comment

cameracker May 14, 2024

Choose a reason for hiding this comment

cameracker May 14, 2024

Choose a reason for hiding this comment

cameracker May 14, 2024

Choose a reason for hiding this comment

codecov bot commented May 14, 2024 • edited Loading

Codecov Report

dylan-bourque May 14, 2024

Choose a reason for hiding this comment

cameracker May 15, 2024 • edited Loading

Choose a reason for hiding this comment

dylan-bourque left a comment

Choose a reason for hiding this comment

dylan-bourque left a comment

Choose a reason for hiding this comment

cameracker commented May 14, 2024 •

edited

Loading

codecov bot commented May 14, 2024 •

edited

Loading

cameracker May 15, 2024 •

edited

Loading