Merge branch 'develop' into release/1.7.3

Author: ashah-splunk

.env

@@ -11,6 +11,6 @@ scheme=https
 # Your version of Splunk (default: 6.2)
 version=9.0
 # Bearer token for authentication
-#bearerToken="<Bearer-token>"
+#splunkToken="<Bearer-token>"
 # Session key for authentication
-#sessionKey="<Session-Key>"
+#token="<Session-Key>"

README.md

@@ -111,9 +111,9 @@ here is an example of .env file:
     # Your version of Splunk Enterprise
     version=9.0
     # Bearer token for authentication
-    #bearerToken=<Bearer-token>
+    #splunkToken=<Bearer-token>
     # Session key for authentication
-    #sessionKey=<Session-Key>
+    #token=<Session-Key>
 
 #### SDK examples
 
@@ -209,7 +209,39 @@ class GeneratorTest(GeneratingCommand):
         checkpoint_dir = inputs.metadata["checkpoint_dir"]
 ```
 
-#### Optional:Set up logging for splunklib
+### Access service object in Custom Search Command & Modular Input apps
+
+#### Custom Search Commands
+* The service object is created from the Splunkd URI and session key passed to the command invocation the search results info file.
+* Service object can be accessed using `self.service` in `generate`/`transform`/`stream`/`reduce` methods depending on the Custom Search Command.
+* For Generating Custom Search Command
+  ```python
+    def generate(self):
+        # other code
+        
+        # access service object that can be used to connect Splunk Service
+        service = self.service
+        # to get Splunk Service Info
+        info = service.info
+  ```
+
+ 
+
+#### Modular Inputs app:
+* The service object is created from the Splunkd URI and session key passed to the command invocation on the modular input stream respectively.
+* It is available as soon as the `Script.stream_events` method is called.
+```python
+    def stream_events(self, inputs, ew):
+        # other code
+        
+        # access service object that can be used to connect Splunk Service
+        service = self.service
+        # to get Splunk Service Info
+        info = service.info
+```
+
+
+### Optional:Set up logging for splunklib
 + The default level is WARNING, which means that only events of this level and above will be visible
 + To change a logging level we can call setup_logging() method and pass the logging level as an argument.
 + Optional: we can also pass log format and date format string as a method argument to modify default format

scripts/templates/env.template

@@ -11,6 +11,6 @@ scheme=$scheme
 # Your version of Splunk (default: 6.2)
 version=$version
 # Bearer token for authentication
-#bearerToken=<Bearer-token>
+#splunkToken=<Bearer-token>
 # Session key for authentication
-#sessionKey=<Session-Key>
+#token=<Session-Key>

splunklib/binding.py

@@ -347,7 +347,8 @@ def _authority(scheme=DEFAULT_SCHEME, host=DEFAULT_HOST, port=DEFAULT_PORT):
             "http://splunk.utopia.net:471"
 
     """
-    if ':' in host:
+    # check if host is an IPv6 address and not enclosed in [ ]
+    if ':' in host and not (host.startswith('[') and host.endswith(']')):
         # IPv6 addresses must be enclosed in [ ] in order to be well
         # formed.
         host = '[' + host + ']'

splunklib/client.py

@@ -3709,24 +3709,31 @@ class KVStoreCollections(Collection):
     def __init__(self, service):
         Collection.__init__(self, service, 'storage/collections/config', item=KVStoreCollection)
 
-    def create(self, name, indexes = {}, fields = {}, **kwargs):
+    def __getitem__(self, item):
+        res = Collection.__getitem__(self, item)
+        for k, v in res.content.items():
+            if "accelerated_fields" in k:
+                res.content[k] = json.loads(v)
+        return res
+
+    def create(self, name, accelerated_fields={}, fields={}, **kwargs):
         """Creates a KV Store Collection.
 
         :param name: name of collection to create
         :type name: ``string``
-        :param indexes: dictionary of index definitions
-        :type indexes: ``dict``
+        :param accelerated_fields: dictionary of accelerated_fields definitions
+        :type accelerated_fields: ``dict``
         :param fields: dictionary of field definitions
         :type fields: ``dict``
         :param kwargs: a dictionary of additional parameters specifying indexes and field definitions
         :type kwargs: ``dict``
 
         :return: Result of POST request
         """
-        for k, v in six.iteritems(indexes):
+        for k, v in six.iteritems(accelerated_fields):
             if isinstance(v, dict):
                 v = json.dumps(v)
-            kwargs['index.' + k] = v
+            kwargs['accelerated_fields.' + k] = v
         for k, v in six.iteritems(fields):
             kwargs['field.' + k] = v
         return self.post(name=name, **kwargs)
@@ -3740,18 +3747,20 @@ def data(self):
         """
         return KVStoreCollectionData(self)
 
-    def update_index(self, name, value):
-        """Changes the definition of a KV Store index.
+    def update_accelerated_field(self, name, value):
+        """Changes the definition of a KV Store accelerated_field.
 
-        :param name: name of index to change
+        :param name: name of accelerated_fields to change
         :type name: ``string``
-        :param value: new index definition
-        :type value: ``dict`` or ``string``
+        :param value: new accelerated_fields definition
+        :type value: ``dict``
 
         :return: Result of POST request
         """
         kwargs = {}
-        kwargs['index.' + name] = value if isinstance(value, six.string_types) else json.dumps(value)
+        if isinstance(value, dict):
+            value = json.dumps(value)
+        kwargs['accelerated_fields.' + name] = value
         return self.post(**kwargs)
 
     def update_field(self, name, value):

tests/test_binding.py

@@ -190,6 +190,12 @@ def test_ipv6_host(self):
                 host="2001:0db8:85a3:0000:0000:8a2e:0370:7334"),
             "https://[2001:0db8:85a3:0000:0000:8a2e:0370:7334]:8089")
 
+    def test_ipv6_host_enclosed(self):
+        self.assertEqual(
+            binding._authority(
+                host="[2001:0db8:85a3:0000:0000:8a2e:0370:7334]"),
+            "https://[2001:0db8:85a3:0000:0000:8a2e:0370:7334]:8089")
+
     def test_all_fields(self):
         self.assertEqual(
             binding._authority(

tests/test_kvstore_conf.py

@@ -15,6 +15,8 @@
 # under the License.
 
 from __future__ import absolute_import
+
+import json
 from tests import testlib
 try:
     import unittest
@@ -42,13 +44,27 @@ def test_create_delete_collection(self):
         self.confs['test'].delete()
         self.assertTrue(not 'test' in self.confs)
 
+    def test_create_fields(self):
+        self.confs.create('test', accelerated_fields={'ind1':{'a':1}}, fields={'a':'number1'})
+        self.assertEqual(self.confs['test']['field.a'], 'number1')
+        self.assertEqual(self.confs['test']['accelerated_fields.ind1'], {"a": 1})
+        self.confs['test'].delete()
+
     def test_update_collection(self):
         self.confs.create('test')
-        self.confs['test'].post(**{'accelerated_fields.ind1': '{"a": 1}', 'field.a': 'number'})
+        val = {"a": 1}
+        self.confs['test'].post(**{'accelerated_fields.ind1': json.dumps(val), 'field.a': 'number'})
         self.assertEqual(self.confs['test']['field.a'], 'number')
-        self.assertEqual(self.confs['test']['accelerated_fields.ind1'], '{"a": 1}')
+        self.assertEqual(self.confs['test']['accelerated_fields.ind1'], {"a": 1})
         self.confs['test'].delete()
 
+    def test_update_accelerated_fields(self):
+        self.confs.create('test', accelerated_fields={'ind1':{'a':1}})
+        self.assertEqual(self.confs['test']['accelerated_fields.ind1'], {'a': 1})
+        # update accelerated_field value
+        self.confs['test'].update_accelerated_field('ind1', {'a': -1})
+        self.assertEqual(self.confs['test']['accelerated_fields.ind1'], {'a': -1})
+        self.confs['test'].delete()
 
     def test_update_fields(self):
         self.confs.create('test')
@@ -77,17 +93,6 @@ def test_overlapping_collections(self):
         self.confs['test'].delete()
         self.confs['test'].delete()
 
-    """
-    def test_create_accelerated_fields_fields(self):
-        self.confs.create('test', indexes={'foo': '{"foo": 1}', 'bar': {'bar': -1}}, **{'field.foo': 'string'})
-        self.assertEqual(self.confs['test']['accelerated_fields.foo'], '{"foo": 1}')
-        self.assertEqual(self.confs['test']['field.foo'], 'string')
-        self.assertRaises(client.HTTPError, lambda: self.confs['test'].post(**{'accelerated_fields.foo': 'THIS IS INVALID'}))
-        self.assertEqual(self.confs['test']['accelerated_fields.foo'], '{"foo": 1}')
-        self.confs['test'].update_accelerated_fields('foo', '')
-        self.assertEqual(self.confs['test']['accelerated_fields.foo'], None)
-    """
-
     def tearDown(self):
         if ('test' in self.confs):
             self.confs['test'].delete()