From 73a038f1eaa268cec330d971fb550befec6f7798 Mon Sep 17 00:00:00 2001 From: Baptiste Lepilleur Date: Fri, 14 Jun 2002 19:21:01 +0000 Subject: Include/cppunit/plugin/PlugInManager. include/cppunit/plugin/PlugInManager.h: * src/cppunit/PlugInManager.cpp: added two methods to use the plug-in interface for Xml Outputter hooks. * include/cppunit/plugin/TestPlugIn.h: added two methods to the plug-in interface for Xml Outputter hooks. * include/cppunit/plugin/TestPlugInAdapter.h: * src/cppunit/plugin/TestPlugInAdapter.cpp: renamed TestPlugInDefaultImpl. Added empty implementation for Xml outputter hook methods. * include/cppunit/tools/StringTools.h: * src/cppunit/tools/StringTools.cpp: added. Functions to manipulate string (conversion, wrapping...) * include/cppunit/tools/XmlElement.h: * src/cppunit/XmlElement.cpp: renamed addNode() to addElement(). Added methods to walk and modify XmlElement (for hook). Added documentation. Use StringTools. * include/cppunit/XmlOutputter.h: * src/cppunit/XmlOutputter.cpp: added hook calls & management. * include/cppunit/XmlOutputterHook.h: * src/cppunit/XmlOutputterHook.cpp: added. Hook to customize XML output. * src/DllPlugInTester/DllPlugInTester.cpp: call plug-in XmlOutputterHook when writing XML output. Modified so that memory is freed before unloading the test plug-in (caused crash when freeing the XmlDocument). * examples/ReadMe.txt: * examples/ClockerPlugIn/ReadMe.txt: added details about the plug-in (usage, xml content...) * examples/ClockerPlugIn/ClockerModel.h: * examples/ClockerPlugIn/ClockerModel.cpp: extracted from ClockerListener. Represents the test hierarchy and tracked time for each test. * examples/ClockerPlugIn/ClockerListener.h: * examples/ClockerPlugIn/ClockerListener.cpp: extracted test hierarchy tracking to ClockerModel. Replaced the 'flat' view option with a 'text' option to print the timed test tree to stdout. * examples/ClockerPlugIn/ClockerPlugIn.cpp: updated to hook the XML output and use the new classes. * examples/ClockerPlugIn/ClockerXmlHook.h: * examples/ClockerPlugIn/ClockerXmlHook.cpp: added. XmlOutputterHook to includes the timed test hierarchy and test timing in the XML output. * examples/cppunittest/XmlElementTest.h: * examples/cppunittest/XmlElementTest.cpp: added new test cases. * examples/cppunittest/XmlOutputterTest.h: * examples/cppunittest/XmlOutputterTest.cpp: added tests for XmlOutputterHook. --- include/cppunit/plugin/Makefile.am | 2 +- include/cppunit/plugin/PlugInManager.h | 11 ++++++ include/cppunit/plugin/TestPlugIn.h | 17 +++++++-- include/cppunit/plugin/TestPlugInAdapter.h | 48 ------------------------ include/cppunit/plugin/TestPlugInDefaultImpl.h | 52 ++++++++++++++++++++++++++ 5 files changed, 78 insertions(+), 52 deletions(-) delete mode 100644 include/cppunit/plugin/TestPlugInAdapter.h create mode 100644 include/cppunit/plugin/TestPlugInDefaultImpl.h (limited to 'include/cppunit/plugin') diff --git a/include/cppunit/plugin/Makefile.am b/include/cppunit/plugin/Makefile.am index 0494373..3fdff64 100644 --- a/include/cppunit/plugin/Makefile.am +++ b/include/cppunit/plugin/Makefile.am @@ -4,6 +4,6 @@ libcppunitinclude_HEADERS = \ DynamicLibraryManager.h \ DynamicLibraryManagerException.h \ TestPlugIn.h \ - TestPlugInAdapter.h \ + TestPlugInDefaultImpl.h \ PlugInManager.h \ Parameters.h diff --git a/include/cppunit/plugin/PlugInManager.h b/include/cppunit/plugin/PlugInManager.h index d3bbc5f..f349ab1 100644 --- a/include/cppunit/plugin/PlugInManager.h +++ b/include/cppunit/plugin/PlugInManager.h @@ -18,6 +18,7 @@ namespace CppUnit class DynamicLibraryManager; class TestResult; +class XmlOutputter; /*! \brief Manges TestPlugIn. @@ -62,6 +63,16 @@ public: */ void removeListener( TestResult *eventManager ); + /*! Provides a way for the plug-in to register some XmlOutputterHook. + */ + void addXmlOutputterHooks( XmlOutputter *outputter ); + + /*! Called when the XmlOutputter is destroyed. + * + * Can be used to free some resources allocated by addXmlOutputterHooks(). + */ + void removeXmlOutputterHooks(); + protected: struct PlugInInfo { diff --git a/include/cppunit/plugin/TestPlugIn.h b/include/cppunit/plugin/TestPlugIn.h index 0847928..0eaf960 100644 --- a/include/cppunit/plugin/TestPlugIn.h +++ b/include/cppunit/plugin/TestPlugIn.h @@ -12,6 +12,7 @@ namespace CppUnit class Test; class TestFactoryRegistry; class TestResult; +class XmlOutputter; } /*! \file @@ -67,6 +68,16 @@ struct CppUnitTestPlugIn */ virtual void removeListener( CppUnit::TestResult *eventManager ) =0; + /*! Provides a way for the plug-in to register some XmlOutputterHook. + */ + virtual void addXmlOutputterHooks( CppUnit::XmlOutputter *outputter ) =0; + + /*! Called when the XmlOutputter is destroyed. + * + * Can be used to free some resources allocated by addXmlOutputterHooks(). + */ + virtual void removeXmlOutputterHooks() = 0; + /*! Called just before unloading the dynamic library. * * Override this method to unregister test factory added in initialize(). @@ -109,7 +120,7 @@ typedef CppUnitTestPlugIn *(*TestPlugInSignature)(); // Note: This include should remain after definition of CppUnitTestPlugIn -#include +#include /*! \def CPPUNIT_PLUGIN_IMPLEMENT_MAIN() @@ -170,8 +181,8 @@ typedef CppUnitTestPlugIn *(*TestPlugInSignature)(); * \see CppUnitTestPlugIn * \see CPPUNIT_PLUGIN_EXPORTED_FUNCTION_IMPL(), CPPUNIT_PLUGIN_IMPLEMENT_MAIN(). */ -#define CPPUNIT_PLUGIN_IMPLEMENT() \ - CPPUNIT_PLUGIN_EXPORTED_FUNCTION_IMPL( CppUnit::TestPlugInAdapter ); \ +#define CPPUNIT_PLUGIN_IMPLEMENT() \ + CPPUNIT_PLUGIN_EXPORTED_FUNCTION_IMPL( CppUnit::TestPlugInDefaultImpl ); \ CPPUNIT_PLUGIN_IMPLEMENT_MAIN() diff --git a/include/cppunit/plugin/TestPlugInAdapter.h b/include/cppunit/plugin/TestPlugInAdapter.h deleted file mode 100644 index 0e54e0e..0000000 --- a/include/cppunit/plugin/TestPlugInAdapter.h +++ /dev/null @@ -1,48 +0,0 @@ -#ifndef CPPUNIT_PLUGIN_TESTPLUGINADAPTER -#define CPPUNIT_PLUGIN_TESTPLUGINADAPTER - -#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 TestPlugInAdapter : public CppUnitTestPlugIn -{ -public: - TestPlugInAdapter(); - - virtual ~TestPlugInAdapter(); - - void initialize( TestFactoryRegistry *registry, - const Parameters ¶meters ); - - void addListener( TestResult *eventManager ); - - void removeListener( TestResult *eventManager ); - - void uninitialize( TestFactoryRegistry *registry ); -}; - - -} // namespace CppUnit - -#endif // !defined(CPPUNIT_NO_TESTPLUGIN) - -#endif // CPPUNIT_PLUGIN_TESTPLUGINADAPTER diff --git a/include/cppunit/plugin/TestPlugInDefaultImpl.h b/include/cppunit/plugin/TestPlugInDefaultImpl.h new file mode 100644 index 0000000..90d4398 --- /dev/null +++ b/include/cppunit/plugin/TestPlugInDefaultImpl.h @@ -0,0 +1,52 @@ +#ifndef CPPUNIT_PLUGIN_TESTPLUGINADAPTER +#define CPPUNIT_PLUGIN_TESTPLUGINADAPTER + +#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( TestFactoryRegistry *registry, + const Parameters ¶meters ); + + void addListener( TestResult *eventManager ); + + void removeListener( TestResult *eventManager ); + + void addXmlOutputterHooks( XmlOutputter *outputter ); + + void removeXmlOutputterHooks(); + + void uninitialize( TestFactoryRegistry *registry ); +}; + + +} // namespace CppUnit + +#endif // !defined(CPPUNIT_NO_TESTPLUGIN) + +#endif // CPPUNIT_PLUGIN_TESTPLUGINADAPTER -- cgit v1.2.1