Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jenkinsci/testflo-for-jira-test-management-automation-plugin
TestFLO test results publisher plugin for Jenkins
https://github.com/jenkinsci/testflo-for-jira-test-management-automation-plugin
deviniti jira test-automation test-management
Last synced: 3 months ago
JSON representation
TestFLO test results publisher plugin for Jenkins
- Host: GitHub
- URL: https://github.com/jenkinsci/testflo-for-jira-test-management-automation-plugin
- Owner: jenkinsci
- License: mit
- Created: 2020-03-17T19:57:03.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-28T10:49:48.000Z (4 months ago)
- Last Synced: 2024-09-30T08:10:06.455Z (3 months ago)
- Topics: deviniti, jira, test-automation, test-management
- Language: Kotlin
- Homepage: https://plugins.jenkins.io/testflo-for-jira-test-management-automation/
- Size: 454 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
### About the plugin
This plugin integrates Jenkins with [TestFLO](https://marketplace.atlassian.com/apps/1211393/testflo-test-management-for-jira?hosting=datacenter&tab=overview)
for Jira app, allowing to publish build test results and import them as Test Cases in Jira.
### Requirements
- Jenkins 2.249 or higher
- Jira instance (Server / Data Center) with TestFLO installed and [CI Server connection configured](https://deviniti.com/support/addon/server/testflo/latest/ci-servers-configuration/).
### Supported test results formats
- JUnit
- TestNG
- Cucumber (only in json output format)
- NUnit
### Compatibility with TestFLO app
| Jenkins plugin version | TestFLO app version |
|------------------------|---------------------|
| 1.3.3 | 8.10.1 and higher |
| 1.3.2 | 8.10.1 and higher |
| 1.3.0 | 8.10.1 and higher |
| 1.2.0 | 8.10.0 |
| 1.1.0 | 8.9.0 |
| 1.0.5 | 8.00 to 8.8.1 |
### Usage
This plugin provides new build task, which should be used in Post-build actions in the configuration of a jenkins job:
The following fields are present:
- Jira URL - URL to Jira instance, which receives test results
- User - Jira user login
- Password - Jira user password
- Test results type - Framework used to produce result files. Cucumber supports only json results format
- Test results files - Paths of test results files
- Missing Test Plan key parameter behaviour - when task doesn't get Jira Test Plan issue key, it can either skip this task or fail it
To verify task configuration, you can use "Test connection" button:
To make job possible to trigger from the TestFLO app, it is required to parametrize a job with 4 parameters:
- testPlanKey - contains issue key of Test Plan from which job is being run
- targetIteration - tells whether to add Test Cases to current iteration in test plan, or to create new. You can provide default value using these options:
- CURRENT_ITERATION
- NEW_ITERATION
- testCaseCreationStrategy - tells whether new Test Cases should be created with test results, or only limited to updating existing Test Cases. You can define
default value, using these options:
- CREATE_AND_UPDATE
- UPDATE_EXISTING
- testFloImportResultsParameters - contains parameters as JSON object sent by TestFLO Run automated tests operation, used for passing parameters to TestFLO test results importer
#### Running tests from Jira
Most common usage is to run tests from Jira, using the TestFLO app.
Clicking on the run button triggers execution of selected job in Jenkins.
After Job completes, test results are sent back to Jira, which become Test Case issues on original Test Plan.
#### Running tests directly from Jenkins manually
Another possible way to run tests is to trigger a job execution manually, providing required parameters, which normally are handled automatically, using first
approach.
In this case, the job completed successfully fixing previous failed tests, displaying them in a next Test Plan iteration.
#### Running tests directly from Jenkins as a part of CI process
It is also possible to use automatic job execution, e.g. after changes in code repository are pushed. This however requires specifying default parameters in
plugin configuration.
Another option is to use environment variables instead of job parameters. That way, a job can be parameterless, which could be more useful for scripting
purposes. Example below uses Jenkins pipeline syntax, providing required parameters inside the "environment" directive.
Variable "testResultsType" accepts the following values:
- JUNIT
- TESTNG
- CUCUMBER
- NUNIT
Variable "missingTestPlanKeyStrategy" accepts the following values:
- FAIL_TASK
- SKIP_TASK
```groovy
pipeline {
agent any
environment {
testPlanKey = 'DDD-804'
testCaseCreationStrategy = 'CREATE_AND_UPDATE'
targetIteration = 'CURRENT_ITERATION'
}
post {
always {
step([
$class : 'TestResultSenderBuildStep',
jiraURL : 'http://localhost:5000/jira',
jiraUserName : 'admin',
jiraPassword : hudson.util.Secret.fromString(SECRET),
testResultsDirectory : '**/target/surefire-reports/*.xml',
testResultsType : 'JUNIT',
missingTestPlanKeyStrategy: 'FAIL_TASK'
])
}
}
}
```