gh-143572: Run 'python3-libraries' fuzzer in CI using CIFuzz #143749
+159
−45
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| # CIFuzz job based on https://google.github.io/oss-fuzz/getting-started/continuous-integration/ | ||
| name: Reusable CIFuzz | ||
|
|
||
| on: | ||
| workflow_call: | ||
| inputs: | ||
| oss-fuzz-project-name: | ||
| description: OSS-Fuzz project name | ||
| required: true | ||
| type: string | ||
| sanitizer: | ||
| description: OSS-Fuzz sanitizer | ||
| required: true | ||
| type: string | ||
| timeout-minutes: | ||
| description: Timeout in minutes for the action | ||
| required: false | ||
| default: 60 | ||
| type: number | ||
|
|
||
| jobs: | ||
| cifuzz: | ||
| name: CIFuzz | ||
| runs-on: ubuntu-latest | ||
| timeout-minutes: ${{ inputs.timeout-minutes }} | ||
| steps: | ||
| - name: Build fuzzers (${{ inputs.sanitizer }}) | ||
| id: build | ||
| uses: google/oss-fuzz/infra/cifuzz/actions/build_fuzzers@master | ||
| with: | ||
| oss-fuzz-project-name: ${{ inputs.oss-fuzz-project-name }} | ||
| sanitizer: ${{ inputs.sanitizer }} | ||
| - name: Run fuzzers (${{ inputs.sanitizer }}) | ||
| uses: google/oss-fuzz/infra/cifuzz/actions/run_fuzzers@master | ||
| with: | ||
| fuzz-seconds: 600 | ||
| oss-fuzz-project-name: ${{ inputs.oss-fuzz-project-name }} | ||
| output-sarif: true | ||
| sanitizer: ${{ inputs.sanitizer }} | ||
| - name: Upload crash | ||
| if: failure() && steps.build.outcome == 'success' | ||
| uses: actions/upload-artifact@v6 | ||
| with: | ||
| name: ${{ inputs.sanitizer }}-artifacts | ||
| path: ./out/artifacts | ||
| - name: Upload SARIF | ||
| if: always() && steps.build.outcome == 'success' | ||
| uses: github/codeql-action/upload-sarif@v4 | ||
| with: | ||
| sarif_file: cifuzz-sarif/results.sarif | ||
| checkout_path: cifuzz-sarif |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -21,8 +21,11 @@ on: # yamllint disable-line rule:truthy | |
| description: Whether to run the Android tests | ||
| value: ${{ jobs.compute-changes.outputs.run-android }} # bool | ||
| run-ci-fuzz: | ||
| description: Whether to run the CIFuzz job for 'cpython' fuzzer | ||
| value: ${{ jobs.compute-changes.outputs.run-ci-fuzz }} # bool | ||
| run-ci-fuzz-stdlib: | ||
| description: Whether to run the CIFuzz job for 'python3-libraries' fuzzer | ||
| value: ${{ jobs.compute-changes.outputs.run-ci-fuzz-stdlib }} # bool | ||
| run-docs: | ||
| description: Whether to build the docs | ||
| value: ${{ jobs.compute-changes.outputs.run-docs }} # bool | ||
|
|
@@ -56,6 +59,7 @@ jobs: | |
| outputs: | ||
| run-android: ${{ steps.changes.outputs.run-android }} | ||
| run-ci-fuzz: ${{ steps.changes.outputs.run-ci-fuzz }} | ||
| run-ci-fuzz-stdlib: ${{ steps.changes.outputs.run-ci-fuzz-stdlib }} | ||
| run-docs: ${{ steps.changes.outputs.run-docs }} | ||
| run-ios: ${{ steps.changes.outputs.run-ios }} | ||
| run-macos: ${{ steps.changes.outputs.run-macos }} | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,7 +11,7 @@ | |
|
|
||
| import os | ||
| import subprocess | ||
| from dataclasses import dataclass, fields | ||
| from pathlib import Path | ||
|
|
||
| TYPE_CHECKING = False | ||
|
|
@@ -52,11 +52,59 @@ | |
| MACOS_DIRS = frozenset({"Mac"}) | ||
| WASI_DIRS = frozenset({Path("Tools", "wasm")}) | ||
|
|
||
| LIBRARY_FUZZER_PATHS = frozenset({ | ||
| # All C/CPP fuzzers. | ||
| Path("configure"), | ||
| Path(".github/workflows/reusable-cifuzz.yml"), | ||
| # ast | ||
| Path("Lib/ast.py"), | ||
| Path("Python/ast.c"), | ||
| # configparser | ||
| Path("Lib/configparser.py"), | ||
| # csv | ||
| Path("Lib/csv.py"), | ||
| Path("Modules/_csv.c"), | ||
| # decode | ||
| Path("Lib/encodings/"), | ||
| Path("Modules/_codecsmodule.c"), | ||
| Path("Modules/cjkcodecs/"), | ||
| Path("Modules/unicodedata*"), | ||
| # difflib | ||
| Path("Lib/difflib.py"), | ||
| Path("Lib/email/"), | ||
| # html | ||
| Path("Lib/html/"), | ||
| Path("Lib/_markupbase.py"), | ||
| # http.client | ||
| Path("Lib/http/client.py"), | ||
| # json | ||
| Path("Lib/json/"), | ||
| Path("Modules/_json.c"), | ||
| # plist | ||
| Path("Lib/plistlib.py"), | ||
| # re | ||
| Path("Lib/re/"), | ||
| Path("Modules/_sre/"), | ||
| # tarfile | ||
| Path("Lib/tarfile.py"), | ||
| # tomllib | ||
| Path("Modules/tomllib/"), | ||
| # xml | ||
| Path("Lib/xml/"), | ||
sethmlarson marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| Path("Lib/_markupbase.py"), | ||
| Path("Modules/expat/"), | ||
| Path("Modules/pyexpat.c"), | ||
| # zipfile | ||
| Path("Lib/zipfile/"), | ||
| }) | ||
|
|
||
|
|
||
| @dataclass(kw_only=True, slots=True) | ||
| class Outputs: | ||
| run_android: bool = False | ||
| run_ci_fuzz: bool = False | ||
| run_ci_fuzz_stdlib: bool = False | ||
| run_docs: bool = False | ||
| run_ios: bool = False | ||
| run_macos: bool = False | ||
|
|
@@ -96,6 +144,11 @@ def compute_changes() -> None: | |
| else: | ||
| print("Branch too old for CIFuzz tests; or no C files were changed") | ||
|
|
||
| if outputs.run_ci_fuzz_stdlib: | ||
| print("Run CIFuzz tests for libraries") | ||
| else: | ||
| print("Branch too old for CIFuzz tests; or no library files were changed") | ||
|
|
||
| if outputs.run_docs: | ||
| print("Build documentation") | ||
|
|
||
|
|
@@ -146,9 +199,18 @@ def get_file_platform(file: Path) -> str | None: | |
| return None | ||
|
|
||
|
|
||
| def is_fuzzable_library_file(file: Path) -> bool: | ||
| return any( | ||
| (file.is_relative_to(needs_fuzz) and needs_fuzz.is_dir()) | ||
| or (file == needs_fuzz and file.is_file()) | ||
| for needs_fuzz in LIBRARY_FUZZER_PATHS | ||
| ) | ||
|
|
||
|
|
||
| def process_changed_files(changed_files: Set[Path]) -> Outputs: | ||
| run_tests = False | ||
| run_ci_fuzz = False | ||
| run_ci_fuzz_stdlib = False | ||
| run_docs = False | ||
| run_windows_tests = False | ||
| run_windows_msi = False | ||
|
|
@@ -162,8 +224,8 @@ def process_changed_files(changed_files: Set[Path]) -> Outputs: | |
| doc_file = file.suffix in SUFFIXES_DOCUMENTATION or doc_or_misc | ||
|
|
||
| if file.parent == GITHUB_WORKFLOWS_PATH: | ||
| if file.name == "build.yml" or file.name == "reusable-cifuzz.yml": | ||
| run_tests = run_ci_fuzz = run_ci_fuzz_stdlib = True | ||
| has_platform_specific_change = False | ||
| if file.name == "reusable-docs.yml": | ||
| run_docs = True | ||
|
|
@@ -194,6 +256,8 @@ def process_changed_files(changed_files: Set[Path]) -> Outputs: | |
| ("Modules", "_xxtestfuzz"), | ||
| }: | ||
| run_ci_fuzz = True | ||
| if not run_ci_fuzz_stdlib and is_fuzzable_library_file(file): | ||
| run_ci_fuzz_stdlib = True | ||
|
|
||
| # Check for changed documentation-related files | ||
| if doc_file: | ||
|
|
@@ -227,6 +291,7 @@ def process_changed_files(changed_files: Set[Path]) -> Outputs: | |
| return Outputs( | ||
| run_android=run_android, | ||
| run_ci_fuzz=run_ci_fuzz, | ||
| run_ci_fuzz_stdlib=run_ci_fuzz_stdlib, | ||
| run_docs=run_docs, | ||
| run_ios=run_ios, | ||
| run_macos=run_macos, | ||
|
|
@@ -261,16 +326,10 @@ def write_github_output(outputs: Outputs) -> None: | |
| return | ||
|
|
||
| with open(os.environ["GITHUB_OUTPUT"], "a", encoding="utf-8") as f: | ||
| for field in fields(outputs): | ||
| name = field.name.replace("_", "-") | ||
| val = bool_lower(getattr(outputs, field.name)) | ||
| f.write(f"{name}={val}\n") | ||
|
|
||
|
|
||
| def bool_lower(value: bool, /) -> str: | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This would need the same treatment as other matrices.