Skip to content

Test documentation #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Nickelpence wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Test documentation #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c0b7b34
added test documentation implementation
Nickelpence Mar 17, 2024
0af09be
modified reporting of failure
Nickelpence Mar 17, 2024
7f89ba7
Implemented assertion documentation
Nickelpence Mar 20, 2024
ef832b0
Added example to show usage and check expected messages are written t…
Nickelpence Mar 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
all: all-examples

EXAMPLES = ex/example1 ex/example2 ex/example3 ex/example4 \
ex/example5 ex/example6 ex/example7 ex/example8 \
ex/example5 ex/example6 ex/example7 ex/example8 ex/example9 \
'ex ws/example1 ws' 'ex ws/example2 ws' 'ex ws/example3 ws' 'ex ws/example4 ws' \
'ex ws/example5 ws' 'ex ws/example6 ws' 'ex ws/example7 ws' 'ex ws/example8 ws'

Expand Down
115 changes: 68 additions & 47 deletions basic_testing.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,27 +78,33 @@
/* Assertion checks
*/

struct bt_assertion_data {
const char *desc;
};

/* Check for generic Boolean expressions
*/
#define CHECK(expr) do { \
if (!(expr)) { \
printf("\n%s:%d: Assertion '"#expr"' failed\n", \
__FILE__, __LINE__); \
TEST_FAILED; \
} \
#define CHECK(expr, ...) do { \
const struct bt_assertion_data data = { __VA_ARGS__ }; \
if (!(expr)) { \
printf("\n%s:%d: Assertion '"#expr"' failed\n %s\n", \
__FILE__, __LINE__, data.desc); \
TEST_FAILED; \
} \
} while (0)

/* Check for comparison between two C strings based on binary
* relations/operators (==, >=, <=, !=, <, >).
*/
#define CHECK_STRING_CMP(X,OP,Y) do { \
#define CHECK_STRING_CMP(X,OP,Y, ...) do { \
const struct bt_assertion_data data = { __VA_ARGS__ }; \
const char * x_ = (X); \
const char * y_ = (Y); \
if (!(strcmp(x_, y_) OP 0)) { \
printf("\n%s:%d: Assertion '"#X" "#OP" "#Y"' failed: %s "#OP" %s\n", \
__FILE__, __LINE__, x_, y_); \
TEST_FAILED; \
} \
if (!(strcmp(x_, y_) OP 0)) { \
printf("\n%s:%d: Assertion '"#X" "#OP" "#Y"' failed: %s "#OP" %s\n %s\n", \
__FILE__, __LINE__, x_, y_, data.desc); \
TEST_FAILED; \
} \
} while (0)

/* Checks for comparisons based on binary relations/operators (==, >=,
Expand All @@ -107,15 +113,18 @@
*/
#ifdef __cplusplus

#define CHECK_CMP(X,OP,Y) do { \
auto x_ = (X); \
#define CHECK_CMP(X,OP,Y, ...) do { \
const struct bt_assertion_data data = { __VA_ARGS__ }; \
auto x_ = (X); \
decltype (x_) y_ = (Y); \
if (!(x_ OP y_)) { \
std::cout << std::endl <<__FILE__ << ":" << __LINE__ \
if (!(x_ OP y_)) { \
std::cout << std::endl <<__FILE__ << ":" << __LINE__\
<< ": Assertion '"#X" "#OP" "#Y"' failed: " \
<< x_ << " "#OP" " << y_ << std::endl; \
TEST_FAILED; \
} \
<< x_ << " "#OP" " << y_ << std::endl \
<< " " << data.desc << std::endl \
;\
TEST_FAILED; \
} \
} while (0)

#else
Expand Down Expand Up @@ -143,7 +152,7 @@ static enum bt_cmp_operator bt_operator (const char * op) {
BT_POSSIBLY_UNUSED
static int check_cmp_int (int x, int y, const char * op,
const char * x_str, const char * y_str,
const char * filename, int line) {
const char * filename, int line, const char* desc) {
int res;
switch (bt_operator(op)) {
case BT_EQ: res = (x == y); break;
Expand All @@ -155,15 +164,15 @@ static int check_cmp_int (int x, int y, const char * op,
default: res = 0;
}
if (!res)
printf("\n%s:%d: Assertion '%s %s %s' failed: %d %s %d\n", \
filename, line, x_str, op, y_str, x, op, y);
printf("\n%s:%d: Assertion '%s %s %s' failed: %d %s %d\n %s\n", \
filename, line, x_str, op, y_str, x, op, y, desc);
return res;
}

BT_POSSIBLY_UNUSED
static int check_cmp_uint (unsigned int x, unsigned int y, const char * op,
const char * x_str, const char * y_str,
const char * filename, int line) {
const char * filename, int line, const char* desc) {
int res;
switch (bt_operator(op)) {
case BT_EQ: res = (x == y); break;
Expand All @@ -175,15 +184,15 @@ static int check_cmp_uint (unsigned int x, unsigned int y, const char * op,
default: res = 0;
}
if (!res)
printf("\n%s:%d: Assertion '%s %s %s' failed: %u %s %u\n", \
filename, line, x_str, op, y_str, x, op, y);
printf("\n%s:%d: Assertion '%s %s %s' failed: %u %s %u\n %s\n", \
filename, line, x_str, op, y_str, x, op, y, desc);
return res;
}

BT_POSSIBLY_UNUSED
static int check_cmp_double (double x, double y, const char * op,
const char * x_str, const char * y_str,
const char * filename, int line) {
const char * filename, int line, const char* desc) {
int res;
switch (bt_operator(op)) {
case BT_EQ: res = (x == y); break;
Expand All @@ -195,28 +204,29 @@ static int check_cmp_double (double x, double y, const char * op,
default: res = 0;
}
if (!res)
printf("\n%s:%d: Assertion '%s %s %s' failed: %f %s %f\n", \
filename, line, x_str, op, y_str, x, op, y);
printf("\n%s:%d: Assertion '%s %s %s' failed: %f %s %f\n %s\n", \
filename, line, x_str, op, y_str, x, op, y, desc);
return res;
}

#define CHECK_CMP(X,OP,Y) do { \
#define CHECK_CMP(X,OP,Y, ...) do { \
const struct bt_assertion_data data = { __VA_ARGS__ }; \
if (! _Generic ((Y), \
int : check_cmp_int, \
unsigned int : check_cmp_uint, \
double : check_cmp_double) \
((X),(Y),#OP,#X,#Y,__FILE__,__LINE__)) { \
int : check_cmp_int, \
unsigned int : check_cmp_uint, \
double : check_cmp_double) \
((X),(Y),#OP,#X,#Y,__FILE__,__LINE__, data.desc)) { \
TEST_FAILED; \
} \
} \
} while (0)

#endif /* C++/C */

#define CHECK_UINT_CMP(X,OP,Y) CHECK_CMP(X,OP,Y)
#define CHECK_UINT_CMP(X,OP,Y, ...) CHECK_CMP(X,OP,Y, __VA_ARGS__)

#define CHECK_INT_CMP(X,OP,Y) CHECK_CMP(X,OP,Y)
#define CHECK_INT_CMP(X,OP,Y, ...) CHECK_CMP(X,OP,Y, __VA_ARGS__)

#define CHECK_DOUBLE_CMP(X,OP,Y) CHECK_CMP(X,OP,Y)
#define CHECK_DOUBLE_CMP(X,OP,Y, ...) CHECK_CMP(X,OP,Y, __VA_ARGS__)



Expand All @@ -229,11 +239,16 @@ static unsigned int bt_timeout = 3; /* three seconds */
BT_POSSIBLY_UNUSED
static int bt_verbose = 1;

struct bt_test_additional_data {
const char *description;
};

struct bt_test_descriptor {
const char * name;
int (*test_function)();
const char * file;
int line;
struct bt_test_additional_data *data;
struct bt_test_descriptor * next;
};

Expand All @@ -249,19 +264,23 @@ static int bt_add_test(struct bt_test_descriptor * t) {
}

#ifdef __cplusplus
#define TEST(test_name) \
BT_POSSIBLY_UNUSED static int test_name ## _test (); \
#define TEST(test_name, ...) \
BT_POSSIBLY_UNUSED static int test_name ## _test (); \
BT_POSSIBLY_UNUSED static struct bt_test_additional_data test_name ## _data \
= { __VA_ARGS__ }; \
BT_POSSIBLY_UNUSED static struct bt_test_descriptor test_name ## _descr \
= { # test_name, test_name ## _test, __FILE__, __LINE__, 0}; \
BT_POSSIBLY_UNUSED static struct bt_test_descriptor * test_name = & test_name ## _descr; \
= { # test_name, test_name ## _test, __FILE__, __LINE__, & test_name ## _data, 0}; \
BT_POSSIBLY_UNUSED static struct bt_test_descriptor * test_name = & test_name ## _descr;\
BT_POSSIBLY_UNUSED static const int test_name ## _init = bt_add_test(test_name); \
BT_POSSIBLY_UNUSED static int test_name ## _test ()
#else
#define TEST(test_name) \
BT_POSSIBLY_UNUSED static int test_name ## _test (); \
#define TEST(test_name, ...) \
BT_POSSIBLY_UNUSED static int test_name ## _test (); \
BT_POSSIBLY_UNUSED static struct bt_test_additional_data test_name ## _data \
= { __VA_ARGS__ }; \
BT_POSSIBLY_UNUSED static struct bt_test_descriptor test_name ## _descr \
= { # test_name, test_name ## _test, __FILE__, __LINE__, 0}; \
BT_POSSIBLY_UNUSED static struct bt_test_descriptor * test_name = & test_name ## _descr; \
= { # test_name, test_name ## _test, __FILE__, __LINE__, & test_name ## _data, 0}; \
BT_POSSIBLY_UNUSED static struct bt_test_descriptor * test_name = & test_name ## _descr;\
BT_POSSIBLY_UNUSED static int test_name ## _test ()
#endif

Expand Down Expand Up @@ -349,8 +368,10 @@ static void bt_run_and_record_test(const struct bt_test_descriptor * t) {
switch (bt_run_test(t)) {
case BT_FAILURE:
bt_fail_count += 1;
if (bt_verbose)
printf("test %-40s FAIL\n", t->name);
if (bt_verbose) {
printf("FAIL\n");
if (t->data->description) printf(" %s\n", t->data->description);
}
break;
case BT_SUCCESS:
bt_pass_count += 1;
Expand Down
18 changes: 18 additions & 0 deletions ex/example9.expected
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
Running test test0...
tests/test0.c:12: Assertion '0 == 1' failed
This assertion should fail

tests/test0.c:17: Assertion '"str1" == "str2"' failed: str1 == str2
This string comparison should fail

tests/test0.c:23: Assertion 'a != a' failed: 0 != 0
This integer comparison should fail

tests/test0.c:29: Assertion 'a != a' failed: 0 != 0
This uint assertion should fail

tests/test0.c:35: Assertion 'a != a' failed: 0.000000 != 0.000000
This double assertion should fail
FAIL
run 'tests/test0' to see what went wrong
run 'tests/test0 -d' with a debugger
3 changes: 3 additions & 0 deletions ex/example9/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
OBJECTS =

include ../../basic_testing.mk
41 changes: 41 additions & 0 deletions ex/example9/tests/test0.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
#include "basic_testing.h"

TEST(test_no_doc) {
TEST_FAILED;
}

TEST(test_doc, .description="Test description") {
TEST_FAILED;
}

TEST(check_doc) {
CHECK(0 == 1, .desc="This assertion should fail");
TEST_FAILED;
}

TEST(check_str_cmp_doc) {
CHECK_STRING_CMP("str1", ==, "str2", .desc="This string comparison should fail");
TEST_FAILED;
}

TEST(check_cmp_int_doc) {
int a = 0;
CHECK_CMP(a, !=, a, .desc="This integer comparison should fail");
TEST_FAILED;
}

TEST(check_cmp_uint_doc) {
unsigned int a = 0;
CHECK_CMP(a, !=, a, .desc="This uint assertion should fail");
TEST_FAILED;
}

TEST(check_cmp_double_doc) {
double a = 0.0;
CHECK_CMP(a, !=, a, .desc="This double assertion should fail");
TEST_FAILED;
}

MAIN_TEST_DRIVER(test_no_doc, test_doc, check_doc, check_str_cmp_doc,
check_cmp_int_doc, check_cmp_uint_doc, check_cmp_double_doc
)