Skip to content

Commit

Permalink
[pw_fuzzer] rebasing submodules to correct version + doc update (proj…
Browse files Browse the repository at this point in the history
…ect-chip#35799)

* update submodules required for fuzztest

* Doc: Clarifying issue related to submodule version of fuzztest and abseil

* Doc: Clarifying issue related to submodule version of fuzztest and abseil

* fix documentation build error
  • Loading branch information
Alami-Amine authored Sep 27, 2024
1 parent 1b1719a commit d4944bf
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 4 deletions.
6 changes: 5 additions & 1 deletion docs/guides/BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -401,7 +401,11 @@ Tests will be located in:
`chip_pw_fuzztest` is the name of the toolchain used.

- Details on How To Run Fuzz Tests in
[Running FuzzTests](https://github.com/project-chip/connectedhomeip/blob/master/docs/testing/fuzz_testing.md)
[Running FuzzTests](https://github.com/project-chip/connectedhomeip/blob/master/docs/testing/fuzz_testing.md#running-fuzztests)

FAQ: In the event of a build failure related to missing files or dependencies
for pw_fuzzer, check the
[FuzzTest FAQ](https://github.com/project-chip/connectedhomeip/blob/master/docs/testing/fuzz_testing.md#FAQ)

## Build custom configuration

Expand Down
19 changes: 19 additions & 0 deletions docs/testing/fuzz_testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,25 @@ $ ./fuzz-chip-cert-pw --fuzz=ChipCert.DecodeChipCertFuzzer

```

### FAQ

#### What revision should the FuzzTest and Abseil submodules be for running `pw_fuzzer` with FuzzTest?

- Google FuzzTest is integrated into Matter using `pw_fuzzer`, which has
several dependencies. These dependencies are listed here:
[Step 0: Set up FuzzTest for your project](https://pigweed.dev/pw_fuzzer/guides/fuzztest.html#step-0-set-up-fuzztest-for-your-project).
- Matter integrates these dependencies as submodules, including Google
FuzzTest and Abseil.
- Since FuzzTest and Abseil only support the `bazel` and `CMake` build systems
and do not support GN, Pigweed maintainers use a script to generate GN files
for these dependencies.
- the revision of FuzzTest and Abseil submodules in Matter should match or at
least be as new as the specific version (SHA1) used when generating these GN
files.
- You can find the version used for the generated GN files here:
[FuzzTest Version](https://pigweed.dev/third_party/fuzztest/#version) and
[Abseil Version](https://pigweed.dev/third_party/abseil-cpp/#version).

#### TO ADD:

- More Information on Test Fixtures (After issues are resolved)
Expand Down
2 changes: 1 addition & 1 deletion third_party/abseil-cpp/src
Submodule src updated 339 files
2 changes: 1 addition & 1 deletion third_party/fuzztest
Submodule fuzztest updated 283 files

0 comments on commit d4944bf

Please sign in to comment.