XRAY is a Test management plugin for Jira. This plugin helps you automate your complete testing process. Also, it has easy integration with BDD which is something we have implemented at our client.<\/p>\n
There are server and cloud versions of XRAY. This article talks about simple methods which we implemented to get XRAY Server integration done with behave BDD.<\/p>\n
Few terms you will see used in the post: The client generates a TestPlanID for the new cycle, and based on the environments, a TestExecutionID is created under this TestplanID. When the tests are run with the ExecutionID(s) the TestcaseID is automatically aligned with them.<\/p>\n One thing to remember, XRAY always aligns tests to execution. So if you don’t want to create TestExecutionID initially and want teams to create their own, teams feel it’s an overhead to go to Jira and create TestExectionID and then use that while running test. Phew!!! In the example, I am passing TestPlanID. And call methods to create TestExectionID and link them, finally upload results to Jira.<\/p>\n When TestPlanID is passed, first check if the planID is valid using XRAY API. If it’s valid then call API to create ExecutionID and link them.<\/p>\n When TestplanID is passed, we need to call the API to create a new TestExecutionID and then call another API to link them.<\/p>\n I hope this post gets you started with the XRAY integration quickly. Reference – https:\/\/docs.getxray.app\/display\/XRAY\/About+Xray<\/p>\n","protected":false},"excerpt":{"rendered":" Why this post XRAY is a Test management plugin for Jira. This plugin helps you automate your complete testing process. Also, it has easy integration with BDD which is something we have implemented at our client. There are server and cloud versions of XRAY. This article talks about simple methods which we implemented to get XRAY Server integration done with […]<\/p>\n","protected":false},"author":26,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[102,18,298],"tags":[],"class_list":["post-15276","post","type-post","status-publish","format-standard","hentry","category-behave","category-python","category-xray"],"_links":{"self":[{"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/posts\/15276","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/users\/26"}],"replies":[{"embeddable":true,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/comments?post=15276"}],"version-history":[{"count":40,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/posts\/15276\/revisions"}],"predecessor-version":[{"id":16544,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/posts\/15276\/revisions\/16544"}],"wp:attachment":[{"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/media?parent=15276"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/categories?post=15276"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/tags?post=15276"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}
\nTest ExecutionID<\/strong> – The XRAY ID of type Test Execution. There can be many test executions based on your test cycles.
\nTest PlanID <\/strong>– This will map to the test plan in Jira. Test execution are mapped to test plans.
\nTestcaseID<\/strong> – These are actual test cases in Jira. TestcaseID is mapped to Test ExecutionID and is part of many test executions. <\/p>\nCurrent flow <\/h4>\n
\nXRAY, on the other hand, allows you to pass TestPlanID while running the test, and it will generate the TestExecutionID and align your tests to it. That’s cool right?<\/p>\nVerify if the TestPlanID and TestExecutionID are valid<\/h4>\n
\r\n \r\ndef find_if_valid_plan_id(test_plan_id):\r\n \"\"\" \r\n Function calls the xray api for checking test plan id.\r\n Returns the response status code to callee function.\r\n :param test_plan_id: xray test plan id\r\n :returns statuscode_plan : api response status code\r\n \"\"\"\r\n \r\n print \"running find_if_valid_planid with plan id with plan id:\", test_plan_id\r\n try:\r\n url = \"{}rest\/raven\/1.0\/api\/testplan\/{}\/test?limit=10\".format(JIRA_BASE_URL, test_plan_id)\r\n headers = header()\r\n response = requests.request(\"GET\", url, headers=headers, data=None)\r\n statuscode_plan = response.status_code\r\n print \"status code returned for plan id and url used are\", statuscode_plan, url\r\n return statuscode_plan\r\n except Exception as e:\r\n print \"Unable to execute find_if_valid_plan_id\", e\r\n raise\r\n\r\ndef find_if_valid_exec_id(xray_execution_id):\r\n \"\"\"\r\n Function calls the xray api for checking test execution id.\r\n Returns the response status code to callee function.\r\n :param xray_execution_id : xray test execution id\r\n :returns statuscode_exec : api response status code\r\n \"\"\"\r\n \r\n print \"running find_if_valid_exec_id with execution id : \", xray_execution_id\r\n try:\r\n url = \"{}rest\/raven\/1.0\/api\/testexec\/{}\/test?limit=10\".format(JIRA_BASE_URL, xray_execution_id)\r\n headers = header()\r\n response = requests.request(\"GET\", url, headers=headers, data=None)\r\n statuscode_exec = response.status_code\r\n print \"status code returned for exececution id and url used are\", statuscode_exec, url\r\n return statuscode_exec\r\n except Exception as e:\r\n print \"Unable to execute find_if_valid_exec_id\", e\r\n raise\r\n\r\n<\/pre>\n\nCreate TestExecutionID<\/h4>\n
\r\ndef create_xray_test_execution_id_and_link_with_test_plan(test_plan_id):\r\n \"\"\"\r\n This function using xray api call creates new test execution id with the details \r\n mentioned in the Payload parameter.\r\n Newly created execution id is then passed to another xray api call which links it with the passed plan id.\r\n The execution id is returned by this function.\r\n :param test_pan_id : xray test plan id\r\n :returns xray_test_execution_id : newly created execution id\r\n :returns execution_creation_resp_status_code : response status for execution id created\r\n \"\"\"\r\n \r\n print \"creating new execution id\"\r\n try:\r\n xray_test_execution_id =\"\"\r\n url = \"{}rest\/api\/2\/issue\/\".format(JIRA_BASE_URL)\r\n payload = {\r\n \"fields\": {\r\n \"project\":{\r\n \"id\": \"xxxx\" #pass the actual id\r\n },\r\n \"summary\": \"Creating a Test Execution issue\",\r\n \"description\": \"Creating of a test execution issue using IDs for projects and issue types using the REST API\",\r\n \"issuetype\": {\r\n \"id\": \"xxx\" #pass the actual id\r\n }\r\n }\r\n }\r\n payloadJson = json.dumps(payload)\r\n headers = header()\r\n response_execution_creation = requests.request(\"POST\", url, headers=headers, data=payloadJson)\r\n execution_creation_resp_status_code = response_execution_creation.status_code\r\n if execution_creation_resp_status_code != 404:\r\n result = json.loads(response_execution_creation.text)\r\n if execution_creation_resp_status_code != 400:\r\n xray_test_execution_id = result['key']\r\n print(result['key'])\r\n #Link Test Plan to Test Execution ID\r\n print \"Linking newly created execution id to plan id\"\r\n link_execution_id(xray_test_execution_id, test_plan_id) \r\n return xray_test_execution_id\r\n except Exception as e:\r\n print \"Unable to execute create_xray_test_execution_id_and_link_with_test_plan\", e\r\n raise\r\n<\/pre>\n\nLink the newly created TestExecutionID to the passed TestPlanID<\/h4>\n
\r\ndef link_execution_id(xray_test_execution_id, test_plan_id):\r\n \"\"\"\r\n This function will link the newly created execution id with the plan id\r\n :param xray_test_execution_id : newly created execution id\r\n :param test_plan_id : test plan id\r\n :returns response_plan_linking_status : returns the status code of linking execution with plan\r\n \"\"\"\r\n try:\r\n print \"Linking newly created execution id to plan id\"\r\n url = \"{}rest\/raven\/1.0\/api\/testplan\/{}\/testexecution\".format(JIRA_BASE_URL, test_plan_id)\r\n print(url)\r\n payload_plan = {\r\n \"add\": [\r\n xray_test_execution_id\r\n ]\r\n }\r\n payloadJson_plan = json.dumps(payload_plan)\r\n response_plan_linking = requests.request(\"POST\", url, headers=headers, data=payloadJson_plan)\r\n response_plan_linking_status = response_plan_linking.status_code\r\n print \"This is response for test plan link to newly created test execution id\", response_plan_linking\r\n if response_plan_linking.status_code != 200:\r\n print \"plan id to execution id linking has failed\"\r\n xray_test_execution_id = None\r\n return response_plan_linking_status\r\n except Exception as e:\r\n print \"Unable to execute link_execution_id\", e\r\n raise\r\n<\/pre>\n\nNow, you can upload the results to XRAY<\/h4>\n
\r\ndef update_xray_results(xray_execution_id, feature_files, config_json_files):\r\n \"\"\" \r\n This is the main function for xray result update which calls various functions in sequence\r\n and updates xray results to jira.\r\n :param xray_execution_id : xray test execution id\r\n :returns : None\r\n \"\"\"\r\n try:\r\n print \"inside update_xray_results\"\r\n final_json_files = \"c:\/behave_json_files\"\r\n update_xray_execution_results_using_behave_api(final_json_files)\r\n except Exception as e:\r\n print \"Unable to execute update_xray_results\", e\r\n raise\r\n\r\ndef update_xray_execution_results_using_behave_api(final_json_files):\r\n \"\"\"\r\n This function makes the XRAY api call to upload the final results from the json files.\r\n :param final_json_files : folder where final json files are stored after cleaning and updating\r\n :returns : None\r\n \"\"\"\r\n try:\r\n url = \"{}rest\/raven\/1.0\/import\/execution\/behave\".format(JIRA_BASE_URL)\r\n headers = header()\r\n response_status = None\r\n for file in final_json_files:\r\n if file.endswith(\".json\"):\r\n print \"Found json for api call. JSON file name is \", file\r\n with open(XRAY_JSON_DIR_FINAL + file, 'r+') as json_file:\r\n json_data = json.load(json_file)\r\n data = json.dumps(json_data)\r\n response = requests.request(\"POST\", url, headers=headers, data=data)\r\n response_status = response.status_code\r\n if response.status_code == 500:\r\n print \"Something has gone wrong, check the json file for more details\", file\r\n else:\r\n continue\r\n return response_status\r\n except Exception as e:\r\n print \"behave api call failing\", e\r\n raise\r\n\r\n<\/pre>\nAll the code put together<\/h3>\n
\r\nimport requests\r\nimport json\r\n\r\nJIRA_AUTH = ('authid authpassword')\r\nJIRA_BASE_URL = \"http:\/\/abc\/\" \r\nXRAY_JSON_DIR_FINAL = \"
\nNote- code example is compatible with python2 only.<\/p>\n