...

Upgrading to version 2.1.0 or above:

Installation

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

...

If you have the actual xray-for-jira-connector.hpi file,

1. Go to the Update Center of Jenkins in Manage Jenkins > Manage Plugins.
2. Select the advanced tab
3. In the Upload Plugin section, click upload and select the file xray-for-jira-connector.hpi file.

Jenkins Native Installation (via web UI)

Since version 2.1.0, you can install the plugin by using the Jenkins native Web UI. You can read more about how to to it here.

Configuration

Xray for Jenkins is configured in the global settings configuration page  Manage Jenkins > Configure System > Xray for Jira configuration.

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
2. Hosting: Hosting (instance type) in this case Server/Data Center.
3. Server Address: The address of the Jira Server where Xray is running
4. Credentials:
   
   1. Use the Jenkins Credentials Plugin to set the username/password (if you are using a Server/Data Center instance) or an API key/secret (if you are using an Cloud instance)
   2. Make sure that the user you are using have the following permissions in the projects where you want to import the results and import/export feature files: View, Edit, Create.

...

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

If you have the actual xray-connector.hpi file,

1. Go to the Update Center of Jenkins in Manage Jenkins > Manage Plugins.
2. Select the advanced tab
3. In the Upload Plugin section, click upload and select the file xray-connector.hpi file.

Jenkins Native Installation (via web UI)

Since version 2.1.0, you can install the plugin by using the Jenkins native Web UI. You can read more about how to to it here.

Configuration

Xray for Jenkins is configured in the global settings configuration page  Manage Jenkins > Configure System > Xray for Jira configuration.

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
2. Hosting: Hosting (instance type) in this case Server/Data Center.
3. Server Address: The address of the Jira Server where Xray is running
4. Credentials:
   
   1. Use the Jenkins Credentials Plugin to set the username/password (if you are using a Server/Data Center instance).
   2. Make sure that the user you are using have the following permissions in the projects where you want to import the results and import/export feature files: View, Edit, Create.

note: the Configuration ID is not editable. This value can be used in the pipelines scripts.

Image Added

Creating a new Project

The project is where the work that should be performed by Jenkins is configured.

For this app, you can configure:

• Freestyle projects
• Maven Projects
• Multi-configuration Projects
• Pipeline Projects

In the home page, clicking for example New Item > Freestyle project, provide a name, and then click OK.

Image Added

Build Steps

Build steps are the building blocks of the build process. These need to be defined in the project 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 post-build action which publishes the execution results back to Jira, regardless of the build process status.

Image Removed

Creating a new Project

The project is where the work that should be performed by Jenkins is configured.

For this app, you can configure:

• Freestyle projects
• Maven Projects
• Multi-configuration Projects
• Pipeline Projects

In the home page, clicking for example New Item > Freestyle project, provide a name, and then click OK.

Image Removed

Build Steps

Build steps are the building blocks of the build process. These need to be defined in the project 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 post-build action which publishes the execution results back to Jira, regardless of the build process status.

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.

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 here).

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 documention here) or the ID of the saved filter in Jira.

Xray: Cucumber Features Import Task

This build step 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 It invokes Xray's Export Cucumber Tests REST API endpoint (see more information here)

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 documention here) or the ID of the saved filter in Jira.

...

Filter ID

...

The relative path of the directory where the features should be exported to; normally, this corresponds to the "features" folder of the Cucumber project that has the implementation steps. Note: The directory will be created if it does not exist.

Xray: Results Import Task

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

It supports importing results in Xray's own JSON format, Cucumber, Behave, JUnit, and NUnit, among others.

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.

Xray: Cucumber Features Import Task

This build step 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 here). Therefore, it mimics the endpoints input parameters.

It supports importing results in Xray's own JSON format, Cucumber, Behave, JUnit, and NUnit, among others.

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 

...

The results relative file path

Note: glob expressions are supported for

• JUnit
• JUnit Multipart
• TestNG
• TestNG Multipart
• NUnit
• NUnit Multipart
• Robot framework
• Robot framework Multipart

Additional fields

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

...

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.

Image Removed

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.

Image Removed

Importing Cucumber features

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

Image Removed

After that, configure it.

In this example, we configured the task to import to the Project IF 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.

Image Removed

Importing the execution results

To start the configuration, add the post-build action Xray: Results Import Task.

Image Removed

After that, configure it.

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

Image Removed

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.

Image Removed

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:

...

Xray: Build Enviroment Variables

Since version 2.2.0, the Xray plugin will now set some build enviroment variables according to the operation result after each of the Xray Steps mensioned above.

Image Added

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.

Image Added

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.

Image Added

Importing Cucumber features

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

Image Added

After that, configure it.

In this example, we configured the task to import to the Project IF 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.

Image Added

Importing the execution results

To start the configuration, add the post-build action Xray: Results Import Task.

Image Added

After that, configure it.

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

Image Added

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

After running the job, the expected result is

...

In this example, we configured the following object:

{
   "fields": {
      "project": {
         "key": "PROJ"
      },
      "summary": "Test Execution for Cucumber results (Generated by job: ${BUILD_TAG})",
      "issuetype": {
         "id": "10102"
      }
   }
}

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

Image Removed

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, with the Test Execution fields as specified in the Jenkins build step configuration.

Image Removed

JUnit

Image Added

Importing the execution results with user-defined field values

For Cucumber, Behave, JUnit, Nunit and RobotApart 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 post-build action Xray: Results Import Task.

Image Removed

...

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 have a configuration where the JUnit XML format is chosen.

Image Removed

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

Image Removed

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

Image Removed

Pipeline projects support

Xray for Jenkins provides support for pipelines projects, allowing you to use Xray specific tasks.

Image Removed

Here is a simple example of a pipeline script using the Xray: Cucumber Features Export Task 

configured the following object:

{
   "fields": {
      "project": {
         "key": "PROJ"
      },
      "summary": "Test Execution for Cucumber results (Generated by job: ${BUILD_TAG})",
      "issuetype": 

pipeline {
    agent any
    stages {"id": "10102"
        stage('Export Cucumber') {
            steps {
               step([$class: 'XrayExportBuilder', filePath: '\\features', issues: 'IF-1', serverInstance: '2ffc3a3e-9e2f-4279-abcd-e9301fe47bed'])
            }
        }
    }
}

Examples

JUnit

This is a declarative example, for JUnit based tests.

}
   }
}

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

Image Added

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, with the Test Execution fields as specified in the Jenkins build step configuration.

Image Added

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 post-build action Xray: Results Import Task.

Image Added

After that, configure it.

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

Image Added

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

Image Added

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

Image Added

Pipeline projects support

Xray for Jenkins provides support for pipelines projects, allowing you to use Xray specific tasks.

Image Added

Here is a simple example of a pipeline script using the Xray: Cucumber Features Export Task 

pipeline {
    agent any
    stages {
        stage('Export Cucumber') {
            steps {
               step([$class: 'XrayExportBuilder', filePath: '\\features', issues: 'IF-1', serverInstance: '2ffc3a3e-9e2f-4279-abcd-e9301fe47bed'])
            }
        }
    }
}

Examples

JUnit

This is a declarative example, for JUnit based tests.

pipeline {
    agent any
    stages {
        stage('Compile'){
            steps {
                checkout([$class: 'GitSCM', branches: [[name: '*/master']], doGenerateSubmoduleConfigurations: false, extensions: [[$class: 'SparseCheckoutPaths', sparseCheckoutPaths: [[path: 'java-junit-calc/']]]], submoduleCfg: [], userRemoteConfigs: [[credentialsId: 'a3285253-a867-4ea7-a843-da349fd36490', url: 'ssh://git@localhost/home/git/repos/automation-samples.git']]])
                sh "mvn clean compile -f java-junit-calc/pom.xml"
            }
        }
        
        stage('Test'){
            steps{
                sh "mvn test -f java-junit-calc/pom.xml"
            }
        }
        
        stage('Import results to Xray') {
            steps {
                step([$class: 'XrayImportBuilder', endpointName: '/junit', fixVersion: 'v3.0', importFilePath: 'java-junit-calc/target/surefire-reports/*.xml', importToSameExecution: 'true', projectKey: 'CALC', serverInstance: '552d0cb6-6f8d-48ba-bbad-50e94f39b722'])
            }
        }
    }
}

JUnit multipart

This is a declarative example, for JUnit based tests using the multipart variant/endpoint which allows customization over the Test Execution issue fields.

By changing the value of the endpointName variable, you can easily adapt it for other automation frameworks (e.g. Robot framework, TestNG, NUnit).  

pipeline {
    agent any
    stages {
        stage('Compile'){
            steps {
                checkout([$class: 'GitSCM', branches: [[name: '*/master']], doGenerateSubmoduleConfigurations: false, extensions: [[$class: 'SparseCheckoutPaths', sparseCheckoutPaths: [[path: 'java-junit-calc/']]]], submoduleCfg: [], userRemoteConfigs: [[credentialsId: 'a3285253-a867-4ea7-a843-da349fd36490', url: 'ssh://git@localhost/home/git/repos/automation-samples.git']]])
                sh "mvn clean compile -f java-junit-calc/pom.xml"
            }
        }
        
        stage('Test'){
            steps{
                sh "mvn test -f java-junit-calc/pom.xml"
            }
        }
        
        stage('Import results to Xray') {
             steps {    

pipeline {
    agent any
    stages {
        stage('Compile'){
        step([$class: 'XrayImportBuilder', endpointName: '/junit/multipart', importFilePath: 'java-junit-calc/target/surefire-reports/TEST-com.xpand.java.CalcTest.xml',  steps importInfo: '''{
                checkout([$class: 'GitSCM', branches: [[name: '*/master']], doGenerateSubmoduleConfigurations: false, extensions: [[$class: 'SparseCheckoutPaths', sparseCheckoutPaths: [[path: 'java-junit-calc/']]]], submoduleCfg: [], userRemoteConfigs: [[credentialsId: 'a3285253-a867-4ea7-a843-da349fd36490', url: 'ssh://git@localhost/home/git/repos/automation-samples.git']]])"fields": {
              "project": {
                sh "key"mvn clean compile -f java-junit-calc/pom.xml: "CALC"
              },
        }
      "summary": "Test 
Execution for java junit ${BUILD_NUMBER}",
    stage('Test'){
          "issuetype":  steps{
                sh "mvn test -f java-junit-calc/pom.xml"
id": "9"
              },
        }
        
 "customfield_11807": [
       stage('Import results to Xray') {
      "CALC-1200"
      steps {
       ]
         step([$class: 'XrayImportBuilder', endpointName: '/junit', fixVersion: 'v3.0', importFilePath: 'java-junit-calc/target/surefire-reports/*.xml', importToSameExecution: 'true', projectKey: 'CALC  }
        }''', inputInfoSwitcher: 'fileContent', serverInstance: '552d0cb6-6f8d-48ba-bbad-50e94f39b722'])
            }
        }

    }
}

Cucumber ("standard" workflow)

...