blob: 8d67be228abc9f3791b4819e12601396e8209ae3 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
[kursg-meta]: # (title: about)
[kursg-meta]: # (order: 1)
About
=====
**mtest** - macro test, is a very small unit test framework. Really small, it
contains only single header file with macros only. **mtest** outputs test
results in [TAP](https://testanything.org/) format, so it can be piped to
anything (like automake or jenkins) for even nicer output.
Dependencies
============
Valid C89 compiler with **fprintf** function implemented.
Posix shell for testing from shell.
Instalation
===========
Just copy **mtest.h** into your project tree, and include it. It's that easy.
You can also call **make install** so **mtest** is copied into local machine.
Just mind that **mtest** will become your build dependency, and it's so small,
it is usually not necessary. The good thing of calling **make install** is that,
man pages will be installed in your system, so you can have quick overview of
the library if you forget anything.
Documentation
=============
Full documentation (and some more info) is available at
[mtest.bofc.pl](http://mtest.bofc.pl/manuals.html)
There are also man pages in **man** directory.
Why
===
Because KISS. There are many good frameworks out there for testing, but I missed
something really small yet powerfull. This framework does its job well, it is
very easy to integrate with tools like Jenkins for test result presentation and
it's a proof that unit testing can be very easy to implement.
Examples
========
Example test is in [example](http://git.bofc.pl/mtest/tree/example)
directory. Also following projects use **mtest** for testing:
* [memperf](http://git.bofc.pl/memperf)
* [embedlog](http://git.bofc.pl/embedlog)
* [kurload](http://git.bofc.pl/kurload)
* [librb](http://git.bofc.pl/librb)
Tests results are integrated with automake **make check** call.
License
=======
Licensed under BSD 2-clause license. See LICENSE file for more information.
Authors
=======
Michał Łyszczek <michal.lyszczek@bofc.pl>
See also
========
* [project webpage](http://mtest.bofc.pl)
* [git repository](http://git.bofc.pl/mtest)
* [test anything protocol (tap)](http://testanything.org)
|
