• Products
  • Documentation
  • Resources

Insert the JUnit report macro

This macro was intentionally excluded from the new editor and will be deprecated from the legacy editor soon. Read the announcement for more information

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.

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

Use the JUnit Report macro

To add the JUnit Report macro:

  1. When editing , select from the toolbar

  2. Find the item to be inserted and select it

  3. Select Insert

You can also type / on the page to bring up the same list you'd see by selecting from the toolbar.

To edit an existing macro

  1. Select the macro placeholder. The floating toolbar appears.

  2. Select Edit. The right panel opens.

  3. Modify the parameters. Your changes are saved as you go.

  4. Resume editing the page, and the panel closes.

Parameters

Parameters are options that you can set to control the content or format of the macro output. 

If the parameter name used in Confluence Cloud storage format or wikimarkup is different than the label used when inserting macros using the browser or the slash command, it will be listed below in brackets (example).

Parameter

Required

Default

Description

URL of the test result XML file
(url

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: http://yourConfluenceInstance.com/download/attachments/<page id>/file.xml

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.

Directory (URL) of your test result files
(directory

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, file:///C:/TEMP/

Example, for a network drive: http://*host*/*path*

Report Detail
(reportdetail

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.

Wiki markup examples

Wiki markup is useful when you need to add a macro outside the editor, for example as custom content in the sidebar, header or footer of a space.

Macro name: junitreport

Macro body: None.

Loading JUnit reports from a local drive:

1 2 3 4 {junitreport:directory=file:///C:/TEMP/}


Loading JUnit reports from a network drive:

1 2 3 4 {junitreport:url=http://*host*/*path*}


Loading JUnit reports from a Confluence site:

1 2 3 4 {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'.

1 2 3 4 {junitreport:url=http://yourConfluenceInstance.com/download/attachments/<page id>/file.xml?os_username=admin&os_password=secret}

 

Additional Help