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?
Importing Test using Xray Cloud
Confirm how you are importing Results
API
UI
Importing Tests using Xray Data Center
Confirm how you are importing Results
API
UI
Confirm if you are using API to import your tests
Authentication Issues: Ensure you have the correct authentication credentials for the Xray API. This typically involves a client ID and client secret.
- Are you missing credentials? → [Xray Cloud] How to get API Keys
API Version Issues: If you’re encountering issues with the v1 API, consider switching to the v2 API.
- Cloud v1 → REST API v1
- Cloud v2 → REST API v2
- Data Center v2 → REST API v2
Incorrect API Endpoint: Make sure you’re using the correct API endpoint for importing test results. For Xray Cloud, the endpoint is different from the one used for Xray Data Center.
- Confirm which endpoint you are using for importing test results.
- → Data Center |
- → Data Center |
- → Cloud v1 | Importing Tests - REST
- → Cloud v2 | Importing Tests - REST v2PUBLISHED
- Confirm which endpoint you are using for importing test results.
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.
Data Format Issues: Ensure your test results are in the correct format. For example, when importing JUnit results, make sure your tests are generating JUnit reports in the correct format.
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.
JUnit Integration
Ensure that your tests are integrated with JUnit and that the JUnit XML output of your test runner is correctly configured.
Xray API Authentication
Verify that you have the correct authentication credentials for the Xray API2. This typically involves a client ID and client secret.
JUnit Report Generation
Make sure your tests are generating JUnit reports in the correct format. Xray can import these reports to create Test Executions
API Endpoint
Check that you’re using the correct API endpoint for importing JUnit results2. For Xray Cloud, the endpoint is different from the one used for Xray Server
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.
JUnit Extensions
Consider using Xray’s JUnit extensions for enhanced JUnit 5 integration.