Skip to content

docs: clarify fuzz testing guidance - #27198

Merged
alamb merged 2 commits into
mainfrom
codex/fuzz-ut-doc-1
Nov 8, 2026
Merged

alamb merged 2 commits into
mainfrom
codex/fuzz-ut-doc-1

Conversation

@2010YOUY01

Copy link
Copy Markdown
Member

Important

Fork CI setup: For pull requests from a fork to main, enable workflows in your fork's Actions tab before you push.
See the fork CI setup guide.

Which issue does this PR close?

part of #27082
Follow up: #27048

Rationale for this change

#27048 introduced a trait for implementing fuzzing UTs, this PR adds documentation for it.

What changes are included in this PR?

What is the testing strategy for this PR?

Are there any user-facing changes?

@2010YOUY01
2010YOUY01 requested a review from alamb November 7, 2026 08:22
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Nov 7, 2026
@2010YOUY01
2010YOUY01 added this pull request to stack #27200 November 7, 2026 08:26
@codecov-commenter

codecov-commenter commented Nov 7, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.32%. Comparing base (4bf32cb) to head (b1acfb3).
⚠️ Report is 15 commits behind head on main.

Flag Coverage Δ
all-tests 83.32% <ø> (+0.01%) ⬆️
sqllogictests 60.86% <ø> (+0.06%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

@@            Coverage Diff             @@
##             main   #27198      +/-   ##
==========================================
+ Coverage   83.31%   83.32%   +0.01%     
==========================================
  Files        1173     1172       -1     
  Lines      477463   478689    +1226     
  Branches   477463   478689    +1226     
==========================================
+ Hits       397797   398885    +1088     
- Misses      55384    55409      +25     
- Partials    24282    24395     +113     

see 48 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@alamb alamb left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @2010YOUY01

For fuzzing unit tests, such as tests for a single operator or an internal utility:

- If the test is small (easy to set up and takes a few seconds), keep it as a unit test.
- If the test is large (requires a fuzzing driver and takes more than 10 seconds), it must implement the [`FuzzTest` trait][fuzz framework] and run through the [central fuzz-test entry point]. See the [spill-pool fuzzer] for a reference implementation.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to make it a "must" ? Perhaps it would be better as an advisory ("should")?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, updated.

@2010YOUY01 2010YOUY01 closed this Nov 8, 2026
@2010YOUY01 2010YOUY01 reopened this Nov 8, 2026
@2010YOUY01
2010YOUY01 added this pull request to the merge queue Nov 8, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Nov 8, 2026
@2010YOUY01
2010YOUY01 added this pull request to the merge queue Nov 8, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Nov 8, 2026
@alamb
alamb added this pull request to the merge queue Nov 8, 2026
Merged via the queue into main with commit b8534c7 Nov 8, 2026
129 of 147 checks passed
@alamb
alamb deleted the codex/fuzz-ut-doc-1 branch November 8, 2026 21:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation v57.0.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants