Merge pull request #175 from reportportal/nested-steps

Nested steps

Author: HardNorth

.pre-commit-config.yaml

@@ -12,6 +12,10 @@ repos:
     rev: 6.0.0
     hooks:
     -   id: pydocstyle
+        exclude: |
+            (?x)^(
+                tests/.*
+            )
 -   repo: https://github.com/Lucas-C/pre-commit-hooks-markup
     rev: v1.0.1
     hooks:

reportportal_client/__init__.py

@@ -1,11 +1,11 @@
 """
-Copyright (c) 2018 http://reportportal.io .
+Copyright (c) 2022 https://reportportal.io .
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
 
-http://www.apache.org/licenses/LICENSE-2.0
+https://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
@@ -15,5 +15,11 @@
 """
 
 from .service import ReportPortalService
+from .steps import step
+from ._local import current
 
-__all__ = ('ReportPortalService',)
+__all__ = [
+    'ReportPortalService',
+    'step',
+    'current'
+]

reportportal_client/_local/__init__.py

@@ -0,0 +1,34 @@
+#  Copyright (c) 2022 https://reportportal.io .
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#  https://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License
+"""Report Portal client context storing and retrieving module."""
+from threading import local
+
+
+__INSTANCES = local()
+
+
+def current():
+    """Return current Report Portal client."""
+    if hasattr(__INSTANCES, 'current'):
+        return __INSTANCES.current
+
+
+def set_current(client):
+    """Save Report Portal client as current.
+
+    The method is not intended to use used by users. Report Portal client calls
+    it itself when new client is created.
+
+    :param client: Report Portal client
+    """
+    __INSTANCES.current = client

reportportal_client/client.py

@@ -1,12 +1,12 @@
 """This module contains Report Portal Client class.
 
-Copyright (c) 2018 http://reportportal.io .
+Copyright (c) 2022 https://reportportal.io .
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
 
-http://www.apache.org/licenses/LICENSE-2.0
+https://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
@@ -19,22 +19,33 @@
 import requests
 from requests.adapters import HTTPAdapter
 
-from reportportal_client.core.log_manager import LogManager
-from reportportal_client.core.rp_requests import (
+from ._local import set_current
+from .core.log_manager import LogManager
+from .core.rp_requests import (
     HttpRequest,
     ItemStartRequest,
     ItemFinishRequest,
     LaunchStartRequest,
     LaunchFinishRequest
 )
-from reportportal_client.helpers import uri_join, verify_value_length
+from .helpers import uri_join, verify_value_length
+from .static.defines import NOT_FOUND
+from .steps import StepReporter
 
 logger = logging.getLogger(__name__)
 logger.addHandler(logging.NullHandler())
 
 
 class RPClient(object):
-    """Report portal client."""
+    """Report portal client.
+
+    The class is supposed to use by Report Portal agents: both custom and
+    official to make calls to Report Portal. It handles HTTP request and
+    response bodies generation and serialization, connection retries and log
+    batching.
+    NOTICE: the class is not thread-safe, use new class instance for every new
+    thread to avoid request/response messing and other issues.
+    """
 
     def __init__(self,
                  endpoint,
@@ -60,6 +71,7 @@ def __init__(self,
         :param max_pool_size:        Option to set the maximum number of
                                      connections to save the pool.
         """
+        set_current(self)
         self._batch_logs = []
         self.api_v1, self.api_v2 = 'v1', 'v2'
         self.endpoint = endpoint
@@ -74,6 +86,8 @@ def __init__(self,
         self.token = token
         self.verify_ssl = verify_ssl
         self.session = requests.Session()
+        self.step_reporter = StepReporter(self)
+        self._item_stack = []
         if retries:
             self.session.mount('https://', HTTPAdapter(
                 max_retries=retries, pool_maxsize=max_pool_size))
@@ -128,13 +142,16 @@ def finish_test_item(self,
                             "failed", "stopped", "skipped", "interrupted",
                             "cancelled" or None
         :param attributes:  Test item attributes(tags). Pairs of key and value.
-                            Overrides attributes on start
+                            Override attributes on start
         :param description: Test item description. Overrides description
                             from start request.
         :param issue:       Issue of the current test item
         :param retry:       Used to report retry of the test. Allowable values:
                            "True" or "False"
         """
+        if item_id is NOT_FOUND:
+            logger.warning("Uttempt to finish non-existent item")
+            return None
         url = uri_join(self.base_url_v2, 'item', item_id)
         request_payload = ItemFinishRequest(
             end_time,
@@ -148,6 +165,7 @@ def finish_test_item(self,
         ).payload
         response = HttpRequest(self.session.put, url=url, json=request_payload,
                                verify_ssl=self.verify_ssl).make()
+        self._item_stack.pop()
         logger.debug('finish_test_item - ID: %s', item_id)
         logger.debug('response message: %s', response.message)
         return response.message
@@ -316,12 +334,19 @@ def start_test_item(self,
             retry=retry,
             test_case_id=test_case_id
         ).payload
+
         response = HttpRequest(self.session.post,
                                url=url,
                                json=request_payload,
                                verify_ssl=self.verify_ssl).make()
-        logger.debug('start_test_item - ID: %s', response.id)
-        return response.id
+        item_id = response.id
+        if item_id is not NOT_FOUND:
+            logger.debug('start_test_item - ID: %s', item_id)
+            self._item_stack.append(item_id)
+        else:
+            logger.warning('start_test_item - invalid response: %s',
+                           str(response.json))
+        return item_id
 
     def terminate(self, *args, **kwargs):
         """Call this to terminate the client."""
@@ -345,3 +370,7 @@ def update_test_item(self, item_uuid, attributes=None, description=None):
                                verify_ssl=self.verify_ssl).make()
         logger.debug('update_test_item - Item: %s', item_id)
         return response.message
+
+    def current_item(self):
+        """Retrieve the last item reported by the client."""
+        return self._item_stack[-1] if len(self._item_stack) > 0 else None

reportportal_client/client.pyi

@@ -1,7 +1,14 @@
-from requests import Session
 from typing import Any, Dict, List, Optional, Text, Tuple, Union
+
+from requests import Session
+
 from reportportal_client.core.log_manager import LogManager as LogManager
 from reportportal_client.core.rp_issues import Issue as Issue
+from reportportal_client.steps import StepReporter
+
+
+def current() -> RPClient: ...
+
 
 class RPClient:
     _log_manager: LogManager = ...
@@ -17,6 +24,8 @@ class RPClient:
     token: Text = ...
     verify_ssl: bool = ...
     session: Session = ...
+    step_reporter: StepReporter = ...
+
     def __init__(self,
                  endpoint: Text,
                  project: Text, token: Text,
@@ -26,29 +35,38 @@ class RPClient:
                  retries: int = ...,
                  max_pool_size: int = ...,
                  launch_id: Text = ...) -> None: ...
+
     def finish_launch(self,
                       end_time: Text,
                       status: Text = ...,
                       attributes: Optional[Union[List, Dict]] = ...,
                       **kwargs: Any) -> Dict: ...
+
     def finish_test_item(self,
-                    item_id: Text,
-                    end_time: Text,
-                    status: Text,
-                    issue: Optional[Issue] = ...,
-                    attributes: List = ...,
-                    **kwargs: Any) -> None: ...
+                         item_id: Text,
+                         end_time: Text,
+                         status: Text,
+                         issue: Optional[Issue] = ...,
+                         attributes: List = ...,
+                         **kwargs: Any) -> Optional[Text]: ...
+
     def get_item_id_by_uuid(self, uuid: Text) -> Text: ...
+
     def get_launch_info(self) -> Dict: ...
+
     def get_launch_ui_id(self) -> Optional[Dict]: ...
+
     def get_launch_ui_url(self) -> Text: ...
+
     def get_project_settings(self) -> Dict: ...
+
     def log(self,
             time: Text,
             message: Text,
             level: Optional[Union[int, Text]] = ...,
             attachment: Optional[Dict] = ...,
             item_id: Optional[Text] = ...) -> None: ...
+
     def start_launch(self,
                      name: Text,
                      start_time: Text,
@@ -58,16 +76,23 @@ class RPClient:
                      rerun: bool = ...,
                      rerun_of: Text = ...,
                      **kwargs: Any) -> Text: ...
+
     def start_test_item(self,
-                   name: Text,
-                   start_time: Text,
-                   item_type: Text,
-                   description: Text = ...,
-                   attributes: Optional[Union[List, Dict]] = ...,
-                   parameters: Dict = ...,
-                   parent_item_id: Text = ...,
-                   has_stats: bool = ...,
-                   code_ref: Text = ...,
-                   **kwargs: Any) -> Text: ...
+                        name: Text,
+                        start_time: Text,
+                        item_type: Text,
+                        description: Text = ...,
+                        attributes: Optional[Union[List, Dict]] = ...,
+                        parameters: Dict = ...,
+                        parent_item_id: Text = ...,
+                        has_stats: bool = ...,
+                        code_ref: Text = ...,
+                        **kwargs: Any) -> Text: ...
+
     def terminate(self, *args: Tuple, **kwargs: Any) -> None: ...
-    def update_test_item(self, item_uuid: Text, attributes: Optional[Union[List, Dict]], description: Optional[Text]):
+
+    def update_test_item(self, item_uuid: Text,
+                         attributes: Optional[Union[List, Dict]],
+                         description: Optional[Text]) -> Text: ...
+
+    def current_item(self) -> Text: ...

reportportal_client/helpers.py

@@ -11,9 +11,11 @@
 See the License for the specific language governing permissions and
 limitations under the License.
 """
+import inspect
 import logging
 import time
 import uuid
+import warnings
 from platform import machine, processor, system
 
 import six
@@ -156,3 +158,27 @@ def uri_join(*uri_parts):
         An uri string.
     """
     return '/'.join(str(s).strip('/').strip('\\') for s in uri_parts)
+
+
+def get_function_params(func, args, kwargs):
+    """Extract argument names from the function and combine them with values.
+
+    :param func: the function to get arg names
+    :param args: function's arg values
+    :param kwargs: function's kwargs
+    :return: a dictionary of values
+    """
+    # Use deprecated method for python 2.7 compatibility, it's still here for
+    # Python 3.10.2, so it's completely redundant to show the warning
+    with warnings.catch_warnings():
+        warnings.filterwarnings("ignore", category=DeprecationWarning)
+        # noinspection PyDeprecation
+        arg_spec = inspect.getargspec(func)
+    result = dict()
+    for i, arg_name in enumerate(arg_spec.args):
+        if i >= len(args):
+            break
+        result[arg_name] = args[i]
+    for arg_name, arg_value in kwargs.items():
+        result[arg_name] = arg_value
+    return result if len(result.items()) > 0 else None

reportportal_client/helpers.pyi

@@ -3,7 +3,7 @@ from .errors import EntryCreatedError as EntryCreatedError, \
     ResponseError as ResponseError
 from logging import Logger
 
-from typing import Text
+from typing import Text, Tuple, List, Callable, Any, Dict, Optional
 from requests import Response
 
 logger: Logger
@@ -21,5 +21,6 @@ def get_data(response: Response) -> dict: ...
 def get_json(response: Response) -> dict: ...
 def get_error_messages(data: dict) -> list: ...
 def verify_value_length(attributes: list[dict]) -> list[dict]: ...
-
 def timestamp() -> Text: ...
+def get_function_params(func: Callable, args: Tuple[Any, ...],
+                        kwargs: Dict[Text, Any]) -> Dict[Text, Any]: ...