Merge branch 'develop' into feature/storage_passwords

Shakeel Mohamed · Shakeel Mohamed · commit 70a6a2bcca16 · 2014-09-11T10:27:42.000-07:00
diff --git a/examples/searchcommands_app/bin/generatehello.py b/examples/searchcommands_app/bin/generatehello.py
@@ -16,15 +16,15 @@
 
 import sys, time
 from splunklib.searchcommands import \
-  dispatch, GeneratingCommand, Configuration, Option, validators
+    dispatch, GeneratingCommand, Configuration, Option, validators
  
 @Configuration()
 class GenerateHelloCommand(GeneratingCommand):
-  count = Option(require=True, validate=validators.Integer())
+    count = Option(require=True, validate=validators.Integer())
  
-  def generate(self):
-    for i in range(1, self.count + 1):
-      text = 'Hello World %d' % i
-      yield {'_time': time.time(), 'event_no': i, '_raw': text } 
+    def generate(self):
+        for i in range(1, self.count + 1):
+            text = 'Hello World %d' % i
+            yield {'_time': time.time(), 'event_no': i, '_raw': text } 
  
 dispatch(GenerateHelloCommand, sys.argv, sys.stdin, sys.stdout, __name__)
diff --git a/examples/searchcommands_template/bin/generate.py b/examples/searchcommands_template/bin/generate.py
@@ -6,18 +6,18 @@
 
 @Configuration()
 class %(command.title())Command(GeneratingCommand):
-   """ %(synopsis)
+    """ %(synopsis)
 
-   ##Syntax
+    ##Syntax
 
-   %(syntax)
+    %(syntax)
 
-   ##Description
+    ##Description
 
-   %(description)
+    %(description)
 
-   """
-   def generate(self):
+    """
+    def generate(self):
        # Put your event  code here
        pass
 
diff --git a/examples/searchcommands_template/bin/stream.py b/examples/searchcommands_template/bin/stream.py
@@ -7,18 +7,18 @@
 
 @Configuration()
 class %(command.title())Command(StreamingCommand):
-   """ %(synopsis)
+    """ %(synopsis)
 
-   ##Syntax
+    ##Syntax
 
-   %(syntax)
+    %(syntax)
 
-   ##Description
+    ##Description
 
-   %(description)
+    %(description)
 
-   """
-   def stream(self, events):
+    """
+    def stream(self, events):
        # Put your event transformation code here
        pass
 
diff --git a/setup.py b/setup.py
@@ -186,7 +186,7 @@ def exclude(path):
     packages = ["splunklib",
                 "splunklib.modularinput",
                 "splunklib.searchcommands",
-                "splunklib.searchcommands.csv"],
+                "splunklib.searchcommands.splunk_csv"],
 
     url="http://github.com/splunk/splunk-sdk-python",
 
diff --git a/splunklib/binding.py b/splunklib/binding.py
@@ -115,12 +115,14 @@ class UrlEncoded(str):
         UrlEncoded('ab c') + 'de f' == UrlEncoded('ab cde f')
         'ab c' + UrlEncoded('de f') == UrlEncoded('ab cde f')
     """
-    def __new__(self, val='', skip_encode=False):
+    def __new__(self, val='', skip_encode=False, encode_slash=False):
         if isinstance(val, UrlEncoded):
             # Don't urllib.quote something already URL encoded.
             return val
         elif skip_encode:
             return str.__new__(self, val)
+        elif encode_slash:
+            return str.__new__(self, urllib.quote_plus(val))
         else:
             # When subclassing str, just call str's __new__ method
             # with your class and the value you want to have in the
@@ -464,7 +466,7 @@ def connect(self):
         sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
         if self.scheme == "https":
             sock = ssl.wrap_socket(sock)
-        sock.connect((self.host, self.port))
+        sock.connect((socket.gethostbyname(self.host), self.port))
         return sock
 
     @_authentication
diff --git a/splunklib/client.py b/splunklib/client.py
@@ -517,25 +517,22 @@ def restart(self, timeout=None):
         :param timeout: A timeout period, in seconds.
         :type timeout: ``integer``
         """
+        msg = { "value": "Restart requested by " + self.username + "via the Splunk SDK for Python"}
+        # This message will be deleted once the server actually restarts.
+        self.messages.create(name="restart_required", **msg)
         result = self.post("server/control/restart")
-        if timeout is None: return result
-        start = datetime.now()
-        diff = timedelta(seconds=10)
-        while datetime.now() - start < diff:
-            try:
-                self.login() # Has the server gone down yet?
-                sleep(0.3)
-            except Exception:
-                break # Server is down. Move on.
+        if timeout is None: 
+            return result
         start = datetime.now()
         diff = timedelta(seconds=timeout)
         while datetime.now() - start < diff:
             try:
-                self.login() # Awake yet?
-                return result
+                self.login()
+                if not self.restart_required:
+                    return result
             except Exception, e:
-                sleep(2)
-        raise Exception, "Operation timed out."
+                sleep(1)
+        raise Exception, "Operation time out."
 
     @property
     def restart_required(self):
@@ -1179,10 +1176,11 @@ def __getitem__(self, key):
                 # x[a,b] is translated to x.__getitem__( (a,b) ), so we
                 # have to extract values out.
                 key, ns = key
+                key = UrlEncoded(key, encode_slash=True)
                 response = self.get(key, owner=ns.owner, app=ns.app)
             else:
+                key = UrlEncoded(key, encode_slash=True)
                 response = self.get(key)
-
             entries = self._load_list(response)
             if len(entries) > 1:
                 raise AmbiguousReferenceException("Found multiple entities named '%s'; please specify a namespace." % key)
@@ -1216,6 +1214,7 @@ def __iter__(self, **kwargs):
             for entity in saved_searches:
                 print "Saved search named %s" % entity.name
         """
+
         for item in self.iter(**kwargs):
             yield item
 
@@ -1423,6 +1422,8 @@ def list(self, count=None, **kwargs):
         return list(self.iter(count=count, **kwargs))
 
 
+
+
 class Collection(ReadOnlyCollection):
     """A collection of entities.
 
@@ -1468,6 +1469,7 @@ class Collection(ReadOnlyCollection):
     :class:`Collection` does no caching. Each call makes at least one
     round trip to the server to fetch data.
     """
+
     def create(self, name, **params):
         """Creates a new entity in this collection.
 
@@ -1542,6 +1544,7 @@ def delete(self, name, **params):
             saved_searches.delete('my_saved_search')
             assert 'my_saved_search' not in saved_searches
         """
+        name = UrlEncoded(name, encode_slash=True)
         if 'namespace' in params:
             namespace = params.pop('namespace')
             params['owner'] = namespace.owner
@@ -1559,6 +1562,56 @@ def delete(self, name, **params):
                 raise
         return self
 
+    def get(self, name="", owner=None, app=None, sharing=None, **query):
+        """Performs a GET request to the server on the collection.
+
+        If *owner*, *app*, and *sharing* are omitted, this method takes a
+        default namespace from the :class:`Service` object for this :class:`Endpoint`.
+        All other keyword arguments are included in the URL as query parameters.
+
+        :raises AuthenticationError: Raised when the ``Service`` is not logged in.
+        :raises HTTPError: Raised when an error in the request occurs.
+        :param path_segment: A path segment relative to this endpoint.
+        :type path_segment: ``string``
+        :param owner: The owner context of the namespace (optional).
+        :type owner: ``string``
+        :param app: The app context of the namespace (optional).
+        :type app: ``string``
+        :param sharing: The sharing mode for the namespace (optional).
+        :type sharing: "global", "system", "app", or "user"
+        :param query: All other keyword arguments, which are used as query
+            parameters.
+        :type query: ``string``
+        :return: The response from the server.
+        :rtype: ``dict`` with keys ``body``, ``headers``, ``reason``,
+                and ``status``
+
+        Example:
+        
+        import splunklib.client
+            s = client.service(...)
+            saved_searches = s.saved_searches
+            saved_searches.get("my/saved/search") == \\
+                {'body': ...a response reader object...,
+                 'headers': [('content-length', '26208'),
+                             ('expires', 'Fri, 30 Oct 1998 00:00:00 GMT'),
+                             ('server', 'Splunkd'),
+                             ('connection', 'close'),
+                             ('cache-control', 'no-store, max-age=0, must-revalidate, no-cache'),
+                             ('date', 'Fri, 11 May 2012 16:30:35 GMT'),
+                             ('content-type', 'text/xml; charset=utf-8')],
+                 'reason': 'OK',
+                 'status': 200}
+            saved_searches.get('nonexistant/search') # raises HTTPError
+            s.logout()
+            saved_searches.get() # raises AuthenticationError
+
+        """
+        name = UrlEncoded(name, encode_slash=True)
+        return super(Collection, self).get(name, owner, app, sharing, **query)
+
+    
+
 
 class ConfigurationFile(Collection):
     """This class contains all of the stanzas from one configuration file.
@@ -2075,27 +2128,32 @@ def __init__(self, service, kindmap=None):
         Collection.__init__(self, service, PATH_INPUTS, item=Input)
 
     def __getitem__(self, key):
+        # The key needed to retrieve the input needs it's parenthesis to be URL encoded
+        # based on the REST API for input
+        # <http://docs.splunk.com/Documentation/Splunk/latest/RESTAPI/RESTinput>
         if isinstance(key, tuple) and len(key) == 2:
             # Fetch a single kind
             key, kind = key
+            key = UrlEncoded(key, encode_slash=True)
             try:
                 response = self.get(self.kindpath(kind) + "/" + key)
                 entries = self._load_list(response)
                 if len(entries) > 1:
                     raise AmbiguousReferenceException("Found multiple inputs of kind %s named %s." % (kind, key))
                 elif len(entries) == 0:
-                    raise KeyError((kind,key))
+                    raise KeyError((key, kind))
                 else:
                     return entries[0]
             except HTTPError as he:
                 if he.status == 404: # No entity matching kind and key
-                    raise KeyError((kind,key))
+                    raise KeyError((key, kind))
                 else:
                     raise
         else:
             # Iterate over all the kinds looking for matches.
             kind = None
             candidate = None
+            key = UrlEncoded(key, encode_slash=True)
             for kind in self.kinds:
                 try:
                     response = self.get(kind + "/" + key)
@@ -2114,7 +2172,7 @@ def __getitem__(self, key):
                     else:
                         raise
             if candidate is None:
-                raise KeyError(key) # Never found a match
+                raise KeyError(key) # Never found a match.
             else:
                 return candidate
 
@@ -2187,11 +2245,14 @@ def create(self, name, kind, **kwargs):
         # If we created an input with restrictToHost set, then
         # its path will be <restrictToHost>:<name>, not just <name>,
         # and we have to adjust accordingly.
+
+        # Url encodes the name of the entity.
+        name = UrlEncoded(name, encode_slash=True)
         path = _path(
             self.path + kindpath,
             '%s:%s' % (kwargs['restrictToHost'], name) \
                 if kwargs.has_key('restrictToHost') else name
-        )
+                )
         return Input(self.service, path, kind)
 
     def delete(self, name, kind=None):
@@ -2268,7 +2329,7 @@ def itemmeta(self, kind):
     def _get_kind_list(self, subpath=None):
         if subpath is None:
             subpath = []
-        
+
         kinds = []
         response = self.get('/'.join(subpath))
         content = _load_atom_entries(response)
@@ -2326,12 +2387,12 @@ def kindpath(self, kind):
         :rtype: ``string``
         """
         if kind in self.kinds:
-            return kind
+            return UrlEncoded(kind, skip_encode=True)
         # Special cases
         elif kind == 'tcp':
-            return 'tcp/raw'
+            return UrlEncoded('tcp/raw', skip_encode=True)
         elif kind == 'splunktcp':
-            return 'tcp/cooked'
+            return UrlEncoded('tcp/cooked', skip_encode=True)
         else:
             raise ValueError("No such kind on server: %s" % kind)
 
@@ -2398,6 +2459,7 @@ def list(self, *kinds, **kwargs):
             path = self.kindpath(kind)
             logging.debug("Path for inputs: %s", path)
             try:
+                path = UrlEncoded(path, skip_encode=True)
                 response = self.get(path, **kwargs)
             except HTTPError, he:
                 if he.status == 404: # No inputs of this kind
@@ -2422,6 +2484,7 @@ def list(self, *kinds, **kwargs):
         for kind in kinds:
             response = None
             try:
+                kind = UrlEncoded(kind, skip_encode=True)
                 response = self.get(self.kindpath(kind), search=search)
             except HTTPError as e:
                 if e.status == 404:
diff --git a/splunklib/modularinput/argument.py b/splunklib/modularinput/argument.py
@@ -48,7 +48,7 @@ class Argument(object):
     data_type_string = "STRING"
 
     def __init__(self, name, description=None, validation=None,
-                 data_type=data_type_string, required_on_edit=False, required_on_create=False):
+                 data_type=data_type_string, required_on_edit=False, required_on_create=False, title=None):
         """
         :param name: ``string``, identifier for this argument in Splunk.
         :param description: ``string``, human-readable description of the argument.
@@ -58,13 +58,15 @@ def __init__(self, name, description=None, validation=None,
         "data_type_boolean", "data_type_number", or "data_type_string".
         :param required_on_edit: ``Boolean``, whether this arg is required when editing an existing modular input of this kind.
         :param required_on_create: ``Boolean``, whether this arg is required when creating a modular input of this kind.
+        :param title: ``String``, a human-readable title for the argument.
         """
         self.name = name
         self.description = description
         self.validation = validation
         self.data_type = data_type
         self.required_on_edit = required_on_edit
         self.required_on_create = required_on_create
+        self.title = title
 
     def add_to_document(self, parent):
         """Adds an ``Argument`` object to this ElementTree document.
diff --git a/splunklib/results.py b/splunklib/results.py
@@ -246,7 +246,7 @@ def _parse_results(self, stream):
                         elem.clear()
 
                 elif elem.tag in ('text', 'v') and event == 'end':
-                    text = elem.text if elem.text is not None else ""
+                    text = "".join(elem.itertext())
                     values.append(text.encode('utf8'))
                     elem.clear()
 
diff --git a/tests/modularinput/test_scheme.py b/tests/modularinput/test_scheme.py
@@ -53,12 +53,15 @@ def test_generate_xml_from_scheme(self):
             validation="is_pos_int('some_name')",
             data_type=Argument.data_type_number,
             required_on_edit=True,
-            required_on_create=True
+            required_on_create=True,
+            title="Argument for ``test_scheme``"
         )
         scheme.add_argument(arg2)
 
         constructed = scheme.to_xml()
+
         expected = ET.parse(data_open("data/scheme_without_defaults.xml")).getroot()
+        self.assertEqual("Argument for ``test_scheme``", arg2.title)
 
         self.assertTrue(xml_compare(expected, constructed))
 
diff --git a/tests/test_binding.py b/tests/test_binding.py
diff --git a/tests/test_collection.py b/tests/test_collection.py
diff --git a/tests/test_results.py b/tests/test_results.py
