daioifddlZddlZddlmZddlmZej eZGddeZ y)N) HTTPError)AtlassianRestAPIcveZdZfdZdZd4dZdZdZdZ d5dZ dZ d Z d Z d Z d Zd ZdZdZdZdZdZdZd4dZdZd4dZd4dZdZd4dZd4dZdZdZd4dZdZ d6dZ!d4d Z"d!Z#d"Z$d#Z%d$Z&d%Z'd&Z(d'Z)d(Z*d4d)Z+d*Z,d+Z-d,Z.d-Z/d.Z0d7d/Z1d8d0Z2d1Z3d9d2Z4d4d3Z5xZ6S):XraycHd|vrd|d<d|d<tt| |i|y)N api_version1.0z rest/ravenapi_root)superr__init__)selfargskwargs __class__s F/var/www/timesheet/venv/lib/python3.12/site-packages/atlassian/xray.pyr z Xray.__init__ s3  &$)F= !)z dD"D3F3cd|jdk(r+|jjddk7r td|d|jcxkrdkr&ny |j }|d}t||y #t $r/}t j||jYd }~y d }~wwxYw) z Checks the response for an error status and raises an exception with the error message provided by the server :param response: :return: iz Content-Typezapplication/json;charset=UTF-8zUnauthorized (401))responseiiXmessageN) status_codeheadersgetrjson Exceptionlogerrorraise_for_status)rrj error_msges rrzXray.raise_for_statuss   3 &8+;+;+?+?+OSs+s08D D (&& , , >MMOiL  H== - , ! ))++ ,sA77 B/%B**B/cr| |j}| |j}djd||d|fDS)z{ Overloading the method from AtlassianRestAPI to be compatible with the "middle man" version used by Xray. /c3DK|]}||jdyw)Nr#)strip).0ss r z$Xray.resource_url..,shZ[Zg hs  api)r r join)rresourcer r s r resource_urlzXray.resource_url$sB  }}H  **KxxhxeX.Vhhhrcj|jddj|}|j|S)z Retrieve information about the provided tests. :param test_keys: list of tests (eg. `['TEST-001', 'TEST-002']`) to retrieve. :return: Returns the retrieved tests. z test?keys=;)r,r*r)r test_keysurls r get_testszXray.get_tests/s3 *SXXi-@,A BCxx}rcF|jd}|j|S)z Retrieve a list of all Test Statuses available in Xray sorted by rank. :return: Returns the test statuses. zsettings/teststatusesr,rrr0s rget_test_statuseszXray.get_test_statuses8s#  78xx}rcN|jd|d}|j|S)z Retrieve test runs of a test. :param test_key: Test key (eg. 'TEST-001'). :return: Returns the exported test runs. test/ /testrunsr3rtest_keyr0s r get_test_runszXray.get_test_runs@+ %z ;<xx}rc|jdk(r tdi}|r||d<|r||d<|r||d<|r||d<|r||d<|r||d<|r||d <|jd } |j| | S) a Retrieves all the Test Runs from a given context. With this endpoint you can obtain all the Test Runs (paginated) in one of the following contexts: * In a Test Execution issue (use testKey to limit to single test) * In a Test Plan issue * In a JQL filter that returns several Test Execution issue In case the Test Run has iterations, steps will not appear. However, if the Test has parameters but executed one time, it will show the steps and the parameters' info :param test_exec_key: The Test Execution issue key :param test_key: The Test issue key (may only be used when using the "test_exec_key" param) :param test_plan_key: The Test Plan issue key :param include_test_fields: List of custom fields of the Test issue to be return in the responde (several custom fields can be requested by separating them with ',') :param saved_filter_id: The Jira JQL filter ID or name containing Test Executions issues :param limit: The number of maximum Test Runs to be returned :param page: The number of the results page :return: Returns the exported test runs. r z Not supported in API version 1.0 testExecKeytestKey testPlanKeyincludeTestFields savedFilterIdlimitpagetestrunsparams)r rr,r) r test_exec_keyr: test_plan_keyinclude_test_fieldssaved_filter_idrCrDrGr0s rget_test_runs_in_contextzXray.get_test_runs_in_contextIsB   u $>? ? $1F= !  (F9  $1F= ! *=F& ' &5F? # #F7O !F6N +xxFx++rc ddj|Dcgc]}tj|c}}|jd|d|}|j |Scc}w)a Retrieve test runs of a test filtered by tests environments. :param test_key: Test key (eg. 'TEST-001'). :param test_environments: Test execution environments separated by ','. :return: Returns the exported test runs. z?testEnvironments=,r7r8)r*reescaper,r)rr:test_environmentsenvr0s rget_test_runs_with_environmentz#Xray.get_test_runs_with_environment~s_#388GX,YRYYs^,Y#Z"[\%z3% @Axx}-ZsA cN|jd|d}|j|S)z Retrieve pre-conditions of a test. :param test_key: Test key (eg. 'TEST-001'). :return: Returns the test pre-conditions of a given test. r7z/preconditionsr3r9s rget_test_preconditionszXray.get_test_preconditionss+ %z @Axx}rcN|jd|d}|j|S)z Retrieve test sets associated with a test. :param test_key: Test key (eg. 'TEST-001'). :return: Returns the exported test sets. r7z /testsetsr3r9s r get_test_setszXray.get_test_setsr<rcN|jd|d}|j|S)z Retrieve test executions of a test. :param test_key: Test key (eg. 'TEST-001'). :return: Returns the exported test executions. r7z/testexecutionsr3r9s rget_test_executionszXray.get_test_executionss+ %z ABxx}rcN|jd|d}|j|S)z Retrieve test plans associated with a test. :param test_key: Test key (eg. 'TEST-001'). :return: Returns the exported test plans. r7z /testplansr3r9s rget_test_planszXray.get_test_planss+ %z <=xx}rcF|jd}|j|S)z Retrieve the test step statuses available in Xray sorted by rank. :return: Returns the test step statuses available in Xray sorted by rank. zsettings/teststepstatusesr3r4s rget_test_step_statuseszXray.get_test_step_statusess#  ;<xx}rcR|jd|d|}|j|S)z Retrieve the specified test step of a given test. :param test_key: Test key (eg. 'TEST-001'). :param test_step_id: ID of the test step. :return: Return the test step with the given id. r7/step/r3rr: test_step_idr0s r get_test_stepzXray.get_test_steps/%z ~ FGxx}rcN|jd|d}|j|S)z Retrieve the test steps of a given test. :param test_key: Test key (eg. 'TEST-001'). :return: Return the test steps of a given test. r7/stepr3r9s rget_test_stepszXray.get_test_stepss+ %z 78xx}rc^|||gd}|jd|d}|j||S)am Create a new test steps for a given test. NOTE: attachments are currently not supported! :param test_key: Test key (eg. 'TEST-001'). :param step: Test Step name (eg. 'Example step'). :param data: Test Step data (eg. 'Example data'). :param result: Test Step results (eg. 'Example results'). :return: stepdataresult attachmentsr7rdr,put)rr:rhrirjcreater0s rcreate_test_stepzXray.create_test_steps<rR%z 78xxV$$rch|||ggdd}|jd|d|}|j||S)a Update the specified test steps for a given test. NOTE: attachments are currently not supported! :param test_key: Test key (eg. 'TEST-001'). :param test_step_id: ID of the test step. :param step: Test Step name (eg. 'Example step'). :param data: Test Step data (eg. 'Example data'). :param result: Test Step results (eg. 'Example results'). :return: addremovergr7r_r,post)rr:rarhrirjupdater0s rupdate_test_stepzXray.update_test_stepsL#%4   %z ~ FGyyf%%rcR|jd|d|}|j|S)z Remove the specified test steps from a given test. :param test_key: Test key (eg. 'TEST-001'). :param test_step_id: ID of the test step. :return: r7r_r,deleter`s rdelete_test_stepzXray.delete_test_steps0%z ~ FG{{3rcN|jd|d}|j|S)z Retrieve the tests associated with the given pre-condition. :param precondition_key: Precondition key (eg. 'TEST-001'). :return: Return a list of the test associated with the pre-condition. precondition//testr3)rprecondition_keyr0s rget_tests_with_preconditionz Xray.get_tests_with_preconditions- -0@/A GHxx}rcj|g}|g}||d}|jd|d}|j||S)a| Associate tests with the given pre-condition. :param precondition_key: Precondition key (eg. 'TEST-001'). :param add: OPTIONAL: List of Test Keys to associate with the pre-condition (eg. ['TEST-2', 'TEST-3']) :param remove: OPTIONAL: List of Test Keys no longer associate with the pre-condition (eg. ['TEST-4', 'TEST-5']) :return: rqr}r~rt)rrrrrsrvr0s rupdate_preconditionzXray.update_preconditionsN >F ;C/-0@/A GHyyf%%rcR|jd|d|}|j|S)a Remove association of the specified tests from the given pre-condition. :param precondition_key: Precondition key (eg. 'TEST-001'). :param test_key: Test Key which should no longer be associate with the pre-condition (eg. 'TEST-100') :return: r}/test/ry)rrr:r0s rdelete_test_from_preconditionz"Xray.delete_test_from_preconditions2-0@/Az RS{{3rcr|jd|d}i}|r||d<|r||d<|j||S)aU Retrieve the tests associated with the given test set. :param test_set_key: Test set key (eg. 'SET-001'). :param limit: OPTIONAL: Limits the number of results per page. :param page: OPTIONAL: Number of the page to be returned. :return: Return a list of the test associated with the test set. testset/r~rCrDrFr3)r test_set_keyrCrDr0rGs rget_tests_with_test_setzXray.get_tests_with_test_setsM(<. >? #F7O !F6NxxFx++rcj|g}|g}||d}|jd|d}|j||S)al Associate tests with the given test set. :param test_set_key: Test set key (eg. 'SET-001'). :param add: OPTIONAL: List of Test Keys to associate with the test set (eg. ['TEST-002', 'TEST-003']) :param remove: OPTIONAL: List of Test Keys no longer associate with the test set (eg. ['TEST-004', 'TEST-005']) :return: rqrr~rt)rrrrrsrvr0s rupdate_test_setzXray.update_test_set-sL ;C >F/(<. >?yyf%%rcR|jd|d|}|j|S)a  Remove association of the specified tests from the given test set. :param test_set_key: Test set key (eg. 'SET-001'). :param test_key: Test Key which should no longer be associate with the test set (eg. 'TEST-100') :return: rrry)rrr:r0s rdelete_test_from_test_setzXray.delete_test_from_test_set=s0(<.xj IJ{{3rcr|jd|d}i}|r||d<|r||d<|j||S)aY Retrieve the tests associated with the given test plan. :param test_plan_key: Test set key (eg. 'PLAN-001'). :param limit: OPTIONAL: Limits the number of results per page. :param page: OPTIONAL: Number of the page to be returned. :return: Return a list of the test associated with the test plan. testplan/r~rCrDrFr3)rrIrCrDr0rGs rget_tests_with_test_planzXray.get_tests_with_test_planHsM)M?% @A #F7O !F6NxxFx++rcj|g}|g}||d}|jd|d}|j||S)ar Associate tests with the given test plan. :param test_plan_key: Test plan key (eg. 'PLAN-001'). :param add: OPTIONAL: List of Test Keys to associate with the test plan (eg. ['TEST-002', 'TEST-003']) :param remove: OPTIONAL: List of Test Keys no longer associate with the test plan (eg. ['TEST-004', 'TEST-005']) :return: rqrr~rtrrIrrrsrvr0s rupdate_test_planzXray.update_test_planZsL ;C >F/)M?% @Ayyf%%rcR|jd|d|}|j|S)a Remove association of the specified tests from the given test plan. :param test_plan_key: Test plan key (eg. 'PLAN-001'). :param test_key: Test Key which should no longer be associate with the test plan (eg. 'TEST-100') :return: rrry)rrIr:r0s rdelete_test_from_test_planzXray.delete_test_from_test_planj0)M?& KL{{3rcN|jd|d}|j|S)z Retrieve test executions associated with the given test plan. :param test_plan_key: Test plan key (eg. 'PLAN-001'). :return: Return a list of the test executions associated with the test plan. r/testexecutionr3)rrIr0s r"get_test_executions_with_test_planz'Xray.get_test_executions_with_test_plants+ )M?. IJxx}rcj|g}|g}||d}|jd|d}|j||S)a| Associate test executions with the given test plan. :param test_plan_key: Test plan key (eg. 'PLAN-001'). :param add: OPTIONAL: List of Test Keys to associate with the test plan (eg. ['TEST-002', 'TEST-003']) :param remove: OPTIONAL: List of Test Keys no longer associate with the test plan (eg. ['TEST-004', 'TEST-005']) :return: rqrrrtrs r update_test_plan_test_executionsz%Xray.update_test_plan_test_executions}sL ;C >F/)M?. IJyyf%%rcR|jd|d|}|j|S)a' Remove association of the specified tests execution from the given test plan. :param test_plan_key: Test plan key (eg. 'PLAN-001'). :param test_exec_key: Test execution Key which should no longer be associate with the test plan (eg. 'TEST-100') :return: rz/testexecution/ry)rrIrHr0s r$delete_test_execution_from_test_planz)Xray.delete_test_execution_from_test_plans0)M?/- YZ{{3rc|jd|d}i}|r||d<|r||d<|r||d<|j||S)a Retrieve the tests associated with the given test execution. :param test_exec_key: Test execution key (eg. 'EXEC-001'). :param detailed: OPTIONAL: (bool) Retrieve detailed information about the testrun :param limit: OPTIONAL: Limits the number of results per page. :param page: OPTIONAL: Number of the page to be returned. :return: Return a list of the test associated with the test execution. testexec/r~detailedrCrDrFr3)rrHrrCrDr0rGs rget_tests_with_test_executionz"Xray.get_tests_with_test_executionsZ)M?% @A !)F:  #F7O !F6NxxFx++rcj|g}|g}||d}|jd|d}|j||S)a Associate tests with the given test execution. :param test_exec_key: Test execution key (eg. 'EXEC-001'). :param add: OPTIONAL: List of Test Keys to associate with the test execution (eg. ['TEST-2', 'TEST-3']) :param remove: OPTIONAL: List of Test Keys no longer associate with the test execution (eg. ['TEST-4', 'TEST-5']) :return: rqrr~rt)rrHrrrsrvr0s rupdate_test_executionzXray.update_test_executionsL ;C >F/)M?% @Ayyf%%rcR|jd|d|}|j|S)a Remove association of the specified tests from the given test execution. :param test_exec_key: Test execution key (eg. 'EXEC-001'). :param test_key: Test Key which should no longer be associate with the test execution (eg. 'TEST-100') :return: rrry)rrHr:r0s rdelete_test_from_test_executionz$Xray.delete_test_from_test_executionrrcL|jd|}|j|S)z Retrieve detailed information about the given test run. :param test_run_id: ID of the test run (e.g. 100). :return: Returns detailed information about the test run. testrun/r3r test_run_idr0s r get_test_runzXray.get_test_runs) (;- 89xx}rcN|jd|d}|j|S)z Retrieve the assignee for the given test run. :param test_run_id: ID of the test run (e.g. 100). :return: Returns the assignee for the given test run rz /assigneer3rs rget_test_run_assigneezXray.get_test_run_assignees+ (;-y ABxx}rcVd|i}|jd|}|j||S)z Update the assignee for the given test run. :param test_run_id: ID of the test run (eg. 100). :param assignee: Assignee id (eg. 'bob') :return: assigneerrl)rrrrvr0s rupdate_test_run_assigneezXray.update_test_run_assignees6h'(;- 89xxV$$rcR|jd|d|}|j|S)a Retrieve the specified iteration for the given test run. :param test_run_id: ID of the test run (e.g. 100). :param iteration_id: ID of the iteration. :return: Returns the specified iteration for the given test run. rz /iteration/r3)rr iteration_idr0s rget_test_run_iterationzXray.get_test_run_iterations/(;-{<. QRxx}rcN|jd|d}|j|S)z Retrieve the status for the given test run. :param test_run_id: ID of the test run (e.g. 100). :return: Returns the status for the given test run rz/statusr3rs rget_test_run_statuszXray.get_test_run_status+ (;-w ?@xx}rcVd|i}|jd|}|j||S)z Update the status for the given test run. :param test_run_id: ID of the test run (e.g. 100). :param status: Status id (eg. 'PASS') :return: statusrrl)rrrrvr0s rupdate_test_run_statuszXray.update_test_run_statuss6F#(;- 89xxV$$rcN|jd|d}|j|S)z Retrieve the defects for the given test run. :param test_run_id: ID of the test run (e.g. 100). :return: Returns a list of defects for the given test run rz/defectr3rs rget_test_run_defectszXray.get_test_run_defectsrrcl|g}|g}d||di}|jd|}|j||S)at Update the defects associated with the given test run. :param test_run_id: ID of the test run (eg. 100). :param add: OPTIONAL: List of defects to associate to the test run (eg. ['BUG-001', 'BUG-002']) :param remove: OPTIONAL: List of defects which no longer need to be associated to the test run (eg. ['BUG-003']) :return: defectsrqrrl)rrrrrsrvr0s rupdate_test_run_defectszXray.update_test_run_defects sO ;C >FSF;<(;- 89xxV$$rcN|jd|d}|j|S)z Retrieve the comment for the given test run. :param test_run_id: ID of the test run (e.g. 100). :return: Returns the comment for the given test run rz/commentr3rs rget_test_run_commentzXray.get_test_run_comments+ (;-x @Axx}rcVd|i}|jd|}|j||S)z Update the comment for the given test run. :param test_run_id: ID of the test run (eg. 100). :param comment: Comment (e.g. 'Test needs to be reworked') :return: commentrrl)rrrrvr0s rupdate_test_run_commentzXray.update_test_run_comment&s6W%(;- 89xxV$$rcN|jd|d}|j|S)z Retrieve the steps for the given test run. :param test_run_id: ID of the test run (e.g. 100). :return: Returns the steps for the given test run rrdr3rs rget_test_run_stepszXray.get_test_run_steps1s+ (;-u =>xx}rcN|jd|d}|j|S)z Retrieve test repository folders of a project. :param project_key: Project key (eg. 'FOO'). :return: Returns the list of test repository folders. testrepository/z/foldersr3)r project_keyr0s rget_test_repo_folderszXray.get_test_repo_folders:s+ /+h GHxx}rcR|jd|d|}|j|S)z Retrieve test repository folder of a project. :param project_key: Project key (eg. 'FOO'). :param folder_id: Internal folder ID. :return: Returns the test repository folder. r /folders/r3rr folder_idr0s rget_test_repo_folderzXray.get_test_repo_folderCs//+i { STxx}rc^d|i}|jd|d|}|j||S)aM Create test repository folder for a project. :param project_key: Project key (eg. 'FOO'). :param folder_name: Name of folder. :param parent_folder_id: Internal folder ID; "-1" corresponds to the root folder of the test repository. :return: Returns the created test repository folder. namerrrirt)rr folder_nameparent_folder_idrir0s rcreate_test_repo_folderzXray.create_test_repo_folderMs@ $/+iHXGY Z[yy4y((rc`||d}|jd|d|}|j||S)a> Update test repository folder for a project. :param project_key: Project key (eg. 'FOO'). :param folder_id: Internal folder ID. :param folder_name: Name of folder. :param rank: Rank within the parent folder. :return: Returns the updated test repository folder. )rrankrrrrl)rrrrrrir0s rupdate_test_repo_folderzXray.update_test_repo_folderYs>$T2/+i { STxx$x''rcR|jd|d|}|j|S)z Delete test repository folder for a project. :param project_key: Project key (eg. 'FOO'). :param folder_id: Internal folder Id. :return: Returns the delete results. rrryrs rdelete_test_repo_folderzXray.delete_test_repo_folderfs0/+i { ST{{3rc|jd|d|d}i}|r||d<|r||d<|r||d<|j||S)a+ Retrieve tests of a test repository folder. :param project_key: Project key (eg. 'FOO'). :param folder_id: Internal folder ID. :param all_descendants: Include all descendants (i.e. all child Tests); "false", by default. :param page: Page of paginated data (first 1) :param limit: Amount of Tests per paginated data. :return: Returns list of the Tests contained in a given folder of the test repository. Note: param "page" and "limit" must coexist, otherwise rest api will raise 400 rr/testsallDescendantsrDrCrFr3)rrrall_descendantsrDrCr0rGs rget_test_repo_folder_testszXray.get_test_repo_folder_testspsb/+i {RX YZ '6F# $ !F6N #F7OxxFx++rcr|g}|g}||d}|jd|d|d}|j||S)aq Update tests of a test repository folder. :param project_key: Project key (eg. 'FOO'). :param folder_id: Internal folder Id. :param add: OPTIONAL: List of tests to be added (eg. ['TEST-001', 'TEST-002']) :param remove: OPTIONAL: List of tests to be removed (eg. ['TEST-003']) :return: Returns the update result. rqrrrrrl)rrrrrrsrir0s rupdate_test_repo_folder_testsz"Xray.update_test_repo_folder_testssU ;C >Ff-/+i {RX YZxx$x''r)NN)NNNNNNN)FNN))r)Fr2)7__name__ __module__ __qualname__r rr,r1r5r;rLrSrUrWrYr[r]rbrerorwr{rrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrr __classcell__)rs@rrr s4 >&i  3,j  %&( &  ,$&  ,$&  &  ,*&"  % %%  % ) ( ,.(rr) loggingrOrequestsr rest_clientr getLoggerrrrrrrs2 )g!L ( L (r