Merge branch 'develop' into feature/storage_passwords

Author: Sam Stelle

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):
@@ -2051,12 +2048,12 @@ def __getitem__(self, key):
                 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:

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.

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))