/* * Copyright (c) 2012 David Siñuela Pastor, siu.4coders@gmail.com * * Permission is hereby granted, free of charge, to any person obtaining * a copy of this software and associated documentation files (the * "Software"), to deal in the Software without restriction, including * without limitation the rights to use, copy, modify, merge, publish, * distribute, sublicense, and/or sell copies of the Software, and to * permit persons to whom the Software is furnished to do so, subject to * the following conditions: * * The above copyright notice and this permission notice shall be * included in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ #ifndef MINUNIT_MINUNIT_H #define MINUNIT_MINUNIT_H #ifdef __cplusplus extern "C" { #endif #if defined(_WIN32) #include #if defined(_MSC_VER) && _MSC_VER < 1900 #define snprintf _snprintf #define __func__ __FUNCTION__ #endif #elif defined(__unix__) || defined(__unix) || defined(unix) || (defined(__APPLE__) && defined(__MACH__)) /* Change POSIX C SOURCE version for pure c99 compilers */ #if !defined(_POSIX_C_SOURCE) || _POSIX_C_SOURCE < 200112L #undef _POSIX_C_SOURCE #define _POSIX_C_SOURCE 200112L #endif #include #include #include /* gethrtime(), gettimeofday() */ #include #include /* clock_gettime(), time() */ #include /* POSIX flags */ #if defined(__MACH__) && defined(__APPLE__) #include #include #endif #else #error "Unable to define timers for an unknown OS." #endif #include #include /* Maximum length of last message */ #define MINUNIT_MESSAGE_LEN 1024 /* Accuracy with which floats are compared */ #define MINUNIT_EPSILON 1E-12 /* Misc. counters */ static int minunit_run = 0; static int minunit_assert = 0; static int minunit_fail = 0; static int minunit_status = 0; /* Timers */ static double minunit_real_timer = 0; static double minunit_proc_timer = 0; /* Last message */ static char minunit_last_message[MINUNIT_MESSAGE_LEN]; /* Test setup and teardown function pointers */ static void (*minunit_setup)(void) = NULL; static void (*minunit_teardown)(void) = NULL; /* Definitions */ #define MU_TEST(method_name) static void method_name(void) #define MU_TEST_SUITE(suite_name) static void suite_name(void) #define MU__SAFE_BLOCK(block) \ do \ { \ block \ } while (0) /* Run test suite and unset setup and teardown functions */ #define MU_RUN_SUITE(suite_name) MU__SAFE_BLOCK( \ suite_name(); \ minunit_setup = NULL; \ minunit_teardown = NULL;) /* Configure setup and teardown functions */ #define MU_SUITE_CONFIGURE(setup_fun, teardown_fun) MU__SAFE_BLOCK( \ minunit_setup = setup_fun; \ minunit_teardown = teardown_fun;) #define STR(X) #X #define ASSTR(X) STR(X) /* Test runner */ #define MU_RUN_TEST(test) MU__SAFE_BLOCK( \ if (minunit_real_timer == 0 && minunit_proc_timer == 0) { \ minunit_real_timer = mu_timer_real(); \ minunit_proc_timer = mu_timer_cpu(); \ } printf("\n-- START " ASSTR(test) " --\n"); \ if (minunit_setup)(*minunit_setup)(); \ minunit_status = 0; \ test(); \ minunit_run++; \ if (minunit_status) { \ minunit_fail++; \ printf("[FAILED]"); \ printf("\n%s\n", minunit_last_message); \ } fflush(stdout); \ if (minunit_teardown)(*minunit_teardown)(); \ printf("\n-- END " ASSTR(test) " --\n");) /* Report */ #define MU_REPORT() MU__SAFE_BLOCK( \ double minunit_end_real_timer; \ double minunit_end_proc_timer; \ printf("\n\n%d tests, %d assertions, %d failures\n", minunit_run, minunit_assert, minunit_fail); \ minunit_end_real_timer = mu_timer_real(); \ minunit_end_proc_timer = mu_timer_cpu(); \ printf("\nFinished in %.8f seconds (real) %.8f seconds (proc)\n\n", \ minunit_end_real_timer - minunit_real_timer, \ minunit_end_proc_timer - minunit_proc_timer);) #define MU_RETURN() MU__SAFE_BLOCK( \ return minunit_fail > 0 ? 1 : 0;) /* Assertions */ #define mu_check(test) MU__SAFE_BLOCK( \ minunit_assert++; \ if (!(test)) { \ snprintf(minunit_last_message, MINUNIT_MESSAGE_LEN, "%s failed:\n\t%s:%d: %s", __func__, __FILE__, __LINE__, #test); \ minunit_status = 1; \ return; \ } else { \ printf(".\n"); \ }) #define mu_fail(message) MU__SAFE_BLOCK( \ minunit_assert++; \ snprintf(minunit_last_message, MINUNIT_MESSAGE_LEN, "%s failed:\n\t%s:%d: %s", __func__, __FILE__, __LINE__, message); \ minunit_status = 1; \ return;) #define mu_assert(test, message) MU__SAFE_BLOCK( \ minunit_assert++; \ if (!(test)) { \ snprintf(minunit_last_message, MINUNIT_MESSAGE_LEN, "%s failed:\n\t%s:%d: %s", __func__, __FILE__, __LINE__, message); \ minunit_status = 1; \ return; \ } else { \ printf(".\n"); \ }) #define mu_assert_int_eq(expected, result) MU__SAFE_BLOCK( \ int minunit_tmp_e; \ int minunit_tmp_r; \ minunit_assert++; \ minunit_tmp_e = (expected); \ minunit_tmp_r = (result); \ if (minunit_tmp_e != minunit_tmp_r) { \ snprintf(minunit_last_message, MINUNIT_MESSAGE_LEN, "%s failed:\n\t%s:%d: %d expected but was %d", __func__, __FILE__, __LINE__, minunit_tmp_e, minunit_tmp_r); \ minunit_status = 1; \ return; \ } else { \ printf("."); \ }) #define mu_assert_double_eq(expected, result) MU__SAFE_BLOCK( \ double minunit_tmp_e; \ double minunit_tmp_r; \ minunit_assert++; \ minunit_tmp_e = (expected); \ minunit_tmp_r = (result); \ if (fabs(minunit_tmp_e - minunit_tmp_r) > MINUNIT_EPSILON) { \ int minunit_significant_figures = 1 - log10(MINUNIT_EPSILON); \ snprintf(minunit_last_message, MINUNIT_MESSAGE_LEN, "%s failed:\n\t%s:%d: %.*g expected but was %.*g", __func__, __FILE__, __LINE__, minunit_significant_figures, minunit_tmp_e, minunit_significant_figures, minunit_tmp_r); \ minunit_status = 1; \ return; \ } else { \ printf("."); \ }) #define mu_assert_string_eq(expected, result) MU__SAFE_BLOCK( \ const char *minunit_tmp_e = expected; \ const char *minunit_tmp_r = result; \ minunit_assert++; \ if (!minunit_tmp_e) { \ minunit_tmp_e = ""; \ } if (!minunit_tmp_r) { \ minunit_tmp_r = ""; \ } if (strcmp(minunit_tmp_e, minunit_tmp_r)) { \ snprintf(minunit_last_message, MINUNIT_MESSAGE_LEN, "%s failed:\n\t%s:%d: '%s' expected but was '%s'", __func__, __FILE__, __LINE__, minunit_tmp_e, minunit_tmp_r); \ minunit_status = 1; \ return; \ } else { \ printf("."); \ }) /* * The following two functions were written by David Robert Nadeau * from http://NadeauSoftware.com/ and distributed under the * Creative Commons Attribution 3.0 Unported License */ /** * Returns the real time, in seconds, or -1.0 if an error occurred. * * Time is measured since an arbitrary and OS-dependent start time. * The returned real time is only useful for computing an elapsed time * between two calls to this function. */ static double mu_timer_real(void) { #if defined(_WIN32) /* Windows 2000 and later. ---------------------------------- */ LARGE_INTEGER Time; LARGE_INTEGER Frequency; QueryPerformanceFrequency(&Frequency); QueryPerformanceCounter(&Time); Time.QuadPart *= 1000000; Time.QuadPart /= Frequency.QuadPart; return (double)Time.QuadPart / 1000000.0; #elif (defined(__hpux) || defined(hpux)) || ((defined(__sun__) || defined(__sun) || defined(sun)) && (defined(__SVR4) || defined(__svr4__))) /* HP-UX, Solaris. ------------------------------------------ */ return (double)gethrtime() / 1000000000.0; #elif defined(__MACH__) && defined(__APPLE__) /* OSX. ----------------------------------------------------- */ static double timeConvert = 0.0; if (timeConvert == 0.0) { mach_timebase_info_data_t timeBase; (void)mach_timebase_info(&timeBase); timeConvert = (double)timeBase.numer / (double)timeBase.denom / 1000000000.0; } return (double)mach_absolute_time() * timeConvert; #elif defined(_POSIX_VERSION) /* POSIX. --------------------------------------------------- */ struct timeval tm; #if defined(_POSIX_TIMERS) && (_POSIX_TIMERS > 0) { struct timespec ts; #if defined(CLOCK_MONOTONIC_PRECISE) /* BSD. --------------------------------------------- */ const clockid_t id = CLOCK_MONOTONIC_PRECISE; #elif defined(CLOCK_MONOTONIC_RAW) /* Linux. ------------------------------------------- */ const clockid_t id = CLOCK_MONOTONIC_RAW; #elif defined(CLOCK_HIGHRES) /* Solaris. ----------------------------------------- */ const clockid_t id = CLOCK_HIGHRES; #elif defined(CLOCK_MONOTONIC) /* AIX, BSD, Linux, POSIX, Solaris. ----------------- */ const clockid_t id = CLOCK_MONOTONIC; #elif defined(CLOCK_REALTIME) /* AIX, BSD, HP-UX, Linux, POSIX. ------------------- */ const clockid_t id = CLOCK_REALTIME; #else const clockid_t id = (clockid_t)-1; /* Unknown. */ #endif /* CLOCK_* */ if (id != (clockid_t)-1 && clock_gettime(id, &ts) != -1) return (double)ts.tv_sec + (double)ts.tv_nsec / 1000000000.0; /* Fall thru. */ } #endif /* _POSIX_TIMERS */ /* AIX, BSD, Cygwin, HP-UX, Linux, OSX, POSIX, Solaris. ----- */ gettimeofday(&tm, NULL); return (double)tm.tv_sec + (double)tm.tv_usec / 1000000.0; #else return -1.0; /* Failed. */ #endif } /** * Returns the amount of CPU time used by the current process, * in seconds, or -1.0 if an error occurred. */ static double mu_timer_cpu(void) { #if defined(_WIN32) /* Windows -------------------------------------------------- */ FILETIME createTime; FILETIME exitTime; FILETIME kernelTime; FILETIME userTime; /* This approach has a resolution of 1/64 second. Unfortunately, Windows' API does not offer better */ if (GetProcessTimes(GetCurrentProcess(), &createTime, &exitTime, &kernelTime, &userTime) != 0) { ULARGE_INTEGER userSystemTime; memcpy(&userSystemTime, &userTime, sizeof(ULARGE_INTEGER)); return (double)userSystemTime.QuadPart / 10000000.0; } #elif defined(__unix__) || defined(__unix) || defined(unix) || (defined(__APPLE__) && defined(__MACH__)) /* AIX, BSD, Cygwin, HP-UX, Linux, OSX, and Solaris --------- */ #if defined(_POSIX_TIMERS) && (_POSIX_TIMERS > 0) /* Prefer high-res POSIX timers, when available. */ { clockid_t id; struct timespec ts; #if _POSIX_CPUTIME > 0 /* Clock ids vary by OS. Query the id, if possible. */ if (clock_getcpuclockid(0, &id) == -1) #endif #if defined(CLOCK_PROCESS_CPUTIME_ID) /* Use known clock id for AIX, Linux, or Solaris. */ id = CLOCK_PROCESS_CPUTIME_ID; #elif defined(CLOCK_VIRTUAL) /* Use known clock id for BSD or HP-UX. */ id = CLOCK_VIRTUAL; #else id = (clockid_t)-1; #endif if (id != (clockid_t)-1 && clock_gettime(id, &ts) != -1) return (double)ts.tv_sec + (double)ts.tv_nsec / 1000000000.0; } #endif #if defined(RUSAGE_SELF) { struct rusage rusage; if (getrusage(RUSAGE_SELF, &rusage) != -1) return (double)rusage.ru_utime.tv_sec + (double)rusage.ru_utime.tv_usec / 1000000.0; } #endif #if defined(_SC_CLK_TCK) { const double ticks = (double)sysconf(_SC_CLK_TCK); struct tms tms; if (times(&tms) != (clock_t)-1) return (double)tms.tms_utime / ticks; } #endif #if defined(CLOCKS_PER_SEC) { clock_t cl = clock(); if (cl != (clock_t)-1) return (double)cl / (double)CLOCKS_PER_SEC; } #endif #endif return -1; /* Failed. */ } #ifdef __cplusplus } #endif #endif /* MINUNIT_MINUNIT_H */