-/* uTest
- * Copyright (C) 2011 Data Differential, http://datadifferential.com/
- * 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.
-*/
-
-#include <stdio.h>
-#include <stdlib.h>
-#include <stdbool.h>
-#include <stdint.h>
-#include <libtest/visibility.h>
#pragma once
-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 */
-};
-
-#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
-}
+#ifndef __INTEL_COMPILER
+#pragma GCC diagnostic ignored "-Wold-style-cast"
#endif
/**
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;
- struct test_st *tests;
-};
-
-
-/**
- Structure which houses the actual callers for the test cases contained in
- the collections.
-*/
-struct world_runner_st {
- test_callback_runner_fn *pre;
- test_callback_runner_fn *run;
- test_callback_runner_fn *post;
-};
-
-
-/**
- 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;
-
- /* This is called a the beginning of any collection run. */
- test_callback_fn *collection_startup;
-
- /* This is called a the end of any collection run. */
- test_callback_fn *collection_shutdown;
-
- /* This is called a the beginning of any run. */
- test_callback_fn *run_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;
-
- /**
- 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&);
-};
-
-
-
-/**
- @note world_stats_st is a simple structure for tracking test successes.
-*/
-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() :
- 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
-
-/* 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_INTERNAL_API
-const char *test_strerror(test_return_t code);
-
#define test_assert_errno(A) \
do \
{ \
if ((A)) { \
- fprintf(stderr, "\nAssertion failed at %s:%d: ", __FILE__, __LINE__);\
+ fprintf(stderr, "\n%s:%d: Assertion failed for %s: ", __FILE__, __LINE__, __func__);\
perror(#A); \
fprintf(stderr, "\n"); \
- create_core(); \
+ libtest::create_core(); \
+ assert((A)); \
+ } \
+} while (0)
+
+#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)
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)
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_got(__expected, __hint) \
do \
{ \
- if (! (A)) { \
- fprintf(stderr, "\nAssertion failed at %s:%d: \"%s\" received \"%s\"\n", __FILE__, __LINE__, #A, (B));\
- create_core(); \
+ 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
#define test_skip(A,B) \
do \
do \
{ \
if (1) { \
- fprintf(stderr, "\nFailed at %s:%d: %s\n", __FILE__, __LINE__, #A);\
- create_core(); \
+ fprintf(stderr, "\n%s:%d: Failed with %s, in %s\n", __FILE__, __LINE__, #A, __func__);\
+ libtest::create_core(); \
return TEST_FAILURE; \
} \
} while (0)
do \
{ \
if ((A)) { \
- fprintf(stderr, "\nAssertion failed in %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)
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_compare(__expected, __actual) \
+do \
+{ \
+ if (not libtest::_compare(__FILE__, __LINE__, __func__, ((__expected)), ((__actual)))) \
+ { \
+ libtest::create_core(); \
+ return TEST_FAILURE; \
+ } \
+} while (0)
-#define test_compare(A,B) \
+#define test_zero(__actual) \
do \
{ \
- if ((A) != (B)) \
+ if (not libtest::_compare_zero(__FILE__, __LINE__, __func__, ((__actual)))) \
{ \
- fprintf(stderr, "\n%s:%d: Expected %s, got %lu\n", __FILE__, __LINE__, #A, (unsigned long)(B)); \
- create_core(); \
+ libtest::create_core(); \
return TEST_FAILURE; \
} \
} while (0)
-#define test_compare_got(A,B,C) \
+#define test_null test_zero
+
+#define test_compare_got(__expected, __actual, __hint) \
do \
{ \
- if ((A) != (B)) \
+ if (not libtest::_compare_hint(__FILE__, __LINE__, __func__, (__expected), (__actual), (__hint))) \
{ \
- fprintf(stderr, "\n%s:%d: Expected %s, got %s\n", __FILE__, __LINE__, #A, (C)); \
- create_core(); \
+ 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))); \
+} while (0)
+
+#define test_compare_warn_hint(__expected, __actual, __hint) \
+do \
+{ \
+ libtest::_compare_hint(__FILE__, __LINE__, __func__, (__expected), (__actual), (__hint)); \
+} while (0)
+
+#define test_warn(__truth) \
+do \
+{ \
+ void(libtest::_truth(__FILE__, __LINE__, __func__, (__truth))); \
+} while (0)
+
+#define test_warn_hint(__truth, __hint) \
+do \
+{ \
+ void(libtest::_compare_truth_hint(__FILE__, __LINE__, __func__, (__truth), #__truth, (__hint))); \
+} while (0)
+
#define test_strcmp(A,B) \
do \
{ \
- if (strcmp((A), (B))) \
+ if ((A) == NULL or (B) == NULL or strcmp((A), (B))) \
{ \
- fprintf(stderr, "\n%s:%d: Expected %s, got %s\n", __FILE__, __LINE__, (A), (B)); \
- create_core(); \
+ 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_memcmp(A,B,C) \
do \
{ \
- if (memcmp((A), (B), (C))) \
+ 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)); \
- create_core(); \
+ libtest::create_core(); \
return TEST_FAILURE; \
} \
} while (0)
-#ifdef __cplusplus
-}
-#endif
+#define test_memcmp_hint(A,B,C,__hint) \
+do \
+{ \
+ 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)
-#ifdef __cplusplus
-#define test_literal_param(X) (X), (static_cast<size_t>((sizeof(X) - 1)))
-#else
-#define test_literal_param(X) (X), ((size_t)((sizeof(X) - 1)))
-#endif
+#define test_return_if(__test_return_t) \
+do \
+{ \
+ if ((__test_return_t) != TEST_SUCCESS) \
+ { \
+ return __test_return_t; \
+ } \
+} while (0)
-#define test_string_make_from_cstr(X) (X), ((X) ? strlen(X) : 0)