Skip to content

Commit 5fee6b5

Browse files
committed
rp_launch_uuid configuration parameter
1 parent 2f04c5d commit 5fee6b5

5 files changed

Lines changed: 26 additions & 9 deletions

File tree

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# Changelog
22

33
## [Unreleased]
4+
### Added
5+
- `rp_launch_uuid` configuration parameter, by @HardNorth
6+
### Changed
7+
- Client version updated on [5.7.1](https://github.com/reportportal/client-Python/releases/tag/5.7.1), by @HardNorth
48

59
## [5.6.1]
610
### Added

pytest_reportportal/config.py

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ class AgentConfig:
4444
rp_bts_project: str
4545
rp_bts_url: str
4646
rp_launch: str
47-
rp_launch_id: Optional[str]
47+
rp_launch_uuid: Optional[str]
4848
rp_launch_attributes: Optional[list[str]]
4949
rp_tests_attributes: Optional[list[str]]
5050
rp_launch_description: str
@@ -105,7 +105,16 @@ def __init__(self, pytest_config: Config) -> None:
105105
self.rp_bts_project = self.find_option(pytest_config, "rp_bts_project")
106106
self.rp_bts_url = self.find_option(pytest_config, "rp_bts_url")
107107
self.rp_launch = self.find_option(pytest_config, "rp_launch")
108-
self.rp_launch_id = self.find_option(pytest_config, "rp_launch_id")
108+
self.rp_launch_uuid = self.find_option(pytest_config, "rp_launch_id")
109+
if self.rp_launch_uuid:
110+
warnings.warn(
111+
"Parameter `rp_launch_id` is deprecated since 5.6.2 and will be subject for removing"
112+
"in the next major version. Use `rp_launch_uuid` argument instead.",
113+
DeprecationWarning,
114+
2,
115+
)
116+
self.rp_launch_uuid = self.find_option(pytest_config, "rp_launch_uuid", self.rp_launch_uuid)
117+
109118
self.rp_launch_attributes = self.find_option(pytest_config, "rp_launch_attributes")
110119
self.rp_tests_attributes = self.find_option(pytest_config, "rp_tests_attributes")
111120
self.rp_launch_description = self.find_option(pytest_config, "rp_launch_description")

pytest_reportportal/plugin.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -531,7 +531,11 @@ def add_shared_option(name, help_str, default=None, action="store"):
531531
)
532532
add_shared_option(
533533
name="rp_launch_id",
534-
help_str="Use already existing launch-id. The plugin won't control " "the Launch status",
534+
help_str="DEPRECATED: Use already existing launch-id. The plugin won't control the Launch status",
535+
)
536+
add_shared_option(
537+
name="rp_launch_uuid",
538+
help_str="Use already existing launch UUID. The plugin won't control the Launch status",
535539
)
536540
add_shared_option(
537541
name="rp_launch_description",

pytest_reportportal/service.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@
7474
except ImportError:
7575
Rule = type("dummy", (), {}) # Old pytest-bdd versions do not have Rule
7676

77-
from reportportal_client import RP, create_client
77+
from reportportal_client import RP, ClientType, create_client, OutputType
7878
from reportportal_client.helpers import dict_to_payload, gen_attributes, get_launch_sys_attrs, get_package_version
7979

8080
LOGGER = logging.getLogger(__name__)
@@ -1417,10 +1417,10 @@ def start(self) -> None:
14171417
self._config.rp_api_key,
14181418
)
14191419
launch_id = self._launch_id
1420-
if self._config.rp_launch_id:
1421-
launch_id = self._config.rp_launch_id
1420+
if self._config.rp_launch_uuid:
1421+
launch_id = self._config.rp_launch_uuid
14221422
self.rp = create_client(
1423-
client_type=self._config.rp_client_type,
1423+
client_type=self._config.rp_client_type or ClientType.SYNC,
14241424
endpoint=self._config.rp_endpoint,
14251425
project=self._config.rp_project,
14261426
api_key=self._config.rp_api_key,
@@ -1431,7 +1431,7 @@ def start(self) -> None:
14311431
launch_uuid=launch_id,
14321432
log_batch_payload_limit=self._config.rp_log_batch_payload_limit,
14331433
launch_uuid_print=self._config.rp_launch_uuid_print,
1434-
print_output=self._config.rp_launch_uuid_print_output,
1434+
print_output=self._config.rp_launch_uuid_print_output or OutputType.STDOUT,
14351435
http_timeout=self._config.rp_http_timeout,
14361436
mode=self._config.rp_mode,
14371437
# OAuth 2.0 parameters

tests/unit/test_plugin.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ def test_pytest_sessionfinish(mocked_session):
224224
:param mocked_session: pytest fixture
225225
"""
226226
mocked_session.config.py_test_service = mock.Mock()
227-
mocked_session.config._reporter_config.rp_launch_id = None
227+
mocked_session.config._reporter_config.rp_launch_uuid = None
228228
pytest_sessionfinish(mocked_session)
229229
assert mocked_session.config.py_test_service.finish_launch.called
230230

0 commit comments

Comments
 (0)