Hook to customize Xml output.
XmlOutputterHook can be passed to XmlOutputter to customize the XmlDocument.
Common customizations are:
See examples/ClockerPlugIn which makes use of most the hook.
Another simple example of an outputter hook is shown below. It may be used to add some meta information to your result files. In the example, the author name as well as the project name and test creation date is added to the head of the xml file.
In order to make this information stored within the xml file, the virtual member function beginDocument() is overriden where a new XmlElement object is created.
This element is simply added to the root node of the document which makes the information automatically being stored when the xml file is written.
#include <cppunit/XmlElement.h>
...
class MyXmlOutputterHook : public CppUnit::XmlOutputterHook
{
public:
MyXmlOutputterHook(const std::string projectName,
const std::string author)
{
m_projectName = projectName;
m_author = author;
};
virtual ~MyXmlOutputterHook()
{
};
{
if (!document)
return;
std::string szDate = CppUnit::StringTools::toString( (int)time(0) );
CppUnit::XmlElement* metaEl = new CppUnit::XmlElement("SuiteInfo",
"");
metaEl->addElement( new CppUnit::XmlElement("Author", m_author) );
metaEl->addElement( new CppUnit::XmlElement("Project", m_projectName) );
metaEl->addElement( new CppUnit::XmlElement("Date", szDate ) );
document->rootElement().addElement(metaEl);
};
private:
std::string m_projectName;
std::string m_author;
};
Within your application's main code, you need to snap the hook object into your xml outputter object like shown below:
std::ofstream outputFile("testResults.xml");
CppUnit::XmlOutputter* outputter = new CppUnit::XmlOutputter( &runner.result(),
outputFile );
MyXmlOutputterHook hook("myProject", "meAuthor");
outputter->addHook(&hook);
runner.setOutputter(outputter);
runner.addTest( VectorFixture::suite() );
runner.run();
outputFile.close();
This results into the following output:
<TestRun>
<suiteInfo>
<author>meAuthor</author>
<project>myProject</project>
<date>1028143912</date>
</suiteInfo>
<FailedTests>
...
- See also:
- XmlOutputter, CppUnitTestPlugIn.