Support string body in the generic request method

Updates #577

Author: mateusz834

splunklib/binding.py

@@ -938,7 +938,12 @@ def request(
             str(mask_sensitive_data(dict(all_headers))),
             mask_sensitive_data(body),
         )
-        if body:
+
+        if isinstance(body, str):
+            if method.upper() == "GET":
+                raise Exception("unable to set string body on GET method request")
+            message = {"method": method, "headers": all_headers, "body": body}
+        elif body:
             body = _encode(**body)
 
             if method == "GET":

tests/system/test_cre_apps.py

@@ -21,7 +21,7 @@
 from splunklib import results
 
 
-class TestJSONCustomRestEndpointsApp(testlib.SDKTestCase):
+class TestJSONCustomRestEndpointsSpecialMethodHelpers(testlib.SDKTestCase):
     app_name = "cre_app"
 
     def test_GET(self):
@@ -75,3 +75,66 @@ def test_DELETE(self):
                 "method": "DELETE",
             },
         )
+
+
+class TestJSONCustomRestEndpointGenericRequest(testlib.SDKTestCase):
+    app_name = "cre_app"
+
+    def test_no_str_body_GET(self):
+        def with_body():
+            self.service.request(
+                app=self.app_name, method="GET", path_segment="execute", body="str"
+            )
+
+        self.assertRaisesRegex(
+            Exception, "unable to set string body on GET method request", with_body
+        )
+
+    def test_GET(self):
+        resp = self.service.request(
+            app=self.app_name,
+            method="GET",
+            path_segment="execute",
+            headers=[("x-bar", "baz")],
+        )
+        self.assertIn(("x-foo", "bar"), resp.headers)
+        self.assertEqual(resp.status, 200)
+        self.assertEqual(
+            json.loads(str(resp.body)),
+            {
+                "headers": {"x-bar": "baz"},
+                "method": "GET",
+            },
+        )
+
+    def test_POST(self):
+        self.method("POST")
+
+    def test_PUT(self):
+        self.method("PUT")
+
+    def test_PATCH(self):
+        self.method("PATCH")
+
+    def test_DELETE(self):
+        self.method("DELETE")
+
+    def method(self, method: str):
+        body = json.dumps({"foo": "bar"})
+        resp = self.service.request(
+            app=self.app_name,
+            method=method,
+            path_segment="execute",
+            body=body,
+            headers=[("x-bar", "baz")],
+        )
+        self.assertIn(("x-foo", "bar"), resp.headers)
+        self.assertEqual(resp.status, 200)
+        self.assertEqual(
+            json.loads(str(resp.body)),
+            {
+                "payload": '{"foo": "bar"}',
+                "headers": {"x-bar": "baz"},
+                "method": method,
+            },
+        )