Merge branch 'develop' into py3-code-migration

Author: ashah-splunk

.github/dependabot.yaml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    target-branch: "master"
+    schedule:
+      interval: "weekly"

.github/workflows/release.yml

@@ -29,12 +29,11 @@ jobs:
         run: |
           rm -rf ./docs/_build
           tox -e docs
-          cd ./docs/_build/html && zip -r ../docs_html.zip . -x ".*" -x "__MACOSX"
       - name : Docs Upload
         uses: actions/upload-artifact@v3
         with:
-          name: apidocs
-          path: docs/_build/docs_html.zip
+          name: python_sdk_docs
+          path: docs/_build/html
       # Test upload
       # - name: Publish package to TestPyPI
       #   uses: pypa/gh-action-pypi-publish@master

.github/workflows/test.yml

@@ -13,6 +13,7 @@ jobs:
           - ubuntu-latest
         python: [ 3.7, 3.9, 3.10.7]
         splunk-version:
+          - "8.1"
           - "8.2"
           - "latest"
       fail-fast: false

splunklib/binding.py

@@ -38,8 +38,9 @@
 from http import client
 from http.cookies import SimpleCookie
 from xml.etree.ElementTree import XML, ParseError
-
 from splunklib.data import record
+from splunklib import __version__
+
 
 logger = logging.getLogger(__name__)
 
@@ -1443,7 +1444,7 @@ def request(url, message, **kwargs):
         head = {
             "Content-Length": str(len(body)),
             "Host": host,
-            "User-Agent": "splunk-sdk-python/1.7.2",
+            "User-Agent": "splunk-sdk-python/%s" % __version__,
             "Accept": "*/*",
             "Connection": "Close",
         }  # defaults

splunklib/modularinput/event_writer.py

@@ -488,6 +488,54 @@ def test_handlers(self):
                 self.assertTrue(isatom(body))
 
 
+def urllib2_insert_cookie_handler(url, message, **kwargs):
+    method = message['method'].lower()
+    data = message.get('body', b"") if method == 'post' else None
+    headers = dict(message.get('headers', []))
+    req = Request(url, data, headers)
+    try:
+        response = urlopen(req, context=ssl._create_unverified_context())
+    except HTTPError as response:
+        pass  # Propagate HTTP errors via the returned response message
+
+    # Mimic the insertion of 3rd party cookies into the response.
+    # An example is "sticky session"/"insert cookie" persistence
+    # of a load balancer for a SHC.
+    header_list = [(k, v) for k, v in response.info().items()]
+    header_list.append(("Set-Cookie", "BIGipServer_splunk-shc-8089=1234567890.12345.0000; path=/; Httponly; Secure"))
+    header_list.append(("Set-Cookie", "home_made=yummy"))
+
+    return {
+        'status': response.code,
+        'reason': response.msg,
+        'headers': header_list,
+        'body': BytesIO(response.read())
+    }
+
+
+class TestCookiePersistence(testlib.SDKTestCase):
+    # Verify persistence of 3rd party inserted cookies.
+    def test_3rdPartyInsertedCookiePersistence(self):
+        paths = ["/services", "authentication/users",
+                 "search/jobs"]
+        logging.debug("Connecting with urllib2_insert_cookie_handler %s", urllib2_insert_cookie_handler)
+        context = binding.connect(
+            handler=urllib2_insert_cookie_handler,
+            **self.opts.kwargs)
+
+        persisted_cookies = context.get_cookies()
+
+        splunk_token_found = False
+        for k, v in persisted_cookies.items():
+            if k[:8] == "splunkd_":
+                splunk_token_found = True
+                break
+
+        self.assertEqual(splunk_token_found, True)
+        self.assertEqual(persisted_cookies['BIGipServer_splunk-shc-8089'], "1234567890.12345.0000")
+        self.assertEqual(persisted_cookies['home_made'], "yummy")
+
+
 @pytest.mark.smoke
 class TestLogout(BindingTestCase):
     def test_logout(self):

tests/test_binding.py

@@ -1,3 +1,6 @@
+import unittest
+import os
+import sys
 from tests import testlib
 from utils import dslice
 
@@ -71,6 +74,32 @@ def test_dslice_all_args(self):
         self.assertTrue(expected == dslice(TEST_DICT, *test_args))
 
 
+class FilePermissionTest(unittest.TestCase):
+
+    def setUp(self):
+        super(FilePermissionTest, self).setUp()
+
+    # Check for any change in the default file permission(i.e 644) for all files within splunklib
+    def test_filePermissions(self):
+
+        def checkFilePermissions(dir_path):
+            for file in os.listdir(dir_path):
+                if file.__contains__('pycache'):
+                    continue
+                path = os.path.join(dir_path, file)
+                if os.path.isfile(path):
+                    permission = oct(os.stat(path).st_mode)
+                    if sys.version_info >= (3, 0):
+                        self.assertEqual(permission, '0o100644')
+                    else :
+                        self.assertEqual(permission, '0100644')
+                else:
+                    checkFilePermissions(path)
+
+        dir_path = os.path.join('..', 'splunklib')
+        checkFilePermissions(dir_path)
+
+
 if __name__ == "__main__":
     import unittest