Merge branch 'bugfix/modularinputArgTitle' into develop

Shakeel Mohamed · Shakeel Mohamed · commit ad080f9c6726 · 2015-05-27T17:29:59.000-07:00
diff --git a/examples/github_forks/github_forks.py b/examples/github_forks/github_forks.py
@@ -50,6 +50,7 @@ def get_scheme(self):
         scheme.use_single_instance = True
 
         owner_argument = Argument("owner")
+        owner_argument.title = "Owner"
         owner_argument.data_type = Argument.data_type_string
         owner_argument.description = "Github user or organization that created the repository."
         owner_argument.required_on_create = True
@@ -59,6 +60,7 @@ def get_scheme(self):
         scheme.add_argument(owner_argument)
 
         repo_name_argument = Argument("repo_name")
+        repo_name_argument.title = "Repo Name"
         repo_name_argument.data_type = Argument.data_type_string
         repo_name_argument.description = "Name of the Github repository."
         repo_name_argument.required_on_create = True
diff --git a/examples/random_numbers/random_numbers.py b/examples/random_numbers/random_numbers.py
@@ -50,6 +50,7 @@ def get_scheme(self):
         scheme.use_single_instance = True
 
         min_argument = Argument("min")
+        min_argument.title = "Minimum"
         min_argument.data_type = Argument.data_type_number
         min_argument.description = "Minimum random number to be produced by this input."
         min_argument.required_on_create = True
@@ -59,6 +60,7 @@ def get_scheme(self):
         scheme.add_argument(min_argument)
 
         max_argument = Argument("max")
+        max_argument.title = "Maximum"
         max_argument.data_type = Argument.data_type_number
         max_argument.description = "Maximum random number to be produced by this input."
         max_argument.required_on_create = True
diff --git a/splunklib/modularinput/argument.py b/splunklib/modularinput/argument.py
@@ -80,6 +80,9 @@ def add_to_document(self, parent):
         arg = ET.SubElement(parent, "arg")
         arg.set("name", self.name)
 
+        if self.title is not None:
+            ET.SubElement(arg, "title").text = self.title
+
         if self.description is not None:
             ET.SubElement(arg, "description").text = self.description
 
diff --git a/tests/modularinput/data/scheme_without_defaults_and_argument_title.xml b/tests/modularinput/data/scheme_without_defaults_and_argument_title.xml
@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<scheme>
+    <title>abcd</title>
+    <description>쎼 and 쎶 and &lt;&amp;&gt; für</description>
+    <use_external_validation>false</use_external_validation>
+    <use_single_instance>true</use_single_instance>
+    <streaming_mode>simple</streaming_mode>
+    <endpoint>
+        <args>
+            <arg name="arg1">
+                <data_type>string</data_type>
+                <required_on_edit>false</required_on_edit>
+                <required_on_create>false</required_on_create>
+            </arg>
+            <arg name="arg2">
+                <title>Argument for ``test_scheme``</title>
+                <description>쎼 and 쎶 and &lt;&amp;&gt; für</description>
+                <validation>is_pos_int('some_name')</validation>
+                <data_type>number</data_type>
+                <required_on_edit>true</required_on_edit>
+                <required_on_create>true</required_on_create>
+            </arg>
+        </args>
+    </endpoint>
+</scheme>
diff --git a/tests/modularinput/test_scheme.py b/tests/modularinput/test_scheme.py
@@ -47,6 +47,35 @@ def test_generate_xml_from_scheme(self):
         arg1 = Argument(name="arg1")
         scheme.add_argument(arg1)
 
+        arg2 = Argument(
+            name="arg2",
+            description=u"쎼 and 쎶 and <&> für",
+            validation="is_pos_int('some_name')",
+            data_type=Argument.data_type_number,
+            required_on_edit=True,
+            required_on_create=True
+        )
+        scheme.add_argument(arg2)
+
+        constructed = scheme.to_xml()
+
+        expected = ET.parse(data_open("data/scheme_without_defaults.xml")).getroot()
+
+        self.assertTrue(xml_compare(expected, constructed))
+
+    def test_generate_xml_from_scheme_with_arg_title(self):
+        """Checks that the XML generated by a Scheme object with all its fields set and
+        some arguments added matches what we expect. Also sets the title on an argument."""
+
+        scheme = Scheme("abcd")
+        scheme.description = u"쎼 and 쎶 and <&> für"
+        scheme.streaming_mode = Scheme.streaming_mode_simple
+        scheme.use_external_validation = "false"
+        scheme.use_single_instance = "true"
+
+        arg1 = Argument(name="arg1")
+        scheme.add_argument(arg1)
+
         arg2 = Argument(
             name="arg2",
             description=u"쎼 and 쎶 and <&> für",
@@ -60,7 +89,7 @@ def test_generate_xml_from_scheme(self):
 
         constructed = scheme.to_xml()
 
-        expected = ET.parse(data_open("data/scheme_without_defaults.xml")).getroot()
+        expected = ET.parse(data_open("data/scheme_without_defaults_and_argument_title.xml")).getroot()
         self.assertEqual("Argument for ``test_scheme``", arg2.title)
 
         self.assertTrue(xml_compare(expected, constructed))
