https://github.com/Xray-App/xray-code-snippets

Xray source-code snippets showcasing the integration with this test management tool for Jira
https://github.com/Xray-App/xray-code-snippets

jira test-automation testing xray

Last synced: 3 months ago
JSON representation

Xray source-code snippets showcasing the integration with this test management tool for Jira

• Host: GitHub
• URL: https://github.com/Xray-App/xray-code-snippets
• Owner: Xray-App
• License: bsd-3-clause
• Created: 2021-07-20T14:45:48.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-07-10T14:07:37.000Z (4 months ago)
• Last Synced: 2024-07-10T22:05:32.168Z (4 months ago)
• Topics: jira, test-automation, testing, xray
• Language: Python
• Homepage:
• Size: 266 KB
• Stars: 22
• Watchers: 8
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - Xray-App/xray-code-snippets - Xray source-code snippets showcasing the integration with this test management tool for Jira (Python)

README

        
# Xray source-code snippets

[![license](https://img.shields.io/badge/License-BSD%203--Clause-green.svg)](https://opensource.org/licenses/BSD-3-Clause)

[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/Xray-App/community)

This repo contains several source-code snippets that show how to invoke [Xray Test Management for Jira](https://getxray.app) using one of the available APIs (see References at bottom), in different languages and, eventually, different HTTP libraries. You can also found examples of how to import from other tools into Xray.

The purpose is to facilitate building out integrations with Xray. Nevertheless, since the open-source community is very active, please check first if there is something already available that meets your needs. There are many packages/libraries already available ([some contributions from the community for Xray server/DC](https://docs.getxray.app/display/XRAY/Integrations+from+the+community+and+other+products)).

Feel free to copy and adapt the code to your own needs.

## Background

### Xray server/DC vs Xray Cloud

Although similar, Xray for Jira server/data center (DC) and Xray for Jira Cloud are different products, essentially because they are built on top of different infrastructure and application capabilities. Jira server/datacenter and Jira Cloud are distinct product, with different roadmaps, built using distinct technologies, providing also different APIs. This has a consequence that apps for Jira server/DC and for Jira Cloud are essentially totally different from an architecture standpoint, but eventually also from a feature perspective.

## Use cases

- [Import test automation results](use_cases/import_automation_results/README.md)

- [Usage of GraphQL API in Xray Cloud](use_cases/graphql_api_usage/README.md)

- [Usage of Jira REST API](use_cases/jira_rest_api_usage/README.md)

- [Import test cases from TestLink](use_cases/import_from_testlink)

## 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

- [Xray server/DC REST API](https://docs.getxray.app/display/XRAY/REST+API)

- [Xray cloud REST API](https://docs.getxray.app/display/XRAYCLOUD/REST+API)

- [Xray cloud GraphQL API](https://docs.getxray.app/display/XRAYCLOUD/GraphQL+API)

## LICENSE

[BSD 3-Clause](LICENSE)