aboutsummaryrefslogtreecommitdiffstats
path: root/lib/common_test
diff options
context:
space:
mode:
authorSiri Hansen <[email protected]>2012-12-12 12:31:12 +0100
committerSiri Hansen <[email protected]>2012-12-12 17:20:31 +0100
commit987b281e597f615f07d7ac70f2a57cc42e36454f (patch)
treead068a50ae209ed7f2328d10eddac9e5dcc7bf11 /lib/common_test
parentf309f03b406b9bc30abcc4daf3154e6475363c96 (diff)
downloadotp-987b281e597f615f07d7ac70f2a57cc42e36454f.tar.gz
otp-987b281e597f615f07d7ac70f2a57cc42e36454f.tar.bz2
otp-987b281e597f615f07d7ac70f2a57cc42e36454f.zip
[common_test] Add documentation of new url_base option to cth_surefire
Diffstat (limited to 'lib/common_test')
-rw-r--r--lib/common_test/doc/src/ct_hooks_chapter.xml24
1 files changed, 19 insertions, 5 deletions
diff --git a/lib/common_test/doc/src/ct_hooks_chapter.xml b/lib/common_test/doc/src/ct_hooks_chapter.xml
index 86237f5fc1..27d56fd47d 100644
--- a/lib/common_test/doc/src/ct_hooks_chapter.xml
+++ b/lib/common_test/doc/src/ct_hooks_chapter.xml
@@ -457,12 +457,26 @@ terminate(State) ->
<row>
<cell>cth_surefire</cell>
<cell>no</cell>
- <cell>Captures all test results and outputs them as surefire XML into
- a file. The file which is created is by default called junit_report.xml.
- The name can be by setting the path option for this hook. e.g.
+ <cell><p>Captures all test results and outputs them as surefire
+ XML into a file. The file which is created is by default
+ called junit_report.xml. The file name can be changed by
+ setting the <c>path</c> option for this hook, e.g.</p>
+
<code>-ct_hooks cth_surefire [{path,"/tmp/report.xml"}]</code>
- Surefire XML can forinstance be used by Jenkins to display test
- results.</cell>
+
+ <p>If the <c>url_base</c> option is set, an additional
+ attribute named <c>url</c> will be added to each
+ <c>testsuite</c> and <c>testcase</c> XML element. The value will
+ be a constructed from the <c>url_base</c> and a relative path
+ to the test suite or test case log respectively, e.g.</p>
+
+ <code>-ct_hooks cth_surefire [{url_base,"http://myserver.com/"}]</code>
+ <p>will give a url attribute value similar to</p>
+
+ <code>"http://myserver.com/[email protected]_11.19.39/x86_64-unknown-linux-gnu.my_test.logs/run.2012-12-12_11.19.39/suite.log.html"</code>
+
+ <p>Surefire XML can for instance be used by Jenkins to display test
+ results.</p></cell>
</row>
</table>