55 lines
1.7 KiB
Markdown
55 lines
1.7 KiB
Markdown
|
# µnit
|
||
|
|
|
||
|
|
µnit is a small but full-featured unit testing framework for C. It has
|
||
|
|
no dependencies (beyond libc), is permissively licensed (MIT), and is
|
||
|
|
easy to include into any project.
|
||
|
|
|
||
|
|
For more information, see
|
||
|
|
[the µnit web site](https://nemequ.github.io/munit).
|
||
|
|
|
||
|
|
[](https://travis-ci.org/nemequ/munit)
|
||
|
|
[](https://ci.appveyor.com/project/quixdb/munit/branch/master)
|
||
|
|
|
||
|
|
## Features
|
||
|
|
|
||
|
|
Features µnit currently includes include:
|
||
|
|
|
||
|
|
* Handy assertion macros which make for nice error messages.
|
||
|
|
* Reproducible cross-platform random number generation, including
|
||
|
|
support for supplying a seed via CLI.
|
||
|
|
* Timing of both wall-clock and CPU time.
|
||
|
|
* Parameterized tests.
|
||
|
|
* Nested test suites.
|
||
|
|
* Flexible CLI.
|
||
|
|
* Forking
|
||
|
|
([except on Windows](https://github.com/nemequ/munit/issues/2)).
|
||
|
|
* Hiding output of successful tests.
|
||
|
|
|
||
|
|
Features µnit does not currently include, but some day may include
|
||
|
|
(a.k.a., if you file a PR…), include:
|
||
|
|
|
||
|
|
* [TAP](http://testanything.org/) support; feel free to discuss in
|
||
|
|
[issue #1](https://github.com/nemequ/munit/issues/1)
|
||
|
|
|
||
|
|
### Include into your project with meson
|
||
|
|
|
||
|
|
In your `subprojects` folder put a `munit.wrap` file containing:
|
||
|
|
|
||
|
|
```
|
||
|
|
[wrap-git]
|
||
|
|
directory=munit
|
||
|
|
url=https://github.com/nemequ/munit/
|
||
|
|
revision=head
|
||
|
|
```
|
||
|
|
|
||
|
|
Then you can use a subproject fallback when you include munit as a
|
||
|
|
dependency to your project: `dependency('munit', fallback: ['munit', 'munit_dep'])`
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
|
||
|
|
See [the µnit web site](https://nemequ.github.io/munit).
|
||
|
|
|
||
|
|
Additionally, there is a heavily-commented
|
||
|
|
[example.c](https://github.com/nemequ/munit/blob/master/example.c) in
|
||
|
|
the repository.
|