-/* uTest
- * Copyright (C) 2006-2009 Brian Aker
- * All rights reserved.
+/* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
+ *
+ * libtest
*
- * Use and distribution licensed under the BSD license. See
- * the COPYING file in the parent directory for full text.
+ * Copyright (C) 2011 Data Differential, http://datadifferential.com/
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
-/*
- Structures for generic tests.
-*/
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-#include <stdio.h>
-#include <stdlib.h>
-#include <stdint.h>
+#pragma once
-#if !defined(__cplusplus)
-# include <stdbool.h>
+#ifndef __INTEL_COMPILER
+#pragma GCC diagnostic ignored "-Wold-style-cast"
#endif
-typedef struct world_st world_st;
-typedef struct collection_st collection_st;
-typedef struct test_st test_st;
-
-typedef enum {
- TEST_SUCCESS= 0, /* Backwards compatibility */
- TEST_FAILURE,
- TEST_MEMORY_ALLOCATION_FAILURE,
- TEST_SKIPPED,
- 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 *);
-
-/* Help function for use with gettimeofday() */
-long int timedif(struct timeval a, struct timeval b);
-
/**
A structure describing the test case.
*/
struct test_st {
const char *name;
bool requires_flush;
- test_callback_fn test_fn;
+ 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)
-/**
- 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;
-};
-
+#define test_assert(A, B) \
+do \
+{ \
+ 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)
-/**
- 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;
+#define test_truth(A) \
+do \
+{ \
+ if (! (A)) { \
+ 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(A) \
+do \
+{ \
+ if (! (A)) { \
+ fprintf(stderr, "\n%s:%d: Assertion \"%s\" failed, in %s\n", __FILE__, __LINE__, #A, __func__);\
+ libtest::create_core(); \
+ return TEST_FAILURE; \
+ } \
+} while (0)
-/**
- 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.
-*/
+#define test_true_got(__expected, __hint) \
+do \
+{ \
+ if (not libtest::_compare_truth_hint(__FILE__, __LINE__, __func__, ((__expected)), #__expected, ((__hint)))) \
+ { \
+ libtest::create_core(); \
+ return TEST_FAILURE; \
+ } \
+} while (0)
+#define test_true_hint test_true_got
-struct world_st {
- collection_st *collections;
+#define test_skip(__expected, __actual) \
+do \
+{ \
+ if (libtest::_compare(__FILE__, __LINE__, __func__, ((__expected)), ((__actual)), false) == false) \
+ { \
+ return TEST_SKIPPED; \
+ } \
+} while (0)
- /* These methods are called outside of any collection call. */
- test_callback_create_fn create;
- test_callback_fn destroy;
+#define test_skip_valgrind() \
+do \
+{ \
+ if (libtest::_in_valgrind(__FILE__, __LINE__, __func__)) \
+ { \
+ return TEST_SKIPPED; \
+ } \
+} while (0)
- struct {
- /* This is called a the beginning of any test run. */
- test_callback_fn startup;
+#define test_fail(A) \
+do \
+{ \
+ 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)
- /* 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;
+#define test_false(A) \
+do \
+{ \
+ if ((A)) { \
+ fprintf(stderr, "\n%s:%d: Assertion failed %s, in %s\n", __FILE__, __LINE__, #A, __func__);\
+ libtest::create_core(); \
+ return TEST_FAILURE; \
+ } \
+} while (0)
- /**
- If an error occurs during the test, this is called.
- */
- test_callback_error_fn on_error;
- } test;
+#define test_false_with(A,B) \
+do \
+{ \
+ if ((A)) { \
+ fprintf(stderr, "\n%s:%d: Assertion failed %s with %s\n", __FILE__, __LINE__, #A, (B));\
+ libtest::create_core(); \
+ return TEST_FAILURE; \
+ } \
+} while (0)
- struct {
- /* This is called a the beginning of any collection run. */
- test_callback_fn startup;
+#define test_compare(__expected, __actual) \
+do \
+{ \
+ if (libtest::_compare(__FILE__, __LINE__, __func__, ((__expected)), ((__actual)), true) == false) \
+ { \
+ libtest::create_core(); \
+ return TEST_FAILURE; \
+ } \
+} while (0)
- /* This is called at the end of any collection run. */
- test_callback_fn shutdown;
- } collection;
+#define test_zero(__actual) \
+do \
+{ \
+ if (not libtest::_compare_zero(__FILE__, __LINE__, __func__, ((__actual)))) \
+ { \
+ libtest::create_core(); \
+ return TEST_FAILURE; \
+ } \
+} while (0)
+#define test_null test_zero
- /**
- Runner represents the callers for the tests. If not implemented we will use
- a set of default implementations.
- */
- world_runner_st *runner;
-};
+#define test_compare_got(__expected, __actual, __hint) \
+do \
+{ \
+ if (not libtest::_compare_hint(__FILE__, __LINE__, __func__, (__expected), (__actual), (__hint))) \
+ { \
+ libtest::create_core(); \
+ return TEST_FAILURE; \
+ } \
+} while (0)
+#define test_compare_hint test_compare_got
+#define test_compare_warn(__expected, __actual) \
+do \
+{ \
+ void(libtest::_compare(__FILE__, __LINE__, __func__, (__expected), (__actual)), true); \
+} 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;
-
-/* How we make all of this work :) */
-void get_world(world_st *world);
-
-void create_core(void);
+#define test_compare_warn_hint(__expected, __actual, __hint) \
+do \
+{ \
+ libtest::_compare_hint(__FILE__, __LINE__, __func__, (__expected), (__actual), (__hint)); \
+} while (0)
-/**
- @note Friendly print function for errors.
-*/
-const char *test_strerror(test_return_t code);
+#define test_warn(__truth) \
+do \
+{ \
+ void(libtest::_truth(__FILE__, __LINE__, __func__, (__truth))); \
+} while (0)
-#define test_fail(A) \
+#define test_warn_hint(__truth, __hint) \
do \
{ \
- if (1) { \
- fprintf(stderr, "\nFailed at %s:%d: %s\n", __FILE__, __LINE__, #A);\
- create_core(); \
- return TEST_FAILURE; \
- } \
+ void(libtest::_compare_truth_hint(__FILE__, __LINE__, __func__, (__truth), #__truth, (__hint))); \
} while (0)
-#define test_true(A) \
+
+#define test_strcmp(A,B) \
do \
{ \
- if (! (A)) { \
- fprintf(stderr, "\nAssertion failed at %s:%d: %s\n", __FILE__, __LINE__, #A);\
- create_core(); \
+ if ((A) == NULL or (B) == NULL or strcmp((A), (B))) \
+ { \
+ if ((B) == NULL) fprintf(stderr, "\n%s:%d: Expected %s, got <null>\n", __FILE__, __LINE__, (A)); \
+ else fprintf(stderr, "\n%s:%d: Expected %s, got \"%s\"\n", __FILE__, __LINE__, (A), (B)); \
+ libtest::create_core(); \
return TEST_FAILURE; \
} \
} while (0)
-#define test_true_got(A,B) \
+#define test_memcmp(A,B,C) \
do \
{ \
- if (! (A)) { \
- fprintf(stderr, "\nAssertion failed at %s:%d: \"%s\" received \"%s\"\n", __FILE__, __LINE__, #A, (B));\
- create_core(); \
+ 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_false(A) \
+#define test_memcmp_hint(A,B,C,__hint) \
do \
{ \
- if ((A)) { \
- fprintf(stderr, "\nAssertion failed at %s:%d: %s\n", __FILE__, __LINE__, #A);\
- create_core(); \
+ if ((A) == NULL or (B) == NULL or memcmp((A), (B), (C))) \
+ { \
+ fprintf(stderr, "\n%s:%d: (hint:%s) %.*s -> %.*s\n", __FILE__, __LINE__, __hint, (int)(C), (char *)(A), (int)(C), (char *)(B)); \
+ libtest::create_core(); \
return TEST_FAILURE; \
} \
} while (0)
-#define test_strcmp(A,B) \
+#define test_return_if(__test_return_t) \
do \
{ \
- if (strcmp((A), (B))) \
+ if ((__test_return_t) != TEST_SUCCESS) \
{ \
- fprintf(stderr, "\n%s:%d: %s -> %s\n", __FILE__, __LINE__, (A), (B)); \
- create_core(); \
- return TEST_FAILURE; \
+ return __test_return_t; \
} \
} while (0)
-#ifdef __cplusplus
-}
-#endif