Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ollelogdahl/ihct
'I Hate C Testing': A minimal testing framework for C.
https://github.com/ollelogdahl/ihct
c test-automation
Last synced: 11 days ago
JSON representation
'I Hate C Testing': A minimal testing framework for C.
- Host: GitHub
- URL: https://github.com/ollelogdahl/ihct
- Owner: ollelogdahl
- License: mit
- Created: 2020-12-13T20:45:53.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-03-31T22:24:13.000Z (over 3 years ago)
- Last Synced: 2024-08-01T03:21:22.959Z (3 months ago)
- Topics: c, test-automation
- Language: C
- Homepage:
- Size: 315 KB
- Stars: 152
- Watchers: 4
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ihct
### 'I Hate C Testing': a minimal testing framework for C
Olle Lögdahl, 13 December 2020
---
**ihct** is a minimal C unit-testing framework. Intended for light unit testing, and focusing on development speed.
Looking for more features, so please give any suggestions.
## Installation & Usage
#### See [documentation](https://ollelogdahl.github.io/ihct/)
To use this framework, simply include `ihct.h` in your project and link to the library. **Everything else happens automatically**.
The following code should get you started.
```c
#include
IHCT_TEST(arithmetic_basic) {
int a = 13;
IHCT_ASSERT(a + 2 == 15);
IHCT_ASSERT(a * 2 == 26);
}
IHCT_TEST(string_basic) {
char *s1 = "abba";
IHCT_ASSERT_STR(s1, "abba");
}
int main(int argc, char **argv) {
return IHCT_RUN(argc, argv);
}
```
To fully install the library, run:
```bash
mkdir build
cd build
cmake .. && make -j4
sudo make install
```
See `ex.c` for an extended example. Note that tests are created as it's own executable, and therefore needs an entrypoint.
The example `ex.c` can be compiled and executed by running:
```bash
mkdir build
cd build
cmake .. && make -j4
./example
```
---
## Why?
I have for a long time been stuck at unit testing in plain C. Many modern solutions use C++ as a test environment for C, but I wanted something
more lightweight, that i can quickly get up to speed with. I decided to write my own test framework with two things in mind: **development speed**
and **minimalism**. To improve development speed, all test functions are automatically included into the runner, and the library interface is kept
minimal. It requires no dependencies other than a POSIX compliant OS, and compiles on all GNU C99 POSIX compatible compilers. The library also
implements some safety to tests, catching fatal signals and hung functions.
---
## Features
- Basic test units
- Basic asserts
- Automatic test loader
- Catching fatal signals (SEGFAULTS etc.) in tests (no line number, but sets them as failed).
- Catching hung tests (again, no line number).
Self tests can be run along with own tests by adding compiler flag `-DIHCT_SELF_TEST`. (This may be very redundant; just see it as more examples :-) )
all macros (`IHCT_TEST`, `IHCT_ASSERT` etc.) can be shortened to remove the `IHCT` prefix, by defining `IHCT_SHORT` **before**
including the header file.
## Compatability notes
- Since it requires `__attribute__((constructor))` it is not compilable with MSVC.
- Since it uses pthreads and signals, it is POSIX (again, not sure it works with Windows).
## Links
- [Repository](https://github.com/ollelogdahl/ihct/)
- For reporting errors, visit [Issue Tracker](https://github.com/ollelogdahl/ihct/issues)!
- Related Projects:
- [cheat](https://github.com/Tuplanolla/cheat) by Guillermo "Tordek" Freschi and Sampsa "Tuplanolla" Kiiskinen
## Licensing
This project, and all code it contains, is licensed under the *MIT License* and can be read [here](LICENSE).