Merge pull request #103 from iivanou/log_batch

Revive log batches functionality

Author: Dmitriy Gumeniuk

reportportal_client/__init__.py

@@ -17,5 +17,3 @@
 from .service import ReportPortalService
 
 __all__ = ('ReportPortalService',)
-
-POST_LOGBATCH_RETRY_COUNT = 10

reportportal_client/service.py

@@ -27,6 +27,7 @@
 
 from .errors import ResponseError, EntryCreatedError, OperationCompletionError
 
+POST_LOGBATCH_RETRY_COUNT = 10
 logger = logging.getLogger(__name__)
 logger.addHandler(logging.NullHandler())
 
@@ -165,6 +166,7 @@ def __init__(self,
                  endpoint,
                  project,
                  token,
+                 log_batch_size=20,
                  is_skipped_an_issue=True,
                  verify_ssl=True,
                  retries=None,
@@ -175,12 +177,15 @@ def __init__(self,
             endpoint: endpoint of report portal service.
             project: project name to use for launch names.
             token: authorization token.
+            log_batch_size: option to set the maximum number of logs
+                            that can be processed in one batch
             is_skipped_an_issue: option to mark skipped tests as not
                 'To Investigate' items on Server side.
             verify_ssl: option to not verify ssl certificates
         """
-        super(ReportPortalService, self).__init__()
+        self._batch_logs = []
         self.endpoint = endpoint
+        self.log_batch_size = log_batch_size
         self.project = project
         self.token = token
         self.is_skipped_an_issue = is_skipped_an_issue
@@ -231,6 +236,9 @@ def finish_launch(self, end_time, status=None, **kwargs):
         Status can be one of the followings:
         (PASSED, FAILED, STOPPED, SKIPPED, RESETED, CANCELLED)
         """
+        # process log batches firstly:
+        if self._batch_logs:
+            self.log_batch([], force=True)
         data = {
             "endTime": end_time,
             "status": status
@@ -395,7 +403,7 @@ def log(self, time, message, level=None, attachment=None, item_id=None):
             logger.debug("log - ID: %s", item_id)
             return _get_id(r)
 
-    def log_batch(self, log_data, item_id=None):
+    def log_batch(self, log_data, item_id=None, force=False):
         """
         Log batch of messages with attachment.
 
@@ -407,11 +415,17 @@ def log_batch(self, log_data, item_id=None):
                     name: name of attachment
                     data: fileobj or content
                     mime: content type for attachment
+        item_id: UUID of the test item that owns log_data
+        force:   Flag that forces client to process all the logs
+                 stored in self._batch_logs immediately
         """
+        self._batch_logs += log_data
+        if len(self._batch_logs) < self.log_batch_size and not force:
+            return
         url = uri_join(self.base_url_v2, "log")
 
         attachments = []
-        for log_item in log_data:
+        for log_item in self._batch_logs:
             if item_id:
                 log_item["itemUuid"] = item_id
             log_item["launchUuid"] = self.launch_id
@@ -435,30 +449,27 @@ def log_batch(self, log_data, item_id=None):
         files = [(
             "json_request_part", (
                 None,
-                json.dumps(log_data),
+                json.dumps(self._batch_logs),
                 "application/json"
             )
         )]
         files.extend(attachments)
-        from reportportal_client import POST_LOGBATCH_RETRY_COUNT
         for i in range(POST_LOGBATCH_RETRY_COUNT):
             try:
                 r = self.session.post(
                     url=url,
                     files=files,
                     verify=self.verify_ssl
                 )
+                logger.debug("log_batch - ID: %s", item_id)
+                logger.debug("log_batch response: %s", r.text)
+                self._batch_logs = []
+                return _get_data(r)
             except KeyError:
                 if i < POST_LOGBATCH_RETRY_COUNT - 1:
                     continue
                 else:
                     raise
-            break
-
-        logger.debug("log_batch - ID: %s", item_id)
-        logger.debug("log_batch response: %s", r.text)
-
-        return _get_data(r)
 
     @staticmethod
     def get_system_information(agent_name='agent_name'):

setup.py

@@ -2,7 +2,7 @@
 
 from setuptools import setup, find_packages
 
-__version__ = '5.0.3'
+__version__ = '5.0.4'
 
 setup(
     name='reportportal-client',