test.qh File Reference

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

Go to the source code of this file.

Macros
#define	_TEST_ASSERT(statement)
#define	ADD_FAILURE(msg)
	Add a failure, but continue.
#define	ASSERT_EQ(expected, actual)
#define	ASSERT_FALSE(condition)
#define	ASSERT_GE(val1, val2)
#define	ASSERT_GT(val1, val2)
#define	ASSERT_LE(val1, val2)
#define	ASSERT_LT(val1, val2)
#define	ASSERT_NE(val1, val2)
#define	ASSERT_NO_FATAL_FAILURE(statement)
#define	ASSERT_TRUE(condition)
#define	EXPECT_EQ(expected_, actual_)
#define	EXPECT_FALSE(condition)
#define	EXPECT_GE(val1, val2)
#define	EXPECT_GT(val1, val2)
#define	EXPECT_LE(val1, val2)
#define	EXPECT_LT(val1, val2)
#define	EXPECT_NE(val1, val2)
#define	EXPECT_NO_FATAL_FAILURE(statement)
#define	EXPECT_NO_FATAL_FAILURE_(statement, then)
#define	EXPECT_NO_FATAL_FAILURE__(statement, then)
#define	EXPECT_TRUE(condition)
#define	FAIL(msg)
	Add a failure and return.
#define	HasFatalFailure()
#define	SUCCEED()
	Must be present at the end of a test.
#define	TEST(suite, test)
	Use UpperCamelCase for suite and test only.

Functions
bool	RUN_ALL_TESTS ()
bool	TEST_Run (string test)

Variables
int	TEST_failed
int	TEST_fatal
bool	TEST_ok

Macro Definition Documentation

_TEST_ASSERT

#define _TEST_ASSERT

(

statement

)

Value:

    MACRO_BEGIN \
    LAMBDA(statement) \
    ++TEST_fatal; return; \
MACRO_END

Definition at line 78 of file test.qh.

#define _TEST_ASSERT(statement) MACRO_BEGIN \
    LAMBDA(statement) \
    ++TEST_fatal; return; \
MACRO_END

ADD_FAILURE

#define ADD_FAILURE

(

msg

)

Value:

    MACRO_BEGIN \
    ++TEST_failed; \
    LOG_WARN(msg); \
MACRO_END

Add a failure, but continue.

Definition at line 20 of file test.qh.

#define ADD_FAILURE(msg) MACRO_BEGIN \
    ++TEST_failed; \
    LOG_WARN(msg); \
MACRO_END

ASSERT_EQ

#define ASSERT_EQ	(		expected,
			actual )

Value:

_TEST_ASSERT(EXPECT_EQ(expected, actual))

Definition at line 45 of file test.qh.

ASSERT_FALSE

#define ASSERT_FALSE

(

condition

)

Value:

ASSERT_EQ(false, condition)

Definition at line 51 of file test.qh.

ASSERT_GE

#define ASSERT_GE	(		val1,
			val2 )

Value:

_TEST_ASSERT(EXPECT_GE(val1, val2))

Definition at line 66 of file test.qh.

ASSERT_GT

#define ASSERT_GT	(		val1,
			val2 )

Value:

_TEST_ASSERT(EXPECT_GT(val1, val2))

Definition at line 63 of file test.qh.

ASSERT_LE

#define ASSERT_LE	(		val1,
			val2 )

Value:

_TEST_ASSERT(EXPECT_LE(val1, val2))

Definition at line 60 of file test.qh.

ASSERT_LT

#define ASSERT_LT	(		val1,
			val2 )

Value:

_TEST_ASSERT(EXPECT_LT(val1, val2))

Definition at line 57 of file test.qh.

ASSERT_NE

#define ASSERT_NE	(		val1,
			val2 )

Value:

_TEST_ASSERT(EXPECT_NE(val1, val2))

Definition at line 54 of file test.qh.

ASSERT_NO_FATAL_FAILURE

#define ASSERT_NO_FATAL_FAILURE

(

statement

)

Value:

EXPECT_NO_FATAL_FAILURE_(statement, { ++TEST_fatal; return; })

Definition at line 69 of file test.qh.

ASSERT_TRUE

#define ASSERT_TRUE

(

condition

)

Value:

ASSERT_EQ(true, condition)

Definition at line 48 of file test.qh.

EXPECT_EQ

#define EXPECT_EQ	(		expected_,
			actual_ )

Value:

    MACRO_BEGIN \
    int expected = expected_; \
    int actual = actual_; \
    if (expected != actual) \
        ADD_FAILURE(sprintf( \
            "Value of: " #actual_ "\n" \
            "  Actual: %d\n" \
            "Expected: %d\n", \
            actual, expected \
        )); \
MACRO_END

Definition at line 34 of file test.qh.

#define EXPECT_EQ(expected_, actual_) MACRO_BEGIN \
    int expected = expected_; \
    int actual = actual_; \
    if (expected != actual) \
        ADD_FAILURE(sprintf( \
            "Value of: " #actual_ "\n" \
            "  Actual: %d\n" \
            "Expected: %d\n", \
            actual, expected \
        )); \
MACRO_END

Referenced by TEST().

EXPECT_FALSE

#define EXPECT_FALSE

(

condition

)

Value:

EXPECT_EQ(false, condition)

Definition at line 50 of file test.qh.

EXPECT_GE

#define EXPECT_GE	(		val1,
			val2 )

Value:

EXPECT_TRUE((val1) >= (val2))

Definition at line 65 of file test.qh.

EXPECT_GT

#define EXPECT_GT	(		val1,
			val2 )

Value:

EXPECT_TRUE((val1) > (val2))

Definition at line 62 of file test.qh.

EXPECT_LE

#define EXPECT_LE	(		val1,
			val2 )

Value:

EXPECT_TRUE((val1) <= (val2))

Definition at line 59 of file test.qh.

EXPECT_LT

#define EXPECT_LT	(		val1,
			val2 )

Value:

EXPECT_TRUE((val1) < (val2))

Definition at line 56 of file test.qh.

Referenced by TEST().

EXPECT_NE

#define EXPECT_NE	(		val1,
			val2 )

Value:

EXPECT_TRUE((val1) != (val2))

Definition at line 53 of file test.qh.

Referenced by MX_Messages_(), MX_Sync_(), PlayerStats_PlayerBasic_Handler(), TEST(), and test_weapons_hurt().

EXPECT_NO_FATAL_FAILURE

#define EXPECT_NO_FATAL_FAILURE

(

statement

)

Value:

EXPECT_NO_FATAL_FAILURE_(statement, { })

Definition at line 68 of file test.qh.

EXPECT_NO_FATAL_FAILURE_

#define EXPECT_NO_FATAL_FAILURE_	(		statement,
			then )

Value:

EXPECT_NO_FATAL_FAILURE__(statement, \
{ \
    LOG_WARNF( \
        "  Actual: %d fatal failures\n" \
        "Expected: no fatal failures\n", \
        TEST_fatal - TEST_prevfatal \
    ); \
    LAMBDA(then) \
})

Definition at line 90 of file test.qh.

#define EXPECT_NO_FATAL_FAILURE_(statement, then) \
    EXPECT_NO_FATAL_FAILURE__(statement, \
    { \
        LOG_WARNF( \
            "  Actual: %d fatal failures\n" \
            "Expected: no fatal failures\n", \
            TEST_fatal - TEST_prevfatal \
        ); \
        LAMBDA(then) \
    })

EXPECT_NO_FATAL_FAILURE__

#define EXPECT_NO_FATAL_FAILURE__	(		statement,
			then )

Value:

    MACRO_BEGIN \
    int TEST_prevfatal = TEST_fatal; \
    LAMBDA(statement) \
    if (TEST_fatal != TEST_prevfatal) \
        LAMBDA(then) \
MACRO_END

Definition at line 83 of file test.qh.

#define EXPECT_NO_FATAL_FAILURE__(statement, then) MACRO_BEGIN \
    int TEST_prevfatal = TEST_fatal; \
    LAMBDA(statement) \
    if (TEST_fatal != TEST_prevfatal) \
        LAMBDA(then) \
MACRO_END

EXPECT_TRUE

#define EXPECT_TRUE

(

condition

)

Value:

EXPECT_EQ(true, condition)

Definition at line 47 of file test.qh.

Referenced by TEST().

FAIL

#define FAIL

(

msg

)

Value:

_TEST_ASSERT(ADD_FAILURE(msg))

Add a failure and return.

Definition at line 26 of file test.qh.

HasFatalFailure

#define HasFatalFailure

(

)

Value:

(TEST_fatal > 0)

Definition at line 28 of file test.qh.

SUCCEED

#define SUCCEED

(

)

Value:

(TEST_ok = true)

Must be present at the end of a test.

Definition at line 17 of file test.qh.

Referenced by TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), and TEST().

TEST

#define TEST	(		suite,
			test )

Value:

void _TEST_##suite##_##test(); \
ACCUMULATE int TEST_RunAll_accumulated(int f) \
{ \
    if (!TEST_Run(#suite "_" #test)) \
        ++f; \
    return = f; \
} \
void _TEST_##suite##_##test()

Use UpperCamelCase for suite and test only.

Definition at line 6 of file test.qh.

#define TEST(suite, test) \
    void _TEST_##suite##_##test(); \
    ACCUMULATE int TEST_RunAll_accumulated(int f) \
    { \
        if (!TEST_Run(#suite "_" #test)) \
            ++f; \
        return = f; \
    } \
    void _TEST_##suite##_##test()

Function Documentation

RUN_ALL_TESTS()

bool RUN_ALL_TESTS

(

)

Definition at line 4 of file test.qc.

{
    int f = TEST_RunAll_accumulated(0);
    if (f)
    {
        LOG_HELPF("%d tests failed", f);
        return true;
    }
    else
    {
        LOG_HELP("All tests OK");
        return false;
    }
}

References LOG_HELP, LOG_HELPF, and TEST_RunAll_accumulated().

Referenced by GenericCommand_runtest().

TEST_Run()

bool TEST_Run

(

string

test

)

Definition at line 19 of file test.qc.

{
    LOG_HELPF("%s: testing...", s);
    TEST_failed = 0;
    TEST_fatal = 0;
    TEST_ok = false;
    string fn = strcat("_TEST_", s);
    if (isfunction(fn))
        callfunction(fn);
    if (TEST_failed > 0)
    {
        LOG_HELPF("%s: %d items failed.", s, TEST_failed);
        return false;
    }
    else if (!TEST_ok)
    {
        LOG_HELPF("%s: did not complete.", s);
        return false;
    }
    return true;
}

References callfunction(), isfunction(), LOG_HELPF, strcat(), TEST_failed, TEST_fatal, and TEST_ok.

Referenced by GenericCommand_runtest().

Variable Documentation

TEST_failed

int TEST_failed

Definition at line 76 of file test.qh.

Referenced by TEST_Run().

TEST_fatal

int TEST_fatal

Definition at line 74 of file test.qh.

Referenced by TEST_Run().

TEST_ok

bool TEST_ok

Definition at line 75 of file test.qh.

Referenced by TEST_Run().