Implement a simple polling for get_launch_info()

Author: NikitaFedoraev

reportportal_client/service.py

@@ -15,6 +15,8 @@
 """
 
 import json
+from time import sleep
+
 import requests
 import uuid
 import logging
@@ -27,7 +29,6 @@
 
 from .errors import ResponseError, EntryCreatedError, OperationCompletionError
 
-
 POST_LOGBATCH_RETRY_COUNT = 10
 logger = logging.getLogger(__name__)
 logger.addHandler(logging.NullHandler())
@@ -253,31 +254,55 @@ def finish_launch(self, end_time, status=None, **kwargs):
         logger.debug("finish_launch - ID: %s", self.launch_id)
         return _get_msg(r)
 
-    def get_launch_info(self):
+    def get_launch_info(self, max_retries=5):
         """Get the current launch information.
 
+        Perform "max_retries" attempts to get current launch information
+        with 0.5 second sleep between them.
+
+        :param int max_retries: Number of retries to get launch information.
         :return dict: launch information
         """
+        if self.launch_id is None:
+            return {}
+
         url = uri_join(self.base_url_v1, "launch/uuid", self.launch_id)
-        launch_info = _get_json(self.session.get(
-            url=url, verify=self.verify_ssl))
-        logger.debug("get_launch_info - ID: %s", self.launch_id)
-        logger.debug("get_launch_info - Launch info: %s", launch_info)
+
+        for _ in range(max_retries):
+            logger.debug("get_launch_info - ID: %s", self.launch_id)
+            resp = self.session.get(url=url, verify=self.verify_ssl)
+
+            if resp.status_code == 200:
+                launch_info = _get_json(resp)
+                logger.debug("get_launch_info - Launch info: %s", launch_info)
+                break
+
+            logger.debug("get_launch_info - Launch info: Response code %s\n%s",
+                         resp.status_code, resp.text)
+            sleep(0.5)
+        else:
+            logger.warning("get_launch_info - Launch info: "
+                           "Failed to fetch launch ID from the API.")
+            launch_info = {}
+
         return launch_info
 
-    def get_launch_ui_id(self):
+    def get_launch_ui_id(self, max_retries=5):
         """Get UI ID of the current launch.
 
         :return str: UI ID of the given launch.
+                     None if UI ID has not been found.
         """
-        return self.get_launch_info()["id"]
+        return self.get_launch_info(max_retries=max_retries).get("id")
 
-    def get_launch_ui_url(self):
+    def get_launch_ui_url(self, max_retries=5):
         """Get UI URL of the current launch.
 
-        :return str: launch URL.
+        If UI ID can`t be found after max_retries, return URL of all launches.
+
+        :return str: launch URL or all launches URL.
         """
-        ui_id = self.get_launch_ui_id()
+        ui_id = self.get_launch_ui_id(max_retries=max_retries) or ""
         path = "ui/#{0}/launches/all/{1}".format(self.project, ui_id)
         url = uri_join(self.endpoint, path)
         logger.debug("get_launch_ui_url - ID: %s", self.launch_id)

tests/test_service.py

@@ -108,8 +108,12 @@ def test_get_launch_info(self, rp_service, monkeypatch):
                             object with mocked session.
         :param monkeypatch: Pytest fixture to safely set/delete an attribute
         """
-        mock_get = mock.Mock(return_value={'id': 112})
+        mock_resp = mock.Mock()
+        mock_resp.status_code = 200
+
+        mock_get = mock.Mock(return_value=mock_resp)
         monkeypatch.setattr(rp_service.session, 'get', mock_get)
+        monkeypatch.setattr(rp_service, 'launch_id', '1234-cafe')
 
         launch_id = rp_service.get_launch_info()
         mock_get.assert_called_once_with(
@@ -118,6 +122,64 @@ def test_get_launch_info(self, rp_service, monkeypatch):
             verify=rp_service.verify_ssl)
         assert launch_id == {'id': 112}
 
+    def test_get_launch_info_launch_id_none(self, rp_service, monkeypatch):
+        """Test get launch information for a non started launch.
+
+        :param rp_service:  Pytest fixture that represents ReportPortalService
+                            object with mocked session.
+        :param monkeypatch: Pytest fixture to safely set/delete an attribute
+        """
+        mock_get = mock.Mock()
+        monkeypatch.setattr(rp_service.session, 'get', mock_get)
+        monkeypatch.setattr(rp_service, 'launch_id', None)
+
+        launch_info = rp_service.get_launch_info()
+        mock_get.assert_not_called()
+        assert launch_info == {}
+
+    @mock.patch('reportportal_client.service.sleep', mock.Mock())
+    @mock.patch('reportportal_client.service._get_json',
+                mock.Mock(return_value={"errorCode": 4041}))
+    def test_get_launch_info_wrong_launch_id(self, rp_service, monkeypatch):
+        """Test get launch information for a non existed launch.
+
+        :param rp_service:  Pytest fixture that represents ReportPortalService
+                            object with mocked session.
+        :param monkeypatch: Pytest fixture to safely set/delete an attribute
+        """
+        mock_get = mock.Mock()
+        monkeypatch.setattr(rp_service.session, 'get', mock_get)
+        monkeypatch.setattr(rp_service, 'launch_id', '1234')
+
+        launch_info = rp_service.get_launch_info()
+        expect(mock_get.call_count == 5)
+        expect(launch_info == {})
+        assert_expectations()
+
+    @mock.patch('reportportal_client.service.sleep', mock.Mock())
+    @mock.patch('reportportal_client.service._get_json',
+                mock.Mock(return_value={'id': 112}))
+    def test_get_launch_info_1st_failed(self, rp_service, monkeypatch):
+        """Test get launch information with 1st attempt failed.
+
+        :param rp_service:  Pytest fixture that represents ReportPortalService
+                            object with mocked session.
+        :param monkeypatch: Pytest fixture to safely set/delete an attribute
+        """
+        mock_resp1 = mock.Mock()
+        mock_resp1.status_code = 404
+        mock_resp2 = mock.Mock()
+        mock_resp2.status_code = 200
+        mock_get = mock.Mock()
+        mock_get.side_effect = [mock_resp1, mock_resp2]
+        monkeypatch.setattr(rp_service.session, 'get', mock_get)
+        monkeypatch.setattr(rp_service, 'launch_id', '1234')
+
+        launch_info = rp_service.get_launch_info()
+        expect(mock_get.call_count == 2)
+        expect(launch_info == {'id': 112})
+        assert_expectations()
+
     def test_get_launch_ui_id(self, rp_service, monkeypatch):
         """Test get launch UI ID.
 
@@ -131,6 +193,19 @@ def test_get_launch_ui_id(self, rp_service, monkeypatch):
                             mock_get_launch_info)
         assert rp_service.get_launch_ui_id() == 113
 
+    def test_get_launch_ui_no_id(self, rp_service, monkeypatch):
+        """Test get launch UI ID when no ID has been retrieved.
+
+        :param rp_service:  Pytest fixture that represents ReportPortalService
+                            object with mocked session.
+        :param monkeypatch: Pytest fixture to safely set/delete an attribute
+        """
+        mock_get_launch_info = mock.Mock(return_value={})
+        monkeypatch.setattr(rp_service,
+                            'get_launch_info',
+                            mock_get_launch_info)
+        assert rp_service.get_launch_ui_id() is None
+
     def test_get_launch_ui_url(self, rp_service, monkeypatch):
         """Test get launch UI URL.
 
@@ -146,6 +221,21 @@ def test_get_launch_ui_url(self, rp_service, monkeypatch):
         assert url == '{0}/ui/#{1}/launches/all/1'.format(rp_service.endpoint,
                                                           rp_service.project)
 
+    def test_get_launch_ui_url_no_id(self, rp_service, monkeypatch):
+        """Test get launch UI URL no ID has been retrieved.
+
+        :param rp_service:  Pytest fixture that represents ReportPortalService
+                            object with mocked session.
+        :param monkeypatch: Pytest fixture to safely set/delete an attribute
+        """
+        mock_get_launch_ui_id = mock.Mock(return_value=0)
+        monkeypatch.setattr(rp_service,
+                            'get_launch_ui_id',
+                            mock_get_launch_ui_id)
+        url = rp_service.get_launch_ui_url()
+        assert url == '{0}/ui/#{1}/launches/all'.format(rp_service.endpoint,
+                                                        rp_service.project)
+
     @mock.patch('platform.system', mock.Mock(return_value='linux'))
     @mock.patch('platform.machine', mock.Mock(return_value='Windows-PC'))
     @mock.patch('platform.processor', mock.Mock(return_value='amd'))