eliasku/unit

Tiny unit testing library for C language

unit

🥼 Tiny unit testing library for C language 🥼

Example

Compile executable with -D UNIT_TESTING to enable tests

#define UNIT_MAIN
#include <unit.h>

SUITE( suite name ) {
  DESCRIBE( subcase name ) {
    IT("is test behaviour") {
      WARN("use WARN_* to print failed assumptions");
      CHECK("use CHECK_* to continue execute assertions on fail");
      REQUIRE("use REQUIRE_* to skip next assertions on fail");
    }
  }
}

Command-line options

• --version, -v: Prints the version of unit library
• --help, -h: Prints usage help message
• --list, -l: Prints all available tests
• --animate, -a: Simulate waits for printing messages, just for making fancy printing animation
• --ascii: Don't use colors and fancy unicode symbols in the output
• --short-filenames, -S: Use only basename for displaying file-pos information
• --quiet, -q: Disables all output
• -r=xml: Special switch prints XML report in DocTest-friendly format (for CLion test run configuration)

Features and design goals

✓ Main focus and features

• Written in Pure C: only standard libc is used
• Simplicity and tiny build-size
• No dynamic memory allocations: only static memory is used for reporting test running infrastructure.
• Single-header library: easy to integrate
• Embedded runner & pretty reporter: build self-executable test
• Disable test code: allow you to write tests for your private implementation right at the end of impl.c file
• Cross-platform: should work for Linux / macOS / Windows / WebAssembly

✕ What you won't find here

• Cross-compiler support: no MSVC support, only clang is tested
• Multithreading and parallel test running
• Tricky test matchers design
• Fixtures, before / after or mocking
• Crash tests and signal interception
• Fuzz testing

In any case, if you have a desire, you can support and contribute! Feel free to ask me any feature you need. Thank you for your interest!

unit's Issues

Split source code

• Split and group to different h/c files in src folder
• Make script which build (amalgamate) to header-only library include/unit.h
• Add version from package.json to library header
• Add library pre-build steps in CI

Ideas for a better macro names

1. rename module to suite
2. add test alias for it
3. rename comment to echo

Inspired by Nim's std/unittest package

how to: before each and after each

compile errors because of `test` macro

Macros should be SCREAMING_UPPER_CASE.
Currently:

• it could be mismatched with variables called it as iterators
• test macro corrupts CXX atomic headers

add coverage report for self-test

Translation Units: duplicated symbols

implement something like:

#define UNIT_IMPL
#include <unit.h>

Bright while text is not readable on light themes