test api_timeout argument passing

fix pre-existing issues with do_api_call() mocking

Author: vladak

tools/src/main/python/opengrok_tools/utils/restful.py

@@ -141,7 +141,7 @@ def subst(src, substitutions):
     return src
 
 
-def call_rest_api(command, substitutions=None, http_headers=None, timeout=None):
+def call_rest_api(command, substitutions=None, http_headers=None, timeout=None, api_timeout=None):
     """
     Make RESTful API call. Occurrence of the pattern in the URI
     (first part of the command) or data payload will be replaced by the name.
@@ -154,6 +154,7 @@ def call_rest_api(command, substitutions=None, http_headers=None, timeout=None):
                           data substitution
     :param http_headers: optional dictionary of HTTP headers to be appended
     :param timeout: optional timeout in seconds for API call response
+    :param api_timeout: optional timeout in seconds for asynchronous API call
     :return value from given requests method
     """
 
@@ -200,4 +201,4 @@ def call_rest_api(command, substitutions=None, http_headers=None, timeout=None):
         data = subst(data, substitutions)
         logger.debug("entity data: {}".format(data))
 
-    return do_api_call(verb, uri, headers=headers, data=data, timeout=timeout)
+    return do_api_call(verb, uri, headers=headers, data=data, timeout=timeout, api_timeout=api_timeout)

tools/src/test/python/test_restful.py

@@ -49,11 +49,11 @@ def __init__(self):
             self.status_code = okay_status
             self.raise_for_status = self.p
 
-    def mock_do_api_call(verb, uri, headers, data, timeout):
+    def mock_do_api_call(verb, uri, **kwargs):
         # Spying on mocked function is maybe too much so verify
         # the arguments here.
         assert uri == "http://localhost:8080/source/api/v1/BAR"
-        assert data == '"fooBARbar"'
+        assert kwargs['data'] == '"fooBARbar"'
 
         return MockResponse()
 
@@ -88,7 +88,8 @@ def test_content_type(monkeypatch):
             command = {"command": ["http://localhost:8080/source/api/v1/foo",
                                    verb, "data", header_arg]}
 
-            def mock_response(uri, verb, headers, data, timeout):
+            def mock_response(verb, uri, **kwargs):
+                headers = kwargs['headers']
                 if header_arg:
                     assert text_plain_header.items() <= headers.items()
                 else:
@@ -109,22 +110,25 @@ def test_headers_timeout(monkeypatch):
     """
     headers = {'Tatsuo': 'Yasuko'}
     expected_timeout = 42
+    expected_api_timeout = 24
     command = {"command": ["http://localhost:8080/source/api/v1/bar",
                            'GET', "data", headers]}
     extra_headers = {'Mei': 'Totoro'}
 
-    def mock_do_api_call(uri, verb, headers, data, timeout):
+    def mock_do_api_call(verb, uri, **kwargs):
         all_headers = headers
         all_headers.update(extra_headers)
         assert headers == all_headers
-        assert timeout == expected_timeout
+        assert kwargs['timeout'] == expected_timeout
+        assert kwargs['api_timeout'] == expected_api_timeout
 
     with monkeypatch.context() as m:
         m.setattr("opengrok_tools.utils.restful.do_api_call",
                   mock_do_api_call)
         call_rest_api(command,
                       http_headers=extra_headers,
-                      timeout=expected_timeout)
+                      timeout=expected_timeout,
+                      api_timeout=expected_api_timeout)
 
 
 def test_headers_timeout_requests():