Skip to content

Add documentation for creating new fuzz test targets. #1467

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.

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

Conversation

arik-so
Copy link
Contributor

@arik-so arik-so commented May 5, 2022

No description provided.

## How do I add a new fuzz test?

1. The easiest approach is to take one of the files in `fuzz/src/`, such as e. g.
`process_network_graph.rs`, and duplicate it, renaming the new file to something more
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit: this doesnt exist quite yet :)

Copy link
Contributor

Choose a reason for hiding this comment

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

Did we wanna resolve this @arik-so?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

nope. I wanna land the graph sync PR 😛

@codecov-commenter
Copy link

codecov-commenter commented May 5, 2022

Codecov Report

Merging #1467 (5c64eec) into main (132b072) will decrease coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #1467      +/-   ##
==========================================
- Coverage   90.91%   90.90%   -0.02%     
==========================================
  Files          75       75              
  Lines       41826    41826              
  Branches    41826    41826              
==========================================
- Hits        38028    38022       -6     
- Misses       3798     3804       +6     
Impacted Files Coverage Δ
lightning/src/ln/functional_tests.rs 97.07% <0.00%> (-0.10%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 132b072...5c64eec. Read the comment docs.

@arik-so arik-so force-pushed the fuzz_new_target_docs branch from 790d54b to ec0436b Compare May 5, 2022 07:51
fuzz/README.md Outdated

## How do I add a new fuzz test?

1. The easiest approach is to take one of the files in `fuzz/src/`, such as e. g.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
1. The easiest approach is to take one of the files in `fuzz/src/`, such as e. g.
1. The easiest approach is to take one of the files in `fuzz/src/`, for example,

Think this reads a bit better :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think just "such as" reads the nicest, so I removed "e. g."

Copy link
Contributor

Choose a reason for hiding this comment

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

Cool, works too!

@arik-so arik-so force-pushed the fuzz_new_target_docs branch from ec0436b to 2d42bfc Compare May 5, 2022 16:55
@arik-so arik-so force-pushed the fuzz_new_target_docs branch from 2d42bfc to 5c64eec Compare May 5, 2022 16:58
Copy link
Contributor

@valentinewallace valentinewallace left a comment

Choose a reason for hiding this comment

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

Looks good mod Matt's feedback. Nice to get more fuzzing docs

@valentinewallace valentinewallace merged commit 6587607 into lightningdevkit:main May 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants