Changes between Version 6 and Version 7 of Boost Test

Timestamp:

Oct 31, 2007, 11:15:11 AM (17 years ago)

Author:

staffan.spam@…

Comment:

Added info on how to redirect the report data to file

Boost Test

@@ -64 +64 @@
 }}}
 
-Using this approach (using `<sh:exec>` to redirect the output to a file) your test log won't be very nice looking. You probably want to tweak this template to generate the XML data by other means and instruct it to output nice log-message.
+Using this approach (using `<sh:exec>` to redirect the output to a file) your test log won't be very nice looking. You probably want to tweak this template to generate the XML data by other means and instruct it to output nice log-messages.
 
-  ''this didn't work for me.  The XSLT is not picking up the error information.  For example, the following Boost.Test XML output:''
+== Appendix A: Redirecting the report data ==
 
-  {{{
-#!xml
-<TestLog>
-  <TestSuite name="MyTest">
-    <TestCase name="my_test">
-      <Error file="tests.cpp" line="13">check add( 2,2 ) == 3 failed</Error>
-      <Error file="tests.cpp" line="14">check add( 2,3 ) == 4 failed</Error>
-      <Error file="tests.cpp" line="15">check add( 2,4 ) == 4 failed</Error>
-      <Info file="tests.cpp" line="17">check add( 2,2 ) == 4 passed</Info>
-      <Info file="tests.cpp" line="28">check &apos;add(..) result: 4&apos; passed</Info>
-      <Info file="tests.cpp" line="30">check add( 2,2 ) == 4 passed</Info>
-      <TestingTime>0</TestingTime>
-    </TestCase>
-  </TestSuite>
-</TestLog>
-  }}}
+By default, Boost.Test outputs the report to stderr and the log to stdout. Ideally, we only want to redirect the report data to our "test_results.xml" file.
 
-  ''gets transformed into:''
+Exactly how you should do this depends on how you use Boost.Test - i.e. if you supply your own main() function or let Boost.Test take care of that for you. In the latter case, this is one way of doing it:
 
-  {{{
-#!xml
-<?xml version="1.0"?>
-<unit_tests>
-  <test>
-    <status/>
-    <fixture>MyTest</fixture>
-    <type>test</type>
-    <name>my_test</name>
-  </test>
-</unit_tests>
-  }}}
+{{{
+//
+// run_tests.cc
+//
 
-  ''clearly something is missing'' -- dabrahams
+#define BOOST_AUTO_TEST_MAIN
+
+#include <iostream>
+#include <fstream>
+#include <cassert>
+#include <boost/test/auto_unit_test.hpp>
+
+
+// Write cerr to file - fail and cry with no apparent error if we can't
+// open the file :)
+struct ReportRedirector
+{
+    std::streambuf *orig;
+    std::ofstream out;
+
+    ReportRedirector() : out("test_results.xml")
+    {
+        assert( out.is_open() );
+        orig = std::cerr.rdbuf(out.rdbuf());
+    }
+
+    ~ReportRedirector()
+    {
+        std::cerr.rdbuf(orig);
+    }
+};
+
+static ReportRedirector foo;
+}}}
+
+There might be other, prettier ways to do this - please contribute if you have a better solution.
+
+Once the report has been properly redirected, you can update your recipe to include logging output:
+
+{{{
+<build xmlns:sh="http://bitten.cmlenz.net/tools/sh" xmlns:x="http://bitten.cmlenz.net/tools/xml">
+  <step id="test" description="Test - run automated tests">
+    <sh:exec executable="run_tests" args="--log_level=all --report_format=XML --report_level=detailed" />
+    <x:transform src="test_results.xml" dest="test_report.xml" stylesheet="test_results.xslt" />
+    <report category="test" file="test_report.xml"/>
+  </step>
+</build>
+}}}