Merge pull request #167 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: |
@@ -87,7 +100,6 @@ jobs:
           mv ${{ env.CHANGE_LOG_FILE }}${{ env.TMP_SUFFIX }} ${{ env.CHANGE_LOG_FILE }}
           git add ${{ env.CHANGE_LOG_FILE }}
           git commit -m "Changelog update"
-          git push
 
       - name: Read changelog Entry
         id: readChangelogEntry
@@ -104,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

@@ -2,6 +2,12 @@
 
 ## [Unreleased]
 ### Changed
+- Client version updated on [5.3.5](https://github.com/reportportal/client-Python/releases/tag/5.3.5), by @HardNorth
+- The Agent publish a warning and does not report anything in case of a missed required variable now,  by @HardNorth
+- `RP_UUID` configuration parameter was renamed to `RP_API_KEY` to maintain common convention, by @HardNorth
+
+## [5.3.2]
+### Changed
 - Client version updated on [5.3.0](https://github.com/reportportal/client-Python/releases/tag/5.3.0), by @HardNorth
 
 ## [5.3.1]

README.md

@@ -57,7 +57,7 @@ REQUIRED:
 
 ```
 --listener robotframework_reportportal.listener
---variable RP_UUID:"your_user_uuid"
+--variable RP_API_KEY:"your_user_api_key"
 --variable RP_ENDPOINT:"your_reportportal_url"
 --variable RP_LAUNCH:"launch_name"
 --variable RP_PROJECT:"reportportal_project_name"

pyproject.toml

@@ -3,6 +3,6 @@ requires = [
   # sync with setup.py until we discard non-pep-517/518
   "setuptools>=40.0",
   "setuptools-scm",
-  "wheel",
+  "wheel==0.37.1",
 ]
 build-backend = "setuptools.build_meta"

requirements.txt

@@ -1,4 +1,4 @@
 python-dateutil>=2.8.1
-reportportal-client==5.3.0
+reportportal-client==5.3.5
 robotframework
 six>=1.15.0

robotframework_reportportal/listener.py

@@ -16,6 +16,7 @@
 
 import logging
 import os
+from functools import wraps
 from mimetypes import guess_type
 
 from reportportal_client.helpers import gen_attributes
@@ -29,6 +30,17 @@
 logger = logging.getLogger(__name__)
 
 
+def check_rp_enabled(func):
+    """Verify is RP is enabled in config."""
+    @wraps(func)
+    def wrap(*args, **kwargs):
+        if args and isinstance(args[0], listener):
+            if not args[0].service:
+                return
+        func(*args, **kwargs)
+    return wrap
+
+
 class listener(object):
     """Robot Framework listener interface for reporting to Report Portal."""
 
@@ -64,6 +76,7 @@ def current_item(self):
         if self._items:
             return self._items[-1]
 
+    @check_rp_enabled
     def log_message(self, message):
         """Send log message to the Report Portal.
 
@@ -73,6 +86,7 @@ def log_message(self, message):
         logger.debug('ReportPortal - Log Message: {0}'.format(message))
         self.service.log(message=msg)
 
+    @check_rp_enabled
     def log_message_with_image(self, msg, image):
         """Send log message to the Report Portal.
 
@@ -98,12 +112,12 @@ def parent_id(self):
     @property
     def service(self):
         """Initialize instance of the RobotService."""
-        if self._service is None:
+        if self.variables.enabled and self._service is None:
             self._service = RobotService()
             self._service.init_service(
                 endpoint=self.variables.endpoint,
                 project=self.variables.project,
-                uuid=self.variables.uuid,
+                api_key=self.variables.api_key,
                 log_batch_size=self.variables.log_batch_size,
                 pool_size=self.variables.pool_size,
                 skipped_issue=self.variables.skipped_issue,
@@ -120,6 +134,7 @@ def variables(self):
             self._variables = Variables()
         return self._variables
 
+    @check_rp_enabled
     def start_launch(self, attributes, ts=None):
         """Start a new launch at the Report Portal.
 
@@ -143,6 +158,7 @@ def start_launch(self, attributes, ts=None):
         else:
             self.service.rp.launch_id = self.variables.launch_id
 
+    @check_rp_enabled
     def start_suite(self, name, attributes, ts=None):
         """Start a new test suite at the Report Portal.
 
@@ -167,6 +183,7 @@ def start_suite(self, name, attributes, ts=None):
             suite.rp_item_id = self.service.start_suite(suite=suite, ts=ts)
             self._items.append(suite)
 
+    @check_rp_enabled
     def end_suite(self, _, attributes, ts=None):
         """Finish started test suite at the Report Portal.
 
@@ -188,6 +205,7 @@ def end_suite(self, _, attributes, ts=None):
                 'ReportPortal - End Suite: {0}'.format(suite.attributes))
             self.service.finish_suite(suite=suite, ts=ts)
 
+    @check_rp_enabled
     def start_test(self, name, attributes, ts=None):
         """Start a new test case at the Report Portal.
 
@@ -207,6 +225,7 @@ def start_test(self, name, attributes, ts=None):
         test.rp_item_id = self.service.start_test(test=test, ts=ts)
         self._items.append(test)
 
+    @check_rp_enabled
     def end_test(self, _, attributes, ts=None):
         """Finish started test case at the Report Portal.
 
@@ -224,6 +243,7 @@ def end_test(self, _, attributes, ts=None):
         self._finish_current_item()
         self.service.finish_test(test=test, ts=ts)
 
+    @check_rp_enabled
     def start_keyword(self, name, attributes, ts=None):
         """Start a new keyword(test step) at the Report Portal.
 
@@ -238,6 +258,7 @@ def start_keyword(self, name, attributes, ts=None):
         kwd.rp_item_id = self.service.start_keyword(keyword=kwd, ts=ts)
         self._items.append(kwd)
 
+    @check_rp_enabled
     def end_keyword(self, _, attributes, ts=None):
         """Finish started keyword at the Report Portal.
 
@@ -275,6 +296,7 @@ def xunit_file(self, xunit_path):
             message = {'message': 'XUnit result file', 'level': 'INFO'}
             self.log_message_with_image(message, xunit_path)
 
+    @check_rp_enabled
     def close(self):
         """Call service terminate when the whole test execution is done."""
         self.service.terminate_service()

robotframework_reportportal/post_report.py

@@ -23,7 +23,7 @@
 
 Command-line usage:
 
-    post_report --variable RP_UUID:"your_user_uuid"
+    post_report --variable RP_API_KEY:"your_user_api_key"
                 --variable RP_ENDPOINT:"your_reportportal_url"
                 --variable RP_PROJECT:"reportportal_project_name"
                 [--variable RP_LAUNCH:"launch_name"]

robotframework_reportportal/service.py

@@ -69,15 +69,15 @@ def _get_launch_attributes(self, cmd_attrs):
             '{}|{}'.format(self.agent_name, self.agent_version))
         return attributes + dict_to_payload(system_attributes)
 
-    def init_service(self, endpoint, project, uuid, log_batch_size, pool_size,
-                     skipped_issue=True, verify_ssl=True,
+    def init_service(self, endpoint, project, api_key, log_batch_size,
+                     pool_size, skipped_issue=True, verify_ssl=True,
                      log_batch_payload_size=MAX_LOG_BATCH_PAYLOAD_SIZE,
                      launch_id=None):
         """Initialize common Report Portal client.
 
         :param endpoint:               Report Portal API endpoint
         :param project:                Report Portal project
-        :param uuid:                   API token
+        :param api_key:                API key
         :param log_batch_size:         Number of logs to be sent within one
                                        batch
         :param pool_size:              HTTPAdapter max pool size
@@ -92,12 +92,12 @@ def init_service(self, endpoint, project, uuid, log_batch_size, pool_size,
         if self.rp is None:
             logger.debug(
                 'ReportPortal - Init service: '
-                'endpoint={0}, project={1}, uuid={2}'
-                .format(endpoint, project, uuid))
+                'endpoint={0}, project={1}, api_key={2}'
+                .format(endpoint, project, api_key))
             self.rp = RPClient(
                 endpoint=endpoint,
                 project=project,
-                token=uuid,
+                api_key=api_key,
                 is_skipped_an_issue=skipped_issue,
                 log_batch_size=log_batch_size,
                 retries=True,

robotframework_reportportal/service.pyi

@@ -35,7 +35,7 @@ class RobotService:
 
     def _get_launch_attributes(self, cmd_attrs: List) -> List: ...
 
-    def init_service(self, endpoint: Text, project: Text, uuid: Text,
+    def init_service(self, endpoint: Text, project: Text, api_key: Text,
                      log_batch_size: int, pool_size: int, skipped_issue: bool,
                      verify_ssl: Union[Text, bool],
                      log_batch_payload_size: int, launch_id: str) -> None: ...

robotframework_reportportal/variables.py

@@ -15,12 +15,11 @@
 
 from distutils.util import strtobool
 from os import path
+from warnings import warn
 
 from reportportal_client.logs.log_manager import MAX_LOG_BATCH_PAYLOAD_SIZE
 from robot.libraries.BuiltIn import BuiltIn, RobotNotRunningError
 
-from .exception import RobotServiceException
-
 # This is a storage for the result visitor
 _variables = {}
 
@@ -43,12 +42,12 @@ class Variables(object):
 
     def __init__(self):
         """Initialize instance attributes."""
-        self._endpoint = None
-        self._launch_name = None
+        self.endpoint = get_variable('RP_ENDPOINT')
+        self.launch_name = get_variable('RP_LAUNCH')
+        self.project = get_variable('RP_PROJECT')
+
         self._pabot_pool_id = None
         self._pabot_used = None
-        self._project = None
-        self._uuid = None
         self.attach_log = bool(strtobool(get_variable(
             'RP_ATTACH_LOG', default='False')))
         self.attach_report = bool(strtobool(get_variable(
@@ -74,33 +73,37 @@ def __init__(self):
             "RP_LOG_BATCH_PAYLOAD_SIZE",
             default=str(MAX_LOG_BATCH_PAYLOAD_SIZE)))
 
-    @property
-    def endpoint(self):
-        """Get Report Portal API endpoint.
-
-        :raises: RobotServiceException if it is None
-        :return: Report Portal API endpoint
-        """
-        self._endpoint = self._endpoint or get_variable('RP_ENDPOINT')
-        if self._endpoint is None:
-            raise RobotServiceException(
-                'Missing parameter RP_ENDPOINT for robot run\n'
-                'You should pass -v RP_ENDPOINT:<endpoint_value>')
-        return self._endpoint
-
-    @property
-    def launch_name(self):
-        """Get Report Portal launch name.
-
-        :raises: RobotServiceException if it is None
-        :return: Report Portal launch name
-        """
-        self._launch_name = self._launch_name or get_variable('RP_LAUNCH')
-        if self._launch_name is None:
-            raise RobotServiceException(
-                'Missing parameter RP_LAUNCH for robot run\n'
-                'You should pass -v RP_LAUNCH:<launch_name_value>')
-        return self._launch_name
+        self.api_key = get_variable('RP_API_KEY')
+        if not self.api_key:
+            token = get_variable('RP_UUID')
+            if token:
+                warn(
+                    message="Argument `token` is deprecated since 2.0.4 and "
+                            "will be subject for removing in the next major "
+                            "version. Use `api_key` argument instead.",
+                    category=DeprecationWarning,
+                    stacklevel=2
+                )
+                self.api_key = token
+            else:
+                warn(
+                    message="Argument `api_key` is `None` or empty string, "
+                            "that's not supposed to happen because Report "
+                            "Portal is usually requires an authorization key. "
+                            "Please check your code.",
+                    category=RuntimeWarning,
+                    stacklevel=2
+                )
+
+        cond = (self.endpoint, self.launch_name, self.project, self.api_key)
+        self.enabled = all(cond)
+        if not self.enabled:
+            warn(
+                'One or required parameter is missing, Report Portal listener '
+                'will be disabled. Please check agent documentation.',
+                RuntimeWarning,
+                2
+            )
 
     @property
     def pabot_pool_id(self):
@@ -122,34 +125,6 @@ def pabot_used(self):
             self._pabot_used = get_variable(name='PABOTLIBURI')
         return self._pabot_used
 
-    @property
-    def project(self):
-        """Get Report Portal project name.
-
-        :raises: RobotServiceException if it is None
-        :return: Report Portal project name
-        """
-        self._project = self._project or get_variable('RP_PROJECT')
-        if self._project is None:
-            raise RobotServiceException(
-                'Missing parameter RP_PROJECT for robot run\n'
-                'You should pass -v RP_PROJECT:<project_name_value>')
-        return self._project
-
-    @property
-    def uuid(self):
-        """Get Report Portal API token UUID.
-
-        :raises: RobotServiceException if it is None
-        :return: Report Portal token UUID
-        """
-        self._uuid = self._uuid or get_variable('RP_UUID')
-        if self._uuid is None:
-            raise RobotServiceException(
-                'Missing parameter RP_UUID for robot run\n'
-                'You should pass -v RP_UUID:<uuid_value>')
-        return self._uuid
-
     @property
     def verify_ssl(self):
         """Get value of the verify_ssl parameter for the client."""