Skip to content

Document how to add fuzzing for stdlib modules to CI #5

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.

Sign up for GitHub

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

Draft
sethmlarson wants to merge 1 commit into
base: main
Choose a base branch
from
+15 −0
Draft

Document how to add fuzzing for stdlib modules to CI #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,21 @@ Components that are hosted elsewhere:
When you create a new fuzz target **don't forget to add the target to the fuzzer image**
so that the fuzz target is executed by OSS-Fuzz.

## Adding fuzzing to CPython CI

Fuzzing Python standard library modules using continuous integration
can be done using CIFuzz and GitHub Actions. There is an existing
configuration for CPython, but running fuzzing is expensive so
only runs when particular files are modified.

When a standard library module has a new fuzzer added to this repository
we also need to add a corresponding "trigger" within the CPython repository.
In the file `Tools/build/compute-changes.py`, there is a list of
file and directory paths (`LIBRARY_FUZZER_PATHS`) that would trigger
a run of the standard library fuzzers within the pull request.
Add relevant paths and files to this list for the newly added fuzzer
to trigger fuzzing when those files are changed.

## Local development

To do develop locally with OSS-Fuzz you need to fork and clone the
Expand Down