diff --git a/docs/Testing.md b/docs/Testing.md new file mode 100644 index 00000000..c6eb3d42 --- /dev/null +++ b/docs/Testing.md @@ -0,0 +1,13 @@ +# Testing in Unicorn + +Unicorn focus on the testing to reduce bugs and ensure the expected behaviors. The `tests/` directory contains a few subdirectories for testing purposes. + +- `unit/`: C unit tests since Unicorn 2. +- `regress/`: The regression tests written in Python and C, imported from Unicorn 1. +- `rust-tests/`: The tests written in rust. +- `fuzz/`: The fuzz drivers for OSS-Fuzz. +- `benchmarks/`: The benchmark suite imported from Unicorn 1. + +## Contribution Guide + +Generally, it is ideal to add new tests whenever a PR is made. `unit/` should be the first place for the new tests to go. \ No newline at end of file diff --git a/tests/README.md b/tests/README.md new file mode 100644 index 00000000..8956a4f6 --- /dev/null +++ b/tests/README.md @@ -0,0 +1,3 @@ +# Testing + +See [this](../docs/Testing.md) \ No newline at end of file