/* * Copyright (c) 2011 Scott Vokes * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ #ifndef GREATEST_H #define GREATEST_H #ifdef __cplusplus #define __STDC_VERSION__ 19901L extern "C" { #endif #define GREATEST_VERSION_MAJOR 0 #define GREATEST_VERSION_MINOR 9 #define GREATEST_VERSION_PATCH 3 /* A unit testing system for C, contained in 1 file. * It doesn't use dynamic allocation or depend on anything * beyond ANSI C89. */ /********************************************************************* * Minimal test runner template *********************************************************************/ #if 0 #include "greatest.h" TEST foo_should_foo() { PASS(); } static void setup_cb(void *data) { printf("setup callback for each test case\n"); } static void teardown_cb(void *data) { printf("teardown callback for each test case\n"); } SUITE(suite) { /* Optional setup/teardown callbacks which will be run before/after * every test case in the suite. * Cleared when the suite finishes. */ SET_SETUP(setup_cb, voidp_to_callback_data); SET_TEARDOWN(teardown_cb, voidp_to_callback_data); RUN_TEST(foo_should_foo); } /* Add all the definitions that need to be in the test runner's main file. */ GREATEST_MAIN_DEFS(); int main(int argc, char **argv) { GREATEST_MAIN_BEGIN(); /* command-line arguments, initialization. */ RUN_SUITE(suite); GREATEST_MAIN_END(); /* display results */ } #endif /*********************************************************************/ #include #include #include #include /*********** * Options * ***********/ /* Default column width for non-verbose output. */ #ifndef GREATEST_DEFAULT_WIDTH #define GREATEST_DEFAULT_WIDTH 72 #endif /* FILE *, for test logging. */ #ifndef GREATEST_STDOUT #define GREATEST_STDOUT stdout #endif /* Remove GREATEST_ prefix from most commonly used symbols? */ #ifndef GREATEST_USE_ABBREVS #define GREATEST_USE_ABBREVS 1 #endif /********* * Types * *********/ /* Info for the current running suite. */ typedef struct greatest_suite_info { unsigned int tests_run; unsigned int passed; unsigned int failed; unsigned int skipped; /* timers, pre/post running suite and individual tests */ clock_t pre_suite; clock_t post_suite; clock_t pre_test; clock_t post_test; } greatest_suite_info; /* Type for a suite function. */ typedef void (greatest_suite_cb)(void); /* Types for setup/teardown callbacks. If non-NULL, these will be run * and passed the pointer to their additional data. */ typedef void (greatest_setup_cb)(void *udata); typedef void (greatest_teardown_cb)(void *udata); typedef enum { GREATEST_FLAG_VERBOSE = 0x01, GREATEST_FLAG_FIRST_FAIL = 0x02, GREATEST_FLAG_LIST_ONLY = 0x04 } GREATEST_FLAG; typedef struct greatest_run_info { unsigned int flags; unsigned int tests_run; /* total test count */ /* Overall pass/fail/skip counts. */ unsigned int passed; unsigned int failed; unsigned int skipped; /* currently running test suite */ greatest_suite_info suite; /* info to print about the most recent failure */ const char *fail_file; unsigned int fail_line; const char *msg; /* current setup/teardown hooks and userdata */ greatest_setup_cb *setup; void *setup_udata; greatest_teardown_cb *teardown; void *teardown_udata; /* formatting info for ".....s...F"-style output */ unsigned int col; unsigned int width; /* only run a specific suite or test */ char *suite_filter; char *test_filter; /* overall timers */ clock_t begin; clock_t end; } greatest_run_info; /* Global var for the current testing context. * Initialized by GREATEST_MAIN_DEFS(). */ extern greatest_run_info greatest_info; /********************** * Exported functions * **********************/ void greatest_do_pass(const char *name); void greatest_do_fail(const char *name); void greatest_do_skip(const char *name); int greatest_pre_test(const char *name); void greatest_post_test(const char *name, int res); void greatest_usage(const char *name); void GREATEST_SET_SETUP_CB(greatest_setup_cb *cb, void *udata); void GREATEST_SET_TEARDOWN_CB(greatest_teardown_cb *cb, void *udata); /********** * Macros * **********/ /* Define a suite. */ #define GREATEST_SUITE(NAME) void NAME(void) /* Start defining a test function. * The arguments are not included, to allow parametric testing. */ #define GREATEST_TEST static int /* Run a suite. */ #define GREATEST_RUN_SUITE(S_NAME) greatest_run_suite(S_NAME, #S_NAME) /* Run a test in the current suite. */ #define GREATEST_RUN_TEST(TEST) \ do { \ if (greatest_pre_test(#TEST) == 1) { \ int res = TEST(); \ greatest_post_test(#TEST, res); \ } else if (GREATEST_LIST_ONLY()) { \ fprintf(GREATEST_STDOUT, " %s\n", #TEST); \ } \ } while (0) /* Run a test in the current suite with one void* argument, * which can be a pointer to a struct with multiple arguments. */ #define GREATEST_RUN_TEST1(TEST, ENV) \ do { \ if (greatest_pre_test(#TEST) == 1) { \ int res = TEST(ENV); \ greatest_post_test(#TEST, res); \ } else if (GREATEST_LIST_ONLY()) { \ fprintf(GREATEST_STDOUT, " %s\n", #TEST); \ } \ } while (0) /* If __VA_ARGS__ (C99) is supported, allow parametric testing * without needing to manually manage the argument struct. */ #if __STDC_VERSION__ >= 19901L #define GREATEST_RUN_TESTp(TEST, ...) \ do { \ if (greatest_pre_test(#TEST) == 1) { \ int res = TEST(__VA_ARGS__); \ greatest_post_test(#TEST, res); \ } else if (GREATEST_LIST_ONLY()) { \ fprintf(GREATEST_STDOUT, " %s\n", #TEST); \ } \ } while (0) #endif /* Check if the test runner is in verbose mode. */ #define GREATEST_IS_VERBOSE() (greatest_info.flags & GREATEST_FLAG_VERBOSE) #define GREATEST_LIST_ONLY() (greatest_info.flags & GREATEST_FLAG_LIST_ONLY) #define GREATEST_FIRST_FAIL() (greatest_info.flags & GREATEST_FLAG_FIRST_FAIL) #define GREATEST_FAILURE_ABORT() (greatest_info.suite.failed > 0 && GREATEST_FIRST_FAIL()) /* Message-less forms. */ #define GREATEST_PASS() GREATEST_PASSm(NULL) #define GREATEST_FAIL() GREATEST_FAILm(NULL) #define GREATEST_SKIP() GREATEST_SKIPm(NULL) #define GREATEST_ASSERT(COND) GREATEST_ASSERTm(#COND, COND) #define GREATEST_ASSERT_FALSE(COND) GREATEST_ASSERT_FALSEm(#COND, COND) #define GREATEST_ASSERT_EQ(EXP, GOT) GREATEST_ASSERT_EQm(#EXP " != " #GOT, EXP, GOT) #define GREATEST_ASSERT_STR_EQ(EXP, GOT) GREATEST_ASSERT_STR_EQm(#EXP " != " #GOT, EXP, GOT) /* The following forms take an additional message argument first, * to be displayed by the test runner. */ /* Fail if a condition is not true, with message. */ #define GREATEST_ASSERTm(MSG, COND) \ do { \ greatest_info.msg = MSG; \ greatest_info.fail_file = __FILE__; \ greatest_info.fail_line = __LINE__; \ if (!(COND)) return -1; \ greatest_info.msg = NULL; \ } while (0) #define GREATEST_ASSERT_FALSEm(MSG, COND) \ do { \ greatest_info.msg = MSG; \ greatest_info.fail_file = __FILE__; \ greatest_info.fail_line = __LINE__; \ if ((COND)) return -1; \ greatest_info.msg = NULL; \ } while (0) #define GREATEST_ASSERT_EQm(MSG, EXP, GOT) \ do { \ greatest_info.msg = MSG; \ greatest_info.fail_file = __FILE__; \ greatest_info.fail_line = __LINE__; \ if ((EXP) != (GOT)) return -1; \ greatest_info.msg = NULL; \ } while (0) #define GREATEST_ASSERT_STR_EQm(MSG, EXP, GOT) \ do { \ const char *exp_s = (EXP); \ const char *got_s = (GOT); \ greatest_info.msg = MSG; \ greatest_info.fail_file = __FILE__; \ greatest_info.fail_line = __LINE__; \ if (0 != strcmp(exp_s, got_s)) { \ fprintf(GREATEST_STDOUT, \ "Expected:\n####\n%s\n####\n", exp_s); \ fprintf(GREATEST_STDOUT, \ "Got:\n####\n%s\n####\n", got_s); \ return -1; \ } \ greatest_info.msg = NULL; \ } while (0) #define GREATEST_PASSm(MSG) \ do { \ greatest_info.msg = MSG; \ return 0; \ } while (0) #define GREATEST_FAILm(MSG) \ do { \ greatest_info.fail_file = __FILE__; \ greatest_info.fail_line = __LINE__; \ greatest_info.msg = MSG; \ return -1; \ } while (0) #define GREATEST_SKIPm(MSG) \ do { \ greatest_info.msg = MSG; \ return 1; \ } while (0) #define GREATEST_SET_TIME(NAME) \ NAME = clock(); \ if (NAME == (clock_t) -1) { \ fprintf(GREATEST_STDOUT, \ "clock error: %s\n", #NAME); \ exit(EXIT_FAILURE); \ } #define GREATEST_CLOCK_DIFF(C1, C2) \ fprintf(GREATEST_STDOUT, " (%lu ticks, %.3f sec)", \ (long unsigned int) (C2) - (C1), \ (double)((C2) - (C1)) / (1.0 * (double)CLOCKS_PER_SEC)) \ /* Include several function definitions in the main test file. */ #define GREATEST_MAIN_DEFS() \ \ /* Is FILTER a subset of NAME? */ \ static int greatest_name_match(const char *name, \ const char *filter) { \ size_t offset = 0; \ size_t filter_len = strlen(filter); \ while (name[offset] != '\0') { \ if (name[offset] == filter[0]) { \ if (0 == strncmp(&name[offset], filter, filter_len)) { \ return 1; \ } \ } \ offset++; \ } \ \ return 0; \ } \ \ int greatest_pre_test(const char *name) { \ if (!GREATEST_LIST_ONLY() \ && (!GREATEST_FIRST_FAIL() || greatest_info.suite.failed == 0) \ && (greatest_info.test_filter == NULL || \ greatest_name_match(name, greatest_info.test_filter))) { \ GREATEST_SET_TIME(greatest_info.suite.pre_test); \ if (greatest_info.setup) { \ greatest_info.setup(greatest_info.setup_udata); \ } \ return 1; /* test should be run */ \ } else { \ return 0; /* skipped */ \ } \ } \ \ void greatest_post_test(const char *name, int res) { \ GREATEST_SET_TIME(greatest_info.suite.post_test); \ if (greatest_info.teardown) { \ void *udata = greatest_info.teardown_udata; \ greatest_info.teardown(udata); \ } \ \ if (res < 0) { \ greatest_do_fail(name); \ } else if (res > 0) { \ greatest_do_skip(name); \ } else if (res == 0) { \ greatest_do_pass(name); \ } \ greatest_info.suite.tests_run++; \ greatest_info.col++; \ if (GREATEST_IS_VERBOSE()) { \ GREATEST_CLOCK_DIFF(greatest_info.suite.pre_test, \ greatest_info.suite.post_test); \ fprintf(GREATEST_STDOUT, "\n"); \ } else if (greatest_info.col % greatest_info.width == 0) { \ fprintf(GREATEST_STDOUT, "\n"); \ greatest_info.col = 0; \ } \ if (GREATEST_STDOUT == stdout) fflush(stdout); \ } \ \ static void greatest_run_suite(greatest_suite_cb *suite_cb, \ const char *suite_name) { \ if (greatest_info.suite_filter && \ !greatest_name_match(suite_name, greatest_info.suite_filter)) \ return; \ if (GREATEST_FIRST_FAIL() && greatest_info.failed > 0) return; \ greatest_info.suite.tests_run = 0; \ greatest_info.suite.failed = 0; \ greatest_info.suite.passed = 0; \ greatest_info.suite.skipped = 0; \ greatest_info.suite.pre_suite = 0; \ greatest_info.suite.post_suite = 0; \ greatest_info.suite.pre_test = 0; \ greatest_info.suite.post_test = 0; \ greatest_info.col = 0; \ fprintf(GREATEST_STDOUT, "\n* Suite %s:\n", suite_name); \ GREATEST_SET_TIME(greatest_info.suite.pre_suite); \ suite_cb(); \ GREATEST_SET_TIME(greatest_info.suite.post_suite); \ if (greatest_info.suite.tests_run > 0) { \ fprintf(GREATEST_STDOUT, \ "\n%u tests - %u pass, %u fail, %u skipped", \ greatest_info.suite.tests_run, \ greatest_info.suite.passed, \ greatest_info.suite.failed, \ greatest_info.suite.skipped); \ GREATEST_CLOCK_DIFF(greatest_info.suite.pre_suite, \ greatest_info.suite.post_suite); \ fprintf(GREATEST_STDOUT, "\n"); \ } \ greatest_info.setup = NULL; \ greatest_info.setup_udata = NULL; \ greatest_info.teardown = NULL; \ greatest_info.teardown_udata = NULL; \ greatest_info.passed += greatest_info.suite.passed; \ greatest_info.failed += greatest_info.suite.failed; \ greatest_info.skipped += greatest_info.suite.skipped; \ greatest_info.tests_run += greatest_info.suite.tests_run; \ } \ \ void greatest_do_pass(const char *name) { \ if (GREATEST_IS_VERBOSE()) { \ fprintf(GREATEST_STDOUT, "PASS %s: %s", \ name, greatest_info.msg ? greatest_info.msg : ""); \ } else { \ fprintf(GREATEST_STDOUT, "."); \ } \ greatest_info.suite.passed++; \ } \ \ void greatest_do_fail(const char *name) { \ if (GREATEST_IS_VERBOSE()) { \ fprintf(GREATEST_STDOUT, \ "FAIL %s: %s (%s:%u)", \ name, greatest_info.msg ? greatest_info.msg : "", \ greatest_info.fail_file, greatest_info.fail_line); \ } else { \ fprintf(GREATEST_STDOUT, "F"); \ /* add linebreak if in line of '.'s */ \ if (greatest_info.col % greatest_info.width != 0) \ fprintf(GREATEST_STDOUT, "\n"); \ greatest_info.col = 0; \ fprintf(GREATEST_STDOUT, "FAIL %s: %s (%s:%u)\n", \ name, \ greatest_info.msg ? greatest_info.msg : "", \ greatest_info.fail_file, greatest_info.fail_line); \ } \ greatest_info.suite.failed++; \ } \ \ void greatest_do_skip(const char *name) { \ if (GREATEST_IS_VERBOSE()) { \ fprintf(GREATEST_STDOUT, "SKIP %s: %s", \ name, \ greatest_info.msg ? \ greatest_info.msg : "" ); \ } else { \ fprintf(GREATEST_STDOUT, "s"); \ } \ greatest_info.suite.skipped++; \ } \ \ void greatest_usage(const char *name) { \ fprintf(GREATEST_STDOUT, \ "Usage: %s [-hlfv] [-s SUITE] [-t TEST]\n" \ " -h print this Help\n" \ " -l List suites and their tests, then exit\n" \ " -f Stop runner after first failure\n" \ " -v Verbose output\n" \ " -s SUITE only run suite named SUITE\n" \ " -t TEST only run test named TEST\n", \ name); \ } \ \ void GREATEST_SET_SETUP_CB(greatest_setup_cb *cb, void *udata) { \ greatest_info.setup = cb; \ greatest_info.setup_udata = udata; \ } \ \ void GREATEST_SET_TEARDOWN_CB(greatest_teardown_cb *cb, \ void *udata) { \ greatest_info.teardown = cb; \ greatest_info.teardown_udata = udata; \ } \ \ greatest_run_info greatest_info /* Handle command-line arguments, etc. */ #define GREATEST_MAIN_BEGIN() \ do { \ int i = 0; \ memset(&greatest_info, 0, sizeof(greatest_info)); \ if (greatest_info.width == 0) { \ greatest_info.width = GREATEST_DEFAULT_WIDTH; \ } \ for (i = 1; i < argc; i++) { \ if (0 == strcmp("-t", argv[i])) { \ if (argc <= i + 1) { \ greatest_usage(argv[0]); \ exit(EXIT_FAILURE); \ } \ greatest_info.test_filter = argv[i+1]; \ i++; \ } else if (0 == strcmp("-s", argv[i])) { \ if (argc <= i + 1) { \ greatest_usage(argv[0]); \ exit(EXIT_FAILURE); \ } \ greatest_info.suite_filter = argv[i+1]; \ i++; \ } else if (0 == strcmp("-f", argv[i])) { \ greatest_info.flags |= GREATEST_FLAG_FIRST_FAIL; \ } else if (0 == strcmp("-v", argv[i])) { \ greatest_info.flags |= GREATEST_FLAG_VERBOSE; \ } else if (0 == strcmp("-l", argv[i])) { \ greatest_info.flags |= GREATEST_FLAG_LIST_ONLY; \ } else if (0 == strcmp("-h", argv[i])) { \ greatest_usage(argv[0]); \ exit(EXIT_SUCCESS); \ } else { \ fprintf(GREATEST_STDOUT, \ "Unknown argument '%s'\n", argv[i]); \ greatest_usage(argv[0]); \ exit(EXIT_FAILURE); \ } \ } \ } while (0); \ GREATEST_SET_TIME(greatest_info.begin) #define GREATEST_MAIN_END() \ do { \ if (!GREATEST_LIST_ONLY()) { \ GREATEST_SET_TIME(greatest_info.end); \ fprintf(GREATEST_STDOUT, \ "\nTotal: %u tests", greatest_info.tests_run); \ GREATEST_CLOCK_DIFF(greatest_info.begin, \ greatest_info.end); \ fprintf(GREATEST_STDOUT, "\n"); \ fprintf(GREATEST_STDOUT, \ "Pass: %u, fail: %u, skip: %u.\n", \ greatest_info.passed, \ greatest_info.failed, greatest_info.skipped); \ } \ return (greatest_info.failed > 0 \ ? EXIT_FAILURE : EXIT_SUCCESS); \ } while (0) /* Make abbreviations without the GREATEST_ prefix for the * most commonly used symbols. */ #if GREATEST_USE_ABBREVS #define TEST GREATEST_TEST #define SUITE GREATEST_SUITE #define RUN_TEST GREATEST_RUN_TEST #define RUN_TEST1 GREATEST_RUN_TEST1 #define RUN_SUITE GREATEST_RUN_SUITE #define ASSERT GREATEST_ASSERT #define ASSERTm GREATEST_ASSERTm #define ASSERT_FALSE GREATEST_ASSERT_FALSE #define ASSERT_EQ GREATEST_ASSERT_EQ #define ASSERT_STR_EQ GREATEST_ASSERT_STR_EQ #define ASSERT_FALSEm GREATEST_ASSERT_FALSEm #define ASSERT_EQm GREATEST_ASSERT_EQm #define ASSERT_STR_EQm GREATEST_ASSERT_STR_EQm #define PASS GREATEST_PASS #define FAIL GREATEST_FAIL #define SKIP GREATEST_SKIP #define PASSm GREATEST_PASSm #define FAILm GREATEST_FAILm #define SKIPm GREATEST_SKIPm #define SET_SETUP GREATEST_SET_SETUP_CB #define SET_TEARDOWN GREATEST_SET_TEARDOWN_CB #if __STDC_VERSION__ >= 19901L #endif /* C99 */ #define RUN_TESTp GREATEST_RUN_TESTp #endif /* USE_ABBREVS */ #ifdef __cplusplus } #endif #endif