Merge pull request #172 from rb1/master

Add a timeout to HTTP POST connects and reads

Author: HardNorth

reportportal_client/service.py

@@ -167,6 +167,7 @@ def __init__(self,
                  verify_ssl=True,
                  retries=None,
                  max_pool_size=50,
+                 http_timeout=(10, 10),
                  **kwargs):
         """Init the service class.
 
@@ -181,6 +182,9 @@ def __init__(self,
             verify_ssl: option to not verify ssl certificates
             max_pool_size: option to set the maximum number of
                            connections to save in the pool.
+            http_timeout: a float in seconds for the connect and read
+                          timeout. Use a Tuple to specific connect and
+                          read separately.
         """
         self._batch_logs = []
         self.endpoint = endpoint
@@ -190,6 +194,7 @@ def __init__(self,
         self.is_skipped_an_issue = is_skipped_an_issue
         self.base_url_v1 = uri_join(self.endpoint, "api/v1", self.project)
         self.base_url_v2 = uri_join(self.endpoint, "api/v2", self.project)
+        self.http_timeout = http_timeout
 
         self.session = requests.Session()
         if retries:
@@ -228,7 +233,13 @@ def start_launch(self,
             "rerunOf": rerunOf
         }
         url = uri_join(self.base_url_v2, "launch")
-        r = self.session.post(url=url, json=data, verify=self.verify_ssl)
+        r = self.session.request(
+            method='POST',
+            url=url,
+            json=data,
+            verify=self.verify_ssl,
+            timeout=self.http_timeout
+        )
         self.launch_id = _get_id(r)
         logger.debug("start_launch - ID: %s", self.launch_id)
         return self.launch_id
@@ -270,7 +281,11 @@ def get_launch_info(self, max_retries=5):
 
         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)
+            resp = self.session.request(
+                method='GET',
+                url=url,
+                verify=self.verify_ssl,
+                timeout=self.http_timeout)
 
             if resp.status_code == 200:
                 launch_info = _get_json(resp)
@@ -355,7 +370,13 @@ def start_test_item(self,
             url = uri_join(self.base_url_v2, "item", parent_item_id)
         else:
             url = uri_join(self.base_url_v2, "item")
-        r = self.session.post(url=url, json=data, verify=self.verify_ssl)
+        r = self.session.request(
+            method='POST',
+            url=url,
+            json=data,
+            verify=self.verify_ssl,
+            timeout=self.http_timeout
+        )
 
         item_id = _get_id(r)
         logger.debug("start_test_item - ID: %s", item_id)
@@ -423,8 +444,11 @@ def get_item_id_by_uuid(self, uuid):
         :return str:     Test item id
         """
         url = uri_join(self.base_url_v1, "item", "uuid", uuid)
-        return _get_json(self.session.get(
-            url=url, verify=self.verify_ssl))["id"]
+        return _get_json(self.session.request(
+            method='GET',
+            url=url,
+            verify=self.verify_ssl,
+            timeout=self.http_timeout))["id"]
 
     def get_project_settings(self):
         """
@@ -433,7 +457,12 @@ def get_project_settings(self):
         :return: json body
         """
         url = uri_join(self.base_url_v1, "settings")
-        r = self.session.get(url=url, json={}, verify=self.verify_ssl)
+        r = self.session.request(
+            method='GET',
+            url=url,
+            json={},
+            verify=self.verify_ssl,
+            timeout=self.http_timeout)
         logger.debug("settings")
         return _get_json(r)
 
@@ -509,10 +538,12 @@ def _log_batch(self, log_data, force=False):
         files.extend(attachments)
         for i in range(POST_LOGBATCH_RETRY_COUNT):
             try:
-                r = self.session.post(
+                r = self.session.request(
+                    method='POST',
                     url=url,
                     files=files,
-                    verify=self.verify_ssl
+                    verify=self.verify_ssl,
+                    timeout=self.http_timeout
                 )
                 logger.debug("log_batch response: %s", r.text)
                 self._batch_logs = []

tests/test_service.py

@@ -109,15 +109,17 @@ def test_get_launch_info(self, rp_service, monkeypatch):
         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)
+        mock_request = mock.Mock(return_value=mock_resp)
+        monkeypatch.setattr(rp_service.session, 'request', mock_request)
         monkeypatch.setattr(rp_service, 'launch_id', '1234-cafe')
 
         launch_id = rp_service.get_launch_info()
-        mock_get.assert_called_once_with(
+        mock_request.assert_called_once_with(
+            method='GET',
             url='{0}/launch/uuid/{1}'.format(rp_service.base_url_v1,
                                              rp_service.launch_id),
-            verify=rp_service.verify_ssl)
+            verify=rp_service.verify_ssl,
+            timeout=(10, 10))
         assert launch_id == {'id': 112}
 
     def test_get_launch_info_launch_id_none(self, rp_service, monkeypatch):
@@ -145,12 +147,12 @@ def test_get_launch_info_wrong_launch_id(self, rp_service, monkeypatch):
                             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)
+        mock_request = mock.Mock()
+        monkeypatch.setattr(rp_service.session, 'request', mock_request)
         monkeypatch.setattr(rp_service, 'launch_id', '1234')
 
         launch_info = rp_service.get_launch_info()
-        expect(mock_get.call_count == 5)
+        expect(mock_request.call_count == 5)
         expect(launch_info == {})
         assert_expectations()
 
@@ -168,13 +170,13 @@ def test_get_launch_info_1st_failed(self, rp_service, monkeypatch):
         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)
+        mock_request = mock.Mock()
+        mock_request.side_effect = [mock_resp1, mock_resp2]
+        monkeypatch.setattr(rp_service.session, 'request', mock_request)
         monkeypatch.setattr(rp_service, 'launch_id', '1234')
 
         launch_info = rp_service.get_launch_info()
-        expect(mock_get.call_count == 2)
+        expect(mock_request.call_count == 2)
         expect(launch_info == {'id': 112})
         assert_expectations()
 
@@ -255,9 +257,11 @@ def test_start_item(self, rp_service):
                                      'testCaseId': None,
                                      'retry': False},
                                url='http://endpoint/api/v2/project/item',
+                               method='POST',
+                               timeout=(10, 10),
                                verify=True)
 
-        rp_service.session.post.assert_called_with(**expected_result)
+        rp_service.session.request.assert_called_with(**expected_result)
         assert rp_start == 123
 
     start_item_optional = [
@@ -301,6 +305,8 @@ def test_start_item_code_optional_params(self, rp_service, field_name,
                                      'testCaseId': None,
                                      'retry': False},
                                url='http://endpoint/api/v2/project/item',
+                               method='POST',
+                               timeout=(10, 10),
                                verify=True)
         expected_result['json'][expected_name] = expected_value
-        rp_service.session.post.assert_called_with(**expected_result)
+        rp_service.session.request.assert_called_with(**expected_result)