Skip to content
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

Jump to bottom

Release #238

Merged
merged 11 commits into from
Oct 1, 2024
Merged

Release #238

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
b82d2fd
Add save.yml
HardNorth Sep 4, 2024
fe81aa4
Add save.yml
HardNorth Sep 4, 2024
cfac8df
Add save.yml
HardNorth Sep 4, 2024
5c2b9a4
Add save.yml
HardNorth Sep 4, 2024
e5f0215
Remove save.yml
HardNorth Sep 4, 2024
4e5817e
Merge master branch into develop after a release
autoreportportal Sep 6, 2024
dfb1a3d
Changelog update
autoreportportal Sep 6, 2024
389e569
Version update
autoreportportal Sep 6, 2024
da4f7b8
Remove 504 HTTP status code retry
HardNorth Sep 17, 2024
f0e9c22
Add `retry_of` and `test_case_id` arguments
HardNorth Sep 30, 2024
7469374
Documentation fix
HardNorth Oct 1, 2024
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
8 changes: 8 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
# Changelog

## [Unreleased]
### Removed
- Retries of requests ended with `504` HTTP status code, since it's not clear if the request was delivered or not, by @HardNorth
### Changed
- `client.RP.start_test_item` method and all its children now accept `retry_of` argument, by @HardNorth
- `client.RP.finish_test_item` method and all its children now accept `retry_of` argument, by @HardNorth
- `client.RP.finish_test_item` method and all its children now accept `test_case_id` argument, by @HardNorth

## [5.5.7]
### Added
- `helpers.to_bool` function, by @HardNorth
- Official `Python 3.12` support, by @HardNorth
Expand Down
2 changes: 1 addition & 1 deletion reportportal_client/_internal/aio/http.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
DEFAULT_RETRY_NUMBER: int = 5
DEFAULT_RETRY_DELAY: float = 0.005
THROTTLING_STATUSES: set = {425, 429}
RETRY_STATUSES: set = {408, 500, 502, 503, 504, 507}.union(THROTTLING_STATUSES)
RETRY_STATUSES: set = {408, 500, 502, 503, 507}.union(THROTTLING_STATUSES)


class RetryClass(int, Enum):
Expand Down
149 changes: 87 additions & 62 deletions reportportal_client/aio/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ def __init__(
launch_uuid_print: bool = False,
print_output: OutputType = OutputType.STDOUT,
truncate_attributes: bool = True,
**kwargs: Any
**_: Any
) -> None:
"""Initialize the class instance with arguments.

Expand Down Expand Up @@ -157,7 +157,7 @@ async def session(self) -> RetryingClientSession:
if self._session:
return self._session

if self.verify_ssl is None or (type(self.verify_ssl) == bool and not self.verify_ssl):
if self.verify_ssl is None or (type(self.verify_ssl) is bool and not self.verify_ssl):
ssl_config = False
else:
if type(self.verify_ssl) is str:
Expand All @@ -183,7 +183,7 @@ async def session(self) -> RetryingClientSession:
}

if self.http_timeout:
if type(self.http_timeout) == tuple:
if type(self.http_timeout) is tuple:
connect_timeout, read_timeout = self.http_timeout
else:
connect_timeout, read_timeout = self.http_timeout, self.http_timeout
Expand Down Expand Up @@ -230,7 +230,7 @@ async def start_launch(self,
attributes: Optional[Union[list, dict]] = None,
rerun: bool = False,
rerun_of: Optional[str] = None,
**kwargs) -> Optional[str]:
**_) -> Optional[str]:
"""Start a new Launch with the given arguments.

:param name: Launch name.
Expand Down Expand Up @@ -279,8 +279,9 @@ async def start_test_item(self,
parameters: Optional[dict] = None,
code_ref: Optional[str] = None,
test_case_id: Optional[str] = None,
has_stats: bool = True,
retry: bool = False,
has_stats: Optional[bool] = True,
retry: Optional[bool] = False,
retry_of: Optional[str] = None,
**_: Any) -> Optional[str]:
"""Start Test Case/Suite/Step/Nested Step Item.

Expand All @@ -299,6 +300,8 @@ async def start_test_item(self,
:param test_case_id: A unique ID of the current Step.
:param has_stats: Set to False if test item is a Nested Step.
:param retry: Used to report retry of the test. Allowed values: "True" or "False".
:param retry_of: For retry mode specifies which test item will be marked as retried. Should be used
with the 'retry' parameter.
:return: Test Item UUID if successfully started or None.
"""
if parent_item_id:
Expand All @@ -316,7 +319,8 @@ async def start_test_item(self,
has_stats=has_stats,
parameters=parameters,
retry=retry,
test_case_id=test_case_id
test_case_id=test_case_id,
retry_of=retry_of
).payload

response = await AsyncHttpRequest((await self.session()).post, url=url, json=request_payload).make()
Expand All @@ -334,25 +338,30 @@ async def finish_test_item(self,
item_id: Union[str, Task[str]],
end_time: str,
*,
status: str = None,
description: str = None,
status: Optional[str] = None,
description: Optional[str] = None,
attributes: Optional[Union[list, dict]] = None,
test_case_id: Optional[str] = None,
issue: Optional[Issue] = None,
retry: bool = False,
**kwargs: Any) -> Optional[str]:
retry: Optional[bool] = False,
retry_of: Optional[str] = None,
**_: Any) -> Optional[str]:
"""Finish Test Suite/Case/Step/Nested Step Item.

:param launch_uuid: A launch UUID where to finish the Test Item.
:param item_id: ID of the Test Item.
:param end_time: The Item end time.
:param status: Test status. Allowed values:
PASSED, FAILED, STOPPED, SKIPPED, INTERRUPTED, CANCELLED, INFO, WARN or None.
:param description: Test Item description. Overrides description from start request.
:param attributes: Test Item attributes(tags). Pairs of key and value. These attributes override
attributes on start Test Item call.
:param issue: Issue which will be attached to the current Item.
:param retry: Used to report retry of the test. Allowed values: "True" or "False".
:return: Response message.
:param launch_uuid: A launch UUID where to finish the Test Item.
:param item_id: ID of the Test Item.
:param end_time: The Item end time.
:param status: Test status. Allowed values:
PASSED, FAILED, STOPPED, SKIPPED, INTERRUPTED, CANCELLED, INFO, WARN or None.
:param description: Test Item description. Overrides description from start request.
:param attributes: Test Item attributes(tags). Pairs of key and value. These attributes override
attributes on start Test Item call.
:param test_case_id: A unique ID of the current Step. Overrides passed on start request.
:param issue: Issue which will be attached to the current Item.
:param retry: Used to report retry of the test. Allowed values: "True" or "False".
:param retry_of: For retry mode specifies which test item will be marked as retried. Should be used
with the 'retry' parameter.
:return: Response message.
"""
url = self.__get_item_url(item_id)
request_payload = AsyncItemFinishRequest(
Expand All @@ -361,9 +370,11 @@ async def finish_test_item(self,
status,
attributes=verify_value_length(attributes) if self.truncate_attributes else attributes,
description=description,
test_case_id=test_case_id,
is_skipped_an_issue=self.is_skipped_an_issue,
issue=issue,
retry=retry
retry=retry,
retry_of=retry_of
).payload
response = await AsyncHttpRequest((await self.session()).put, url=url, json=request_payload).make()
if not response:
Expand All @@ -377,15 +388,15 @@ async def finish_launch(self,
launch_uuid: Union[str, Task[str]],
end_time: str,
*,
status: str = None,
status: Optional[str] = None,
attributes: Optional[Union[list, dict]] = None,
**kwargs: Any) -> Optional[str]:
"""Finish a Launch.

:param launch_uuid: A Launch UUID to finish.
:param end_time: Launch end time.
:param status: Launch status. Can be one of the followings:
PASSED, FAILED, STOPPED, SKIPPED, INTERRUPTED, CANCELLED.
PASSED, FAILED, STOPPED, SKIPPED, INTERRUPTED, CANCELLED or None.
:param attributes: Launch attributes. These attributes override attributes on Start Launch call.
:return: Response message or None.
"""
Expand Down Expand Up @@ -530,7 +541,7 @@ def clone(self) -> 'Client':
"""Clone the client object, set current Item ID as cloned item ID.

:return: Cloned client object
:rtype: AsyncRPClient
:rtype: Client
"""
cloned = Client(
endpoint=self.endpoint,
Expand Down Expand Up @@ -721,6 +732,7 @@ async def start_test_item(self,
code_ref: Optional[str] = None,
retry: bool = False,
test_case_id: Optional[str] = None,
retry_of: Optional[str] = None,
**kwargs: Any) -> Optional[str]:
"""Start Test Case/Suite/Step/Nested Step Item.

Expand All @@ -738,13 +750,15 @@ async def start_test_item(self,
:param code_ref: Physical location of the Test Item.
:param retry: Used to report retry of the test. Allowed values: "True" or "False".
:param test_case_id: A unique ID of the current Step.
:param retry_of: For retry mode specifies which test item will be marked as retried. Should be used
with the 'retry' parameter.
:return: Test Item UUID if successfully started or None.
"""
item_id = await self.__client.start_test_item(self.launch_uuid, name, start_time, item_type,
description=description, attributes=attributes,
parameters=parameters, parent_item_id=parent_item_id,
has_stats=has_stats, code_ref=code_ref, retry=retry,
test_case_id=test_case_id, **kwargs)
test_case_id=test_case_id, retry_of=retry_of, **kwargs)
if item_id and item_id is not NOT_FOUND:
logger.debug('start_test_item - ID: %s', item_id)
self._add_current_item(item_id)
Expand All @@ -753,35 +767,39 @@ async def start_test_item(self,
async def finish_test_item(self,
item_id: str,
end_time: str,
status: str = None,
status: Optional[str] = None,
issue: Optional[Issue] = None,
attributes: Optional[Union[list, dict]] = None,
description: str = None,
retry: bool = False,
test_case_id: Optional[str] = None,
retry_of: Optional[str] = None,
**kwargs: Any) -> Optional[str]:
"""Finish Test Suite/Case/Step/Nested Step Item.

:param item_id: ID of the Test Item.
:param end_time: The Item end time.
:param status: Test status. Allowed values:
PASSED, FAILED, STOPPED, SKIPPED, INTERRUPTED, CANCELLED, INFO, WARN or None.
:param issue: Issue which will be attached to the current Item.
:param attributes: Test Item attributes(tags). Pairs of key and value. These attributes override
attributes on start Test Item call.
:param description: Test Item description. Overrides description from start request.
:param retry: Used to report retry of the test. Allowed values: "True" or "False".
:return: Response message.
"""
result = await self.__client.finish_test_item(self.launch_uuid, item_id, end_time, status=status,
issue=issue, attributes=attributes,
description=description,
retry=retry, **kwargs)
:param item_id: ID of the Test Item.
:param end_time: The Item end time.
:param status: Test status. Allowed values:
PASSED, FAILED, STOPPED, SKIPPED, INTERRUPTED, CANCELLED, INFO, WARN or None.
:param issue: Issue which will be attached to the current Item.
:param attributes: Test Item attributes(tags). Pairs of key and value. These attributes override
attributes on start Test Item call.
:param description: Test Item description. Overrides description from start request.
:param retry: Used to report retry of the test. Allowed values: "True" or "False".
:param test_case_id: A unique ID of the current Step.
:param retry_of: For retry mode specifies which test item will be marked as retried. Should be used
with the 'retry' parameter.
:return: Response message.
"""
result = await self.__client.finish_test_item(
self.launch_uuid, item_id, end_time, status=status, issue=issue, attributes=attributes,
description=description, retry=retry, test_case_id=test_case_id, retry_of=retry_of, **kwargs)
self._remove_current_item()
return result

async def finish_launch(self,
end_time: str,
status: str = None,
status: Optional[str] = None,
attributes: Optional[Union[list, dict]] = None,
**kwargs: Any) -> Optional[str]:
"""Finish a Launch.
Expand Down Expand Up @@ -1132,6 +1150,7 @@ def start_test_item(self,
code_ref: Optional[str] = None,
retry: bool = False,
test_case_id: Optional[str] = None,
retry_of: Optional[str] = None,
**kwargs: Any) -> Task[str]:
"""Start Test Case/Suite/Step/Nested Step Item.

Expand All @@ -1149,50 +1168,56 @@ def start_test_item(self,
:param code_ref: Physical location of the Test Item.
:param retry: Used to report retry of the test. Allowed values: "True" or "False".
:param test_case_id: A unique ID of the current Step.
:param retry_of: For retry mode specifies which test item will be marked as retried. Should be used
with the 'retry' parameter.
:return: Test Item UUID if successfully started or None.
"""
item_id_coro = self.__client.start_test_item(self.launch_uuid, name, start_time, item_type,
description=description, attributes=attributes,
parameters=parameters, parent_item_id=parent_item_id,
has_stats=has_stats, code_ref=code_ref, retry=retry,
test_case_id=test_case_id, **kwargs)
test_case_id=test_case_id, retry_of=retry_of, **kwargs)
item_id_task = self.create_task(item_id_coro)
self._add_current_item(item_id_task)
return item_id_task

def finish_test_item(self,
item_id: Task[str],
end_time: str,
status: str = None,
status: Optional[str] = None,
issue: Optional[Issue] = None,
attributes: Optional[Union[list, dict]] = None,
description: str = None,
retry: bool = False,
test_case_id: Optional[str] = None,
retry_of: Optional[str] = None,
**kwargs: Any) -> Task[str]:
"""Finish Test Suite/Case/Step/Nested Step Item.

:param item_id: ID of the Test Item.
:param end_time: The Item end time.
:param status: Test status. Allowed values:
PASSED, FAILED, STOPPED, SKIPPED, INTERRUPTED, CANCELLED, INFO, WARN or None.
:param issue: Issue which will be attached to the current Item.
:param attributes: Test Item attributes(tags). Pairs of key and value. These attributes override
attributes on start Test Item call.
:param description: Test Item description. Overrides description from start request.
:param retry: Used to report retry of the test. Allowed values: "True" or "False".
:return: Response message.
"""
result_coro = self.__client.finish_test_item(self.launch_uuid, item_id, end_time, status=status,
issue=issue, attributes=attributes,
description=description,
retry=retry, **kwargs)
:param item_id: ID of the Test Item.
:param end_time: The Item end time.
:param status: Test status. Allowed values:
PASSED, FAILED, STOPPED, SKIPPED, INTERRUPTED, CANCELLED, INFO, WARN or None.
:param issue: Issue which will be attached to the current Item.
:param attributes: Test Item attributes(tags). Pairs of key and value. These attributes override
attributes on start Test Item call.
:param description: Test Item description. Overrides description from start request.
:param retry: Used to report retry of the test. Allowed values: "True" or "False".
:param test_case_id: A unique ID of the current Step.
:param retry_of: For retry mode specifies which test item will be marked as retried. Should be used
with the 'retry' parameter.
:return: Response message.
"""
result_coro = self.__client.finish_test_item(
self.launch_uuid, item_id, end_time, status=status, issue=issue, attributes=attributes,
description=description, retry=retry, test_case_id=test_case_id, retry_of=retry_of, **kwargs)
result_task = self.create_task(result_coro)
self._remove_current_item()
return result_task

def finish_launch(self,
end_time: str,
status: str = None,
status: Optional[str] = None,
attributes: Optional[Union[list, dict]] = None,
**kwargs: Any) -> Task[str]:
"""Finish a Launch.
Expand Down
Loading