X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=libtest%2Ftest.h;h=d6d7d787c616d9386db6fbea19f15e22aa2144ff;hb=9fd31c03436acf24c593dc3a77c905eb137ef570;hp=656be1698967f36f92c0d50b6aefbb5b99e4cee0;hpb=ae6bc7501efd5aeaaee92dabe2da0ec2d1625c5b;p=awesomized%2Flibmemcached diff --git a/libtest/test.h b/libtest/test.h index 656be169..d6d7d787 100644 --- a/libtest/test.h +++ b/libtest/test.h @@ -1,73 +1,45 @@ -/* 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. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are - * met: - * - * * Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * - * * Redistributions in binary form must reproduce the above - * copyright notice, this list of conditions and the following disclaimer - * in the documentation and/or other materials provided with the - * distribution. - * - * * The names of its contributors may not be used to endorse or - * promote products derived from this software without specific prior - * written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +/* uTest + * Copyright (C) 2011 Data Differential, http://datadifferential.com/ + * Copyright (C) 2006-2009 Brian Aker + * All rights reserved. * + * Use and distribution licensed under the BSD license. See + * the COPYING file in the parent directory for full text. */ -#pragma once - -#include - /* Structures for generic tests. */ #include #include +#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; +#pragma once -typedef enum { +enum test_return_t { TEST_SUCCESS= 0, /* 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 */ -} test_return_t; +}; -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 *); +#ifdef __cplusplus +extern "C" { +#endif + +typedef void* (test_callback_create_fn)(enum test_return_t*); +typedef enum test_return_t (test_callback_fn)(void *); +typedef enum test_return_t (test_callback_runner_fn)(test_callback_fn*, void *); +typedef enum test_return_t (test_callback_error_fn)(const enum test_return_t, void *); + +#ifdef __cplusplus +} +#endif /** A structure describing the test case. @@ -75,7 +47,7 @@ typedef test_return_t (*test_callback_error_fn)(test_return_t, void *); struct test_st { const char *name; bool requires_flush; - test_callback_fn test_fn; + test_callback_fn *test_fn; }; @@ -84,9 +56,9 @@ struct test_st { */ struct collection_st { const char *name; - test_callback_fn pre; - test_callback_fn post; - test_st *tests; + test_callback_fn *pre; + test_callback_fn *post; + struct test_st *tests; }; @@ -94,11 +66,11 @@ struct collection_st { 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; +struct world_runner_st { + test_callback_runner_fn *pre; + test_callback_runner_fn *run; + test_callback_runner_fn *post; +}; /** @@ -111,43 +83,59 @@ 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; + test_callback_create_fn *create; + test_callback_fn *destroy; - /* This called on a test if the test requires a flush call (the bool is from test_st) */ - test_callback_fn flush; + /* This is called a the beginning of any collection run. */ + test_callback_fn *collection_startup; - /** - 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; + /* This is called a the end of any collection run. */ + test_callback_fn *collection_shutdown; - /** - If an error occurs during the test, this is called. - */ - test_callback_error_fn on_error; - } test; + /* This is called a the beginning of any run. */ + test_callback_fn *run_startup; - struct { - /* This is called a the beginning of any collection 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; - /* This is called at the end of any collection run. */ - test_callback_fn shutdown; - } collection; + /** + 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; /** Runner represents the callers for the tests. If not implemented we will use a set of default implementations. */ world_runner_st *runner; + + world_st() : + collections(NULL), + create(NULL), + destroy(NULL), + collection_startup(NULL), + collection_shutdown(NULL), + run_startup(NULL), + flush(NULL), + pre_run(NULL), + post_run(NULL), + on_error(NULL), + runner(NULL) + { } + + virtual ~world_st() + { } + +private: + world_st(const world_st&); + world_st& operator=(const world_st&); }; @@ -155,25 +143,37 @@ struct world_st { /** @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; +struct world_stats_st { + int32_t collection_success; + int32_t collection_skipped; + int32_t collection_failed; + int32_t collection_total; + uint32_t success; uint32_t skipped; uint32_t failed; uint32_t total; -} world_stats_st; + + world_stats_st() : + collection_success(0), + collection_skipped(0), + collection_failed(0), + collection_total(0), + success(0), + skipped(0), + failed(0), + total(0) + { } +}; + +#define TEST_STRINGIFY(x) #x +#define TEST_TOSTRING(x) TEST_STRINGIFY(x) +#define TEST_AT __FILE__ ":" TEST_TOSTRING(__LINE__) #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); @@ -184,14 +184,26 @@ void create_core(void); /** @note Friendly print function for errors. */ -LIBTEST_API +LIBTEST_INTERNAL_API const char *test_strerror(test_return_t code); -#define test_fail(A) \ +#define test_assert_errno(A) \ do \ { \ - if (1) { \ - fprintf(stderr, "\nFailed at %s:%d: %s\n", __FILE__, __LINE__, #A);\ + if ((A)) { \ + fprintf(stderr, "\nAssertion failed at %s:%d: ", __FILE__, __LINE__);\ + perror(#A); \ + fprintf(stderr, "\n"); \ + create_core(); \ + assert((A)); \ + } \ +} while (0) + +#define test_truth(A) \ +do \ +{ \ + if (! (A)) { \ + fprintf(stderr, "\nAssertion failed at %s:%d: %s\n", __FILE__, __LINE__, #A);\ create_core(); \ return TEST_FAILURE; \ } \ @@ -217,22 +229,31 @@ do \ } \ } while (0) -#define test_compare(A,B) \ +#define test_skip(A,B) \ do \ { \ if ((A) != (B)) \ { \ - fprintf(stderr, "\n%s:%d: Expected %lu == %lu\n", __FILE__, __LINE__, (unsigned long)(A), (unsigned long)(B)); \ + return TEST_SKIPPED; \ + } \ +} while (0) + +#define test_fail(A) \ +do \ +{ \ + if (1) { \ + fprintf(stderr, "\nFailed at %s:%d: %s\n", __FILE__, __LINE__, #A);\ 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);\ + fprintf(stderr, "\nAssertion failed in %s:%d: %s\n", __FILE__, __LINE__, #A);\ create_core(); \ return TEST_FAILURE; \ } \ @@ -248,12 +269,36 @@ do \ } \ } while (0) + +#define test_compare(A,B) \ +do \ +{ \ + if ((A) != (B)) \ + { \ + fprintf(stderr, "\n%s:%d: Expected %s, got %lu\n", __FILE__, __LINE__, #A, (unsigned long)(B)); \ + create_core(); \ + return TEST_FAILURE; \ + } \ +} while (0) + +#define test_compare_got(A,B,C) \ +do \ +{ \ + if ((A) != (B)) \ + { \ + fprintf(stderr, "\n%s:%d: Expected %s, got %s\n", __FILE__, __LINE__, #A, (C)); \ + create_core(); \ + return TEST_FAILURE; \ + } \ +} while (0) + + #define test_strcmp(A,B) \ do \ { \ if (strcmp((A), (B))) \ { \ - fprintf(stderr, "\n%s:%d: `%s` -> `%s`\n", __FILE__, __LINE__, (A), (B)); \ + fprintf(stderr, "\n%s:%d: Expected %s, got %s\n", __FILE__, __LINE__, (A), (B)); \ create_core(); \ return TEST_FAILURE; \ } \ @@ -270,22 +315,14 @@ do \ } \ } while (0) -#define STRINGIFY(x) #x -#define TOSTRING(x) STRINGIFY(x) -#define AT __FILE__ ":" TOSTRING(__LINE__) - -#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))) +#ifdef __cplusplus +} #endif #ifdef __cplusplus -#define STRING_PARAM_WITH_LEN(X) X, static_cast(sizeof(X) - 1) +#define test_literal_param(X) (X), (static_cast((sizeof(X) - 1))) #else -#define STRING_PARAM_WITH_LEN(X) X, (size_t)((sizeof(X) - 1)) +#define test_literal_param(X) (X), ((size_t)((sizeof(X) - 1))) #endif -#ifdef __cplusplus -} -#endif +#define test_string_make_from_cstr(X) (X), ((X) ? strlen(X) : 0)