From 1b4bcf6f703248cb397587fe08635a1491d460ec Mon Sep 17 00:00:00 2001 From: Baptiste Lepilleur Date: Mon, 15 Apr 2002 14:33:11 +0000 Subject: NEWS: updated. NEWS: updated. * configure.in: added include/cppunit/config/Makefile and include/cppunit/plugin/Makefile to the list of target. * doc/CppUnit-win.dox: enabled generation of HTML Help documentation. * include/cppunit/config/Makefile.am: * include/cppunit/plugin/Makefile.am: added. * include/cppunit/config-bcb5.h: * include/cppunit/config-msvc6.h: * include/cppunit/config-mac.h: moved to include/cppunit/config/. * include/cppunit/Portability.h: updated config files location. Added macros CPPUNIT_STRINGIZE and CPPUNIT_JOIN (implementation adapted from boost.org). Added macro CPPUNIT_MAKE_UNIQUE_NAME. * include/cppunit/Test.h: modified methods order. * include/cppunit/extensions/HelperMacros.h: renamed macro __CPPUNIT_MAKE_UNIQUE_NAME to CPPUNIT_MAKE_UNIQUE_NAME and moved its definition to include/cppunit/Portability.h. * include/cppunit/extensions/TestDecorator.h: Inherits Test instead of TestLeaf. * include/cppunit/plugin/DynamicLibraryManager.h: * src/cppunit/DynamicLibraryManager.cpp: added. DLL manager (load & lookup symbol). * src/cppunit/BeOsDynamicLibraryManager.cpp: * src/cppunit/UnixDynamicLibraryManager.cpp: * src/cppunit/Win32DynamicLibraryManager.cpp: added. Implementation of platform dependent methods of DynamicLibraryManager. * include/cppunit/plugin/DynamicLibraryManagerException.h: * src/cppunit/DynamicLibraryManagerException.cpp: added. Exception thrown by DynamicLibraryManager. * include/cppunit/plugin/TestPlugIn.h: added. CppUnitTestPlugIn interface definition. Helper macros to implements plug-in. * include/cppunit/plugin/TestPlugInSuite.h: * src/cppunit/plugin/TestPlugInSuite.cpp: added. A suite to wrap a test plug-in. * include/cppunit/plugin/TestPlugInDefaultImpl.h: * src/cppunit/TestPlugInDefaultImpl.cpp: added. A default implementation of the test plug-in interface. * src/msvc6/DllPlugInTester/DllPlugInTester.cpp: updated to use the new TestPlugIn. * examples/cppunittest/TestResultCollectorTest.cpp: fixed typo. --- include/cppunit/plugin/DynamicLibraryManager.h | 114 +++++++++++++++ .../plugin/DynamicLibraryManagerException.h | 49 +++++++ include/cppunit/plugin/Makefile.am | 8 ++ include/cppunit/plugin/TestPlugIn.h | 153 +++++++++++++++++++++ include/cppunit/plugin/TestPlugInDefaultImpl.h | 50 +++++++ include/cppunit/plugin/TestPlugInSuite.h | 54 ++++++++ 6 files changed, 428 insertions(+) create mode 100644 include/cppunit/plugin/DynamicLibraryManager.h create mode 100644 include/cppunit/plugin/DynamicLibraryManagerException.h create mode 100644 include/cppunit/plugin/Makefile.am create mode 100644 include/cppunit/plugin/TestPlugIn.h create mode 100644 include/cppunit/plugin/TestPlugInDefaultImpl.h create mode 100644 include/cppunit/plugin/TestPlugInSuite.h (limited to 'include/cppunit/plugin') diff --git a/include/cppunit/plugin/DynamicLibraryManager.h b/include/cppunit/plugin/DynamicLibraryManager.h new file mode 100644 index 0000000..93ce583 --- /dev/null +++ b/include/cppunit/plugin/DynamicLibraryManager.h @@ -0,0 +1,114 @@ +#ifndef CPPUNIT_PLUGIN_DYNAMICLIBRARYMANAGER_H +#define CPPUNIT_PLUGIN_DYNAMICLIBRARYMANAGER_H + +#include + +#if !defined(CPPUNIT_NO_TESTPLUGIN) +#include + + +namespace CppUnit +{ + + +/*! \brief Manages dynamic libraries. + * + * The Dynamic Library Manager provides a platform independent way to work with + * dynamic library. It load a specific dynamic library, and can returns specific + * symbol exported by the dynamic library. + * + * If an error occurs, a DynamicLibraryManagerException is thrown. + * + * \internal Implementation of the OS independent methods is in + * DynamicLibraryManager.cpp. + * + * \internal Porting to a new platform: + * - Adds platform detection in config/SelectDllLoader.h. Should define a specific + * macro for that platform of the form: CPPUNIT_HAVE_XYZ_DLL_LOADER, where + * XYZ is the platform. + * - Makes a copy of UnixDynamicLibraryManager.cpp and named it after the platform. + * - Updated the 'guard' in your file (CPPUNIT_HAVE_XYZ_DLL_LOADER) so that it is + * only processed if the matching platform has been detected. + * - Change the implementation of methods doLoadLibrary(), doReleaseLibrary(), + * doFindSymbol() in your copy. Those methods usually maps directly to OS calls. + * - Adds the file to the project. + */ +class DynamicLibraryManager +{ +public: + typedef void *Symbol; + typedef void *LibraryHandle; + + /*! Loads the specified library. + * \param libraryFileName Name of the library to load. + * \exception DynamicLibraryManagerException if a failure occurs while loading + * the library (fail to found or load the library). + */ + DynamicLibraryManager( const std::string &libraryFileName ); + + /// Releases the loaded library.. + ~DynamicLibraryManager(); + + /*! Returns a pointer on the specified symbol exported by the library. + * \param symbol Name of the symbol exported by the library. + * \return Pointer on the symbol. Should be casted to the actual type. Never \c NULL. + * \exception DynamicLibraryManagerException if the symbol is not found. + */ + Symbol findSymbol( const std::string &symbol ); + +private: + /*! Loads the specified library. + * \param libraryName Name of the library to load. + * \exception DynamicLibraryManagerException if a failure occurs while loading + * the library (fail to found or load the library). + */ + void loadLibrary( const std::string &libraryName ); + + /*! Releases the loaded library. + * + * \warning Must NOT throw any exceptions (called from destructor). + */ + void releaseLibrary(); + + /*! Loads the specified library. + * + * May throw any exceptions (indicates failure). + * \param libraryName Name of the library to load. + * \return Handle of the loaded library. \c NULL indicates failure. + */ + LibraryHandle doLoadLibrary( const std::string &libraryName ); + + /*! Releases the loaded library. + * + * The handle of the library to free is in \c m_libraryHandle. It is never + * \c NULL. + * \warning Must NOT throw any exceptions (called from destructor). + */ + void doReleaseLibrary(); + + /*! Returns a pointer on the specified symbol exported by the library. + * + * May throw any exceptions (indicates failure). + * \param symbol Name of the symbol exported by the library. + * \return Pointer on the symbol. \c NULL indicates failure. + */ + Symbol doFindSymbol( const std::string &symbol ); + + /// Prevents the use of the copy constructor. + DynamicLibraryManager( const DynamicLibraryManager © ); + + /// Prevents the use of the copy operator. + void operator =( const DynamicLibraryManager © ); + +private: + LibraryHandle m_libraryHandle; + std::string m_libraryName; +}; + + +} // namespace CppUnit + + +#endif // !defined(CPPUNIT_NO_TESTPLUGIN) + +#endif // CPPUNIT_PLUGIN_DYNAMICLIBRARYMANAGER_H diff --git a/include/cppunit/plugin/DynamicLibraryManagerException.h b/include/cppunit/plugin/DynamicLibraryManagerException.h new file mode 100644 index 0000000..c6b956a --- /dev/null +++ b/include/cppunit/plugin/DynamicLibraryManagerException.h @@ -0,0 +1,49 @@ +#ifndef CPPUNIT_PLUGIN_DYNAMICLIBRARYMANAGEREXCEPTION_H +#define CPPUNIT_PLUGIN_DYNAMICLIBRARYMANAGEREXCEPTION_H + +#include + +#if !defined(CPPUNIT_NO_TESTPLUGIN) +#include +#include + + +namespace CppUnit +{ + +/*! \brief Exception thrown by DynamicLibraryManager when a failure occurs. + * + * Use getCause() to know what function caused the failure. + * + */ +class DynamicLibraryManagerException : public std::runtime_error +{ +public: + enum Cause + { + /// Failed to load the dynamic library + loadingFailed =0, + /// Symbol not found in the dynamic library + symbolNotFound, + }; + + /// Failed to load the dynamic library + DynamicLibraryManagerException( const std::string &libraryName ); + + /// Symbol not found in the dynamic library + DynamicLibraryManagerException( const std::string &libraryName, + const std::string &symbol ); + + Cause getCause() const; + +private: + Cause m_cause; +}; + + +} // namespace CppUnit + + +#endif // !defined(CPPUNIT_NO_TESTPLUGIN) + +#endif // CPPUNIT_PLUGIN_DYNAMICLIBRARYMANAGEREXCEPTION_H diff --git a/include/cppunit/plugin/Makefile.am b/include/cppunit/plugin/Makefile.am new file mode 100644 index 0000000..4ea36e9 --- /dev/null +++ b/include/cppunit/plugin/Makefile.am @@ -0,0 +1,8 @@ +libcppunitincludedir = $(includedir)/cppunit/plugin + +libcppunitinclude_HEADERS = \ + DynamicLibraryManager.h \ + DynamicLibraryManagerException.h \ + TestPlugIn.h \ + TestPlugInDefaultImpl.h \ + TestPlugInSuite.h diff --git a/include/cppunit/plugin/TestPlugIn.h b/include/cppunit/plugin/TestPlugIn.h new file mode 100644 index 0000000..78ab4a6 --- /dev/null +++ b/include/cppunit/plugin/TestPlugIn.h @@ -0,0 +1,153 @@ +#ifndef CPPUNIT_PLUGIN_TESTPLUGIN +#define CPPUNIT_PLUGIN_TESTPLUGIN + +#include + +#if !defined(CPPUNIT_NO_TESTPLUGIN) + +namespace CppUnit +{ +class Test; +} + +/*! \file + */ + + +/*! Test plug-in interface. + * \ingroup WritingTestPlugIn + * + * This class define the interface implemented by test plug-in. A pointer to that + * interface is returned by the function exported by the test plug-in. + * \see CPPUNIT_PLUGIN_IMPLEMENT, CPPUNIT_PLUGIN_EXPORTED_FUNCTION_IMPL + * \see TestPlugInDefaultImpl. + */ +struct CppUnitTestPlugIn +{ + /*! Called just after loading the dynamic library. + * + * Initializes the plug-in. + */ + virtual void initialize() = 0; + + /*! Returns the root test of the plug-in. + * + * Caller does not assume ownership of the test. + * \return Pointer on a Test. Must never be \c NULL. The caller does not assume + * ownership of the returned Test. The Test must remain valid until + * uninitialize() is called. + */ + virtual CppUnit::Test *getTestSuite() =0; + + /*! Called just before unloading the dynamic library. + * Unitializes the plug-in. + */ + virtual void uninitialize() = 0; +}; + + + +/*! Name of the function exported by a test plug-in. + * \ingroup WritingTestPlugIn + * + * The signature of the exported function is: + * \code + * CppUnitTestPlugIn *CPPUNIT_PLUGIN_EXPORTED_NAME(void); + * \endif + */ +#define CPPUNIT_PLUGIN_EXPORTED_NAME cppunitTestPlugIn + +/*! Type of the function exported by a plug-in. + * \ingroup WritingTestPlugIn + */ +typedef CppUnitTestPlugIn *(*CppUnitTestPlugInSignature)(); + + +/*! Implements the function exported by the test plug-in + * \ingroup WritingTestPlugIn + */ +#define CPPUNIT_PLUGIN_EXPORTED_FUNCTION_IMPL( TestPlugInInterfaceType ) \ + CPPUNIT_PLUGIN_EXPORT CppUnitTestPlugIn *CPPUNIT_PLUGIN_EXPORTED_NAME(void) \ + { \ + static TestPlugInInterfaceType plugIn; \ + return &plugIn; \ + } \ + typedef char __CppUnitPlugInExportFunctionDummyTypeDef // dummy typedef so it can end with ';' + + +// Note: This include should remain after definition of CppUnitTestPlugIn +#include + + +/*! \def CPPUNIT_PLUGIN_IMPLEMENT_MAIN() + * \brief Implements the 'main' function for the plug-in. + * + * This macros implements the main() function for dynamic library. + * For example, WIN32 requires a DllMain function, while some Unix + * requires a main() function. This macros takes care of the implementation. + */ + +// Win32 +#if defined(CPPUNIT_HAVE_WIN32_DLL_LOADER) +#if !defined(APIENTRY) +#define WIN32_LEAN_AND_MEAN +#define NOGDI +#define NOUSER +#define NOKERNEL +#define NOSOUND +#define NOMINMAX +#include +#endif +#define CPPUNIT_PLUGIN_IMPLEMENT_MAIN() \ + BOOL APIENTRY DllMain( HANDLE hModule, \ + DWORD ul_reason_for_call, \ + LPVOID lpReserved ) \ + { \ + return TRUE; \ + } \ + typedef char __CppUnitPlugInImplementMainDummyTypeDef + +// Unix +#elif defined(CPPUNIT_HAVE_UNIX_DLL_LOADER) +#define CPPUNIT_PLUGIN_IMPLEMENT_MAIN() \ + int main( int argc, char *argv[] ) \ + { \ + (void)argc; (void)argv; \ + return 0; \ + } \ + typedef char __CppUnitPlugInImplementMainDummyTypeDef + +// Other +#else // other platforms don't require anything specifics +#endif + + + +/*! Implements and exports the test plug-in interface. + * \ingroup WritingTestPlugIn + * + * This macro creates a subclass of CppUnitTestPlugInDefaultImpl to specify set + * the name of the suite returned by CppUnitTestPlugIn::getTestSuite(), exports + * the test plug-in function using the subclass, and implements the 'main' + * function for the plug-in using CPPUNIT_PLUGIN_IMPLEMENT_MAIN(). + * + * \see CppUnitTestPlugIn, CppUnitTestPlugInDefaultImpl + * \see CPPUNIT_PLUGIN_EXPORTED_FUNCTION_IMPL(), CPPUNIT_PLUGIN_IMPLEMENT_MAIN(). + */ +#define CPPUNIT_PLUGIN_IMPLEMENT( suiteName ) \ + class __CppUnitTestPlugInNamedDefaultImpl : public CppUnit::TestPlugInDefaultImpl \ + { \ + virtual std::string getSuiteName() \ + { \ + return suiteName; \ + } \ + }; \ + \ + CPPUNIT_PLUGIN_EXPORTED_FUNCTION_IMPL( __CppUnitTestPlugInNamedDefaultImpl ); \ + CPPUNIT_PLUGIN_IMPLEMENT_MAIN() + + +#endif // !defined(CPPUNIT_NO_TESTPLUGIN) + + +#endif // CPPUNIT_PLUGIN_TESTPLUGIN diff --git a/include/cppunit/plugin/TestPlugInDefaultImpl.h b/include/cppunit/plugin/TestPlugInDefaultImpl.h new file mode 100644 index 0000000..06f1bb3 --- /dev/null +++ b/include/cppunit/plugin/TestPlugInDefaultImpl.h @@ -0,0 +1,50 @@ +#ifndef CPPUNIT_PLUGIN_TESTPLUGINDEFAULTIMPL +#define CPPUNIT_PLUGIN_TESTPLUGINDEFAULTIMPL + +#include + +#if !defined(CPPUNIT_NO_TESTPLUGIN) + +#include + +namespace CppUnit +{ + +class TestSuite; + + +/*! Default implementation of test plug-in interface. + * \ingroup WritingTestPlugIn + * + * Override getSuiteName() to specify the suite name. Default is "All Tests". + * + * CppUnitTestPlugIn::::getTestSuite() returns a suite that contains + * all the test registered to the default test factory registry + * ( TestFactoryRegistry::getRegistry() ). + * + */ +class CPPUNIT_API TestPlugInDefaultImpl : public CppUnitTestPlugIn +{ +public: + TestPlugInDefaultImpl(); + + virtual ~TestPlugInDefaultImpl(); + + void initialize(); + + CppUnit::Test *getTestSuite(); + + void uninitialize(); + +protected: + virtual std::string getSuiteName(); + + TestSuite *m_suite; +}; + + +} // namespace CppUnit + +#endif // !defined(CPPUNIT_NO_TESTPLUGIN) + +#endif // CPPUNIT_PLUGIN_TESTPLUGINDEFAULTIMPL diff --git a/include/cppunit/plugin/TestPlugInSuite.h b/include/cppunit/plugin/TestPlugInSuite.h new file mode 100644 index 0000000..19dc65d --- /dev/null +++ b/include/cppunit/plugin/TestPlugInSuite.h @@ -0,0 +1,54 @@ +#ifndef CPPUNIT_EXTENSIONS_TESTPLUGINSUITE_H +#define CPPUNIT_EXTENSIONS_TESTPLUGINSUITE_H + +#include +#if !defined(CPPUNIT_NO_TESTPLUGIN) + +#include + +namespace CppUnit +{ + +class DynamicLibraryManager; + + +/*! \brief A suite that wrap a test plug-in. + * \ingroup WritingTestPlugIn + */ +class TestPlugInSuite : public TestComposite +{ +public: + /*! Constructs a TestPlugInSuite object. + */ + TestPlugInSuite( const std::string &libraryFileName ); + + /// Destructor. + virtual ~TestPlugInSuite(); + + int getChildTestCount() const; + +protected: + Test *doGetChildTestAt( int index ) const; + + /// Prevents the use of the copy constructor. + TestPlugInSuite( const TestPlugInSuite © ); + + /// Prevents the use of the copy operator. + void operator =( const TestPlugInSuite © ); + +private: + /// Manager for the dynamic library. + DynamicLibraryManager *m_library; + /// Interface returned by the plug-in. + CppUnitTestPlugIn *m_interface; + /// Suite returned by the plug-in. + Test *m_librarySuite; +}; + + +} // namespace CppUnit + + +#endif // !defined(CPPUNIT_NO_TESTPLUGIN) + +#endif // CPPUNIT_EXTENSIONS_TESTPLUGINSUITE_H -- cgit v1.2.1