https://github.com/2hdddg/chili
Unit tests for C in C
https://github.com/2hdddg/chili
c embedded-c embedded-linux test-framework testrunner unit-testing unittest
Last synced: about 1 month ago
JSON representation
Unit tests for C in C
- Host: GitHub
- URL: https://github.com/2hdddg/chili
- Owner: 2hdddg
- License: mit
- Created: 2016-06-06T20:07:31.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-03-17T19:45:15.000Z (about 8 years ago)
- Last Synced: 2025-04-17T18:23:50.346Z (about 2 months ago)
- Topics: c, embedded-c, embedded-linux, test-framework, testrunner, unit-testing, unittest
- Language: C
- Homepage:
- Size: 117 KB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Chili - testrunner for C in C
### What is Chili
A test runner for C programmers that makes it easy and fun to write nice
and slim unit tests with minimum hazzle. You write your Chili tests
completely without build dependencies.
Chili is written in C with minimal dependencies on external libraries.
The idea is that Chili could be used on target for embedded development.
### Installation
```bash
~$ make && make install
```
Chili is Linux only.
### Simplest possible unit test
**Create new file**: unittests.c
```C
#include
int test_that_succeeds()
{
printf("Returning 1 indicates success\n");
return 1;
}
```
Tests should always be named with the prefix *test_*. Also note
that the funcion must NOT be static.
**Build the unit test:**
```bash
~$ gcc unittests.c -fPIC --shared -o unittests.so
```
This builds a shared library with the test as an exported
symbol. This what Chili finds and executes.
**Run the unit test:**
```bash
~$ chili all ./unittests.so
./unittests.so: test_that_succeeds: Success [0]
Executed: 1, Succeeded: 1, Failed: 0, Errors: 0
```
The *all* command executes all tests in the shared library,
in this case only one test.
Note that the output of *printf* is not shown in the output above,
Chili will default to suppress output of all succeeding tests.
### Unit test return values
Unit tests should always return an int and should not
take any parameters. Chili interprets the returned values the
following way:
* Positive values are interpreted as a successful/green test.
* Zero are interpreted as a failing/red test.
* Negative values are interpreted as an unexpected error occured
while executing the test. Chili will not execute any more tests
in this suite when it encounters a test that returns a negative
value.
A test could also crash during it's execution, this is reported
as a crash but Chili will continue executing other tests.
```C
#include
int test_that_succeeds()
{
printf("Positive indicates success\n");
return 1;
}
int test_that_fails()
{
printf("Zero indicates failure\n");
return 0;
}
int test_that_crashes()
{
int *x = (int*)0;
printf("This will crash\n");
*x = 0;
}
int test_with_error()
{
printf("This is an error\n");
return -1;
}
```
Build this into a shared library named unittests.so and let Chili execute the tests:
```bash
~$ chili all ./unittests.so
./unittests.so: test_that_succeeds: Success [0]
./unittests.so: test_that_fails: Failed [1]
>>>Capture start
Zero indicates failure
<<< Capture end
./unittests.so: test_that_crashes: Crashed [2]
>>> Capture start
This will crash
<<< Capture end
./unittests.so: test_with_error: Error [3]
>>> Capture start
This is an error
<<< Capture end
Executed: 4, Succeeded: 1, Failed: 1, Errors: 2
```
As shown above prints are only shown on tests with any type of problem.
### Suite setup functions
### Debugging a unit test
To debug a problematic unit test do like this. To debug the test *test_that_crashes* in the following module.
```C
#include
int test_that_crashes()
{
int *x = (int*)0;
printf("This will crash\n");
*x = 0;
}
```
To be able to debug, the tests and other linked modules need to be built with debug information:
```bash
~$ gcc unittests.c -fPIC --shared -g -o unittests.so
```
Debugging is done with Chilis debug command and the name of the test:
```bash
~$ chili debug ./unittests.so:test_that_crashes
GNU gdb (Ubuntu 7.11.1-0ubuntu1~16.04) 7.11.1
Copyright (C) 2016 Free Software Foundation, Inc
...
Attaching to process 1637
Reading symbols from ...
Reading symbols ./unittests.so..done
...
Breakpoint 1 at 0x7fa51cab1766: file unittest.c, line 3.
Continuing with signal SIGCONT.
Breakpoint 1, test_that_crashes () at unittest.c:3
3 int *x = (int*)0;
(gdb)
```
Gdb of course needs to be installed for this to work.
### Other usable commands
To list all tests in a suite use the *list* command:
```bash
~$ chili list ./unittests.so
./unittests.so:test_one
./unittests.so:test_two
```
Format of listed test are on the same format that is used to run tests by name. The *named* command runs all named tests that is found in a file or from stdin:
```bash
~$ chili list ./unittests.so | grep two | chili named
./unittests.so: test_two: Success [0]
Executed: 1, Succeeded: 1, Failed: 0, Errors: 0
```