test.h File Reference

#include <stdbool.h>

Include dependency graph for test.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	test_t

Macros
#define	TEST_EQUAL_EPSILON   0.1
#define	TEST_ERROR_DELTA_PERCENT   5
#define	TEST(NAME, BODY)
#define	ASSERT(BOOL, OK, ERR)   test_assert(T, OK, ERR, BOOL)
#define	ASSERT_OK(BOOL, LABEL)    ASSERT(BOOL, LABEL " is okay", LABEL " is not okay")
#define	ASSERT_EQ(GOT, WANT, GOT_LABEL, WANT_LABEL)    test_assert_equal(T, GOT_LABEL, WANT_LABEL, GOT, WANT)
#define	ASSERT_IN_ERROR(GOT, WANT, GOT_LABEL, WANT_LABEL)    test_assert_within_error(T, GOT_LABEL, WANT_LABEL, GOT, WANT)

Functions
test_t *	test_start (const char *name)
void	test_end (test_t *t)
void	test_assert (test_t *t, const char *pass_message, const char *fail_message, bool passes)
void	test_assert_equal (test_t *t, const char *a_label, const char *b_label, float a, float b)
void	test_assert_within_error (test_t *t, const char *actual_label, const char *expected_label, float actual, float expected)

Macro Definition Documentation

ASSERT

#define ASSERT	(		BOOL,
			OK,
			ERR
	)		test_assert(T, OK, ERR, BOOL)

Definition at line 27 of file test.h.

ASSERT_EQ

#define ASSERT_EQ	(		GOT,
			WANT,
			GOT_LABEL,
			WANT_LABEL
	)		test_assert_equal(T, GOT_LABEL, WANT_LABEL, GOT, WANT)

Definition at line 32 of file test.h.

ASSERT_IN_ERROR

#define ASSERT_IN_ERROR	(		GOT,
			WANT,
			GOT_LABEL,
			WANT_LABEL
	)		test_assert_within_error(T, GOT_LABEL, WANT_LABEL, GOT, WANT)

Definition at line 35 of file test.h.

ASSERT_OK

#define ASSERT_OK	(		BOOL,
			LABEL
	)		ASSERT(BOOL, LABEL " is okay", LABEL " is not okay")

Definition at line 29 of file test.h.

TEST

#define TEST	(		NAME,
			BODY
	)

Value:

  {                                                                            \
    test_t *T = test_start(#NAME);                                             \
    BODY test_end(T);                                                          \
  }

Definition at line 19 of file test.h.

TEST_EQUAL_EPSILON

#define TEST_EQUAL_EPSILON   0.1

Definition at line 7 of file test.h.

TEST_ERROR_DELTA_PERCENT

#define TEST_ERROR_DELTA_PERCENT   5

Definition at line 11 of file test.h.

Function Documentation

test_assert()

void test_assert	(	test_t *	t,
		const char *	pass_message,
		const char *	fail_message,
		bool	passes
	)

Definition at line 33 of file test.c.

                              {
  if (passes) {
    printf(TEST_OK "%s %s\n", t->name, pass_message);
  } else {
    printf(TEST_ERR "%s %s\n", t->name, fail_message);
  }
 
  t->passes &= passes;
}

test_assert_equal()

void test_assert_equal	(	test_t *	t,
		const char *	a_label,
		const char *	b_label,
		float	a,
		float	b
	)

Definition at line 44 of file test.c.

                                         {
  bool passes = fabs(a - b) < TEST_EQUAL_EPSILON;
  if (passes) {
    printf(TEST_OK "%s %s = %s (%f = %f)\n", t->name, a_label, b_label, a, b);
  } else {
    printf(TEST_ERR "%s %s ≠ %s (%f ≠ %f)\n", t->name, a_label, b_label, a, b);
  }
 
  t->passes &= passes;
}

test_assert_within_error()

void test_assert_within_error	(	test_t *	t,
		const char *	actual_label,
		const char *	expected_label,
		float	actual,
		float	expected
	)

Definition at line 56 of file test.c.

                                              {
  float percent_error = (actual - expected) / expected * 100;
  bool passes = fabs(percent_error) < TEST_ERROR_DELTA_PERCENT;
  if (passes) {
    printf(TEST_OK "%s %s ≈ %s (%f ≈ %f)\n", t->name, actual_label,
           expected_label, actual, expected);
  } else {
    printf(TEST_ERR "%s %s ≠ %s (%f ≠ %f)\n", t->name, actual_label,
           expected_label, actual, expected);
  }
 
  t->passes &= passes;
}

test_end()

void test_end

(

test_t *

t

)

Definition at line 22 of file test.c.

                         {
  if (t->passes) {
    printf(TEST_PASS "%s all passed\n\n", t->name);
  } else {
    printf(TEST_FAIL "%s failed\n\n", t->name);
  }
 
  // NOTE If t->name is copied in test_start, it needs to be freed
  free(t);
}

test_start()

test_t * test_start

(

const char *

name

)

Definition at line 9 of file test.c.

                                     {
  test_t *t = malloc(sizeof(test_t));
  assert(t != NULL);
 
  // TODO strncpy?
  t->name = name;
  t->passes = true;
 
  printf(TEST_START "%s\n", t->name);
 
  return t;
}