check command structure in call_rest_api()

add tests

Author: Vladimir Kotal

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

@@ -60,23 +60,27 @@ def call_rest_api(command, pattern, name):
 
     logger = logging.getLogger(__name__)
 
-    command = command.get(COMMAND_PROPERTY)
-    if pattern and name:
-        uri = command[0].replace(pattern, name)
-    else:
-        uri = command[0]
+    if not isinstance(command, dict) or command.get(COMMAND_PROPERTY) is None:
+        raise Exception("invalid command")
 
-    verb = command[1]
-    data = command[2]
+    command = command[COMMAND_PROPERTY]
 
+    uri, verb, data, *_ = command
+    if verb not in ['PUT', 'POST', 'DELETE']:
+        raise Exception("invalid verb: {}".format(verb))
     try:
         headers = command[3]
+        if headers and not isinstance(headers, dict):
+            raise Exception("headers must be a dictionary")
     except IndexError:
         headers = {}
 
-    if not headers:
+    if headers is None:
         headers = {}
 
+    if pattern and name:
+        uri = uri.replace(pattern, name)
+
     header_names = [x.lower() for x in headers.keys()]
 
     if data:

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

@@ -26,6 +26,7 @@
 import pytest
 from opengrok_tools.utils.restful import call_rest_api,\
     CONTENT_TYPE, APPLICATION_JSON
+from opengrok_tools.utils.patterns import COMMAND_PROPERTY
 
 
 def test_replacement(monkeypatch):
@@ -88,3 +89,18 @@ def mock_response(command, uri, verb, headers_arg, data):
                 m.setattr("opengrok_tools.utils.restful.do_api_call",
                           mock_response)
                 call_rest_api(command, None, None)
+
+
+def test_invalid_command_negative():
+    with pytest.raises(Exception):
+        call_rest_api(None, None, None)
+
+    with pytest.raises(Exception):
+        call_rest_api({"foo": "bar"}, None, None)
+
+    with pytest.raises(Exception):
+        call_rest_api(["foo", "bar"], None, None)
+
+    with pytest.raises(Exception):
+        call_rest_api({COMMAND_PROPERTY: ["foo", "PUT", "data", "headers"]},
+                      None, None)