Introduction
This article provides a guide to troubleshooting common issues and optimizing your testing workflow when importing tests using the Xray API or UI on both Jira Data Center and Jira Cloud.
Common Issues & Potential Solutions:
Software Version
Confirm whether you are using Xray Cloud or Xray Data Center and adapt to our documentation accordingly.
Do you want to confirm your Xray Version? → [Xray] How can I find my Xray version?
- Looking for Xray Data Center article? → [Xray DataCenter] I'm unable to import Tests
Authentication Issues
Ensure you have the correct authentication credentials for the Xray API. This typically involves a client_id and client_secret.
- How-to → [Xray Cloud] How to get API Keys & [Xray Cloud] Can't generate API Keys (no user found)
- Documentation → Authentication - REST v2PUBLISHED
You may also have authentication errors as described below:
- 400 Bad Request -
- Possibly linked to a wrong request syntax.
- No import test job was created. The content may be in the wrong format or a job might already be in progress.
- Each user can only have one import job running at each given time. So if a job is running and the user tries to start another one, this will result in a 400 response.
- There is a maximum of 1000 tests that can be imported each time, if the input contains more tests than this, the request will also result in a 400 response.
- 401 Unauthorized - Possibly linked to your Xray license may no longer be valid
- 500 INTERNAL SERVER ERROR - An internal error occurred when authenticating the request.
- Occasionally, your authentication token may be revoked and will give you an error. This is due to
Readme
The method you choose to import your test will determine the aspects you need to address.
Importing using API
API Version Issues:
If you are encountering issues with the v1 API, consider switching to the v2 API.- Cloud v1 → REST API v1
- Cloud v2 → REST API v2
Incorrect API Endpoint:
Make sure you’re using the correct API endpoint for importing Tests. For Xray Cloud, the endpoint is different from the one used for Xray Data Center.- Cloud v1 → Importing Tests - REST
- Cloud v2 → Importing Tests - REST v2PUB
Data Format Issues:
Ensure your Tests are in the correct format. For example, when importing using JUnit, make sure your tests are generating reports in the correct format.- Verify JUnit Structure → Taking advantage of JUnit XML reports
When importing data via an API, format issues often arise in the request. For instance, when using the
curl
command, an incorrect number of quotation marks, or hidden characters can cause the request to fail.Parameter-related issues are also frequent. If you provide the wrong Project key or Test Key, it can lead to problems during the import process.
Importing using UI
Data Format Issues:
Ensure your Tests are in the correct format. For example, when importing using JUnit, make sure your tests are generating reports in the correct format.- Verify JUnit Structure → Taking advantage of JUnit XML reports
Note:
Other Common Issues:
Error Messages: Understand common error messages and their solutions.
For example, a 404 error might indicate that you’re trying to import results to the wrong server.
A “No Project” error might indicate an issue with the project key in your import file.
Software Version Issues: If you’re encountering issues after an Xray or Jira update, it could be a software bug. Check the Xray support portal for known issues and updates.
Looking to learn more:
Check out this: TTT: Examples using JUnit