Page History
Table of Contents |
---|
...
Xray for Jenkins provides support for pipelines projects, allowing you to use Xray specific tasks.
Here is a simple example of a pipeline script using the Xray: Cucumber Features Export Task
Code Block | ||||
---|---|---|---|---|
| ||||
pipeline {
agent any
stages {
stage('Export Cucumber') {
steps {
step([$class: 'XrayExportBuilder', filePath: '\\features', issues: 'IF-1', serverInstance: '2ffc3a3e-9e2f-4279-abcd-e9301fe47bed'])
}
}
}
} |
Info | ||
---|---|---|
| ||
For Pipeline specific documentation, you may want to give a look at: |
Examples
JUnit
This is a declarative example, for JUnit based tests.
There are 3 available steps to be used in a Pipeline project:
XrayImportBuilder
-
Import test results (Junit, NUnit, etc...) from your Jenkins job to JiraXrayExportBuilder
-
Export feature files from Jira to your Jenkins job workspaceXrayImportFeatureBuilder
-
Import feature files from Jenkins to Jira
Info | ||
---|---|---|
| ||
For each of the steps mentioned above, you can check the generated syntax reference in the official Jenkins documentation website. |
Step: XrayImportBuilder (import test execution results)
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
| ||||||||
Code Block | ||||||||
| ||||||||
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
|
Expand | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||
| title | Jenkinsfile example (scripted)
|
Expand | |||||||
---|---|---|---|---|---|---|---|
| |||||||
|
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).
|
Expand | |||||||
---|---|---|---|---|---|---|---|
| |||||||
|
Step: XrayExportBuilder (export cucumber features from Jira to Jenkins)
Expand | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
|
Expand | |||||
---|---|---|---|---|---|
| |||||
|
Expand | |||||
---|---|---|---|---|---|
| |||||
|
Expand | |||||
---|---|---|---|---|---|
| |||||
|
Step: XrayImportFeatureBuilder (import cucumber features from Jenkins to Jira)
Expand | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||
|
Expand | |||||
---|---|---|---|---|---|
| |||||
|
Expand | |||||
---|---|---|---|---|---|
| |||||
|
Info | ||
---|---|---|
| ||
For Pipeline specific documentation, you may want to give a look at: |
Cucumber Workflow suggestions
Cucumber ("standard" workflow)
This is a declarative example, for Cucumber tests using the "standard" workflow (see Testing in BDD with Gherkin based frameworks (e.g. Cucumber)).
Code Block | ||||
---|---|---|---|---|
| ||||
pipeline {
agent any
stages { | ||||
Code Block | ||||
| ||||
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']]]) stage('Export features from Xray'){ sh "mvn clean compile -f java-junit-calc/pom.xml"steps { } checkout([$class: 'GitSCM', branches: } stage('Test'){[[name: '*/master']], doGenerateSubmoduleConfigurations: false, extensions: [], submoduleCfg: [], userRemoteConfigs: [[credentialsId: 'a3285253-a867-4ea7-a843-da349fd36490', url: 'ssh://git@localhost/home/git/repos/automation-samples.git']]]) steps{ step([$class: 'XrayExportBuilder', filePath: 'cucumber_xray_tests/features', filter: '11400', sh "mvn test -f java-junit-calc/pom.xml"serverInstance: '552d0cb6-6f8d-48ba-bbad-50e94f39b722']) } } stage('Import results to XrayTest') { steps { sh "cd cucumber_xray_tests step([$class: 'XrayImportBuilder', endpointName: '/junit/multipart', importFilePath: 'java-junit-calc/target/surefire-reports/TEST-com.xpand.java.CalcTest.xml', importInfo: '''{&& cucumber -x -f json -o data.json" } } "fields": { stage('Import results to Xray') { "project": steps { "key": "CALC" step([$class: 'XrayImportBuilder', endpointName: '/cucumber', importFilePath: 'cucumber_xray_tests/data.json', serverInstance: '552d0cb6-6f8d-48ba-bbad-50e94f39b722']) }, } "summary": "Test Execution for java junit ${BUILD_NUMBER}",} } |
Cucumber ("VCS/Git based" workflow)
This is a declarative example, for Cucumber tests using the "VCS/Git based" workflow (see Testing in BDD with Gherkin based frameworks (e.g. Cucumber)).
Code Block | ||||
---|---|---|---|---|
| ||||
pipeline { agent any "issuetype":stages { stage('Synch (update) recent tests to Xray'){ "id": "9" steps { }, checkout([$class: "customfield_11807"'GitSCM', branches: [[ "CALC-1200"name: '*/master']], doGenerateSubmoduleConfigurations: false, extensions: [], submoduleCfg: [], userRemoteConfigs: [[credentialsId: 'a3285253-a867-4ea7-a843-da349fd36490', url: 'ssh://git@localhost/home/git/repos/automation-samples.git']]]) ] step([$class: 'XrayImportFeatureBuilder', } }''', inputInfoSwitcher: 'fileContentfolderPath: 'cucumber_xray_tests/features', lastModified: '10', projectKey: 'CALC', serverInstance: '552d0cb6-6f8d-48ba-bbad-50e94f39b722']) } } } } |
Cucumber ("standard" workflow)
This is a declarative example, for Cucumber tests using the "standard" workflow (see Testing in BDD with Gherkin based frameworks (e.g. Cucumber)).
Code Block | ||||
---|---|---|---|---|
| ||||
pipeline { } agent any} stages { stage('Export features from Xray'){ steps { checkout([$class: 'GitSCM', branches: [[name: '*/master']], doGenerateSubmoduleConfigurations: false, extensions: [], submoduleCfg: [], userRemoteConfigs: [[credentialsId: 'a3285253-a867-4ea7-a843-da349fd36490', url: 'ssh://git@localhost/home/git/repos/automation-samples.git']]]) step([$class: 'XrayExportBuilder', filePath: 'cucumber_xray_tests/features', filterurl: '11400', serverInstance: '552d0cb6-6f8d-48ba-bbad-50e94f39b722']ssh://git@localhost/home/git/repos/automation-samples.git']]]) } sh "rm } stage('Test'){ steps{ -rf cucumber_xray_tests/features" sh "cd step([$class: 'XrayExportBuilder', filePath: 'cucumber_xray_tests && cucumber -x -f json -o data.json"/features', filter: '11400', serverInstance: '552d0cb6-6f8d-48ba-bbad-50e94f39b722']) } } stage('Import results to XrayTest') { steps { step([$class: 'XrayImportBuilder', endpointName: '/cucumber', importFilePath: 'sh "cd cucumber_xray_tests/data.json', serverInstance: '552d0cb6-6f8d-48ba-bbad-50e94f39b722']) && cucumber -x -f json -o data.json" } } } } |
Cucumber ("VCS/Git based" workflow)
This is a declarative example, for Cucumber tests using the "VCS/Git based" workflow (see Testing in BDD with Gherkin based frameworks (e.g. Cucumber)).
Code Block | ||||
---|---|---|---|---|
| ||||
pipeline { agent any stages stage('Import results to Xray') { steps { stage('Synch (update) recent tests to Xray'){ step([$class: 'XrayImportBuilder', endpointName: '/cucumber', importFilePath: 'cucumber_xray_tests/data.json', serverInstance: '552d0cb6-6f8d-48ba-bbad-50e94f39b722']) steps} { } } } |
Using parameters
You can ask for human input in your pipeline builds by passing parameters
Code Block | ||||
---|---|---|---|---|
| ||||
pipeline{ checkout([$class: 'GitSCM', branches: [[name: '*/master']], doGenerateSubmoduleConfigurations: false, extensions: [], submoduleCfg: [], userRemoteConfigs: [[credentialsId: 'a3285253-a867-4ea7-a843-da349fd36490', url: 'ssh://git@localhost/home/git/repos/automation-samples.git']]]agent any parameters { string(defaultValue: "NTP", description: '', name: 'projectKey') string(defaultValue: "Android", description: '', name: 'env') step([$class: 'XrayImportFeatureBuilder', folderPath: 'cucumber_xray_tests/features', lastModified: '10', projectKey: 'CALC', serverInstance: '552d0cb6-6f8d-48ba-bbad-50e94f39b722']) } stages { stage ('Import Results') { }steps { } step([$class: 'XrayImportBuilder', stage('Export features from Xray'){ endpointName: '/junit', steps { importFilePath: 'java-junit-calc/target/surefire-reports/*.xml', checkout([$class: 'GitSCM', branches: [[name: '*/master']], doGenerateSubmoduleConfigurations: false, extensions: [], submoduleCfgimportToSameExecution: [], userRemoteConfigs: [[credentialsId: 'a3285253-a867-4ea7-a843-da349fd36490', url: 'ssh://git@localhost/home/git/repos/automation-samples.git']]]) 'true', sh "rm -rf cucumber_xray_tests/features"projectKey: params.projectKey, step([$classrevision: 'XrayExportBuilder', filePath: 'cucumber_xray_tests/features', filter: '11400',params.projectKey + env.BUILD_NUMBER, serverInstance: '552d0cb6-6f8d-48ba-bbad-50e94f39b722'', testEnvironments: params.env]) } } stage('Test'){ steps{ sh "cd cucumber_xray_tests && cucumber -x -f json -o data.json" } } stage('Import results to Xray') { steps { step([$class: 'XrayImportBuilder', endpointName: '/cucumber', importFilePath: 'cucumber_xray_tests/data.json', serverInstance: '552d0cb6-6f8d-48ba-bbad-50e94f39b722']) } } } } |
Using parameters
You can ask for human input in your pipeline builds by passing parameters
}
}
} |
Recommendations
You can automatically generate your step scripts using the Jenkins Snippet Generator.
This is the simplest way to generate your step script, and we strongly recommend the use of this snippet due to the complexity of some task related parameters.
Jira instances configuration via Groovy script (Jenkins Script Console)
If you use a containerized version of Jenkins, or simply want to avoid creating the Jira configurations manually (using the Jenkins UI), you can use the following script in the Jenkins Script Console.
To use the script below, you just need to modify the contents of the instances and deleteOldInstances variables.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
import jenkins.model.Jenkins
import net.sf.json.JSONArray
import net.sf.json.JSONObject
import com.xpandit.plugins.xrayjenkins.model.HostingType
import com.xpandit.plugins.xrayjenkins.model.XrayInstance
import com.xpandit.plugins.xrayjenkins.model.ServerConfiguration
// true, if you want the old Jira instances removed, false otherwise.
boolean deleteOldInstances = false
/* Represents the Jira instances to be added to the Global Jenkins configuration.
* - name: the name of the Jira instance to be displayed to the users.
* - hostingType: must be one of two values. 'SERVER' for Server or Data Center instances OR 'CLOUD' for cloud instances.
* - url: [ONLY FOR SERVER INSTANCES] the base URL/IP of the Jira server address.
* - credentialId: [OPTIONAL] the credential ID from the 'Credentials' plugin that will be used to authenticate the jira REST API requests.
*/
JSONArray instances = [
[
name: 'my Jira server',
| ||||||
Code Block | ||||||
| ||||||
pipeline{ agent any parameters { string(defaultValue: "NTP", description: '', name: 'projectKey') string(defaultValue: "Android", descriptionhostingType: 'SERVER', name: 'env') } stages {url: 'http://example.com', stage ('Import Results') { credentialId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' // Credential ID from the steps {'Credentials' plugin. ], step([$class: 'XrayImportBuilder', endpointNamename: '/junitmy Jira cloud', importFilePathhostingType: 'java-junit-calc/target/surefire-reports/*.xmlCLOUD', importToSameExecutioncredentialId: 'true', xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' // Credential ID from the 'Credentials' plugin. ] ] projectKey: params.projectKey, revision: params.projectKey + env.BUILD_NUMBER,as JSONArray // ~~~ Saves the new Jira instances into the Jenkins global configuration ~~~ ServerConfiguration config = ServerConfiguration.get() List<XrayInstance> xrayInstances = new ArrayList<XrayInstance>() instances.each {instance -> String name = instance.optString('name', '') String hostingTypeString = serverInstance: '552d0cb6-6f8d-48ba-bbad-50e94f39b722',instance.optString('hostingType', '') String url = instance.optString('url', '') String credentialId = testEnvironments: params.env])instance.optString('credentialId', null) HostingType hostingType = hostingTypeString == 'CLOUD' ? }HostingType.CLOUD : HostingType.SERVER xrayInstances.add(new XrayInstance(null, name, hostingType, url, credentialId)) } List<XrayInstance> oldXrayInstances = config.getServerInstances() if (!deleteOldInstances && oldXrayInstances != null) { xrayInstances.addAll(oldXrayInstances) } config.setServerInstances(xrayInstances) config.save() println('Xray Jira Instances } } |
Recommendations
You can automatically generate your step scripts using the Jenkins Snippet Generator.
This is the simplest way to generate your step script, and we strongly recommend the use of this snippet due to the complexity of some task related parameters.
created :)') |
Troubleshooting
The build process is failing with status code 403
...
If you are a Jira administrator, you can go to Jira administration > User Management and reset the failed login.
The Jira xxx configuration of this
...
task was not found
If you obtain this error, probably you have migrated from an old version of this plugin. You need to open each project/job configuration and save it.
...