make call_rest_api() robust in the face of None args

add tests for HTTP header handling

Author: Vladimir Kotal

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

@@ -28,6 +28,10 @@
 from .patterns import COMMAND_PROPERTY
 
 
+CONTENT_TYPE = 'Content-Type'
+APPLICATION_JSON = 'application/json'   # default
+
+
 def do_api_call(command, uri, verb, headers, data):
     verbs = {
         'PUT': put,
@@ -53,19 +57,25 @@ def call_rest_api(command, pattern, name):
     :param name: command name
     :return return value from given requests method
     """
+
+    logger = logging.getLogger(__name__)
+
     command = command.get(COMMAND_PROPERTY)
-    uri = command[0].replace(pattern, name)
+    if pattern and name:
+        uri = command[0].replace(pattern, name)
+    else:
+        uri = command[0]
+
     verb = command[1]
     data = command[2]
+
     try:
         headers = command[3]
     except IndexError:
         headers = {}
 
-    logger = logging.getLogger(__name__)
-
-    CONTENT_TYPE = 'Content-Type'
-    APPLICATION_JSON = 'application/json'   # default
+    if not headers:
+        headers = {}
 
     header_names = [x.lower() for x in headers.keys()]
 
@@ -82,7 +92,8 @@ def call_rest_api(command, pattern, name):
                     data = json.dumps(data)
                 break
 
-        data = data.replace(pattern, name)
+        if pattern and name:
+            data = data.replace(pattern, name)
         logger.debug("entity data: {}".format(data))
 
     logger.debug("{} API call: {} with data '{}' and headers: {}".

opengrok-tools/src/test/python/test_restful.py

@@ -24,7 +24,8 @@
 #
 
 import pytest
-from opengrok_tools.utils.restful import call_rest_api
+from opengrok_tools.utils.restful import call_rest_api,\
+    CONTENT_TYPE, APPLICATION_JSON
 
 
 def test_replacement(monkeypatch):
@@ -64,3 +65,26 @@ def test_unknown_verb():
     value = "BAR"
     with pytest.raises(Exception):
         call_rest_api(command, pattern, value)
+
+
+def test_headers(monkeypatch):
+    """
+    Test HTTP header handling.
+    """
+    for verb in ["PUT", "POST", "DELETE"]:
+        TEXT_PLAIN = {'Content-type': 'text/plain'}
+        for headers in [TEXT_PLAIN, None]:
+            command = {"command": ["http://localhost:8080/source/api/v1/foo",
+                                   verb, "data", headers]}
+
+            def mock_response(command, uri, verb, headers_arg, data):
+                if headers:
+                    assert TEXT_PLAIN.items() <= headers_arg.items()
+                else:
+                    assert {CONTENT_TYPE: APPLICATION_JSON}.items() \
+                        <= headers_arg.items()
+
+            with monkeypatch.context() as m:
+                m.setattr("opengrok_tools.utils.restful.do_api_call",
+                          mock_response)
+                call_rest_api(command, None, None)