# musli-tests
[<img alt="github" src="https://img.shields.io/badge/github-udoprog/musli-8da0cb?style=for-the-badge&logo=github" height="20">](https://github.com/udoprog/musli)
[<img alt="crates.io" src="https://img.shields.io/crates/v/musli-tests.svg?style=for-the-badge&color=fc8d62&logo=rust" height="20">](https://crates.io/crates/musli-tests)
[<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-musli--tests-66c2a5?style=for-the-badge&logoColor=white&logo=data:image/svg+xml;base64,PHN2ZyByb2xlPSJpbWciIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDUxMiA1MTIiPjxwYXRoIGZpbGw9IiNmNWY1ZjUiIGQ9Ik00ODguNiAyNTAuMkwzOTIgMjE0VjEwNS41YzAtMTUtOS4zLTI4LjQtMjMuNC0zMy43bC0xMDAtMzcuNWMtOC4xLTMuMS0xNy4xLTMuMS0yNS4zIDBsLTEwMCAzNy41Yy0xNC4xIDUuMy0yMy40IDE4LjctMjMuNCAzMy43VjIxNGwtOTYuNiAzNi4yQzkuMyAyNTUuNSAwIDI2OC45IDAgMjgzLjlWMzk0YzAgMTMuNiA3LjcgMjYuMSAxOS45IDMyLjJsMTAwIDUwYzEwLjEgNS4xIDIyLjEgNS4xIDMyLjIgMGwxMDMuOS01MiAxMDMuOSA1MmMxMC4xIDUuMSAyMi4xIDUuMSAzMi4yIDBsMTAwLTUwYzEyLjItNi4xIDE5LjktMTguNiAxOS45LTMyLjJWMjgzLjljMC0xNS05LjMtMjguNC0yMy40LTMzLjd6TTM1OCAyMTQuOGwtODUgMzEuOXYtNjguMmw4NS0zN3Y3My4zek0xNTQgMTA0LjFsMTAyLTM4LjIgMTAyIDM4LjJ2LjZsLTEwMiA0MS40LTEwMi00MS40di0uNnptODQgMjkxLjFsLTg1IDQyLjV2LTc5LjFsODUtMzguOHY3NS40em0wLTExMmwtMTAyIDQxLjQtMTAyLTQxLjR2LS42bDEwMi0zOC4yIDEwMiAzOC4ydi42em0yNDAgMTEybC04NSA0Mi41di03OS4xbDg1LTM4Ljh2NzUuNHptMC0xMTJsLTEwMiA0MS40LTEwMi00MS40di0uNmwxMDItMzguMiAxMDIgMzguMnYuNnoiPjwvcGF0aD48L3N2Zz4K" height="20">](https://docs.rs/musli-tests)
[<img alt="build status" src="https://img.shields.io/github/actions/workflow/status/udoprog/musli/ci.yml?branch=main&style=for-the-badge" height="20">](https://github.com/udoprog/musli/actions?query=branch%3Amain)
Helper utilities for ensuring that musli is safe to use and behaves as expected.
This does include a fairly sophisticated benchmarking suite.
<br>
## Benchmarking
Now this includes the `extra` category, which requires `model_minimal`. This
is not exactly a fair comparison, because it compares serialization formats
which were designed to model data that others are not capable off.
The exact tradeoff can be seen by comparing the feature `model_full` with
`model_minimal`.
```sh
cargo bench --no-default-features --features musli,full,extra,model_minimal,simdutf8
```
To run benchmarks for serialization suites which *do* support all features, do:
```sh
cargo bench --features full
```
<br>
## Fuzz testing
This comes with the `fuzz` binary which can do the following things.
Run serialization for a long time against a lot of random data. Both with
and without miri. When run with miri, the size of the datasets is
drastically reduced.
```sh
cargo run --bin fuzz
cargo +nightly miri run --bin fuzz
```
Run deserialization against randomly generated bytes. Both with and without
miri. When run with miri, the size of the datasets is drastically reduced.
```sh
cargo run --bin fuzz -- --random
cargo +nightly miri run --bin fuzz -- --random
```
> **Note** you can add the running of optional crates by enabling its
> corresponding feature, such as `--features bincode`.
<br>
## Potential security issues discovered by this crate
* `dlhn`: Allocating and initializing large arrays based on untrusted input
(DoS): [dlhn#11](https://github.com/otake84/dlhn/issues/11).
<br>
## Size comparison
To perform a one-off size comparison:
```sh
cargo run --bin fuzz -- --size
```
This will *for now* just take the first generated field of a given type,
serialize it, and print out its size. In the future it will perform an
average over the entire set with more statistics.