Skip to content

Xray: add pagination support for api methods #595

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 7, 2020
Merged

Xray: add pagination support for api methods #595

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 35 additions & 14 deletions atlassian/xray.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,8 +168,8 @@ def update_precondition(self, precondition_key, add=None, remove=None):
"""
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'])
: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:
"""
if remove is None:
Expand All @@ -191,21 +191,30 @@ def delete_test_from_precondition(self, precondition_key, test_key):
return self.delete(url)

# Test Set API
def get_tests_with_test_set(self, test_set_key):
def get_tests_with_test_set(self, test_set_key, limit=None, page=None):
"""
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.
"""
url = 'rest/raven/1.0/api/testset/{0}/test'.format(test_set_key)
return self.get(url)
params = {}

if limit:
params['limit'] = limit
if page:
params['page'] = page

return self.get(url, params=params)

def update_test_set(self, test_set_key, add=None, remove=None):
"""
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'])
: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:
"""
if add is None:
Expand Down Expand Up @@ -240,8 +249,8 @@ def update_test_plan(self, test_plan_key, add=None, remove=None):
"""
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'])
: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:
"""
if add is None:
Expand All @@ -263,21 +272,33 @@ def delete_test_from_test_plan(self, test_plan_key, test_key):
return self.delete(url)

# Test Executions API
def get_tests_with_test_execution(self, test_exec_key):
def get_tests_with_test_execution(self, test_exec_key, detailed=False, limit=None, page=None):
"""
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.
"""
url = 'rest/raven/1.0/api/testexec/{0}/test'.format(test_exec_key)
return self.get(url)
params = {}

if detailed:
params['detailed'] = detailed
if limit:
params['limit'] = limit
if page:
params['page'] = page

return self.get(url, params=params)

def update_test_execution(self, test_exec_key, add=None, remove=None):
"""
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'])
: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:
"""
if add is None:
Expand Down Expand Up @@ -361,8 +382,8 @@ def update_test_run_defects(self, test_run_id, add=None, remove=None):
"""
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'])
: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:
"""
if add is None:
Expand Down
4 changes: 2 additions & 2 deletions docs/xray.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Manage Test sets
.. code-block:: python

# Retrieve the tests associated with the given test set
xray.get_tests_with_test_set('SET-001')
xray.get_tests_with_test_set('SET-001', page=1, limit=10)

# Associate tests with the given test set
xray.update_test_set('SET-001',add=['TEST-001','TEST-002'], remove=['TEST-003'])
Expand Down Expand Up @@ -103,7 +103,7 @@ Manage Test Executions
.. code-block:: python

# Retrieve the tests associated with the given test execution
xray.get_tests_with_test_execution('EXEC-001')
xray.get_tests_with_test_execution('EXEC-001', detailed=True, page=1, limit=10)

# Associate tests with the given test execution
xray.update_test_execution('EXEC-001', add=['TEST-001', 'TEST-002'], remove=['TEST-003'])
Expand Down