Blame include/cppunit/XmlOutputterHook.h

Packit 8c9aa0
#ifndef CPPUNIT_XMLOUTPUTTERHOOK_H
Packit 8c9aa0
#define CPPUNIT_XMLOUTPUTTERHOOK_H
Packit 8c9aa0
Packit 8c9aa0
#include <cppunit/Portability.h>
Packit 8c9aa0
Packit 8c9aa0
Packit 8c9aa0
CPPUNIT_NS_BEGIN
Packit 8c9aa0
Packit 8c9aa0
Packit 8c9aa0
class Test;
Packit 8c9aa0
class TestFailure;
Packit 8c9aa0
class XmlDocument;
Packit 8c9aa0
class XmlElement;
Packit 8c9aa0
Packit 8c9aa0
Packit 8c9aa0
Packit 8c9aa0
/*! \brief Hook to customize Xml output.
Packit 8c9aa0
 *
Packit 8c9aa0
 * XmlOutputterHook can be passed to XmlOutputter to customize the XmlDocument.
Packit 8c9aa0
 *
Packit 8c9aa0
 * Common customizations are:
Packit 8c9aa0
 * - adding some datas to successfull or failed test with
Packit 8c9aa0
 *   failTestAdded() and successfulTestAdded(),
Packit 8c9aa0
 * - adding some statistics with statisticsAdded(),
Packit 8c9aa0
 * - adding other datas with beginDocument() or endDocument().
Packit 8c9aa0
 *
Packit 8c9aa0
 * See examples/ClockerPlugIn which makes use of most the hook.
Packit 8c9aa0
 *
Packit 8c9aa0
 * Another simple example of an outputter hook is shown below. It may be  
Packit 8c9aa0
 * used to add some meta information to your result files. In the example,
Packit 8c9aa0
 * the author name as well as the project name and test creation date is
Packit 8c9aa0
 * added to the head of the xml file.
Packit 8c9aa0
 *
Packit 8c9aa0
 * In order to make this information stored within the xml file, the virtual 
Packit 8c9aa0
 * member function beginDocument() is overriden where a new 
Packit 8c9aa0
 * XmlElement object is created.
Packit 8c9aa0
 *
Packit 8c9aa0
 * This element is simply added to the root node of the document which
Packit 8c9aa0
 * makes the information automatically being stored when the xml file
Packit 8c9aa0
 * is written.
Packit 8c9aa0
 *
Packit 8c9aa0
 * \code
Packit 8c9aa0
 * #include <cppunit/XmlOutputterHook.h>
Packit 8c9aa0
 * #include <cppunit/XmlElement.h>
Packit 8c9aa0
 * #include <cppunit/tools/StringTools.h>
Packit 8c9aa0
 * 
Packit 8c9aa0
 * ...
Packit 8c9aa0
 * 
Packit 8c9aa0
 * class MyXmlOutputterHook : public CppUnit::XmlOutputterHook
Packit 8c9aa0
 * {
Packit 8c9aa0
 * public:
Packit 8c9aa0
 *   MyXmlOutputterHook(const std::string projectName,
Packit 8c9aa0
 *                      const std::string author)
Packit 8c9aa0
 *   {
Packit 8c9aa0
 *      m_projectName = projectName;
Packit 8c9aa0
 *      m_author      = author;
Packit 8c9aa0
 *   };
Packit 8c9aa0
 * 
Packit 8c9aa0
 *   virtual ~MyXmlOutputterHook()
Packit 8c9aa0
 *   {
Packit 8c9aa0
 *   };
Packit 8c9aa0
 * 
Packit 8c9aa0
 *   void beginDocument(CppUnit::XmlDocument* document)
Packit 8c9aa0
 *   {
Packit 8c9aa0
 *     if (!document)
Packit 8c9aa0
 *       return;
Packit 8c9aa0
 *
Packit 8c9aa0
 *     // dump current time
Packit 8c9aa0
 *     std::string szDate          = CppUnit::StringTools::toString( (int)time(0) );
Packit 8c9aa0
 *     CppUnit::XmlElement* metaEl = new CppUnit::XmlElement("SuiteInfo", 
Packit 8c9aa0
 *                                                           "");
Packit 8c9aa0
 *
Packit 8c9aa0
 *     metaEl->addElement( new CppUnit::XmlElement("Author", m_author) );
Packit 8c9aa0
 *     metaEl->addElement( new CppUnit::XmlElement("Project", m_projectName) );
Packit 8c9aa0
 *     metaEl->addElement( new CppUnit::XmlElement("Date", szDate ) );
Packit 8c9aa0
 *    
Packit 8c9aa0
 *     document->rootElement().addElement(metaEl);
Packit 8c9aa0
 *   };
Packit 8c9aa0
 * private:
Packit 8c9aa0
 *   std::string m_projectName;
Packit 8c9aa0
 *   std::string m_author;
Packit 8c9aa0
 * }; 
Packit 8c9aa0
 * \endcode
Packit 8c9aa0
 *
Packit 8c9aa0
 * Within your application's main code, you need to snap the hook 
Packit 8c9aa0
 * object into your xml outputter object like shown below:
Packit 8c9aa0
 *
Packit 8c9aa0
 * \code
Packit 8c9aa0
 * CppUnit::TextUi::TestRunner runner;
Packit 8c9aa0
 * std::ofstream outputFile("testResults.xml");
Packit 8c9aa0
 * 
Packit 8c9aa0
 * CppUnit::XmlOutputter* outputter = new CppUnit::XmlOutputter( &runner.result(),
Packit 8c9aa0
 *                                                               outputFile );    
Packit 8c9aa0
 * MyXmlOutputterHook hook("myProject", "meAuthor");
Packit 8c9aa0
 * outputter->addHook(&hook);
Packit 8c9aa0
 * runner.setOutputter(outputter);    
Packit 8c9aa0
 * runner.addTest( VectorFixture::suite() );   
Packit 8c9aa0
 * runner.run();
Packit 8c9aa0
 * outputFile.close();
Packit 8c9aa0
 * \endcode
Packit 8c9aa0
 *
Packit 8c9aa0
 * This results into the following output:
Packit 8c9aa0
 *
Packit 8c9aa0
 * \code
Packit 8c9aa0
 * <TestRun>
Packit 8c9aa0
 *   <suiteInfo>
Packit 8c9aa0
 *     <author>meAuthor</author>
Packit 8c9aa0
 *     <project>myProject</project>
Packit 8c9aa0
 *     <date>1028143912</date>
Packit 8c9aa0
 *   </suiteInfo>
Packit 8c9aa0
 *   <FailedTests>
Packit 8c9aa0
 *    ...
Packit 8c9aa0
 * \endcode
Packit 8c9aa0
 *
Packit 8c9aa0
 * \see XmlOutputter, CppUnitTestPlugIn.
Packit 8c9aa0
 */
Packit 8c9aa0
class CPPUNIT_API XmlOutputterHook
Packit 8c9aa0
{
Packit 8c9aa0
public:
Packit 8c9aa0
  /*! Called before any elements is added to the root element.
Packit 8c9aa0
   * \param document XML Document being created.
Packit 8c9aa0
   */
Packit 8c9aa0
  virtual void beginDocument( XmlDocument *document );
Packit 8c9aa0
Packit 8c9aa0
  /*! Called after adding all elements to the root element.
Packit 8c9aa0
   * \param document XML Document being created.
Packit 8c9aa0
   */
Packit 8c9aa0
  virtual void endDocument( XmlDocument *document );
Packit 8c9aa0
Packit 8c9aa0
  /*! Called after adding a fail test element.
Packit 8c9aa0
   * \param document XML Document being created.
Packit 8c9aa0
   * \param testElement \<FailedTest\> element.
Packit 8c9aa0
   * \param test Test that failed.
Packit 8c9aa0
   * \param failure Test failure data.
Packit 8c9aa0
   */
Packit 8c9aa0
  virtual void failTestAdded( XmlDocument *document,
Packit 8c9aa0
                              XmlElement *testElement,
Packit 8c9aa0
                              Test *test,
Packit 8c9aa0
                              TestFailure *failure );
Packit 8c9aa0
Packit 8c9aa0
  /*! Called after adding a successful test element.
Packit 8c9aa0
   * \param document XML Document being created.
Packit 8c9aa0
   * \param testElement \<Test\> element.
Packit 8c9aa0
   * \param test Test that was successful.
Packit 8c9aa0
   */
Packit 8c9aa0
  virtual void successfulTestAdded( XmlDocument *document,
Packit 8c9aa0
                                    XmlElement *testElement,
Packit 8c9aa0
                                    Test *test );
Packit 8c9aa0
Packit 8c9aa0
  /*! Called after adding the statistic element.
Packit 8c9aa0
   * \param document XML Document being created.
Packit 8c9aa0
   * \param statisticsElement \<Statistics\> element.
Packit 8c9aa0
   */
Packit 8c9aa0
  virtual void statisticsAdded( XmlDocument *document,
Packit 8c9aa0
                                XmlElement *statisticsElement );
Packit 8c9aa0
Packit 8c9aa0
  virtual ~XmlOutputterHook() {}
Packit 8c9aa0
};
Packit 8c9aa0
Packit 8c9aa0
Packit 8c9aa0
CPPUNIT_NS_END
Packit 8c9aa0
Packit 8c9aa0
#endif  // CPPUNIT_XMLOUTPUTTERHOOK_H