Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zpl-c/tester
🧪 A simple, minimalist tester for your minimalist needs
https://github.com/zpl-c/tester
c99 no-dependencies single-header unit-testing
Last synced: about 2 hours ago
JSON representation
🧪 A simple, minimalist tester for your minimalist needs
- Host: GitHub
- URL: https://github.com/zpl-c/tester
- Owner: zpl-c
- License: other
- Created: 2021-02-19T15:01:56.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-17T05:47:25.000Z (over 1 year ago)
- Last Synced: 2023-02-26T19:47:27.967Z (over 1 year ago)
- Topics: c99, no-dependencies, single-header, unit-testing
- Language: C
- Homepage:
- Size: 33.2 KB
- Stars: 13
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
A simple, minimalist tester for your minimalist needs
# Introduction
Simple to use library to easily cover your code with tests. No dependencies, no obscure or over-engineered pipeline, just a dead-simple framework.
You can easily make use of it, it looks pleasant (especially on CI flows), and it won't slow you down anyhow.
## Who uses this library?
* [zpl](https://github.com/zpl-c/zpl) - This is where the library has originated.
* [librg](https://github.com/zpl-c/librg) - Making multi-player simpler since 2017. Single-header cross-platform world replication library in pure C99.
# Features
* Easy to use single-header framework
* No dependencies (except the standard library :)
* Works with C99 code
* Integrates well within any CI pipeline
* Supports the following checks: `FAIL`, `UFAIL`, `STRFAIL`, `EQUALS`, `UEQUALS`, `STREQUALS`, `STRCEQUALS`, `STRCNEQUALS`, `STRNEQUALS`, `NEQUALS`, `LESSER`, `GREATER`, `LESSEREQ`, `GREATEREQ`, `SKIP`
* Did I mention it takes a minimum time to set up?
# How to obtain the library?
* Either clone the repository or download [unit.h](include/unit.h).
* Include `unit.h` in your test app and cover your code already!
# Example Usage
At first, we should define our entry point for the tester app:
```c
#define UNIT_MAX_MODULES 2
#include "unit.h"
/* TEST CATEGORIES */
#include "cases/some_math.h"
#include "cases/cool_stuff.h"
int main() {
UNIT_CREATE("small");
UNIT_MODULE(math);
UNIT_MODULE(cool_stuff);
return UNIT_RUN();
}
```
As you can see, this app defines 2 test modules called: `math` and `cool_stuff`, respectively.
Let's explore them!
[some_math.h](example/cases/some_math.h)
```c
#include
MODULE(math, {
IT("can do cos(0)", {
EQUALS(cosf(0), 1);
});
IT("can do sqrt(9)", {
EQUALS(sqrtf(9), 3);
});
});
```
[cool_stuff.h](example/cases/cool_stuff.h)
```c
MODULE(cool_stuff, {
IT("can predict the future", {
// Not today ...
SKIP();
});
});
```
As you can see, this is all it takes to cover your code, relatively simple, right?
You can also skip tests you plan on running later in the future (or never :)
Have fun!
