Atlassian Bamboo CI integration

This article explains how to install and use the Applitools Eyes plug-in for the Atlassian Bamboo CI system.

The Eyes plug-in provides the following functionality:

• A Bamboo task can be used to run an Eyes visual test.

• All visual tasks that run in a Bamboo stage run as a single Eyes batch Two or more test runs can be grouped together as a "batch" using the SDK set batch method/property. In the Eyes Test Manager Test result page, you can see a list of all the batches that have run. You can select the batch and can then see the tests that ran in that batch. Eyes Test Manager provides has various features that allow you to operate on a subset of the batch tests or steps as a whole..

• Test results can be directly viewed directly from the Applitools tab in the Build results page.

This article assumes that you already have Bamboo installed on your system and that you know how to use it. Note that depending on your version of Bamboo, some of the necessary steps or screenshots may be different from those described here.

Installing the Applitools plug-in

Install the Applitools Eyes plugin from the Atlassian Marketplace for Bamboo. Search for the plug-in using the term "Applitools".

Setting up a Visual test

To integrate Bamboo with an Eyes test there are two steps:

• Configure an Applitools plug-in Bamboo task.

• Ensure that the Applitools Eyes test code does call Eyes configurations that clash with the setup done by the Applitools plug-in.

How to do this is covered in the next two sections.

Configuring the Applitools plugin

Open the Plan configuration, Miscellaneous tab:

• Select the "Enable Applitools support" checkbox.

• Enter your API key. To obtain your API key see the article How to retrieve your API key.

• If you use an on-premise server or private cloud, put its URL in the Applitools server URL field (for example https://eyesapi.yourcompany.com). If you use the Applitools public cloud, then leave the field with its default value.

• If you want Eyes to send batch completion notifications then select the Notify on completion checkbox. You configure when, to whom and how the notification are sent using the Eyes Test Manager See Batch completion notifications for details.

• Click Save.

Impact on your test code

The Applitools Bamboo plugin is responsible for setting up the test for the correct Eyes URL, API Key, and Batch information. Therefore you should ensure that your code does not call any of the following methods or their equivalents:

• eyes.setApiKey

• configuration.setApiKey

• eyes.setServerUrl

• configuration.setServerUrl

• eyes.setBatch

• configuration.setBatch

Viewing test results

After your test has run, you can see the results on the Applitools test results tab on the Bamboo Build results page.