This page last changed on Jun 03, 2009 by ggaskell.

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.

The JUnit report macro appears as shown in the screenshot below.

Screenshot: The JUnit Report Macro in Confluence

When generating reports from JUnit, set the Apache Ant formatter to 'XML'.

On this page:

Usage with the Macro Browser

To insert the JUnit report macro into a page using the Macro Browser,

  1. Open your desired Confluence page, then click the 'Edit' button. The 'Edit Page' mode opens.
  2. Next, click the Macro Browser icon on the editor toolbar. The Macro Browser will open in the middle of the screen.
  3. In the Macro Browser, type the name of your desired macro into the search box at the top right of the window. Macros with a matching name will appear in the centre pane. Click on the desired macro to see its options screen. Here, you can set the macro parameters then click 'insert' to put the macro into the page.

Once you've found the JUnit report macro, fill in the URL fields and click 'insert' to add it to your page.

Usage with the Wiki Markup Editor

To insert the JUnit report macro into a page using the Wiki Markup Editor,

Enter the junitreport code tags into your document as follows.

{junitreport:directory=file:///*directory*/}

Parameters

Parameters are settings for Confluence macros that allow the user to control their content or presentation. The table below lists relevant parameters for this macro.

Parameter names are displayed differently in the macro browser interface and in wiki markup. Below, parameter names used in the macro browser are indicated in Bold text, while their equivalents in wiki markup are indicated in (bracketed) text. If the latter is not shown, then in wiki markup, the parameter's name should be omitted and only its value should be added immediately after the colon symbol (:).

Parameter Default Description
Directory (URL) of your test result files
(directory)
None URL of a directory containing your test result files.
Report Detail
(reportdetail)
'fixture' Detail for report. Can be 'all', 'fixture', 'summary' or 'failuresonly'.
URL of the test result XML file
(url)
None URL of a particular test result XML file. For Confluence installations without anonymous user access, you can specify logon credentials as part of this parameter in the form of URL parameters:
  • os_username — The username of a Confluence user with permission to access to the JUnit test results.
  • os_password — The password of the Confluence user specified in the os_username parameter.
(debug) None Shows the content of failures, as well as the error messages.

Examples

Loading JUnit reports from a local drive

{junitreport:directory=file:///C:/TEMP/}

Must be a directory name and not the XML file itself.


Loading JUnit reports from a network drive

{junitreport:url=http://*host*/*path*}


Loading JUnit reports from a Confluence instance

{junitreport:url=http://yourConfluenceInstance.com/download/attachments/<page id>/file.xml}


Loading JUnit reports from a Confluence instance without anonymous user access

If your Confluence instance is not accessible by anonymous users, specify logon 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 "admin".

{junitreport:url=http://yourConfluenceInstance.com/download/attachments/<page id>/file.xml?os_username=admin&os_password=admin}
If you use both the directory and url parameters in the same macro, the directory will be used and the url parameter ignored.
RELATED TOPICS

Working with Macros

Take me back to the Confluence User Guide.

Document generated by Confluence on Nov 05, 2009 23:35