Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ctronp/mct
Micro C Test, a single header library for testing.
https://github.com/ctronp/mct
c c-testing ctest testing
Last synced: 24 days ago
JSON representation
Micro C Test, a single header library for testing.
- Host: GitHub
- URL: https://github.com/ctronp/mct
- Owner: ctronp
- License: mit
- Created: 2022-07-14T05:22:09.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-05T19:20:44.000Z (about 2 years ago)
- Last Synced: 2024-04-24T05:25:03.460Z (9 months ago)
- Topics: c, c-testing, ctest, testing
- Language: C
- Homepage:
- Size: 38.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MCT
MCT (Micro C Test) is a single header library for fast and efficient testing.
The purpose of creating this library as a single header is to easily integrate it with CMake or any other compilation
method.
## Usage
just copy the [MCT.h](/MCT.h) file to the project in which you want to use it.
## Example
```C
#include "MCT.h"
// We call the macro to start the tests
START_TESTING(NULL){
printf("Only run on first execution.");
}
// The code between START_TESTING and TEST
// will be evaluated countless times, no
// code should be outside the braces.
TEST(test name, test description){
// Code for the first test
ASSERT(1)
ASSERT_EQ_INT(1, 1)
ASSERT_EQ_DBL(1.0, 1.0)
ASSERT_EQ_STR("test", "test")
ASSERT_EQ_PTR(NULL, NULL)
}
TEST(failed test, description of failed test){
// Code for the second test
ASSERT(0)
ASSERT_EQ_INT(1, 2)
ASSERT_EQ_DBL(1.0, 2.0)
ASSERT_EQ_STR("test", "test2")
ASSERT_EQ_PTR(NULL, "test")
}
END_TESTING
```
a longer example can be found [here](https://github.com/ctronp/EfficientDataStructures/tree/dev/tests)
or [here](/pass_test.c)
## Macros
### START_TESTING
This macro generates the basic structure for test execution.
It receives as argument a function ```void (*fun)()``` which will be executed prior to each test, in case it is not
required, set NULL.
this macro must be used in conjunction with 2 curly brackets that will contain the code to be executed prior to
all tests.
#### Example
```C
START_TESTING(NULL) { printf("starting tests"); }
```
### TEST
This macro generates a test. The macro receives 2 parameters, the first is the name the test takes, the second is the
description of the test.
This macro must be used in conjunction with 2 curly brackets that will contain the code to be executed.
a TEST can only be placed after START_TESTING or another TEST.
### ASSERT_*
Multiple ```ASSERT``` macros were created that work to validate inside a [TEST](#TEST), in case they fail they will stop
the execution of the test, print the error to the stdout, and continue with the next TEST in case it exists.
#### Example
```C
TEST(test name, test description){
// Code for the first test
ASSERT(1)
ASSERT_EQ_INT(1, 1)
ASSERT_EQ_DBL(1.0, 1.0)
ASSERT_EQ_STR("test", "test")
ASSERT_EQ_PTR(NULL, NULL)
}
```
### END_TESTING
This macro prints the final results and ends the program execution.
in case 1 or more tests have failed the program will close with code 1.
in case there is no TEST the program will close with code 1.
in case there is at least 1 TEST and no test has failed, the program will close with code 0.
## Include in CMake
can be included directly as an ``add_executable`` file or as an ``INTERFACE`` library.