Merge pull request #336 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

@@ -1,6 +1,14 @@
 # Changelog
 
 ## [Unreleased]
+### Fixed
+- Plugin Exception in case of Launch creation timed out, by @HardNorth
+### Changed
+- Client version updated on [5.3.1](https://github.com/reportportal/client-Python/releases/tag/5.3.1), by @HardNorth
+
+## [5.1.6]
+### Changed
+- Client version updated on [5.3.0](https://github.com/reportportal/client-Python/releases/tag/5.3.0), by @HardNorth
 
 ## [5.1.5]
 ### Added

README.rst

@@ -24,7 +24,6 @@ Pytest plugin for reporting test results of the Pytest to the Report Portal.
 * Usage
 * Installation
 * Configuration
-* Contribution
 * Examples
 * Launching
 * Send attachment (screenshots)
@@ -44,21 +43,7 @@ To install pytest plugin execute next command in a terminal:
 
     pip install pytest-reportportal
 
-**IMPORTANT!**
-The latest version **does not** support Report Portal versions below 5.0.0.
 
-Specify the last one release of the client version 1 to install or update the client for other versions of Report Portal below 5.0.0:
-
-.. code-block:: bash
-
-    pip install pytest-reportportal~=1.0
-
-
-Contribution
-~~~~~~~~~~~~~
-
-All the fixes for the agent that supports Report Portal versions below 5.0.0 should go into the v1 branch.
-The master branch will store the code base for the agent for Report Portal versions 5 and above.
 
 Look through the CONTRIBUTING.rst for contribution guidelines.
 
@@ -257,11 +242,11 @@ deactivate :code:`pytest_reportportal` plugin with command like:
     py.test -p no:pytest_reportportal ./tests
 
 
-Integration with GA
--------------------
+Integration with Google analytics
+---------------------------------
 ReportPortal is now supporting integrations with more than 15 test frameworks simultaneously. In order to define the most popular agents and plan the team workload accordingly, we are using Google analytics.
 
-ReportPortal collects information about agent name and its version only. This information is sent to Google analytics on the launch start. Please help us to make our work effective.
+ReportPortal collects information about agent name and its version only. This information is sent to Google Analytics on the launch start. Please help us to make our work effective.
 If you still want to switch Off Google analytics, please change env variable the way below.
 
 .. code-block:: bash

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"

pytest_reportportal/config.pyi

@@ -2,36 +2,36 @@ from _pytest.config import Config as Config
 from typing import List, Optional, Text, Union, Any
 
 class AgentConfig:
-    rp_rerun: Optional[bool] = ...
-    pconfig: Config = ...
-    rp_endpoint: Text = ...
-    rp_hierarchy_code: bool = ...
-    rp_dir_level: int = ...
-    rp_hierarchy_dirs: bool = ...
-    rp_dir_path_separator: Text = ...
-    rp_ignore_attributes: set = ...
-    rp_is_skipped_an_issue: bool = ...
-    rp_issue_id_marks: bool = ...
-    rp_issue_system_url: Text = ...
-    rp_bts_project: Text = ...
-    rp_bts_url: Text = ...
-    rp_launch: Text = ...
-    rp_launch_id: Optional[Text] = ...
-    rp_launch_attributes: Optional[List] = ...
-    rp_launch_description: Text = ...
-    rp_log_batch_size: int = ...
-    rp_log_batch_payload_size: int = ...
-    rp_log_level: Optional[int] = ...
-    rp_log_format: Optional[Text] = ...
-    rp_mode: Text = ...
-    rp_parent_item_id: Optional[Text] = ...
-    rp_project: Text = ...
-    rp_rerun_of: Optional[Text] = ...
-    rp_retries: int = ...
-    rp_skip_connection_test: bool = ...
-    rp_uuid: Text = ...
-    rp_verify_ssl: Union[bool, Text] = ...
-    rp_launch_timeout: int = ...
+    rp_rerun: Optional[bool]
+    pconfig: Config
+    rp_endpoint: Text
+    rp_hierarchy_code: bool
+    rp_dir_level: int
+    rp_hierarchy_dirs: bool
+    rp_dir_path_separator: Text
+    rp_ignore_attributes: set
+    rp_is_skipped_an_issue: bool
+    rp_issue_id_marks: bool
+    rp_issue_system_url: Text
+    rp_bts_project: Text
+    rp_bts_url: Text
+    rp_launch: Text
+    rp_launch_id: Optional[Text]
+    rp_launch_attributes: Optional[List]
+    rp_launch_description: Text
+    rp_log_batch_size: int
+    rp_log_batch_payload_size: int
+    rp_log_level: Optional[int]
+    rp_log_format: Optional[Text]
+    rp_mode: Text
+    rp_parent_item_id: Optional[Text]
+    rp_project: Text
+    rp_rerun_of: Optional[Text]
+    rp_retries: int
+    rp_skip_connection_test: bool
+    rp_uuid: Text
+    rp_verify_ssl: Union[bool, Text]
+    rp_launch_timeout: int
 
     def __init__(self, pytest_config: Config) -> None: ...
 

pytest_reportportal/plugin.py

@@ -1,8 +1,19 @@
 """This module contains changed pytest for report-portal."""
 
+#  Copyright (c) 2023 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
+
 import logging
-# This program is free software: you can redistribute it
-# and/or modify it under the terms of the GPL licence
 import os.path
 import time
 
@@ -27,6 +38,10 @@
     'rp_endpoint: {}, ' + \
     'rp_uuid: {}'
 
+FAILED_LAUNCH_WAIT = 'Failed to initialize reportportal-client service. ' \
+                     + 'Waiting for Launch start timed out. ' \
+                     + 'Reporting is disabled.'
+
 
 @pytest.mark.optionalhook
 def pytest_configure_node(node):
@@ -59,8 +74,9 @@ def wait_launch(rp_client):
     timeout = time.time() + LAUNCH_WAIT_TIMEOUT
     while not rp_client.launch_id:
         if time.time() > timeout:
-            raise Exception("Launch has not started.")
+            return False
         time.sleep(1)
+    return True
 
 
 # noinspection PyProtectedMember
@@ -90,7 +106,10 @@ def pytest_sessionstart(session):
         config.py_test_service.start_launch()
         if config.pluginmanager.hasplugin('xdist') \
                 or config.pluginmanager.hasplugin('pytest-parallel'):
-            wait_launch(session.config.py_test_service.rp)
+            if not wait_launch(session.config.py_test_service.rp):
+                log.error(FAILED_LAUNCH_WAIT)
+                config.py_test_service.rp = None
+                config._rp_enabled = False
 
 
 def pytest_collection_finish(session):

pytest_reportportal/plugin.pyi

@@ -4,20 +4,19 @@ from typing import Text
 import pytest
 
 from .config import AgentConfig
-from .service import PyTestServiceClass as PyTestServiceClass
-from _pytest.config import Config as Config
-from _pytest.config.argparsing import Parser as Parser
-from _pytest.main import Session as Session
-from pytest_reportportal import LAUNCH_WAIT_TIMEOUT as LAUNCH_WAIT_TIMEOUT
-from reportportal_client.service import ReportPortalService as ReportPortalService
-from xdist.workermanage import WorkerController as WorkerController
+from _pytest.config import Config
+from _pytest.config.argparsing import Parser
+from _pytest.main import Session
+from reportportal_client import RPClient
+from xdist.workermanage import WorkerController
 
 log: Logger
 MANDATORY_PARAMETER_MISSED_PATTERN: Text
+FAILED_LAUNCH_WAIT: Text
 
 def check_connection(agent_config: AgentConfig) -> bool: ...
 def is_control(config: Config) -> bool: ...
-def wait_launch(rp_client: ReportPortalService) -> None: ...
+def wait_launch(rp_client: RPClient) -> bool: ...
 def pytest_configure_node(node: WorkerController) -> None: ...
 def pytest_sessionstart(session: Session) -> None: ...
 def pytest_collection_finish(session: Session) -> None: ...

pytest_reportportal/service.pyi

@@ -15,25 +15,25 @@ from .config import AgentConfig
 from typing import List, Dict, Text, Any, Tuple, Set, Optional
 from pytest import Item
 from threading import Lock
-from reportportal_client.client import RPClient
+from reportportal_client import RPClient
 
 class PyTestServiceClass:
 
-    _config: AgentConfig = ...
-    _issue_types: Dict[Text, Text] = ...
-    _tree_path: Dict[Item, List[Dict[Text, Any]]] = ...
-    _log_levels: Tuple = ...
-    _skip_analytics: Text = ...
-    _start_tracker: Set[Text] = ...
-    _process_level_lock: Lock = ...
-    _launch_id: Optional[Text] = ...
-    agent_name: Text = ...
-    agent_version: Text = ...
-    ignored_attributes: List[Text] = ...
-    log_batch_size: int = ...
-    parent_item_id: Optional[Text] = ...
-    rp: Optional[RPClient] = ...
-    project_settings: Dict[Text, Any] = ...
+    _config: AgentConfig
+    _issue_types: Dict[Text, Text]
+    _tree_path: Dict[Item, List[Dict[Text, Any]]]
+    _log_levels: Tuple
+    _skip_analytics: Text
+    _start_tracker: Set[Text]
+    _process_level_lock: Lock
+    _launch_id: Optional[Text]
+    agent_name: Text
+    agent_version: Text
+    ignored_attributes: List[Text]
+    log_batch_size: int
+    parent_item_id: Optional[Text]
+    rp: Optional[RPClient]
+    project_settings: Dict[Text, Any]
 
     def __init__(self, agent_config: AgentConfig) -> None: ...
     def start(self) -> None: ...

requirements.txt

@@ -1,6 +1,6 @@
 dill>=0.2.7.1
 pytest>=3.8.0
-reportportal-client==5.3.0
+reportportal-client==5.3.1
 six>=1.15.0
 aenum>=3.1.0
 requests

setup.cfg

@@ -2,7 +2,7 @@
 test=pytest
 
 [metadata]
-description-file = README.rst
+description_file = README.rst
 
 [sdist]
 formats=gztar