Merge pull request #209 from reportportal/develop

Release

Author: HardNorth

.github/workflows/release.yml

@@ -75,6 +75,19 @@ jobs:
           git tag -a ${{ env.RELEASE_VERSION }} -m "Release ${{ env.RELEASE_VERSION }}"
           git push --tags
 
+      - name: Checkout develop branch
+        uses: actions/checkout@v3
+        with:
+          ref: 'develop'
+          fetch-depth: 0
+
+      - name: Merge release branch into develop
+        id: mergeIntoDevelop
+        run: |
+          git merge -m 'Merge master branch into develop after a release' origin/master
+          git status | (! grep -Fq 'both modified:') || git status | grep -F 'both modified:' \
+          | { echo -e 'Unable to merge master into develop, merge conflicts:'; (! grep -Eo '[^ ]+$') }
+
       - name: Update CHANGELOG.md
         id: changelogUpdate
         run: |
@@ -103,19 +116,6 @@ jobs:
           name: Release ${{ env.RELEASE_VERSION }}
           body: ${{ steps.readChangelogEntry.outputs.changes }}
 
-      - name: Checkout develop branch
-        uses: actions/checkout@v3
-        with:
-          ref: 'develop'
-          fetch-depth: 0
-
-      - name: Merge release branch into develop
-        id: mergeIntoDevelop
-        run: |
-          git merge -m 'Merge master branch into develop after a release' origin/master
-          git status | (! grep -Fq 'both modified:') || git status | grep -F 'both modified:' \
-          | { echo -e 'Unable to merge master into develop, merge conflicts:'; (! grep -Eo '[^ ]+$') }
-
       - name: Update version file
         id: versionFileUpdate
         run: |

CHANGELOG.md

@@ -1,6 +1,14 @@
 # Changelog
 
 ## [Unreleased]
+### Added
+- `MAX_LOG_BATCH_SIZE` constant into `log_manager` module, by @HardNorth
+### Fixed
+- Missed `verify_ssl` argument passing to `LogManager` class, by @rplevka
+### Changed
+- Statistics service was refactored, by @HardNorth
+
+## [5.3.0]
 ### Fixed
 - Issue [#198](https://github.com/reportportal/client-Python/issues/198): Python 3.8+ logging issue, by @HardNorth
 - Issue [#200](https://github.com/reportportal/client-Python/issues/200): max_pool_size not worked without retries setting, by @ericscobell

README.md

@@ -10,14 +10,12 @@
 
 Library used only for implementors of custom listeners for ReportPortal
 
-
 ## Already implemented listeners:
 
 - [PyTest Framework](https://github.com/reportportal/agent-python-pytest)
 - [Robot Framework](https://github.com/reportportal/agent-Python-RobotFramework)
 - [Behave Framework](https://github.com/reportportal/agent-python-behave)
-- [Nose Framework](https://github.com/reportportal/agent-python-nosetests)
-
+- [Nose Framework (archived)](https://github.com/reportportal/agent-python-nosetests)
 
 ## Installation
 
@@ -27,116 +25,60 @@ The latest stable version is available on PyPI:
 pip install reportportal-client
 ```
 
-**IMPORTANT!**
-The latest client version **does** not support Report Portal versions below
-5.0.0.
-
-Version 3 is the latest one which supports Report Portal versions below 5.0.0
-to install it:
-
-```
-pip install reportportal-client~=3.0
-```
-
-
-## Contribution
-
-All the fixes for the client that supports Report Portal versions below 5.0.0
-should go into the v3 branch. The master branch will store the code base for
-the client for Report Portal versions 5 and above.
-
-
 ## Usage
 
-Main classes are:
-
-- reportportal_client.ReportPortalService
-- reportportal_client.ReportPortalServiceAsync(Client version 3.x only)
-
 Basic usage example:
 
 ```python
 import os
 import subprocess
-import traceback
 from mimetypes import guess_type
-from time import time
-
-# Report Portal versions below 5.0.0:
-from reportportal_client import ReportPortalServiceAsync
-
-# Report Portal versions >= 5.0.0:
-from reportportal_client import ReportPortalService
-
-
-def timestamp():
-    return str(int(time() * 1000))
 
+from reportportal_client import RPClient
+from reportportal_client.helpers import timestamp
 
-endpoint = "http://10.6.40.6:8080"
+endpoint = "http://docker.local:8080"
 project = "default"
 # You can get UUID from user profile page in the Report Portal.
 token = "1adf271d-505f-44a8-ad71-0afbdf8c83bd"
 launch_name = "Test launch"
 launch_doc = "Testing logging with attachment."
 
 
-def my_error_handler(exc_info):
-    """
-    This callback function will be called by async service client when error occurs.
-    Return True if error is not critical and you want to continue work.
-    :param exc_info: result of sys.exc_info() -> (type, value, traceback)
-    :return:
-    """
-    print("Error occurred: {}".format(exc_info[1]))
-    traceback.print_exception(*exc_info)
+client = RPClient(endpoint=endpoint, project=project,
+                  token=token)
 
-
-# Report Portal versions below 5.0.0:
-service = ReportPortalServiceAsync(endpoint=endpoint, project=project,
-                                   token=token, error_handler=my_error_handler)
-
-# Report Portal versions >= 5.0.0:
-service = ReportPortalService(endpoint=endpoint, project=project,
-                                   token=token)
+# Start log upload thread
+client.start()
 
 # Start launch.
-launch = service.start_launch(name=launch_name,
-                              start_time=timestamp(),
-                              description=launch_doc)
-
-# Start test item Report Portal versions below 5.0.0:
-test = service.start_test_item(name="Test Case",
-                               description="First Test Case",
-                               tags=["Image", "Smoke"],
-                               start_time=timestamp(),
-                               item_type="STEP",
-                               parameters={"key1": "val1",
-                                           "key2": "val2"})
-
-# Start test item Report Portal versions >= 5.0.0:
-item_id = service.start_test_item(name="Test Case",
-                                  description="First Test Case",
-                                  start_time=timestamp(),
-                                  item_type="STEP",
-                                  parameters={"key1": "val1",
-                                              "key2": "val2"})
-
+launch = client.start_launch(name=launch_name,
+                             start_time=timestamp(),
+                             description=launch_doc)
+
+item_id = client.start_test_item(name="Test Case",
+                                 description="First Test Case",
+                                 start_time=timestamp(),
+                                 attributes=[{"key": "key", "value": "value"},
+                                             {"value", "tag"}],
+                                 item_type="STEP",
+                                 parameters={"key1": "val1",
+                                             "key2": "val2"})
 
 # Create text log message with INFO level.
-service.log(time=timestamp(),
-            message="Hello World!",
-            level="INFO")
+client.log(time=timestamp(),
+           message="Hello World!",
+           level="INFO")
 
 # Create log message with attached text output and WARN level.
-service.log(time=timestamp(),
-            message="Too high memory usage!",
-            level="WARN",
-            attachment={
-                "name": "free_memory.txt",
-                "data": subprocess.check_output("free -h".split()),
-                "mime": "text/plain"
-            })
+client.log(time=timestamp(),
+           message="Too high memory usage!",
+           level="WARN",
+           attachment={
+               "name": "free_memory.txt",
+               "data": subprocess.check_output("free -h".split()),
+               "mime": "text/plain"
+           })
 
 # Create log message with binary file, INFO level and custom mimetype.
 image = "/tmp/image.png"
@@ -146,57 +88,49 @@ with open(image, "rb") as fh:
         "data": fh.read(),
         "mime": guess_type(image)[0] or "application/octet-stream"
     }
-    service.log(timestamp(), "Screen shot of issue.", "INFO", attachment)
-
-# Create log message supplying only contents
-service.log(
-    timestamp(),
-    "running processes",
-    "INFO",
-    attachment=subprocess.check_output("ps aux".split()))
+    client.log(timestamp(), "Screen shot of issue.", "INFO", attachment)
 
-# Finish test item Report Portal versions below 5.0.0.
-service.finish_test_item(end_time=timestamp(), status="PASSED")
-
-# Finish test item Report Portal versions >= 5.0.0.
-service.finish_test_item(item_id=item_id, end_time=timestamp(), status="PASSED")
+client.finish_test_item(item_id=item_id, end_time=timestamp(), status="PASSED")
 
 # Finish launch.
-service.finish_launch(end_time=timestamp())
+client.finish_launch(end_time=timestamp())
 
 # Due to async nature of the service we need to call terminate() method which
 # ensures all pending requests to server are processed.
 # Failure to call terminate() may result in lost data.
-service.terminate()
+client.terminate()
 ```
 
-
 # Send attachment (screenshots)
 
-[python-client](https://github.com/reportportal/client-Python/blob/64550693ec9c198b439f8f6e8b23413812d9adf1/reportportal_client/service.py#L259) uses `requests` library for working with RP and the same semantics to work with attachments (data).
+The client uses `requests` library for working with RP and the same semantics
+to work with attachments (data).
 
-There are two ways to pass data as attachment:
+To log an attachment you need to pass file content and metadata to ``
 
-### Case 1 - pass file-like object
-```
-with open(screenshot_file_path, "rb") as image_file:
-    rp_logger.info("Some Text Here",
-                   attachment={"name": "test_name_screenshot.png",
-                               "data": image_file,
-                               "mime": "image/png"})
-```
+```python
+import logging
 
-### Case 2 - pass file content itself (like you did)
-```
-with open(screenshot_file_path, "rb") as image_file:
-        file_data = image_file.read()
+from reportportal_client import RPLogger, RPLogHandler
 
-rp_logger.info("Some Text Here",
-               attachment={"name": "test_name_screenshot.png",
-                           "data": file_data,
-                           "mime": "image/png"})
-```
+logging.setLoggerClass(RPLogger)
+rp_logger = logging.getLogger(__name__)
+rp_logger.setLevel(logging.DEBUG)
+rp_logger.addHandler(RPLogHandler())
+
+screenshot_file_path = 'path/to/file.png'
 
+with open(screenshot_file_path, "rb") as image_file:
+    file_data = image_file.read()
+
+    # noinspection PyArgumentList
+    rp_logger.info(
+        "Some Text Here",
+        attachment={"name": "test_name_screenshot.png",
+                    "data": file_data,
+                    "mime": "image/png"}
+    )
+```
 
 # Copyright Notice
 

reportportal_client/client.py

@@ -120,7 +120,8 @@ def __init__(self,
         self._log_manager = LogManager(
             self.endpoint, self.session, self.api_v2, self.launch_id,
             self.project, max_entry_number=log_batch_size,
-            max_payload_size=log_batch_payload_size)
+            max_payload_size=log_batch_payload_size,
+            verify_ssl=self.verify_ssl)
 
     def finish_launch(self,
                       end_time,

reportportal_client/client.pyi

@@ -90,7 +90,7 @@ class RPClient:
                         start_time: Text,
                         item_type: Text,
                         description: Text = ...,
-                        attributes: Optional[Union[List, Dict]] = ...,
+                        attributes: Optional[List[Dict]] = ...,
                         parameters: Dict = ...,
                         parent_item_id: Text = ...,
                         has_stats: bool = ...,

reportportal_client/helpers.pyi

@@ -15,7 +15,7 @@ TYPICAL_MULTIPART_FOOTER_LENGTH: int
 def generate_uuid() -> Text: ...
 def convert_string(value: Text) -> Text: ...
 def dict_to_payload(dictionary: dict) -> list[dict]: ...
-def gen_attributes(rp_attributes: list) -> list[dict]: ...
+def gen_attributes(rp_attributes: List[Text]) -> List[Dict[Text, Text]]: ...
 def get_launch_sys_attrs()-> dict[Text]: ...
 def get_package_version(package_name:Text) -> Text: ...
 def uri_join(*uri_parts: Text) -> Text: ...

reportportal_client/logs/__init__.py

@@ -174,9 +174,8 @@ def emit(self, record):
             self.handleError(record)
 
         log_level = self._get_rp_log_level(record.levelno)
-        if self.rp_client:
-            rp_client = self.rp_client
-        else:
+        rp_client = self.rp_client
+        if not rp_client:
             rp_client = current()
         if rp_client:
             rp_client.log(

reportportal_client/logs/log_manager.py

@@ -30,14 +30,15 @@
 
 logger = logging.getLogger(__name__)
 
+MAX_LOG_BATCH_SIZE = 20
 MAX_LOG_BATCH_PAYLOAD_SIZE = 65000000
 
 
 class LogManager(object):
     """Manager of the log items."""
 
     def __init__(self, rp_url, session, api_version, launch_id, project_name,
-                 max_entry_number=20, verify_ssl=True,
+                 max_entry_number=MAX_LOG_BATCH_SIZE, verify_ssl=True,
                  max_payload_size=MAX_LOG_BATCH_PAYLOAD_SIZE):
         """Initialize instance attributes.
 

reportportal_client/logs/log_manager.pyi

@@ -25,6 +25,7 @@ from reportportal_client.core.worker import APIWorker as APIWorker
 
 logger: Logger
 
+MAX_LOG_BATCH_SIZE: int
 MAX_LOG_BATCH_PAYLOAD_SIZE: int