# wumpus-hunter - run test suite repeatedly to find flaky tests

It is common that an automated test suite for some software mostly
works, but that one or more tests sometimes fail. These are called
"flaky tests".

The wumpus hunter is a tool that runs the test suite for some software
repeatedly. At a very high level, the wumpus hunter clones the other
software's git repository, and runs the test suite, and does this
repeatedly, and logs and reports results. The details are slightly
more complicated, but the basic idea is that.

See [`spec.yaml`] for a sample configuration file.

Run `wumpus-hunter --help` (or `cargo run -- --help` from the source tree) to
get an overview of how to run.

Example:

~~~
wumpus-hunter spec.yaml --logs /tmp
~~~

## License

The wumpus hunter is distributed under the terms of both the MIT
license and the Apache License (Version 2.0).

See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) for details.
