4.1.  Integration for Atlassian Confluence

Table of Contents

4.1.1. Using the Testcenter Macro in Confluence
4.1.2. The Macro Settings Dialog

The plugin can be downloaded from the following URL: https://download.froglogic.com/resources/confluence-testcenter-integration-latest.jar.

Once you have downloaded the plugin, log in to the Confluence platform where the plugin will be installed (admin rights are required) and navigate to the Add-ons system panel.

Select Upload add-on, enter the path to the downloaded .jar file in the Upload Plugin dialog which pops up, and select 'Upload'.

Now the Testcenter Macro should be listed within the user installed add-ons list.

Before the plugin can be used, you will need to configure a Squish Test Center URL and valid login credentials for that defined server instance. To initialize it, in the Add-ons list, click the Testcenter Macro plugin. Click the Configure button, beside the Enable and Disable buttons. The Testcenter Macro Configuration page will open.

Enter the URL of your Test Center server in the Squish Test Center field and press the Save button:


Confluence Configuration page

Now the Testcenter Macro is ready to use.

4.1.1.  Using the Testcenter Macro in Confluence

By using the plugin, you can refer to some distinct test suite which is managed by your server. Any occurrences of the word {Testcenter} within Confluence pages will now be replaced the the latest result outcomes ("PASS", "FAIL", "WARN"). Tests can be defined for each instance individually, where 'instances" here is meant to be occurrences of the word {Testcenter} on the page.

To define a certain test to be looked up, edit the Confluence page:

  • type: {Testcenter}

  • hover and click the {Testcenter} macro (now contained in a macro-instance box)

  • a menu will pop up - select Edit to open the Macro dialog

4.1.2. The Macro Settings Dialog


Confluence Macro Settings Dialog


Below is a description of the fields in the dialog and how to use them.

Project (*must be filled) - Synopsis: projectname

Defines within which Test Center defined project the macro should do lookup for latest results of tests which the next parameter ('Test' - see below) defines.

Test (*can be left blank) - Synopsis: testsuite|testcase|feature|scenario

When 'Test' parameter field is left blank, the macro then shows up by indicating a 'whole project' overview.

Which means:

  • Project is failed (): In cases where any single test contained in 'project' was a FAIL.

  • Project is warned (): If maybe no test run has failed actually, but if any kind of WARNING came up.

  • Project is passed (): If ALL tests logged just PASS results, and not a single FAIL or WARN was logged.

To create lookup for distinct test suite's latest result outcomes, this can be selected by giving the test suite's name as parameter to the 'Test' field.

The same way, for linking to a single test case of a suite, a BDD feature or even a single Scenario within a feature, these then can be appended, each after another, separated by '|' signs.

Labels (*can be left blank) - Synopsis: label1=value1,label2=value2,...

Does lookup that test which the 'Test' field parameter defines, but filtered by a list of given labels, coma separated, each given in a form: 'labelname=labelvalue'.

Mode (selectable mode value) - One of the following modes can be chosen:

  • Info : shows additional information beside the test outcome: test name, labels (if any defined) and a timestamp of the test's last execution date.

  • Text : shows the test outcome only, as a link to that test run on the server

  • Badge : shows the link as a 'Status Badge' in either red, green or yellow, according to the test's result outcome

  • SmallIcon : shows a small icon indicating the result (useful for placement in Table cells) as a link to the run on the server

  • LargeIcon : shows a large icon indicating the result as a link to the run on the server

  • InlineText : shows latest result inline, within floating text contents, as colored link to the test

  • InlineBadge : shows as 'Status Badge' usable inline within floating texts

  • InlineIcon : shows an inline 'result icon' which can be used like emojis within floating text contents