X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=libtest%2Ftest.h;h=5c449ab02f9e3c0341b4c1638f3f70f83c93fa3d;hb=25efe3485198149616820ab4e52d2f18f0abe5a7;hp=2245e798da6899253d1ddd072ef49017e2538d14;hpb=625e84ebfc422790372bc2984f504bdcb4da779c;p=m6w6%2Flibmemcached diff --git a/libtest/test.h b/libtest/test.h index 2245e798..5c449ab0 100644 --- a/libtest/test.h +++ b/libtest/test.h @@ -1,10 +1,8 @@ /* vim:expandtab:shiftwidth=2:tabstop=2:smarttab: - * - * Gearmand client and server library. * - * Copyright (C) 2011 Data Differential, http://datadifferential.com/ - * Copyright (C) 2006-2010 Brian Aker - * All rights reserved. + * Data Differential YATL (i.e. libtest) library + * + * Copyright (C) 2012 Data Differential, http://datadifferential.com/ * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are @@ -38,234 +36,103 @@ #pragma once -#include - -/* - Structures for generic tests. -*/ - -#include -#include -#include - -#if !defined(__cplusplus) -# include -#endif - -typedef struct world_st world_st; -typedef struct collection_st collection_st; -typedef struct test_st test_st; - -enum test_return_t { - TEST_SUCCESS, /* Backwards compatibility */ - TEST_FAILURE, - TEST_MEMORY_ALLOCATION_FAILURE, - TEST_SKIPPED, - TEST_FATAL, // Collection should not be continued - TEST_MAXIMUM_RETURN /* Always add new error code before */ -}; - -#ifdef __cplusplus -extern "C" { +#ifndef __INTEL_COMPILER +#pragma GCC diagnostic ignored "-Wold-style-cast" #endif -typedef enum test_return_t test_return_t; - -#ifdef __cplusplus -} -#endif - - -typedef void *(*test_callback_create_fn)(test_return_t *error); -typedef test_return_t (*test_callback_fn)(void *); -typedef test_return_t (*test_callback_runner_fn)(test_callback_fn, void *); -typedef test_return_t (*test_callback_error_fn)(test_return_t, void *); - /** A structure describing the test case. */ struct test_st { const char *name; bool requires_flush; - test_callback_fn test_fn; -}; - - -/** - A structure which describes a collection of test cases. -*/ -struct collection_st { - const char *name; - test_callback_fn pre; - test_callback_fn post; - test_st *tests; -}; - - -/** - Structure which houses the actual callers for the test cases contained in - the collections. -*/ -typedef struct { - test_callback_runner_fn pre; - test_callback_runner_fn run; - test_callback_runner_fn post; -} world_runner_st; - - -/** - world_st is the structure which is passed to the test implementation to be filled. - This must be implemented in order for the test framework to load the tests. We call - get_world() in order to fill this structure. -*/ - -struct world_st { - collection_st *collections; - - /* These methods are called outside of any collection call. */ - test_callback_create_fn create; - test_callback_fn destroy; - - struct { - /* This is called a the beginning of any test run. */ - test_callback_fn startup; - - /* This called on a test if the test requires a flush call (the bool is from test_st) */ - test_callback_fn flush; - - /** - These are run before/after the test. If implemented. Their execution is not controlled - by the test. - */ - test_callback_fn pre_run; - test_callback_fn post_run; - - /** - If an error occurs during the test, this is called. - */ - test_callback_error_fn on_error; - } test; - - struct { - /* This is called a the beginning of any collection run. */ - test_callback_fn startup; - - /* This is called at the end of any collection run. */ - test_callback_fn shutdown; - } collection; - - - /** - Runner represents the callers for the tests. If not implemented we will use - a set of default implementations. - */ - world_runner_st *runner; + test_callback_fn *test_fn; }; +#define test_assert_errno(A) \ +do \ +{ \ + if ((A)) { \ + fprintf(stderr, "\n%s:%d: Assertion failed for %s: ", __FILE__, __LINE__, __func__);\ + perror(#A); \ + fprintf(stderr, "\n"); \ + libtest::create_core(); \ + assert((A)); \ + } \ +} while (0) - -/** - @note world_stats_st is a simple structure for tracking test successes. -*/ -typedef struct { - uint32_t collection_success; - uint32_t collection_skipped; - uint32_t collection_failed; - uint32_t collection_total; - uint32_t success; - uint32_t skipped; - uint32_t failed; - uint32_t total; -} world_stats_st; - -#ifdef __cplusplus -extern "C" { -#endif - -/* Help function for use with gettimeofday() */ -LIBTEST_API -long int timedif(struct timeval a, struct timeval b); - -/* How we make all of this work :) */ -LIBTEST_API -void get_world(world_st *world); - -LIBTEST_INTERNAL_API -void create_core(void); - -/** - @note Friendly print function for errors. -*/ -LIBTEST_API -const char *test_strerror(test_return_t code); - -#define test_fail(A) \ +#define test_assert(A, B) \ do \ { \ - if (1) { \ - fprintf(stderr, "\nFailed at %s:%d: %s\n", __FILE__, __LINE__, #A);\ - create_core(); \ - return TEST_FAILURE; \ + if ((A)) { \ + fprintf(stderr, "\n%s:%d: Assertion failed %s, with message %s, in %s", __FILE__, __LINE__, (B), #A, __func__ );\ + fprintf(stderr, "\n"); \ + libtest::create_core(); \ + assert((A)); \ } \ } while (0) -#define test_true(A) \ +#define test_truth(A) \ do \ { \ if (! (A)) { \ - fprintf(stderr, "\nAssertion failed at %s:%d: %s\n", __FILE__, __LINE__, #A);\ - create_core(); \ + fprintf(stderr, "\n%s:%d: Assertion \"%s\" failed, in %s\n", __FILE__, __LINE__, #A, __func__);\ + libtest::create_core(); \ return TEST_FAILURE; \ } \ } while (0) -#define test_true_got(A,B) \ +#define test_true(A) \ do \ { \ if (! (A)) { \ - fprintf(stderr, "\nAssertion failed at %s:%d: \"%s\" received \"%s\"\n", __FILE__, __LINE__, #A, (B));\ - create_core(); \ + fprintf(stderr, "\n%s:%d: Assertion \"%s\" failed, in %s\n", __FILE__, __LINE__, #A, __func__);\ + libtest::create_core(); \ return TEST_FAILURE; \ } \ } while (0) -#define test_compare(A,B) \ +#define test_true_got(A, B) test_true(A); +#define test_true_hint(A, B) test_true(A); + +#define test_compare_hint(A, B, C) test_compare(A, B); +#define test_compare_got(A, B, C) test_compare(A, B); + +#define test_skip(__expected, __actual) \ do \ { \ - if ((A) != (B)) \ + if (libtest::_compare(__FILE__, __LINE__, __func__, ((__expected)), ((__actual)), false) == false) \ { \ - fprintf(stderr, "\n%s:%d: Expected %s, got %lu\n", __FILE__, __LINE__, #A, (unsigned long)(B)); \ - create_core(); \ - return TEST_FAILURE; \ + return TEST_SKIPPED; \ } \ } while (0) -#define test_skip(A,B) \ +#define test_skip_valgrind() \ do \ { \ - if ((A) != (B)) \ + if (libtest::_in_valgrind(__FILE__, __LINE__, __func__)) \ { \ return TEST_SKIPPED; \ } \ } while (0) -#define test_compare_got(A,B,C) \ +#define test_fail(A) \ do \ { \ - if ((A) != (B)) \ - { \ - fprintf(stderr, "\n%s:%d: Expected %s, got %s\n", __FILE__, __LINE__, #A, (C)); \ - create_core(); \ + if (1) { \ + fprintf(stderr, "\n%s:%d: Failed with %s, in %s\n", __FILE__, __LINE__, #A, __func__);\ + libtest::create_core(); \ return TEST_FAILURE; \ } \ } while (0) + #define test_false(A) \ do \ { \ if ((A)) { \ - fprintf(stderr, "\nAssertion failed at %s:%d: %s\n", __FILE__, __LINE__, #A);\ - create_core(); \ + fprintf(stderr, "\n%s:%d: Assertion failed %s, in %s\n", __FILE__, __LINE__, #A, __func__);\ + libtest::create_core(); \ return TEST_FAILURE; \ } \ } while (0) @@ -274,50 +141,79 @@ do \ do \ { \ if ((A)) { \ - fprintf(stderr, "\nAssertion failed at %s:%d: %s with %s\n", __FILE__, __LINE__, #A, (B));\ - create_core(); \ + fprintf(stderr, "\n%s:%d: Assertion failed %s with %s\n", __FILE__, __LINE__, #A, (B));\ + libtest::create_core(); \ return TEST_FAILURE; \ } \ } while (0) -#define test_strcmp(A,B) \ +#define test_ne_compare(__expected, __actual) \ do \ { \ - if (strcmp((A), (B))) \ + if (libtest::_ne_compare(__FILE__, __LINE__, __func__, ((__expected)), ((__actual)), true) == false) \ { \ - fprintf(stderr, "\n%s:%d: `%s` -> `%s`\n", __FILE__, __LINE__, (A), (B)); \ - create_core(); \ + libtest::create_core(); \ return TEST_FAILURE; \ } \ } while (0) -#define test_memcmp(A,B,C) \ +#define test_compare(__expected, __actual) \ do \ { \ - if (memcmp((A), (B), (C))) \ + if (libtest::_compare(__FILE__, __LINE__, __func__, ((__expected)), ((__actual)), true) == false) \ { \ - fprintf(stderr, "\n%s:%d: %.*s -> %.*s\n", __FILE__, __LINE__, (int)(C), (char *)(A), (int)(C), (char *)(B)); \ - create_core(); \ + libtest::create_core(); \ return TEST_FAILURE; \ } \ } while (0) -#define STRINGIFY(x) #x -#define TOSTRING(x) STRINGIFY(x) -#define AT __FILE__ ":" TOSTRING(__LINE__) +#define test_zero(__actual) \ +do \ +{ \ + if (not libtest::_compare_zero(__FILE__, __LINE__, __func__, ((__actual)))) \ + { \ + libtest::create_core(); \ + return TEST_FAILURE; \ + } \ +} while (0) -#ifdef __cplusplus -#define STRING_WITH_LEN(X) (X), (static_cast((sizeof(X) - 1))) -#else -#define STRING_WITH_LEN(X) (X), ((size_t)((sizeof(X) - 1))) -#endif +#define test_null test_zero -#ifdef __cplusplus -#define STRING_PARAM_WITH_LEN(X) X, static_cast(sizeof(X) - 1) -#else -#define STRING_PARAM_WITH_LEN(X) X, (size_t)((sizeof(X) - 1)) -#endif +#define test_compare_warn(__expected, __actual) \ +do \ +{ \ + void(libtest::_compare(__FILE__, __LINE__, __func__, (__expected), (__actual)), true); \ +} while (0) + +#define test_warn(__truth, __explain) \ +do \ +{ \ + void(libtest::_assert_truth(__FILE__, __LINE__, __func__, bool((__truth)), #__truth, __explain)); \ +} while (0) + +#define test_strcmp(__expected, __actual) \ +do \ +{ \ + void(libtest::_compare_strcmp(__FILE__, __LINE__, __func__, (__expected), (__actual))); \ +} while (0) + +#define test_memcmp(A,B,C) \ +do \ +{ \ + if ((A) == NULL or (B) == NULL or memcmp((A), (B), (C))) \ + { \ + fprintf(stderr, "\n%s:%d: %.*s -> %.*s\n", __FILE__, __LINE__, (int)(C), (char *)(A), (int)(C), (char *)(B)); \ + libtest::create_core(); \ + return TEST_FAILURE; \ + } \ +} while (0) + +#define test_return_if(__test_return_t) \ +do \ +{ \ + if ((__test_return_t) != TEST_SUCCESS) \ + { \ + return __test_return_t; \ + } \ +} while (0) -#ifdef __cplusplus -} -#endif