Refactoring: item tracking moved to the client

Author: HardNorth

reportportal_client/client.py

@@ -16,10 +16,10 @@
 """
 import logging
 
-
 import requests
 from requests.adapters import HTTPAdapter
 
+from ._local import set_current
 from .core.log_manager import LogManager
 from .core.rp_requests import (
     HttpRequest,
@@ -31,7 +31,6 @@
 from .helpers import uri_join, verify_value_length
 from .static.defines import NOT_FOUND
 from .steps import StepReporter
-from ._local import set_current
 
 logger = logging.getLogger(__name__)
 logger.addHandler(logging.NullHandler())
@@ -88,6 +87,7 @@ def __init__(self,
         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))
@@ -149,6 +149,9 @@ def finish_test_item(self,
         :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,
@@ -162,7 +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.step_reporter.remove_parent(item_id)
+        self._item_stack.pop()
         logger.debug('finish_test_item - ID: %s', item_id)
         logger.debug('response message: %s', response.message)
         return response.message
@@ -337,9 +340,9 @@ def start_test_item(self,
                                json=request_payload,
                                verify_ssl=self.verify_ssl).make()
         item_id = response.id
-        self.step_reporter.set_parent(item_type, item_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))
@@ -367,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,5 +1,7 @@
-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
@@ -23,6 +25,7 @@ class RPClient:
     verify_ssl: bool = ...
     session: Session = ...
     step_reporter: StepReporter = ...
+
     def __init__(self,
                  endpoint: Text,
                  project: Text, token: Text,
@@ -32,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) -> Text: ...
+                         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,
@@ -64,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/steps/__init__.py

@@ -45,7 +45,6 @@ def test_my_nested_step():
 
 from reportportal_client._local import current
 from reportportal_client.helpers import get_function_params, timestamp
-from reportportal_client.static.defines import NOT_FOUND
 
 NESTED_STEP_ITEMS = ('step', 'scenario', 'before_class', 'before_groups',
                      'before_method', 'before_suite', 'before_test',
@@ -63,34 +62,8 @@ def __init__(self, rp_client):
         :param rp_client: Report Portal client which will be used to report
                           steps
         """
-        self.__levels = []
         self.client = rp_client
 
-    def set_parent(self, item_type, parent_id):
-        """Put an id into parent items queue if it has correct type.
-
-        :param item_type: type of the parent item
-        :param parent_id: ID of the parent item
-        """
-        if parent_id is not NOT_FOUND:
-            if item_type.lower() in NESTED_STEP_ITEMS:
-                self.__levels.append(parent_id)
-
-    def get_parent(self):
-        """Retrieve the last item in the parent queue."""
-        if len(self.__levels) > 0:
-            return self.__levels[-1]
-
-    def remove_parent(self, parent_id):
-        """Remove the last item in the parent queue.
-
-        Remove the last item in the parent queue if it's equal to the method's
-        argument.
-        :param parent_id: item ID to remove
-        """
-        if len(self.__levels) > 0 and self.__levels[-1] == parent_id:
-            return self.__levels.pop()
-
     def start_nested_step(self,
                           name,
                           start_time,
@@ -102,8 +75,8 @@ def start_nested_step(self,
         :param start_time: Nested Step start time
         :param parameters: Nested Step parameters
         """
-        parent_id = self.get_parent()
-        if parent_id is None:
+        parent_id = self.client.current_item()
+        if not parent_id:
             return
         return self.client.start_test_item(name, start_time, 'step',
                                            has_stats=False,
@@ -121,8 +94,6 @@ def finish_nested_step(self,
         :param end_time: Nested Step finish time
         :param status:   Nested Step finish status
         """
-        if not self.remove_parent(item_id):
-            return
         return self.client.finish_test_item(item_id, end_time, status=status)
 
 

reportportal_client/steps/__init__.pyi

@@ -21,13 +21,6 @@ class StepReporter:
 
     def __init__(self, rp_client: RPClient) -> None: ...
 
-    def set_parent(self, item_type: Text, parent_id: Text) -> None: ...
-
-    def get_parent(self) -> Optional[Text]: ...
-
-    def remove_parent(self, parent_id: Optional[Text] = ...) \
-            -> Optional[Text]: ...
-
     def start_nested_step(self,
                           name: Text,
                           start_time: Text,

tests/steps/test_steps.py

@@ -31,7 +31,7 @@ def test_nested_steps_are_skipped_without_parent(rp_client):
 
 
 def test_nested_steps_reported_with_parent(rp_client):
-    rp_client.step_reporter.set_parent('STEP', PARENT_STEP_ID)
+    rp_client._item_stack.append(PARENT_STEP_ID)
 
     with step(NESTED_STEP_NAME):
         pass
@@ -41,7 +41,7 @@ def test_nested_steps_reported_with_parent(rp_client):
 
 
 def test_nested_steps_are_skipped_without_client(rp_client):
-    rp_client.step_reporter.set_parent('STEP', PARENT_STEP_ID)
+    rp_client._item_stack.append(PARENT_STEP_ID)
     set_current(None)
     with step(NESTED_STEP_NAME):
         pass
@@ -51,7 +51,7 @@ def test_nested_steps_are_skipped_without_client(rp_client):
 
 
 def test_nested_step_name(rp_client):
-    rp_client.step_reporter.set_parent('STEP', PARENT_STEP_ID)
+    rp_client._item_stack.append(PARENT_STEP_ID)
 
     with step(NESTED_STEP_NAME):
         pass
@@ -61,7 +61,7 @@ def test_nested_step_name(rp_client):
 
 
 def test_nested_step_times(rp_client):
-    rp_client.step_reporter.set_parent('STEP', PARENT_STEP_ID)
+    rp_client._item_stack.append(PARENT_STEP_ID)
 
     with step(NESTED_STEP_NAME):
         pass
@@ -76,7 +76,7 @@ def nested_step():
 
 
 def test_nested_step_decorator(rp_client):
-    rp_client.step_reporter.set_parent('STEP', PARENT_STEP_ID)
+    rp_client._item_stack.append(PARENT_STEP_ID)
     nested_step()
 
     assert rp_client.session.post.call_count == 1
@@ -85,7 +85,7 @@ def test_nested_step_decorator(rp_client):
 
 
 def test_nested_step_failed(rp_client):
-    rp_client.step_reporter.set_parent('STEP', PARENT_STEP_ID)
+    rp_client._item_stack.append(PARENT_STEP_ID)
     try:
         with step(NESTED_STEP_NAME):
             raise AssertionError
@@ -97,7 +97,7 @@ def test_nested_step_failed(rp_client):
 
 
 def test_nested_step_custom_status(rp_client):
-    rp_client.step_reporter.set_parent('STEP', PARENT_STEP_ID)
+    rp_client._item_stack.append(PARENT_STEP_ID)
     with step(NESTED_STEP_NAME, status='INFO'):
         pass
     assert rp_client.session.post.call_count == 1
@@ -106,7 +106,7 @@ def test_nested_step_custom_status(rp_client):
 
 
 def test_nested_step_custom_status_failed(rp_client):
-    rp_client.step_reporter.set_parent('STEP', PARENT_STEP_ID)
+    rp_client._item_stack.append(PARENT_STEP_ID)
     try:
         with step(NESTED_STEP_NAME, status='INFO'):
             raise AssertionError
@@ -123,31 +123,31 @@ def nested_step_params(param1, param2, param3=None):
 
 
 def test_verify_parameters_logging_default_value(rp_client):
-    rp_client.step_reporter.set_parent('STEP', PARENT_STEP_ID)
+    rp_client._item_stack.append(PARENT_STEP_ID)
     nested_step_params(1, 'two')
     assert len(rp_client._log_manager._logs_batch) == 1
     assert rp_client._log_manager._logs_batch[0].message \
            == "Parameters: param1: 1; param2: two"
 
 
 def test_verify_parameters_logging_no_default_value(rp_client):
-    rp_client.step_reporter.set_parent('STEP', PARENT_STEP_ID)
+    rp_client._item_stack.append(PARENT_STEP_ID)
     nested_step_params(1, 'two', 'three')
     assert len(rp_client._log_manager._logs_batch) == 1
     assert rp_client._log_manager._logs_batch[0].message \
            == "Parameters: param1: 1; param2: two; param3: three"
 
 
 def test_verify_parameters_logging_named_value(rp_client):
-    rp_client.step_reporter.set_parent('STEP', PARENT_STEP_ID)
+    rp_client._item_stack.append(PARENT_STEP_ID)
     nested_step_params(1, 'two', param3='three')
     assert len(rp_client._log_manager._logs_batch) == 1
     assert rp_client._log_manager._logs_batch[0].message \
            == "Parameters: param1: 1; param2: two; param3: three"
 
 
 def test_verify_parameters_inline_logging(rp_client):
-    rp_client.step_reporter.set_parent('STEP', PARENT_STEP_ID)
+    rp_client._item_stack.append(PARENT_STEP_ID)
     with step(NESTED_STEP_NAME, params={'param1': 1, 'param2': 'two'}):
         pass
     assert len(rp_client._log_manager._logs_batch) == 1
@@ -171,7 +171,7 @@ def parent_nested_step():
 
 
 def test_two_level_nested_step_decorator(rp_client):
-    rp_client.step_reporter.set_parent('STEP', PARENT_STEP_ID)
+    rp_client._item_stack.append(PARENT_STEP_ID)
     rp_client.session.post.side_effect = item_id_gen
     parent_nested_step()