Merge branch 'develop' into py3-code-migration

Author: akaila-splunk

.github/workflows/test.yml

@@ -17,26 +17,20 @@ jobs:
           - "latest"
       fail-fast: false
 
-    services:
-      splunk:
-        image: splunk/splunk:${{matrix.splunk-version}}
-        env:
-          SPLUNK_START_ARGS: --accept-license
-          SPLUNK_HEC_TOKEN: 11111111-1111-1111-1111-1111111111113
-          SPLUNK_PASSWORD: changed!
-          SPLUNK_APPS_URL: https://github.com/splunk/sdk-app-collection/releases/download/v1.1.0/sdkappcollection.tgz
-        ports:
-          - 8000:8000
-          - 8088:8088
-          - 8089:8089
-
     steps:
-      - uses: actions/checkout@v2
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Run docker-compose
+        run: SPLUNK_VERSION=${{matrix.splunk-version}} docker-compose up -d
+
       - name: Setup Python
         uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python }}
+
       - name: Install tox
         run: pip install tox
+
       - name: Test Execution
         run: tox -e py

CHANGELOG.md

@@ -1,5 +1,31 @@
 # Splunk Enterprise SDK for Python Changelog
 
+## Version 1.7.2
+
+### Minor changes
+* [#482](https://github.com/splunk/splunk-sdk-python/pull/482) Special handling related to the semantic versioning of specific Search APIs functional in Splunk Enterprise 9.0.2 and (Splunk Cloud 9.0.2209). These SDK changes will enable seamless transition between the APIs based on the version of the Splunk Enterprise in use
+
+## Version 1.7.1
+
+### Bug fixes
+* [#471](https://github.com/splunk/splunk-sdk-python/pull/471) Fixed support of Load Balancer "sticky sessions" (persistent cookies) [[issue#438](https://github.com/splunk/splunk-sdk-python/issues/438)]
+
+### Minor changes
+* [#466](https://github.com/splunk/splunk-sdk-python/pull/466) tests for CSC apps
+* [#467](https://github.com/splunk/splunk-sdk-python/pull/467) Added 'kwargs' parameter for Saved Search History function
+* [#475](https://github.com/splunk/splunk-sdk-python/pull/475) README updates
+
+## Version 1.7.0
+
+### New features and APIs
+* [#468](https://github.com/splunk/splunk-sdk-python/pull/468) SDK Support for splunkd search API changes
+
+### Bug fixes
+* [#464](https://github.com/splunk/splunk-sdk-python/pull/464) updated checks for wildcards in StoragePasswords [[issue#458](https://github.com/splunk/splunk-sdk-python/issues/458)]
+
+### Minor changes
+* [#463](https://github.com/splunk/splunk-sdk-python/pull/463) Preserve thirdparty cookies
+
 ## Version 1.6.20
 
 ### New features and APIs

README.md

@@ -3,7 +3,7 @@
 
 # The Splunk Enterprise Software Development Kit for Python
 
-#### Version 1.6.20
+#### Version 1.7.2
 
 The Splunk Enterprise Software Development Kit (SDK) for Python contains library code designed to enable developers to build applications using the Splunk platform.
 
@@ -28,7 +28,9 @@ Here's what you need to get going with the Splunk Enterprise SDK for Python.
 
   The Splunk Enterprise SDK for Python has been tested with Python v2.7 and v3.7.
 
-* Splunk Enterprise
+* Splunk Enterprise 9.0 or 8.2
+
+    The Splunk Enterprise SDK for Python has been tested with Splunk Enterprise 9.0 and 8.2
 
   If you haven't already installed Splunk Enterprise, download it [here](http://www.splunk.com/download). 
   For more information, see the Splunk Enterprise [_Installation Manual_](https://docs.splunk.com/Documentation/Splunk/latest/Installation).

docker-compose.yml

@@ -18,3 +18,12 @@ services:
             interval: 5s
             timeout: 5s
             retries: 20
+        volumes:
+            - "./tests/searchcommands/test_apps/eventing_app:/opt/splunk/etc/apps/eventing_app"
+            - "./tests/searchcommands/test_apps/generating_app:/opt/splunk/etc/apps/generating_app"
+            - "./tests/searchcommands/test_apps/reporting_app:/opt/splunk/etc/apps/reporting_app"
+            - "./tests/searchcommands/test_apps/streaming_app:/opt/splunk/etc/apps/streaming_app"
+            - "./splunklib:/opt/splunk/etc/apps/eventing_app/lib/splunklib"
+            - "./splunklib:/opt/splunk/etc/apps/generating_app/lib/splunklib"
+            - "./splunklib:/opt/splunk/etc/apps/reporting_app/lib/splunklib"
+            - "./splunklib:/opt/splunk/etc/apps/streaming_app/lib/splunklib"

splunklib/binding.py

@@ -532,22 +532,24 @@ def _auth_headers(self):
         header = []
         if self.has_cookies():
             return [("Cookie", _make_cookie_header(list(self.get_cookies().items())))]
-        if self.basic and (self.username and self.password):
-            encoded_username_password = b64encode(f"{self.username}:{self.password}".encode('utf-8')).decode('ascii')
-            token = f'Basic {encoded_username_password}'
-            return [("Authorization", token)]
-        if self.bearerToken:
-            token = f"Bearer {self.bearerToken}"
-            return [("Authorization", token)]
-        if self.token is _NoAuthenticationToken:
-            return []
+        elif self.basic and (self.username and self.password):
+            token = 'Basic %s' % b64encode(("%s:%s" % (self.username, self.password)).encode('utf-8')).decode('ascii')
+        elif self.bearerToken:
+            token = 'Bearer %s' % self.bearerToken
+        elif self.token is _NoAuthenticationToken:
+            token = []
         else:
             # Ensure the token is properly formatted
             if self.token.startswith('Splunk '):
                 token = self.token
             else:
-                token = f"Splunk {self.token}"
-            return [("Authorization", token)]
+                token = 'Splunk %s' % self.token
+        if token:
+            header.append(("Authorization", token))
+        if self.get_cookies():
+            header.append(("Cookie", _make_cookie_header(list(self.get_cookies().items()))))
+
+        return header
 
     def connect(self):
         """Returns an open connection (socket) to the Splunk instance.
@@ -1441,7 +1443,7 @@ def request(url, message, **kwargs):
         head = {
             "Content-Length": str(len(body)),
             "Host": host,
-            "User-Agent": "splunk-sdk-python/1.6.20",
+            "User-Agent": "splunk-sdk-python/1.7.2",
             "Accept": "*/*",
             "Connection": "Close",
         }  # defaults

splunklib/client.py

@@ -415,6 +415,7 @@ def __init__(self, **kwargs):
         super().__init__(**kwargs)
         self._splunk_version = None
         self._kvstore_owner = None
+        self._instance_type = None
 
     @property
     def apps(self):
@@ -565,7 +566,7 @@ def parse(self, query, **kwargs):
         :type kwargs: ``dict``
         :return: A semantic map of the parsed search query.
         """
-        if self.splunk_version >= (9,):
+        if not self.disable_v2_api:
             return self.post("search/v2/parser", q=query, **kwargs)
         return self.get("search/parser", q=query, **kwargs)
 
@@ -688,6 +689,22 @@ def splunk_version(self):
             self._splunk_version = tuple(int(p) for p in self.info['version'].split('.'))
         return self._splunk_version
 
+    @property
+    def splunk_instance(self):
+        if self._instance_type is None :
+            splunk_info = self.info;
+            if hasattr(splunk_info, 'instance_type') :
+                self._instance_type = splunk_info['instance_type']
+            else:
+                self._instance_type = ''
+        return self._instance_type
+
+    @property
+    def disable_v2_api(self):
+        if self.splunk_instance.lower() == 'cloud':
+            return self.splunk_version < (9,0,2209)
+        return self.splunk_version < (9,0,2)
+
     @property
     def kvstore_owner(self):
         """Returns the KVStore owner for this instance of Splunk.
@@ -1186,6 +1203,36 @@ def reload(self):
         self.post("_reload")
         return self
 
+    def acl_update(self, **kwargs):
+        """To update Access Control List (ACL) properties for an endpoint.
+
+        :param kwargs: Additional entity-specific arguments (required).
+
+            - "owner" (``string``): The Splunk username, such as "admin". A value of "nobody" means no specific user (required).
+
+            - "sharing" (``string``): A mode that indicates how the resource is shared. The sharing mode can be "user", "app", "global", or "system" (required).
+
+        :type kwargs: ``dict``
+
+        **Example**::
+
+            import splunklib.client as client
+            service = client.connect(...)
+            saved_search = service.saved_searches["name"]
+            saved_search.acl_update(sharing="app", owner="nobody", app="search", **{"perms.read": "admin, nobody"})
+        """
+        if "body" not in kwargs:
+            kwargs = {"body": kwargs}
+
+        if "sharing" not in kwargs["body"]:
+            raise ValueError("Required argument 'sharing' is missing.")
+        if "owner" not in kwargs["body"]:
+            raise ValueError("Required argument 'owner' is missing.")
+
+        self.post("acl", **kwargs)
+        self.refresh()
+        return self
+
     @property
     def state(self):
         """Returns the entity's state record.
@@ -2704,7 +2751,7 @@ def __init__(self, service, sid, **kwargs):
         # Default to v2 in Splunk Version 9+
         path = "{path}{sid}"
         # Formatting path based on the Splunk Version
-        if service.splunk_version < (9,):
+        if service.disable_v2_api:
             path = path.format(path=PATH_JOBS, sid=sid)
         else:
             path = path.format(path=PATH_JOBS_V2, sid=sid)
@@ -2764,7 +2811,7 @@ def events(self, **kwargs):
         kwargs['segmentation'] = kwargs.get('segmentation', 'none')
 
         # Search API v1(GET) and v2(POST)
-        if self.service.splunk_version < (9,):
+        if self.service.disable_v2_api:
             return self.get("events", **kwargs).body
         return self.post("events", **kwargs).body
 
@@ -2856,7 +2903,7 @@ def results(self, **query_params):
         query_params['segmentation'] = query_params.get('segmentation', 'none')
 
         # Search API v1(GET) and v2(POST)
-        if self.service.splunk_version < (9,):
+        if self.service.disable_v2_api:
             return self.get("results", **query_params).body
         return self.post("results", **query_params).body
 
@@ -2901,7 +2948,7 @@ def preview(self, **query_params):
         query_params['segmentation'] = query_params.get('segmentation', 'none')
 
         # Search API v1(GET) and v2(POST)
-        if self.service.splunk_version < (9,):
+        if self.service.disable_v2_api:
             return self.get("results_preview", **query_params).body
         return self.post("results_preview", **query_params).body
 
@@ -2994,7 +3041,7 @@ class Jobs(Collection):
 
     def __init__(self, service):
         # Splunk 9 introduces the v2 endpoint
-        if service.splunk_version >= (9,):
+        if not service.disable_v2_api:
             path = PATH_JOBS_V2
         else:
             path = PATH_JOBS
@@ -3275,12 +3322,15 @@ def fired_alerts(self):
             item=AlertGroup)
         return c
 
-    def history(self):
+    def history(self, **kwargs):
         """Returns a list of search jobs corresponding to this saved search.
 
+        :param `kwargs`: Additional arguments (optional).
+        :type kwargs: ``dict``
+
         :return: A list of :class:`Job` objects.
         """
-        response = self.get("history")
+        response = self.get("history", **kwargs)
         entries = _load_atom_entries(response)
         if entries is None: return []
         jobs = []

tests/README.md

@@ -1,7 +1,7 @@
 # Splunk Test Suite
 
 The test suite uses Python's standard library and the built-in **unittest** 
-library. If you're using Python 2.7, you're all set. However, if you are using 
+library. If you're using Python 2.7 or Python 3.7, you're all set. However, if you are using 
 Python 2.6, you'll also need to install the **unittest2** library to get the 
 additional features that were added to Python 2.7 (just run `pip install 
 unittest2` or `easy_install unittest2`).