docs icon indicating copy to clipboard operation
docs copied to clipboard
verified publisher icon WasmEdge

feat: add docs for fuzzing

Open adithyaakrishna opened this issue 2 years ago • 3 comments

Description:

  • This PR is a continuation of #177 and adds Docs related to Fuzz testing of WasmEdge applications

adithyaakrishna avatar Oct 27 '23 13:10 adithyaakrishna

Hello, I am a code review bot on flows.network. Here are my reviews of code commits in this PR.

Overall, the pull request adds introductory information and prerequisites for fuzzing, as well as detailed steps on how to perform fuzz testing using AFL. It also includes best practices and references for more information on fuzzing. However, there are a few potential problems, such as not addressing specific issues or bugs related to fuzzing, lacking instructions on how to perform fuzz tests on WasmEdge applications, and not including specific details and examples. The patch also does not include any test cases or examples of fuzzing in action. Additionally, there is a missing newline at the end of the new document, and it's unclear if the changes made in the second file were intentional or not. A more descriptive commit message would also be helpful. Despite these issues, overall, the changes made in the pull request are valuable additions to the project and provide comprehensive documentation on fuzz testing.

Details

Commit 66da00d53dc87a4628c7009abfe5533b085107e1

Key changes:

  • Added a brief introduction to fuzzing.
  • Added a section on prerequisites for running fuzz tests on WasmEdge applications.

Potential problems:

  • The patch does not address any specific issues or bugs related to fuzzing. It only adds introductory information and prerequisites for fuzzing.
  • The patch does not provide any instructions or guidance on how to actually perform fuzz tests on WasmEdge applications.
  • It would be helpful to include more specific details and examples in the guide to make it more practical and actionable for contributors.
  • It is unclear why the "Work in Progress" comment was removed. If the guide is still in progress, it should be mentioned in the patch or updated accordingly.
  • The patch does not include any test cases or examples of fuzzing in action, which would be valuable for readers.

Commit 77358964a6a649aabbb3e1a8cda297e12cde8266

Key changes:

  • Added a new document for fuzzing in the docs/contribute/ directory.
  • Added detailed steps on how to perform fuzz testing using AFL (American Fuzzy Lop) as the fuzzing tool.
  • Included best practices for fuzz testing.
  • Added further references for more information on fuzzing.

Potential problems found:

  • The new document does not have a newline at the end of the file. This should be fixed to maintain consistency.
  • The patch modifies two files, but it's not clear if the changes made in the second file were intentional or if there is a duplicate file modified in error. This should be clarified with the author of the pull request.
  • The first line of the commit message includes "feat: add docs for fuzzing," which follows common conventions. However, it would be helpful to provide a more descriptive commit message that explains the purpose and context of the changes made.

Overall, the pull request includes comprehensive documentation on how to perform fuzz testing for WasmEdge applications and incorporates best practices. There are a few minor issues that can be addressed, but the changes themselves are valuable additions to the project.

alabulei1 avatar Oct 27 '23 13:10 alabulei1

Hi, @adithyaakrishna

We ae using Google/OSS-Fuzz, can you use this in your docs? https://github.com/google/oss-fuzz/tree/master/projects/wasmedge

alabulei1 avatar Nov 02 '23 16:11 alabulei1

Hi, @adithyaakrishna

We ae using Google/OSS-Fuzz, can you use this in your docs? https://github.com/google/oss-fuzz/tree/master/projects/wasmedge

And could you please check out this one?

alabulei1 avatar Dec 16 '23 09:12 alabulei1