diff options
Diffstat (limited to 'include/cppunit/extensions/HelperMacros.h')
| -rw-r--r-- | include/cppunit/extensions/HelperMacros.h | 164 |
1 files changed, 164 insertions, 0 deletions
diff --git a/include/cppunit/extensions/HelperMacros.h b/include/cppunit/extensions/HelperMacros.h new file mode 100644 index 0000000..7c725c5 --- /dev/null +++ b/include/cppunit/extensions/HelperMacros.h @@ -0,0 +1,164 @@ +// ////////////////////////////////////////////////////////////////////////// +// Header file AutoRegisterTests.h for class AutoRegisterTests +// (c)Copyright 2000, Baptiste Lepilleur. +// Created: 2001/04/15 +// ////////////////////////////////////////////////////////////////////////// +#ifndef CPPUNIT_HELPERMACROS_H +#define CPPUNIT_HELPERMACROS_H + +#include "AutoRegisterSuite.h" +#include "TestSuiteBuilder.h" + + +/** Begins the declaration of the test suite + * + * The CU_TEST_XXX macros are helper to define test suite that are + * automatically registered to the TestRegistry. + * + * You just need to add a set of macro to declare the unit test method. + * Those macros will create a template method named registerTests + * with adds the test methods using TestCaller to the suite. + * + * This macro will also define a static method named suite() that + * return a pointer on the suite associated to the test case type. + * The method signature is: \code static CppUnit::TestSuite *suite().\endcode + * + * Notes that you must directly inherit from CppUnit::TestCase when using + * this macro. See CU_TEST_SUB_SUITE if you need to declare a suite + * for a sub-class inheriting a test case that use CU_TEST_SUITE. + * + * \code + * #include <cppunit/AutoRegisterTests.h> + * class MyTest : public CppUnit::TestCase { + * CU_TEST_SUITE( MyTest ); + * CU_TEST( testEquality ); + * CU_TEST( testSetName ); + * CU_TEST_SUITE_END(); + * public: + * void testEquality(); + * void testSetName(); + * }; + * \endcode + * + * Somewhere in an implementation file: + * + * \code + * CU_TEST_SUITE_REGISTRATION( MyTest ); + * \encode + * + * The great thing about that is that you can even used it on template test case. + * You only need to specify the full qualified name of the class. For example: + * + * \code + * template<class CharType> + * class StringTest : public CppUnit::Testcase { + * CU_TEST_SUITE( StringTest<CharType> ); + * CU_TEST( testAppend ); + * CU_TEST_SUITE_END(); + * public: + * ... + * }; + * \endcode + * + * And you need to add in an implementation file: + * + * \code + * CU_TEST_SUITE_REGISTRATION( String<char> ); + * CU_TEST_SUITE_REGISTRATION( String<wchar_t> ); + * \encode + * + * \param ATestCaseType Type of the test case class. + * \see CU_TEST_SUB_SUITE, CU_TEST, CU_TEST_SUITE_END, CU_TEST_SUITE_REGISTRATION. + */ +#define CU_TEST_SUITE( ATestCaseType ) \ + private: \ + typedef ATestCaseType __ThisTestCaseType; \ + public: \ + typedef CppUnit::AutoRegisterSuite<__ThisTestCaseType> AutoRegisterSuite; \ + static CppUnit::Test *suite() \ + { \ + __ThisTestCaseType *test =NULL; \ + CppUnit::TestSuiteBuilder<__ThisTestCaseType> suite; \ + __ThisTestCaseType::registerTests( suite, test ); \ + return suite.takeSuite(); \ + } \ + template<class TestCaseType> \ + static void \ + registerTests( CppUnit::TestSuiteBuilder<TestCaseType> &suite, \ + TestCaseType *test ) \ + { + + +/** Begins the declaration of the test suite + * + * This macro works just the same as CU_TEST_SUITE, but allow you to specify + * the base class. When the test are registered, the base class test + * defined using the CU_TEST_SUITE macro or CU_TEST_SUB_SUITE macro are + * added to the suite. + * + * Here is an example: + * + * \code + * #include <cppunit/AutoRegisterTests.h> + * class MySubTest : public MyTest { + * CU_TEST_SUB_SUITE( MySubTest, MyTest ); + * CU_TEST( testAdd ); + * CU_TEST( testSub ); + * CU_TEST_SUITE_END(); + * public: + * void testAdd(); + * void testSub(); + * }; + * \endcode + * + * \param ATestCaseType Type of the test case class. + * \see CU_TEST_SUITE. + */ +#define CU_TEST_SUB_SUITE( ATestCaseType, ASuperClass ) \ + private: \ + typedef ASuperClass __ThisSuperClassType; \ + CU_TEST_SUITE( ATestCaseType ); \ + __ThisSuperClassType::registerTests( suite, test ) + +/** Adds a method to the suite. + * \param testMethod Name of the method of the test case to add to the + * suite. The signature of the method must be of + * type: void testMethod(); + * \see CU_TEST_SUITE. + */ +#define CU_TEST( testMethod ) \ + suite.addTestCaller( #testMethod, testMethod ) + +/** Ends the declaration of the test suite and automatically register + * the test suite in the TestRegistry. + * + * After this macro, member access is set to "private". + * + * \see TestRegistry. + * \see CU_TEST_SUITE. + */ +#define CU_TEST_SUITE_END() \ +} \ + private: + +#define CU_CONCATENATE_DIRECT( s1, s2 ) s1##s2 +#define CU_CONCATENATE( s1, s2 ) CU_CONCATENATE_DIRECT( s1, s2 ) + +/** Decorates the specified string with the line number to obtain a unique name; + * @param str String to decorate. + */ +#define CU_MAKE_UNIQUE_NAME( str ) CU_CONCATENATE( str, __LINE__ ) + +/** Implementation of the auto-registration of test into the TestRegistry. + * Should be placed in the cpp file. + * @param ATestCaseType Type of the test case class. + * \warning This macro should be used only once per line of code (the line + * number is used to name a hidden static variable). + * \see CU_TEST_SUITE, CppUnit::AutoRegisterSuite. + */ +#define CU_TEST_SUITE_REGISTRATION( ATestCaseType ) \ + static ATestCaseType::AutoRegisterSuite \ + CU_MAKE_UNIQUE_NAME(__autoRegisterSuite ) + + +#endif // CPPUNIT_HELPERMACROS_H |