JUnit Report Macro
The JUnit Report macro displays a summary of JUnit test results from a directory accessible by the Confluence server. JUnit is a unit testing framework which allows programmers to ensure that individual units of Java source code are functioning correctly.For security reasons JUnit test result files can only be imported from a specified location in the Confluence server's file system. We recommend administrators create a folder in their Confluence home directory, add the system property confluence.junit.report.directory and specify the location for JUnit test result files to be imported from. JUnit Test result files cannot be imported from the server until this system property is set.The JUnit Report macro appears as shown in the screenshot below.
Screenshot: The JUnit Report macro in Confluence
Note:When generating reports from the JUnit Report macro, set the Apache Ant formatter to 'XML'.
Using the JUnit Report macro
To add the JUnit Report macro to a page:
- In the Confluence editor, choose Insert > Other Macros
- Find and select the required macro
Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Autocomplete for links, files, macros and mentions.
To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro.
Parameters
Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example).
Parameter | Required | Default | Description |
|---|---|---|---|
URL of the test result XML file | Must include either the directory or the url parameter | None | URL of a particular test result XML file. Is overridden by the Directory (URL) of your test result files parameter if you use both. Example, from a Confluence instance: For Confluence installations without anonymous user access, you can specify logon credentials as part of this parameter in the form of URL parameters:
|
Directory (URL) of your test result files | Must include either the directory or the url parameter | None | URL of a directory containing your test result files. This must be a directory name and not the XML file itself. Overrides the URL of the test result XML file parameter if you use both. Example, Example, for a network drive: |
Report Detail | No | all | Detail for the report. Can be all, fixture, summary or failuresonly. |
Debug(debug) | No | None | Shows the content of failures, as well as the error messages. |
Code examples
The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page.
Macro name: junitreport
Macro body: None.
Storage format example
<ac:structured-macro ac:name="junitreport">
<ac:parameter ac:name="reportdetail">summary</ac:parameter>
<ac:parameter ac:name="directory">
<ri:url ri:value="http://confluence.com/download/attachments/123/"/>
</ac:parameter>
<ac:parameter ac:name="debug">true</ac:parameter>
<ac:parameter ac:name="url">
<ri:url ri:value="http://confluence.com/download/attachments/123/file.xml"/>
</ac:parameter>
</ac:structured-macro>Wiki markup examples
Loading JUnit reports from a local drive:
{junitreport:directory=file:///C:/TEMP/}
Loading JUnit reports from a network drive:
{junitreport:url=http://*host*/*path*}
Loading JUnit reports from a Confluence site:
{junitreport:url=http://yourConfluenceInstance.com/download/attachments/<page id>/file.xml}
Loading JUnit reports from a Confluence site that requires authentication:
If your Confluence site is not accessible by anonymous users, specify login credentials with the os_username and os_password URL parameters (as part of the macro's url parameter). In this case, we are specifying a username of 'admin' and a password of 'secret'.
{junitreport:url=http://yourConfluenceInstance.com/download/attachments/<page id>/file.xml?os_username=admin&os_password=secret}