Updated modular input tests so they work when run with all tests

There was an issue with relative paths, which has now been resolved.
See modularinput_testlib for the new data_open() function.

Author: Shakeel Mohamed

tests/modularinput/modularinput_testlib.py

@@ -23,4 +23,7 @@
 
 sys.path.insert(0, os.path.join('../../splunklib', '..'))
 
-from splunklib.modularinput.utils import xml_compare, parse_xml_data, parse_parameters
+from splunklib.modularinput.utils import xml_compare, parse_xml_data, parse_parameters
+
+def data_open(filepath):
+    return os.path.join(os.path.dirname(os.path.abspath(__file__)), filepath)

tests/modularinput/test_event.py

@@ -14,7 +14,7 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
-from tests.modularinput.modularinput_testlib import unittest, xml_compare
+from tests.modularinput.modularinput_testlib import unittest, xml_compare, data_open
 from splunklib.modularinput.event import Event, ET
 from splunklib.modularinput.event_writer import EventWriter
 
@@ -46,7 +46,7 @@ def test_xml_of_event_with_minimal_configuration(self):
         event.write_to(stream)
 
         constructed = ET.fromstring(stream.getvalue())
-        expected = ET.parse(open("data/event_minimal.xml")).getroot()
+        expected = ET.parse(data_open("data/event_minimal.xml")).getroot()
 
         self.assertTrue(xml_compare(expected, constructed))
 
@@ -69,7 +69,7 @@ def test_xml_of_event_with_more_configuration(self):
         event.write_to(stream)
 
         constructed = ET.fromstring(stream.getvalue())
-        expected = ET.parse(open("data/event_maximal.xml")).getroot()
+        expected = ET.parse(data_open("data/event_maximal.xml")).getroot()
 
         self.assertTrue(xml_compare(expected, constructed))
 
@@ -95,7 +95,7 @@ def test_writing_events_on_event_writer(self):
         ew.write_event(e)
 
         found = ET.fromstring("%s</stream>" % out.getvalue())
-        expected = ET.parse(open("data/stream_with_one_event.xml")).getroot()
+        expected = ET.parse(data_open("data/stream_with_one_event.xml")).getroot()
 
         self.assertTrue(xml_compare(expected, found))
         self.assertEqual(err.getvalue(), "")
@@ -104,7 +104,7 @@ def test_writing_events_on_event_writer(self):
         ew.close()
 
         found = ET.fromstring(out.getvalue())
-        expected = ET.parse(open("data/stream_with_two_events.xml")).getroot()
+        expected = ET.parse(data_open("data/stream_with_two_events.xml")).getroot()
 
         self.assertTrue(xml_compare(expected, found))
 
@@ -142,7 +142,7 @@ def test_write_xml_is_sane(self):
 
         ew = EventWriter(out, err)
 
-        expected_xml = ET.parse(open("data/event_maximal.xml")).getroot()
+        expected_xml = ET.parse(data_open("data/event_maximal.xml")).getroot()
 
         ew.write_xml_document(expected_xml)
         found_xml = ET.fromstring(out.getvalue())

tests/modularinput/test_input_definition.py

@@ -14,15 +14,15 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
-from tests.modularinput.modularinput_testlib import unittest
+from tests.modularinput.modularinput_testlib import unittest, data_open
 from splunklib.modularinput.input_definition import InputDefinition
 
 class InputDefinitionTestCase(unittest.TestCase):
 
     def test_parse_inputdef_with_zero_inputs(self):
         """Check parsing of XML that contains only metadata"""
 
-        found = InputDefinition.parse(open("data/conf_with_0_inputs.xml"))
+        found = InputDefinition.parse(data_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(open("data/conf_with_2_inputs.xml"))
+        found = InputDefinition.parse(data_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(open("data/conf_with_invalid_inputs.xml"))
+            found = InputDefinition.parse(data_open("data/conf_with_invalid_inputs.xml"))
 
 if __name__ == "__main__":
     unittest.main()

tests/modularinput/test_scheme.py

@@ -13,7 +13,7 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
-from tests.modularinput.modularinput_testlib import unittest, xml_compare
+from tests.modularinput.modularinput_testlib import unittest, xml_compare, data_open
 from splunklib.modularinput.scheme import Scheme
 from splunklib.modularinput.argument import Argument
 
@@ -30,7 +30,7 @@ def test_generate_xml_from_scheme_with_default_values(self):
         scheme = Scheme("abcd")
 
         constructed = scheme.to_xml()
-        expected = ET.parse(open("data/scheme_with_defaults.xml")).getroot()
+        expected = ET.parse(data_open("data/scheme_with_defaults.xml")).getroot()
 
         self.assertTrue(xml_compare(expected, constructed))
 
@@ -58,7 +58,7 @@ def test_generate_xml_from_scheme(self):
         scheme.add_argument(arg2)
 
         constructed = scheme.to_xml()
-        expected = ET.parse(open("data/scheme_without_defaults.xml")).getroot()
+        expected = ET.parse(data_open("data/scheme_without_defaults.xml")).getroot()
 
         self.assertTrue(xml_compare(expected, constructed))
 
@@ -71,7 +71,7 @@ def test_generate_xml_from_argument_with_default_values(self):
         root = ET.Element("")
         constructed = argument.add_to_document(root)
 
-        expected = ET.parse(open("data/argument_with_defaults.xml")).getroot()
+        expected = ET.parse(data_open("data/argument_with_defaults.xml")).getroot()
 
         self.assertTrue(xml_compare(expected, constructed))
 
@@ -90,7 +90,7 @@ def test_generate_xml_from_argument(self):
         root = ET.Element("")
         constructed = argument.add_to_document(root)
 
-        expected = ET.parse(open("data/argument_without_defaults.xml")).getroot()
+        expected = ET.parse(data_open("data/argument_without_defaults.xml")).getroot()
 
         self.assertTrue(xml_compare(expected, constructed))
 

tests/modularinput/test_script.py

@@ -12,7 +12,7 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
-from tests.modularinput.modularinput_testlib import unittest, xml_compare
+from tests.modularinput.modularinput_testlib import unittest, xml_compare, data_open
 from splunklib.modularinput.argument import Argument
 from splunklib.modularinput.event import Event
 from splunklib.modularinput.event_writer import EventWriter
@@ -103,7 +103,7 @@ def stream_events(self, inputs, ew):
         self.assertEqual(0, return_value)
 
         found = ET.fromstring(out.getvalue())
-        expected = ET.parse(open("data/scheme_without_defaults.xml")).getroot()
+        expected = ET.parse(data_open("data/scheme_without_defaults.xml")).getroot()
 
         self.assertTrue(xml_compare(expected, found))
 
@@ -131,7 +131,7 @@ def stream_events(self, inputs, ew):
 
         args = [TEST_SCRIPT_PATH, "--validate-arguments"]
 
-        return_value = script.run_script(args, ew, open("data/validation.xml"))
+        return_value = script.run_script(args, ew, data_open("data/validation.xml"))
 
         self.assertEqual("", err.getvalue())
         self.assertEqual("", out.getvalue())
@@ -160,9 +160,9 @@ def stream_events(self, inputs, ew):
 
         args = [TEST_SCRIPT_PATH, "--validate-arguments"]
 
-        return_value = script.run_script(args, ew, open("data/validation.xml"))
+        return_value = script.run_script(args, ew, data_open("data/validation.xml"))
 
-        expected = ET.parse(open("data/validation_error.xml")).getroot()
+        expected = ET.parse(data_open("data/validation_error.xml")).getroot()
         found = ET.fromstring(out.getvalue())
 
         self.assertEqual("", err.getvalue())
@@ -194,7 +194,7 @@ def stream_events(self, inputs, ew):
                 ew.write_event(event)
 
         script = NewScript()
-        input_configuration = open("data/conf_with_2_inputs.xml")
+        input_configuration = data_open("data/conf_with_2_inputs.xml")
 
         out = StringIO()
         err = StringIO()
@@ -205,7 +205,7 @@ def stream_events(self, inputs, ew):
         self.assertEqual(0, return_value)
         self.assertEqual("", err.getvalue())
 
-        expected = ET.parse(open("data/stream_with_two_events.xml")).getroot()
+        expected = ET.parse(data_open("data/stream_with_two_events.xml")).getroot()
         found = ET.fromstring(out.getvalue())
 
         self.assertTrue(xml_compare(expected, found))

tests/modularinput/test_validation_definition.py

@@ -14,13 +14,13 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
-from tests.modularinput.modularinput_testlib import unittest
+from tests.modularinput.modularinput_testlib import unittest, data_open
 from splunklib.modularinput.validation_definition import ValidationDefinition
 
 class ValidationDefinitionTestCase(unittest.TestCase):
     def test_validation_definition_parse(self):
         """Check that parsing produces expected result"""
-        found = ValidationDefinition.parse(open("data/validation.xml"))
+        found = ValidationDefinition.parse(data_open("data/validation.xml"))
 
         expected = ValidationDefinition()
         expected.metadata = {