bytecodealliance / bytecodealliance/wit-bindgen

Test Suggestion: Add Fuzzing Tests

Open
#780 1 comment 0 reactions 0 assignees View on GitHub
help wanted
Dominant language
Rust
Stars
1.5k
Forks
286
Avg merge
6h 32m
Merged PRs (30d)
19

Description

Fuzz testing is testing mechanism that involves providing pseudo-random data as input into the generators to find correctness issues. There are multiple Bytecode Alliance projects that heavily leverage fuzz testing to improve code quality and find security and correctness issues (e.g. `wasmtime` and `wasm-tools`). So far, there is no fuzz testing existing in this repo. Part of the reasons applying fuzz testing against `wit-bindgen` repo is to raise the bar for generator code quality across multiple languages.

The goal of this issue is to suggest a fuzz framework adding to this repo. It could be as simply as feeding generated valid WIT packages to each `wit-bindgen` generator and check if the generated code are buildable. As the `wit-bindgen-go` maintainer, I hope there is a continuous fuzzing running in the background and invokes `TinyGo` compiler to compile generated WIT bindings. It could go as difficult as making sure the generated code is "correct" - the compiled Wasm modules / components are correct to our expectations.

To get started, I propose to use [`wit-smith`](https://github.com/bytecodealliance/wasm-tools/tree/main/crates/wit-smith) and [`libfuzzer-sys`](https://github.com/rust-fuzz/libfuzzer) crate and `cargo-fuzz` tool for fuzz testing.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.