Skip to content

docs: fix typo and explain FuzzedDataProvider in Jest documentation #311

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

Merged
kyakdan merged 1 commit into from
Feb 8, 2023
Merged

docs: fix typo and explain FuzzedDataProvider in Jest documentation #311

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
10 changes: 6 additions & 4 deletions docs/jest-integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ which can be specified through the CLI client.
}
```

## Writing a Jest fuzz tests
## Writing a Jest fuzz test

To create a fuzz test, the `fuzz` function on Jest's `test` and `it` can be
used.
Expand Down Expand Up @@ -116,9 +116,11 @@ describe("My describe", () => {
});
```

However, the provided `Buffer` is not the nicest abstraction to work with. For
that reason, Jazzer.js provides the wrapper class `FuzzedDataProvider`. An
example on how to use everything in combination is shown below.
If the function you want to test expects parameters of types other than
`Buffer`, you have to take care of constructing the corresponding arguments from
the provided buffer. To facilitate this step, Jazzer.js provides a utility class
`FuzzedDataProvider` that you can use to consume data of certain types from the
fuzzer input. An example on how to use everything in combination is shown below.

```js
const target = require("./target");
Expand Down