Assertions

Macros
#define	BV_TEST_SETUP(desc)
#define	BV_TEST_TEARDOWN(desc)
#define	BV_TEST(name, desc)
#define	BV_IGNORE
#define	BV_ASSERT_TRUE(expr)
#define	BV_ASSERT_FALSE(expr)
#define	BV_ASSERT_NULLPTR(expr)
#define	BV_ASSERT_EQUAL(lhs, rhs)
#define	BV_ASSERT_NOT_EQUAL(lhs, rhs)

Detailed Description

Describes the BitShift Validate assertion macros.

Macro Definition Documentation

BV_TEST_SETUP

#define BV_TEST_SETUP

(

desc

)

Register a test setup function.

Parameters

desc	A description of the setup function.

Usage Example:

BV_TEST_SETUP(setup environment)
{
  // ...
}

BV_TEST_TEARDOWN

#define BV_TEST_TEARDOWN

(

desc

)

Register a test teardown function.

Parameters

desc	A description of the teardown function.

Usage Example:

BV_TEST_TEARDOWN(cleanup resources)
{
  // ...
}

BV_TEST

#define BV_TEST	(		name,
			desc )

Register a test function.

Parameters

name	An identifier for the test.
desc	A decsription of the test.

Usage Example:

BV_TEST(str.length, "test string length")
{
  // ...
}

BV_IGNORE

#define BV_IGNORE

Ignore a test.

BV_ASSERT_TRUE

#define BV_ASSERT_TRUE

(

expr

)

Assert a true value.

Parameters

expr	The expression to test.

Usage Example:

BV_TEST(str.empty, "test string 'empty'")
{
  std::string empty{};
  BV_ASSERT_TRUE(empty.empty());
}

BV_ASSERT_FALSE

#define BV_ASSERT_FALSE

(

expr

)

Assert a false value.

Parameters

expr	The expression to test.

Usage Example:

BV_TEST(str.not_empty, "test string not 'empty'")
{
  std::string not_empty{"hello, world"};
  BV_ASSERT_FALSE(not_empty.empty());
}

BV_ASSERT_NULLPTR

#define BV_ASSERT_NULLPTR

(

expr

)

Assert a nullptr value.

Parameters

expr	The expression to test.

Usage Example:

BV_TEST(ptr.is_null, "test null pointer")
{
  char const* this_is_null{nullptr};
  BV_ASSERT_NULLPTR(this_is_null);
}

BV_ASSERT_EQUAL

#define BV_ASSERT_EQUAL	(		lhs,
			rhs )

Assert lhs is equal to rhs.

Parameters

lhs	The left-hand side expression to test.
rhs	The right-hand side expression to test.

Usage Example:

BV_TEST(equal, "test equal")
{
  int lhs = 1;
  int rhs = 1;
  BV_ASSERT_EQUAL(lhs, rhs);
}

BV_ASSERT_NOT_EQUAL

#define BV_ASSERT_NOT_EQUAL	(		lhs,
			rhs )

Assert lhs is not equal to rhs.

Parameters

lhs	The left-hand side expression to test.
rhs	The right-hand side expression to test.

Usage Example:

BV_TEST(not_equal, "test not equal")
{
  int lhs = 1;
  int rhs = 2;
  BV_ASSERT_NOT_EQUAL(lhs, rhs);
}