1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
|
/* uTest
* 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.
*/
/*
Structures for generic tests.
*/
#ifdef __cplusplus
extern "C" {
#endif
#include <stdio.h>
#include <stdlib.h>
#include <stdbool.h>
#include <stdint.h>
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 *);
/**
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;
/* This is called a the beginning of any collection run. */
test_callback_fn collection_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;
};
/**
@note world_stats_st is a simple structure for tracking test successes.
*/
typedef struct {
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);
/**
@note Friendly print function for errors.
*/
const char *test_strerror(test_return_t code);
#define test_truth(A) \
do \
{ \
if (! (A)) { \
fprintf(stderr, "\nAssertion failed in %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 in %s:%d: %s\n", __FILE__, __LINE__, #A);\
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)); \
create_core(); \
return TEST_FAILURE; \
} \
} while (0)
#ifdef __cplusplus
}
#endif
|