https://github.com/xray-app/tutorial-java-cucumber
Tutorial for Cucumber using Java integrated with Xray and Jira
https://github.com/xray-app/tutorial-java-cucumber
bdd cucumber java jira test-automation testing xray
Last synced: 8 months ago
JSON representation
Tutorial for Cucumber using Java integrated with Xray and Jira
- Host: GitHub
- URL: https://github.com/xray-app/tutorial-java-cucumber
- Owner: Xray-App
- Created: 2021-06-17T14:50:56.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-12-16T16:06:08.000Z (12 months ago)
- Last Synced: 2025-04-06T07:37:35.317Z (8 months ago)
- Topics: bdd, cucumber, java, jira, test-automation, testing, xray
- Language: Shell
- Homepage:
- Size: 25.4 KB
- Stars: 6
- Watchers: 4
- Forks: 15
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Tutorial with Cucumber scenarios/tests, in Java, integrated with Xray
[](https://github.com/Xray-App/tutorial-java-cucumber/actions/workflows/main-cloud.yml)
[](https://opensource.org/licenses/BSD-3-Clause)
[](https://gitter.im/Xray-App/community)
## Overview
Code that supports the tutorial [Testing using Cucumber in Java](https://docs.getxray.app/display/XRAYCLOUD/Testing+using+Cucumber+in+Java) showcasing the integration between [Xray Test Management](https://www.getxray.app/) on Jira and Cucumber (Java).
The test automation code implements some basic tests (i.e. scenarios/scenario outlines) for a dummy calculator, using two stories (i.e. addition and multiplication) as the features we aim to deliver.
## Prerequisites
In order to run this tutorial, you need to have Java (i.e. a JDK) and Maven.
Dependencies aree installed automatically whenever running Maven.
## Running
The straighforward approach to run everything in a single shot is to invoke the auxiliary script [run_all_cloud_standard_workflow.sh](run_all_cloud_standard_workflow.sh).
You need to update the client_id and client_secret to interact with your Xray cloud instance (obtainable from Xray API Keys section); you also need to update the issue keys of the corresponding stories in Jira, that you'll use as basis to generate the .feature file(s).
Remember that to be able to run the scenarios, we need to have the corresponding .feature files. The previous script assumes you are using Xray to manage the specification of the scenarios, so you need to extract them from Jira (more on the possible workflows [here](https://docs.getxray.app/pages/viewpage.action?pageId=31622264)).
When you have the .feature files, containing the Feature along with the Scenario properly tagged, you can finally run the tests using the `mvn` tool.
```bash
mvn clean compile test -Dcucumber.plugin="json:report.json" -Dcucumber.features="features/"
```
We need to specify that we want a Cucumber JSON report as output, and also the path where the .feature files are at.
Tests can also run inside a Docker container; local directory/file should be mounted so that Cucumber results are stored locally.
```bash
docker build . -t cucumber_java_tests
docker run --rm -v $(pwd)/report.json:/source/report.json -t cucumber_java_tests
```
## Submitting results to Jira
Results can be submitted to Jira so that they can be shared with the team and their impacts be easily analysed.
This can be achieved using [Xray Test Management](https://www.getxray.app/) as shown in further detail in this [tutorial](https://docs.getxray.app/display/XRAYCLOUD/Testing+using+Cucumber+in+Java).
This repo contains an auxiliary script [import_results_cloud.sh](import_results_cloud.sh) that does that; it uses a configuration file to have Xray's client_id and client_secret.
You can also have a look at the [workflows implemented in this repo](.github/workflows) using GitHub Actions.
## Auxiliary scripts
This repo also contains some auxiliary shell scripts, provided as an example; feel free to download and customize them to your needs.
You may find scripts for interacting both with Xray server/DC or Xray cloud, which have slightly different APIs.
## Contact
Any questions related with this code, please raise issues in this GitHub project. Feel free to contribute and submit PR's.
For Xray specific questions, please contact [Xray's support team](https://jira.getxray.app/servicedesk/customer/portal/2).
## References
- [Cucumber docs](https://cucumber.io/docs/installation/)
- [Possible workflows for implementing Cucumber](https://docs.getxray.app/pages/viewpage.action?pageId=31622264)
- [Detailed tutorial for Xray Cloud showcasing the integration with Jira Cloud](https://docs.getxray.app/display/XRAYCLOUD/Testing+using+Cucumber+in+Java)
- [Detailed tutorial for Xray server/DC showcasing the integration with Jira server/DC](https://docs.getxray.app/display/XRAY/Testing+using+Cucumber+in+Java)
## LICENSE
[BSD 3-Clause](LICENSE)