refactor call_rest_api(), add tests

Author: Vladimir Kotal

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

@@ -18,18 +18,17 @@
 #
 
 #
-# Copyright (c) 2017, 2018, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2017, 2019, Oracle and/or its affiliates. All rights reserved.
 #
 
 import logging
 from .command import Command
-from .webutil import put, post, delete
 from .utils import is_web_uri
 from .exitvals import (
     CONTINUE_EXITVAL,
     SUCCESS_EXITVAL
 )
-import json
+from .restful import call_rest_api
 import re
 
 
@@ -100,33 +99,6 @@ def run_command(self, command):
 
         return cmd.getretcode()
 
-    def call_rest_api(self, command):
-        """
-        Make RESTful API call. Occurrence of PROJECT_SUBST in the URI will be
-        replaced by project name.
-        """
-        command = command.get("command")
-        uri = command[0].replace(self.PROJECT_SUBST, self.name)
-        verb = command[1]
-        data = command[2]
-
-        headers = None
-        json_data = None
-        if data:
-            headers = {'Content-Type': 'application/json'}
-            json_data = json.dumps(data).replace(self.PROJECT_SUBST, self.name)
-            self.logger.debug("JSON data: {}".format(json_data))
-
-        if verb == 'PUT':
-            put(self.logger, uri, headers=headers, data=json_data)
-        elif verb == 'POST':
-            post(self.logger, uri, headers=headers, data=json_data)
-        elif verb == 'DELETE':
-            delete(self.logger, uri, data)
-        else:
-            self.logger.error('Unknown HTTP verb in command {}'.
-                              format(command))
-
     def run(self):
         """
         Run the sequence of commands and capture their output and return code.
@@ -145,7 +117,7 @@ def run(self):
 
         for command in self.commands:
             if is_web_uri(command.get("command")[0]):
-                self.call_rest_api(command)
+                call_rest_api(command, self.PROJECT_SUBST, self.name)
             else:
                 retcode = self.run_command(command)
 
@@ -184,7 +156,7 @@ def run_cleanup(self):
 
         for cleanup_cmd in self.cleanup:
             if is_web_uri(cleanup_cmd.get("command")[0]):
-                self.call_rest_api(cleanup_cmd)
+                call_rest_api(cleanup_cmd, self.PROJECT_SUBST, self.name)
             else:
                 command_args = cleanup_cmd.get("command")
                 self.logger.debug("Running cleanup command '{}'".

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

@@ -0,0 +1,67 @@
+#
+# CDDL HEADER START
+#
+# The contents of this file are subject to the terms of the
+# Common Development and Distribution License (the "License").
+# You may not use this file except in compliance with the License.
+#
+# See LICENSE.txt included in this distribution for the specific
+# language governing permissions and limitations under the License.
+#
+# When distributing Covered Code, include this CDDL HEADER in each
+# file and include the License file at LICENSE.txt.
+# If applicable, add the following below this CDDL HEADER, with the
+# fields enclosed by brackets "[]" replaced with your own identifying
+# information: Portions Copyright [yyyy] [name of copyright owner]
+#
+# CDDL HEADER END
+#
+
+#
+# Copyright (c) 2017, 2019, Oracle and/or its affiliates. All rights reserved.
+#
+
+import logging
+from .webutil import put, post, delete
+import json
+
+
+def do_api_call(command, uri, headers, json_data):
+    logger = logging.getLogger(__name__)
+
+    if verb == 'PUT':
+        return put(logger, uri, headers=headers, data=json_data)
+    elif verb == 'POST':
+        return post(logger, uri, headers=headers, data=json_data)
+    elif verb == 'DELETE':
+        return delete(logger, uri, headers=headers)
+    else:
+        raise Exception('Unknown HTTP verb in command {}'.
+                        format(command))
+
+
+def call_rest_api(command, pattern, name):
+    """
+    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.
+
+    :param command: command (list of URI, HTTP verb, data payload)
+    :param pattern: pattern for command name and/or data substitution
+    :param name: command name
+    :return return value from given requests method
+    """
+    command = command.get("command")
+    uri = command[0].replace(pattern, name)
+    verb = command[1]
+    data = command[2]
+
+    logger = logging.getLogger(__name__)
+
+    headers = None
+    json_data = None
+    if data:
+        headers = {'Content-Type': 'application/json'}
+        json_data = json.dumps(data).replace(pattern, name)
+        logger.debug("JSON data: {}".format(json_data))
+
+    return do_api_call(command, uri, headers, json_data)

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

@@ -0,0 +1,63 @@
+#!/usr/bin/env python3
+
+#
+# CDDL HEADER START
+#
+# The contents of this file are subject to the terms of the
+# Common Development and Distribution License (the "License").
+# You may not use this file except in compliance with the License.
+#
+# See LICENSE.txt included in this distribution for the specific
+# language governing permissions and limitations under the License.
+#
+# When distributing Covered Code, include this CDDL HEADER in each
+# file and include the License file at LICENSE.txt.
+# If applicable, add the following below this CDDL HEADER, with the
+# fields enclosed by brackets "[]" replaced with your own identifying
+# information: Portions Copyright [yyyy] [name of copyright owner]
+#
+# CDDL HEADER END
+#
+
+#
+# Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
+#
+
+import pytest
+from opengrok_tools.utils.restful import call_rest_api
+
+
+def test_restful_verbs(monkeypatch):
+    okay_status = 200
+
+    class MockResponse:
+        def __init__(self):
+            self.status_code = okay_status
+
+    def mock_response(command, uri, headers, json_data):
+        # Spying on mocked function is maybe too much so verify
+        # the arguments here.
+        assert uri == "http://localhost:8080/source/api/v1/BAR"
+        assert json_data == '"fooBARbar"'
+
+        return MockResponse()
+
+    for verb in ["PUT", "POST", "DELETE"]:
+        command = {"command": ["http://localhost:8080/source/api/v1/%FOO%",
+                               verb, "foo%FOO%bar"]}
+        pattern = "%FOO%"
+        value = "BAR"
+        with monkeypatch.context() as m:
+            m.setattr("opengrok_tools.utils.restful.do_api_call",
+                      mock_response)
+            assert call_rest_api(command, pattern, value). \
+                status_code == okay_status
+
+
+def test_unknown_verb():
+    command = {"command": ["http://localhost:8080/source/api/v1/foo",
+                           "FOOBAR", "data"]}
+    pattern = "%FOO%"
+    value = "BAR"
+    with pytest.raises(Exception):
+        call_rest_api(command, pattern, value)