Xray Cloud migration

WARNING

MIGRATION AVAILABLE FOR ALLURE TESTOPS VERSION > 4.26.0

Configuration file example

Create the json file with content like:

{
  "type": "xray-cloud",
  "debug": true,
  "oneByOne": true,
  "allureConfig": {
    "endpoint": "https://demo.testops.cloud/",
    "token": "1f4b4acd-418c-4d0b-8533-1d747abb7599",
    "sslTrustAll": true,
    "projectId": 6,
    "migrationTagPrefix": "xray"
  },
  "jiraConfig": {
    "endpoint": "https://comp.atlassian.net/",
    "username": "@comp.com",
    "password": "atlasian-api-key"
  },
  "xrayCloudConfig": {
    "clientId": "11E23F3692F5425282D36BACB9D6E00Q",
    "clientSecret": "111111135724158d84b9306e6230fa7f9c149a86aff674a75806caaf96bdb111",
    "projectKey": "XI",
    "issueType": "Test",
    "testSetKey": "XI-1079",
    "testSetAsSuite": true,
    "testKeys": ["XI-1", "XI-4"],
    "customFields": {
      "priority": "Priority",
			"reporter": "CreatedBy"
    },
    "statusMapping": {
      "Done": "Outdated",
      "In Progress": "Active",
      "To Do": "Draft"
    }
  }
}

Configuration parameters

Name	Mandatory	Description	Example
commonProperties	yes	see description here: Common properties
allureConfig	yes	see description here: Allure TestOps properties
jiraConfig.endpoint	yes	Jira instance url
jiraConfig.username	yes	Jira username
jiraConfig.password	yes	Jira api token Can be generated here: https://id.atlassian.com/manage-profile/security/api-tokens
xrayCloudConfig.clientId	yes	Credentials for xray cloud See: Xray Cloud API Keys Documentation Can be generated here: Generate Xray API Keys
xrayCloudConfig.clientSecret	yes	Credentials for xray cloud See: Xray Cloud API Keys Documentation Can be generated here: Generate Xray API Keys
xrayCloudConfig.projectKey	yes	Jira project key	XM
xrayCloudConfig.issueType	yes	The name of issue type in Jira system	Test
xrayCloudConfig.testSetKey	no	A list of specific test set keys for migration can be specified. Without this parameter, the migration will take place for all tests. The testKeys parameter will be ignored in this case	XI-123
xrayCloudConfig.testSetAsSuite	no	If this parameter is set to true, the test set name will be migrated as the Suite custom field value for tests in this set	true
xrayCloudConfig.testKeys	no	A list of specific test keys for migration can be specified. Without this parameter, the migration will take place for all tests	["XI-1", "XI-4"]
xrayCloudConfig.customFields	no	A list of Jira fields that need to be migrated to Allure as custom fields. Structure: "jira_field_name": "TestOps_custom_field_name"	{"Priority": "Severity"}
testItConfig.statusMapping	no	The mapping for statuses. The default mapping looks like in the example. If you want to use it, don’t add this config into the file. All other different statuses will be mapped to “Draft” if no other rule is specified.	"statusMapping": { "Done": "Outdated", "In progress": "Active", "To do": "Draft" }

Common Issues and Troubleshooting

Error	Description	Troubleshooting
Caused by: io.qameta.ato.migration.generic.exception.MigrationConnectionException: Response code [401]: : {"error":"Xray data is in another region. Contact support to migrate Xray data to current region."}	This error occurs because the Xray data is located in a different region than your current region.	1. Verify if the regions for your Jira and Xray match. 2. If the issue persists, contact Xray support to migrate your data to the current region.