header-file-only unit test "framework" for C for linux

ctdd.h

#ifndef CTDD_H
#define CTDD_H

// ctdd - Single header unit test framework for C
// To use this, checkout the examples at tests/

#include <stdio.h>
#include <sys/time.h>

#define __CTDD_MESSAGE_LEN 1024

#define __ctdd_fail_code 0
#define __ctdd_success_code 1

typedef struct __CTDD_SUITE_VARS {
  // where error messages are temporarily stored
  char error_message[__CTDD_MESSAGE_LEN];

  unsigned long num_tests;
  unsigned long test_time_millisecs;
  unsigned long suite_time_millisecs;
  int status;
} __CTDD_SUITE_VARS;

static struct __CTDD_SUITE_VARS __ctdd_suite_vars = {0};

static void (*__ctdd_setup)(void) = NULL;
static void (*__ctdd_teardown)(void) = NULL;

// define multi statement macro more easily
#define __ctdd_code_block(code_block) do {\
  code_block\
} while(0)

#define __ctdd_link_suite_struct(test_suite) __CTDD_SUITE_VARS* __ctdd_test_suite_struct_##test_suite = &__ctdd_suite_vars
#define __ctdd_use_suite_struct(test_suite) extern __CTDD_SUITE_VARS* __ctdd_test_suite_struct_##test_suite
#define __ctdd_get_suite_struct(test_suite) __ctdd_test_suite_struct_##test_suite

#define __ctdd_link_suite_func(test_suite) void (*__ctdd_test_suite_func_##test_suite)() = &__ctdd_test_suite_wrapper_##test_suite
#define __ctdd_use_suite_func(test_suite) extern void (*__ctdd_test_suite_func_##test_suite)()

#define __ctdd_reset_struct(test_suite) __ctdd_code_block(\
    __ctdd_get_suite_struct(test_suite)->num_tests = 0;\
    __ctdd_get_suite_struct(test_suite)->test_time_millisecs = 0;\
    __ctdd_get_suite_struct(test_suite)->suite_time_millisecs = 0;\
  )

// define a single test case, which calls ctdd_assert, ctdd_check and ctdd_fail
#define ctdd_test(test)\
static void test();\
static void __ctdd_test_case_wrapper_##test() {\
  if(__ctdd_setup) __ctdd_setup();\
  test();\
  if(__ctdd_teardown) __ctdd_teardown();\
}\
static void test()

// define a test suite, which calls ctdd_run_test for each test case
#define ctdd_test_suite(test_suite)\
static void test_suite();\
static void __ctdd_test_suite_wrapper_##test_suite() {\
  test_suite();\
  __ctdd_setup = NULL;\
  __ctdd_teardown = NULL;\
}\
__ctdd_link_suite_struct(test_suite);\
__ctdd_link_suite_func(test_suite);\
static void test_suite()

// set setup and teardown functions for this test suite
#define ctdd_configure(setup, teardown) __ctdd_code_block(\
      __ctdd_setup = setup;\
      __ctdd_teardown = teardown;\
    )

// runs a single test case
#define ctdd_run_test(test) __ctdd_code_block(\
    __ctdd_suite_vars.status = __ctdd_success_code;\
    struct timeval start;\
    struct timeval stop;\
    gettimeofday(&start, NULL);\
    __ctdd_test_case_wrapper_##test();\
    gettimeofday(&stop, NULL);\
    if(__ctdd_suite_vars.status == __ctdd_fail_code) {\
      fprintf(stderr, "\x1b[31m%lu\x1b[1m ❌\x1b[0m\n%s\n", __ctdd_suite_vars.num_tests, __ctdd_suite_vars.error_message);\
      return;\
    } else {\
      unsigned long secs = stop.tv_sec - start.tv_sec;\
      unsigned long millisecs = stop.tv_usec - start.tv_usec;\
      fprintf(stderr, "\x1b[32m%lu\x1b[1m ✅\x1b[0m %lu.%lu secs\n", __ctdd_suite_vars.num_tests, secs, millisecs);\
      __ctdd_suite_vars.num_tests++;\
      __ctdd_suite_vars.test_time_millisecs = secs * 10e6 + millisecs;\
      __ctdd_suite_vars.suite_time_millisecs += __ctdd_suite_vars.test_time_millisecs;\
    }\
  )

// runs test suite
#define ctdd_run_suite(test_suite)\
  __ctdd_use_suite_struct(test_suite);\
  __ctdd_use_suite_func(test_suite);\
  __ctdd_code_block(\
    __ctdd_reset_struct(test_suite);\
    __ctdd_test_suite_func_##test_suite();\
    if(__ctdd_get_suite_struct(test_suite)->status == __ctdd_fail_code) {\
      fprintf(stderr, "\x1b[34m"#test_suite "\x1b[1;31m FAILED!\x1b[0m\n");\
      return 1;\
    } else {\
      unsigned long millisecs = __ctdd_get_suite_struct(test_suite)->suite_time_millisecs;\
      fprintf(stderr, "Test suite \x1b[34m"#test_suite "\x1b[1;32m PASSED!\x1b[0m %lu.%lu secs\n", millisecs/10000, millisecs%10000);\
    }\
  )

// runs with report
#define ctdd_run_suite_with_report(test_suite)\
  ctdd_run_suite(test_suite);\
  __ctdd_code_block(\
    unsigned long millisecs = __ctdd_get_suite_struct(test_suite)->suite_time_millisecs;\
    unsigned long avg_millisecs = millisecs / __ctdd_get_suite_struct(test_suite)->num_tests;\
    fprintf(\
      stderr,\
      "\x1b[34m"#test_suite"\x1b[0m report:\n"\
        "\tstatus: %s\n"\
        "\tnumber of tests: %lu\n"\
        "\ttotal test time: %lu.%lu secs\n"\
        "\taverage test time: %lu.%lu secs\n",\
      __ctdd_get_suite_struct(test_suite)->status == __ctdd_fail_code ? "\x1b[1;31m❌\x1b[0m" : "\x1b[1;32m✅\x1b[0m",\
      __ctdd_get_suite_struct(test_suite)->num_tests,\
      millisecs/10000, millisecs%10000,\
      avg_millisecs/10000, avg_millisecs%10000\
      );\
  )
// save results to csv
#define ctdd_run_suite_and_save_to_csv(test_suite, filename)\
  ctdd_run_suite(test_suite);\
  __ctdd_code_block(\
    unsigned long millisecs = __ctdd_get_suite_struct(test_suite)->suite_time_millisecs;\
    unsigned long num_tests = __ctdd_get_suite_struct(test_suite)->num_tests;\
    unsigned long avg_millisecs = millisecs / num_tests;\
    int status = __ctdd_get_suite_struct(test_suite)->status;\
    FILE* file;\
    int write_headers=1;\
    if((file = fopen(filename, "r"))) {\
      fclose(file);\
      file = NULL;\
      write_headers=0;\
    }\
    if(!( file = fopen(filename, write_headers ? "w" : "a"))) {\
      fprintf(stderr, "couldn't open " #filename " \x1b[1;31m❌\x1b[0m\n");\
      return 1;\
    }\
    if(write_headers) {\
      fprintf(file, "name,total_time_milli,avg_time_milli,num_tests,status\n");\
    }\
    fprintf(file, "%s,%lu,%lu,%lu,%d\n", #test_suite, millisecs, avg_millisecs, num_tests, status);\
    fclose(file);\
  )
// assert condition
#define ctdd_assert(test, message) __ctdd_code_block(\
    if(!(test)) {\
      snprintf(\
          __ctdd_suite_vars.error_message,\
          __CTDD_MESSAGE_LEN,\
          "Test case '%s' \x1b[31mFAILED ❌\x1b[0m\n"\
            "\tFile: \x1b[33m%s\x1b[0m\n"\
            "\tLine: \x1b[33m%d\x1b[0m\n"\
            "\tExpression: \x1b[33m%s\x1b[0m",\
            __func__,\
            __FILE__,\
            __LINE__,\
            message);\
      __ctdd_suite_vars.status = __ctdd_fail_code;\
      return;\
    } else {\
      fprintf(stderr, ".");\
    }\
  )
// assert check
#define ctdd_check(test) ctdd_assert(test, #test)
// just fail
#define ctdd_fail(message) ctdd_assert(0, message)
#endif