Final bits of code cleanup & simplification

Author: Shakeel Mohamed

splunklib/modularinput/event.py

@@ -23,7 +23,7 @@ class Event(object):
     To write an input to a stream, call the write_to function, passing in a stream.
     """
     def __init__(self, data=None, stanza=None, time=None, host=None, index=None, source=None,
-                 sourceType=None, done=True, unbroken=True):
+                 sourcetype=None, done=True, unbroken=True):
         """There are no required parameters for constructing an Event
 
         Example with minimal configuration:
@@ -43,7 +43,7 @@ def __init__(self, data=None, stanza=None, time=None, host=None, index=None, sou
                 host="localhost",
                 index="main",
                 source="Splunk",
-                sourceType="misc",
+                sourcetype="misc",
                 done=True,
                 unbroken=True
             )
@@ -54,7 +54,7 @@ def __init__(self, data=None, stanza=None, time=None, host=None, index=None, sou
         :param host: string, the event's host, ex: localhost
         :param index: string, the index this event is specified to write to, or None if default index
         :param source: string, the source of this event, or None to have Splunk guess
-        :param sourceType: string, source type currently set on this event, or None to have Splunk guess
+        :param sourcetype: string, source type currently set on this event, or None to have Splunk guess
         :param done: boolean, is this a complete Event? False if an Event fragment
         :param unbroken: boolean, Is this event completely encapsulated in this Event object?
         """
@@ -63,7 +63,7 @@ def __init__(self, data=None, stanza=None, time=None, host=None, index=None, sou
         self.host = host
         self.index = index
         self.source = source
-        self.sourceType = sourceType
+        self.sourceType = sourcetype
         self.stanza = stanza
         self.time = time
         self.unbroken = unbroken
@@ -72,7 +72,7 @@ def write_to(self, stream):
         """Write an XML representation of self, an Event object, to the given stream
 
         The Event object will only be written if its data field is defined,
-        else a ValueError is raised.
+        otherwise a ValueError is raised.
 
         :param stream: stream to write XML to
         """

splunklib/modularinput/input_definition.py

@@ -36,7 +36,7 @@ def __eq__(self, other):
         return self.metadata == other.metadata and self.inputs == other.inputs
 
     @staticmethod
-    def parse_input_definition(stream):
+    def parse(stream):
         """Parse a stream containing XML into an InputDefinition.
 
         :param stream: stream containing XML to parse

splunklib/modularinput/script.py

@@ -61,7 +61,7 @@ def run_script(self, args, event_writer, input_stream):
             if len(args) == 0:
                 # This script is running as an input. Input definitions will be passed on stdin
                 # as XML, and the script will write events on stdout and log entries on stderr.
-                input_definition = InputDefinition.parse_input_definition(input_stream)
+                input_definition = InputDefinition.parse(input_stream)
                 self.stream_events(input_definition, event_writer)
                 event_writer.close()
                 return 0
@@ -78,7 +78,7 @@ def run_script(self, args, event_writer, input_stream):
                     return 0
 
             elif args[0].lower() == "--validate-arguments":
-                validation_definition = ValidationDefinition.parse_validation_definition(input_stream)
+                validation_definition = ValidationDefinition.parse(input_stream)
                 try:
                     self.validate_input(validation_definition)
                     return 0

splunklib/modularinput/validation_definition.py

@@ -37,7 +37,7 @@ def __eq__(self, other):
         return self.metadata == other.metadata and self.parameters == other.parameters
 
     @staticmethod
-    def parse_validation_definition(stream):
+    def parse(stream):
         """Creates a ValidationDefinition from a provided stream containing XML.
 
         The XML typically will look like

tests/modularinput/test_event.py

@@ -62,7 +62,7 @@ def test_xml_of_event_with_more_configuration(self):
             host="localhost",
             index="main",
             source="hilda",
-            sourceType="misc",
+            sourcetype="misc",
             done=True,
             unbroken=True
         )
@@ -88,7 +88,7 @@ def test_writing_events_on_event_writer(self):
             host="localhost",
             index="main",
             source="hilda",
-            sourceType="misc",
+            sourcetype="misc",
             done=True,
             unbroken=True
         )

tests/modularinput/test_input_definition.py

@@ -22,7 +22,7 @@ class InputDefinitionTestCase(unittest.TestCase):
     def test_parse_inputdef_with_zero_inputs(self):
         """Check parsing of XML that contains only metadata"""
 
-        found = InputDefinition.parse_input_definition(open("data/conf_with_0_inputs.xml"))
+        found = InputDefinition.parse(open("data/conf_with_0_inputs.xml"))
 
         expectedDefinition = InputDefinition()
         expectedDefinition.metadata = {
@@ -37,7 +37,7 @@ def test_parse_inputdef_with_zero_inputs(self):
     def test_parse_inputdef_with_two_inputs(self):
         """Check parsing of XML that contains 2 inputs"""
 
-        found = InputDefinition.parse_input_definition(open("data/conf_with_2_inputs.xml"))
+        found = InputDefinition.parse(open("data/conf_with_2_inputs.xml"))
 
         expectedDefinition = InputDefinition()
         expectedDefinition.metadata = {
@@ -67,7 +67,7 @@ def test_attempt_to_parse_malformed_input_definition_will_throw_exception(self):
         """Does malformed XML cause the expected exception."""
 
         with self.assertRaises(ValueError):
-            found = InputDefinition.parse_input_definition(open("data/conf_with_invalid_inputs.xml"))
+            found = InputDefinition.parse(open("data/conf_with_invalid_inputs.xml"))
 
 if __name__ == "__main__":
     unittest.main()

tests/modularinput/test_script.py

@@ -182,7 +182,7 @@ def stream_events(self, inputs, ew):
                     host="localhost",
                     index="main",
                     source="hilda",
-                    sourceType="misc",
+                    sourcetype="misc",
                     done=True,
                     unbroken=True
                 )

tests/modularinput/test_validation_definition.py

@@ -20,7 +20,7 @@
 class ValidationDefinitionTestCase(unittest.TestCase):
     def test_validation_definition_parse(self):
         """Check that parsing produces expected result"""
-        found = ValidationDefinition.parse_validation_definition(open("data/validation.xml"))
+        found = ValidationDefinition.parse(open("data/validation.xml"))
 
         expected = ValidationDefinition()
         expected.metadata = {