Test declaration

Oveview

Macros
#define	GTEST_TEST(test_suite_name, test_name)
#define	TEST(test_suite_name, test_name)   GTEST_TEST(test_suite_name, test_name)
#define	TEST_F(test_fixture, test_name)
#define	FRIEND_TEST(test_suite_name, test_name)    friend class test_suite_name##_##test_name##_Test

Macro Definition Documentation

FRIEND_TEST

#define FRIEND_TEST	(		test_suite_name,
			test_name
	)		friend class test_suite_name##_##test_name##_Test

Defines a test case from a test suite as a friend class of an implementation class.

Warning

Use of FRIEND_TEST is discouraged, because it induces coupling between testing and implementation code. Consider this a last resort only.

Parameters

[in]	test_suite_name	The name of the test suite to befriend.
[in]	test_name	The name of the test case to befriend.

GTEST_TEST

#define GTEST_TEST	(		test_suite_name,
			test_name
	)

Value:

  _PW_TEST_SUITE_NAMES_MUST_BE_UNIQUE(void /* TEST */, test_suite_name); \
  _PW_TEST(test_suite_name, test_name, ::pw::unit_test::internal::Test)

Alias for TEST.

TEST

#define TEST	(		test_suite_name,
			test_name
	)		GTEST_TEST(test_suite_name, test_name)

Defines a test given the suite name and test case name.

If TEST is conflicting with other code, set GTEST_DONT_DEFINE_TEST to 1 and use GTEST_TEST instead.

Parameters

[in]	test_suite_name	The name of the test suite or collection of tests.
[in]	test_name	The name of the test case.

TEST_F

#define TEST_F	(		test_fixture,
			test_name
	)

Value:

  _PW_TEST_SUITE_NAMES_MUST_BE_UNIQUE(int /* TEST_F */, test_fixture); \
  _PW_TEST(test_fixture, test_name, test_fixture)

Defines a test case using a test fixture.

Note

TEST_F may allocate fixtures separately from the stack. Large variables should be stored in test fixture fields, rather than stack variables. This allows the test framework to statically ensure that enough space is available to store these variables.

Parameters

[in]	test_fixture	The name of the test fixture class to use.
[in]	test_name	The name of the test case.