Overview

Xray enables easy integration with TeamCity through the "Xray TeamCity Plugin", providing the means for successful Continuous Integration by allowing users to report automated testing results.

Release Notes

• Xray TeamCity Plugin 1.1.4 Release Notes
• Xray TeamCity Plugin 1.1.3 Release Notes
• Xray TeamCity Plugin 1.1.2 Release Notes
• Xray TeamCity Plugin 1.1.1 Release Notes
• Xray TeamCity Plugin 1.1.0 Release Notes
• Xray TeamCity Plugin 1.0.0 Release Notes

Installation

The installation is made manually. For more information on how to install add-ons, please refer to how to install add-ons.

Manual Installation

1. Upload the plugin
   
   

2. Restart TeamCity (if needed as shown in the screenshot below)

Configuration

Xray for TeamCity is configured in the global settings configuration page  Administration > Integrations > Xray.

Jira servers

The Jira servers configuration defines connections with Jira instances. 

To add a new Jira instance connection, you need to specify some properties:

1. Configuration alias: a friendly name for the configuration
2. Server or Cloud: Server
   
3. Server Address: The address of the Jira Server where Xray is running
4. Authentication:
   
   1. User: username
   2. Password.

Jira Cloud

The Jira Cloud configuration defines connections with Jira Cloud. 

To add a new Jira Cloud connection, you need to specify some properties:

1. Configuration alias: a friendly name for the configuration
2. Server or Cloud: Cloud
3. Authentication:
   
   1. Client ID: obtained from Xray Cloud (more info here)
   2. Client Secret: obtained from Xray Cloud (more info here)

Build Steps

Build steps are the building blocks of the build process. These need to be defined in the build configuration.

The app provides:

• one build step for exporting Cucumber Scenario/Scenario Outlines from Jira as .feature files
• one build step for importing Cucumber Tests from existing Cucumber features into Jira.
• one build step which publishes the execution results back to Jira.

Xray: Cucumber Features Export Task

This build step will export the Cucumber Tests (i.e., Scenario/Scenario Outlines) in .feature or bundled in a .zip file. The rules for exporting are defined here.

It invokes Xray's Export Cucumber Tests REST API endpoint (see more information: server or cloud).

Configuration

Some fields need to be configured in order to export the Cucumber Tests. As input, you can either specify issue keys (see the endpoint documentation for the server or cloud) or the ID of the saved filter in Jira.

Xray: Cucumber Features Import Task

This build step is only available for the server and will import existing cucumber Tests from existing Cucumber feature files into Xray issues. This Task will import from .feature files and also from .zip files.

It invokes Xray's Import Cumcumber Tests REST API endpoint (see more information here)

Xray: Results Import Task

The app provides easy access to Xray's Import Execution Results REST API endpoints (see more information for the server or cloud). Therefore, it mimics the endpoints input parameters.

It supports importing results in Xray's own JSON format, Cucumber, Behave, JUnit, and NUnit, among others. However, there are some endpoints in the server that may not yet be available for Xray Cloud. 

These are the available endpoints.

	Server	Cloud
Xray JSON
Cucumber JSON
Cucumber JSON multipart
Behave JSON
Behave JSON multipart
JUnit XML
JUnit XML multipart
NUnit XML
NUnit XML multipart
Robot XML
Robot XML multipart
Compressed .zip file
TestNG XML
TestNG XML multipart

Using a glob expression, you can import multiple results files in the following formats:

• JUnit
• TestNG
• NUnit
• Robot framework

For those formats, the file path needs to be relative to the workspace.

Configuration 

Additional fields

Depending on the chose test result format and endpoint, some additional fields may need to be configured.

Examples

Cucumber

In a typical Cucumber Workflow, after having created a Cucumber project and the Cucumber tests specified in Jira, you may want to have a project that exports the features from Jira, executes the automated tests on a CI environment and then imports back its results.

For this scenario, the Jenkins project would be configured with a set of tasks responsible for:

1. Pulling the Cucumber project
2. Exporting Cucumber features from Jira to your Cucumber project
3. Executing the tests in the CI environment
4. Importing the execution results back to Jira

Exporting Cucumber features

To start the configuration, add the build step Xray: Cucumber Features Export Task.

After that, configure it.

In this example, we configured the task to extract the features from a set of issues (PROJ-78 and PROJ-79) to the folder that holds the Cucumber project.

Importing Cucumber features

To start the configuration, add the build step Xray: Cucumber Features Import Task.

After that, configure it.

In this example, we configured the task to import to the Project TEAM of the Xray instance all the .features and .zip files that are contained in /Cucumber directory and sub directories, which were modified in the last 3 hours.

Importing the execution results

To start the configuration, add a build step Xray: Results Import Task.

After that, you may configure it.

In this example, we configured the task to import the Cucumber JSON results back to Jira.

Once all configurations are done, click Save at the bottom of the page.

After running the job, the expected result is a new Test Execution issue created in the Jira instance.

Importing the execution results with user-defined field values

For Cucumber, Behave, JUnit, Nunit and Robot, Xray for Jenkins allows you to create new Test Executions and have control over newly-created Test Execution fields. You can send two files, the normal execution result file and a JSON file similar to the one Jira uses to create new issues. More details regarding how Jira creates new issues here. 

For this scenario and example, the import task needs to be configured with the Cucumber JSON Multipart format. When selecting this option, you can additionally configure the Test Execution fields in one of two ways:

• Insert the relative path to the JSON file containing the information;
• Or, insert the JSON content directly in the field.
  
  

In this example, we configured the following object:

{
   "fields": {
      "project": {
         "key": "PROJ"
      },
      "summary": "Test Execution for Cucumber results",
      "issuetype": {
         "id": "10102"
      }
   }
}

And configured the task to import the Cucumber JSON Multipart results back to Jira.

Once all configurations are done, click Save.

After running the job, the expected result is a new Test Execution issue created in the Jira instance, with the Test Execution fields as specified in the build step configuration.

JUnit

Apart from supporting Cucumber natively, Xray enables you to take advantage of many other testing frameworks like JUnit. In this sense, Xray for Jenkins lets you import results in other formats besides Cucumber JSON.

If you want to import JUnit XML reports, a typical Job outline would be:

1. Pulling the JUnit project
2. Executing the tests in the CI environment
3. Importing the execution results, including Tests, to JIRA

Importing the execution results

To start the configuration, add the build step Xray: Results Import Task.

After that, configure it.

In this example, we have a configuration where the JUnit XML format is chosen.

After running the plan, the expected result is a new Test Execution issue created in the JIRA instance.

Make sure to select "Always, even if build stop command was issued" so, even some previous step fail, the tests will still be imported.

You can also import multiple results using a glob expression, like in the following example

Troubleshooting

The build process is failing with status code 403

When you check the log, it has the following:

By default, when you successively try to log into Jira with the wrong credentials, the Jira instance will prompt you to provide a CAPTCHA the next time you try to log in. It is not possible to provide this information via the build process, so it will fail with status code 403 Forbidden.

You will need to log into Jira via the browser and provide the CAPTCHA.

If you are a Jira administrator, you can go to Jira administration > User Management and reset the failed login.

Invalid JIRA instance

When you check the log, it has the following:

This occurs when a JIRA instance is selected in the build step configuration and that instance is later deleted in the Xray global settings.

This error is shown in the build step.

To solve this, edit the build step, select a valid JIRA Instance and save.