Add docstring and tests describing how to add body to POST request.

Author: zenmoto

splunklib/binding.py

@@ -724,7 +724,10 @@ def post(self, path_segment, owner=None, app=None, sharing=None, headers=None, *
         :type headers: ``list`` of 2-tuples.
         :param query: All other keyword arguments, which are used as query
             parameters.
-        :type query: ``string``
+        :param body: Parameters to be used in the post body. If specified,
+            any parameters in the query will be applied to the URL instead of
+            the body.
+        :type body: dict
         :return: The response from the server.
         :rtype: ``dict`` with keys ``body``, ``headers``, ``reason``,
                 and ``status``

tests/test_binding.py

@@ -808,6 +808,47 @@ def test_connect_with_preexisting_token_sans_user_and_pass(self):
         socket.write("\r\n".encode('utf-8'))
         socket.close()
 
+
+class TestPostWithBodyParam(unittest.TestCase):
+
+    def test_post(self):
+        def handler(url, message, **kwargs):
+            assert url == "https://localhost:8089/servicesNS/testowner/testapp/foo/bar"
+            assert message["body"]["testkey"] == "testvalue"
+            return splunklib.data.Record({
+                "status": 200,
+                "headers": [],
+            })
+        ctx = binding.Context(handler=handler)
+        ctx.post("foo/bar", owner="testowner", app="testapp", body={"testkey": "testvalue"})
+
+    def test_post_with_params_and_body(self):
+        def handler(url, message, **kwargs):
+            assert url == "https://localhost:8089/servicesNS/testowner/testapp/foo/bar?extrakey=extraval"
+            assert message["body"]["testkey"] == "testvalue"
+            return splunklib.data.Record({
+                "status": 200,
+                "headers": [],
+            })
+        ctx = binding.Context(handler=handler)
+        ctx.post("foo/bar", extrakey="extraval", owner="testowner", app="testapp", body={"testkey": "testvalue"})
+
+    def test_post_with_params_and_no_body(self):
+        def handler(url, message, **kwargs):
+            assert url == "https://localhost:8089/servicesNS/testowner/testapp/foo/bar"
+            assert message["body"] == "extrakey=extraval"
+            return splunklib.data.Record({
+                "status": 200,
+                "headers": [],
+            })
+        ctx = binding.Context(handler=handler)
+        ctx.post("foo/bar", extrakey="extraval", owner="testowner", app="testapp")
+
+    def test_with_body_with_full_request(self):
+        class TestRequestHandler(BaseHTTPRequestHandler):
+            pass
+
+
 if __name__ == "__main__":
     try:
         import unittest2 as unittest