Fixes to tests.searchcommands tests that were problematic on either Linux or Windows

We're good on OS X and CentOS 7 running against Splunk 6.3. More test fixes on the way for Windows.

Author: David Noble

CHANGELOG.md

@@ -4,6 +4,10 @@
 
 * Added support for Search Command Protocol V2, for Splunk 6.3+.
 
+* Added `splunklib` logger so that command loggers can be configured independently of the `splunklib.searchcommands` module.
+
+  See `examples/searchcommands_app/package/default/logger.conf` for guidance on logging configuration.
+
 * Added `splunklib.searchcommands.validators.Match` class for verifying that an option value matches a regular expression pattern.
 
 ### Bug fixes

tests/searchcommands/test_decorators.py

@@ -221,8 +221,8 @@ def fix_up(cls, command_class):
              (True, False),
              (None, 'anything other than a bool')),
             ('maxinputs',
-             (0, 50000, sys.maxsize),
-             (None, -1, sys.maxsize + 1, 'anything other than an int')),
+             (0, 50000, sys.maxint),
+             (None, -1, sys.maxint + 1, 'anything other than an int')),
             ('overrides_timeorder',
              (True, False),
              (None, 'anything other than a bool')),
@@ -391,7 +391,7 @@ def test_option(self):
             "('code', u'foo == \"bar\"'),"
             "('duration', u'24:59:59'),"
             "('fieldname', u'some.field_name'),"
-            "('file', u'" + __file__ + "'),"
+            "('file', u" + unicode(repr(__file__)) + "),"
             "('integer', u'100'),"
             "('logging_configuration', " + repr(environment.logging_configuration) + "),"
             "('logging_level', u'WARNING'),"
@@ -404,7 +404,7 @@ def test_option(self):
             "('required_code', u'foo == \"bar\"'),"
             "('required_duration', u'24:59:59'),"
             "('required_fieldname', u'some.field_name'),"
-            "('required_file', u'" + __file__ + "'),"
+            "('required_file', u" + unicode(repr(__file__)) + "),"
             "('required_integer', u'100'),"
             "('required_map', 'foo'),"
             "('required_match', u'123-45-6789'),"
@@ -414,7 +414,7 @@ def test_option(self):
             "('set', u'bar'),"
             "('show_configuration', u'f')])")
 
-        observed = repr(command.options)
+        observed = unicode(repr(command.options))
         self.assertEqual(observed, expected)
 
         expected = (

tests/searchcommands/test_internals_v1.py

@@ -206,13 +206,9 @@ def test_command_line_parser_unquote(self):
 
         # Command line with an assortment of string values
 
-        print('Observed:', options[-4], '=>', parser.unquote(options[-4]))
-        print('Expected:', expected[-4])
         self.assertEqual(expected[-4], parser.unquote(options[-4]))
 
         for i in range(0, len(options)):
-            print(i, 'Observed:', options[i], '=>', parser.unquote(options[i]))
-            print(i, 'Expected:', expected[i])
             self.assertEqual(expected[i], parser.unquote(options[i]))
 
         self.assertRaises(SyntaxError, parser.unquote, '"')

tests/searchcommands/test_internals_v2.py

@@ -24,7 +24,7 @@
 from functools import wraps
 from glob import iglob
 from itertools import chain, ifilter, imap, izip
-from sys import float_info, maxsize, maxunicode
+from sys import float_info, maxint as maxsize, maxunicode
 from tempfile import mktemp
 from time import time
 from types import MethodType

tests/searchcommands/test_searchcommands_app.py

@@ -39,9 +39,13 @@
 
 
 def pypy():
-    process = Popen(['pypy', '--version'], stderr=PIPE, stdout=PIPE)
-    output, errors = process.communicate()
-    return process.returncode == 0
+    try:
+        process = Popen(['pypy', '--version'], stderr=PIPE, stdout=PIPE)
+    except OSError:
+        return False
+    else:
+        process.communicate()
+        return process.returncode == 0
 
 
 class Recording(object):
@@ -123,23 +127,28 @@ def __iter__(self):
 
 class TestSearchCommandsApp(TestCase):
 
+    app_root = os.path.join(project_root, 'examples', 'searchcommands_app', 'build', 'searchcommands_app')
+
     def setUp(self):
+        if not os.path.isdir(TestSearchCommandsApp.app_root):
+            build_command = os.path.join(project_root, 'examples', 'searchcommands_app', 'setup.py build')
+            self.skipTest("You must build the searchcommands_app by running " + build_command)
         TestCase.setUp(self)
 
     def test_countmatches_as_unit(self):
 
         expected, output, errors, exit_status = self._run_command('countmatches', action='getinfo', protocol=1)
-        self.assertEqual(0, exit_status)
+        self.assertEqual(0, exit_status, msg=unicode(errors))
         # self.assertEqual('', errors)
         self.assertEqual(expected, output)
 
         expected, output, errors, exit_status = self._run_command('countmatches', action='execute', protocol=1)
-        self.assertEqual(0, exit_status)
+        self.assertEqual(0, exit_status, msg=unicode(errors))
         # self.assertEqual('', errors)
         self.assertEqual(expected, output)
 
         expected, output, errors, exit_status = self._run_command('countmatches')
-        self.assertEqual(0, exit_status)
+        self.assertEqual(0, exit_status, msg=unicode(errors))
         # self.assertEqual('', errors)
         self.assertEqual(expected, output)
 
@@ -148,17 +157,17 @@ def test_countmatches_as_unit(self):
     def test_generatehello_as_unit(self):
 
         expected, output, errors, exit_status = self._run_command('generatehello', action='getinfo', protocol=1)
-        self.assertEqual(0, exit_status)
+        self.assertEqual(0, exit_status, msg=unicode(errors))
         # self.assertEqual('', errors)
         # self.assertEqual(expected, output)
 
         expected, output, errors, exit_status = self._run_command('generatehello', action='execute', protocol=1)
-        self.assertEqual(0, exit_status)
+        self.assertEqual(0, exit_status, msg=unicode(errors))
         # self.assertEqual('', errors)
         # self.assertEqual(expected, output)
 
         expected, output, errors, exit_status = self._run_command('generatehello')
-        self.assertEqual(0, exit_status)
+        self.assertEqual(0, exit_status, msg=unicode(errors))
         # self.assertEqual('', errors)
         # self.assertEqual(expected, output)
 
@@ -171,17 +180,17 @@ def test_generatehello_as_unit(self):
     def test_pypygeneratetext_as_unit(self):
 
         expected, output, errors, exit_status = self._run_command('pypygeneratetext', action='getinfo', protocol=1)
-        self.assertEqual(0, exit_status)
+        self.assertEqual(0, exit_status, msg=unicode(errors))
         # self.assertEqual('', errors)
         self.assertEqual(expected, output)
 
         expected, output, errors, exit_status = self._run_command('pypygeneratetext', action='execute', protocol=1)
-        self.assertEqual(0, exit_status)
+        self.assertEqual(0, exit_status, msg=unicode(errors))
         # self.assertEqual('', errors)
         # self.assertEqual(expected, output)
 
         expected, output, errors, exit_status = self._run_command('pypygeneratetext')
-        self.assertEqual(0, exit_status)
+        self.assertEqual(0, exit_status, msg=unicode(errors))
         # self.assertEqual('', errors)
         # self.assertEqual(expected, output)
 
@@ -190,32 +199,32 @@ def test_pypygeneratetext_as_unit(self):
     def test_sum_as_unit(self):
 
         expected, output, errors, exit_status = self._run_command('sum', action='getinfo', phase='reduce', protocol=1)
-        self.assertEqual(0, exit_status)
+        self.assertEqual(0, exit_status, msg=unicode(errors))
         # self.assertEqual('', errors)
         self.assertInfoEqual(output, expected)
 
         expected, output, errors, exit_status = self._run_command('sum', action='getinfo', phase='map', protocol=1)
-        self.assertEqual(0, exit_status)
+        self.assertEqual(0, exit_status, msg=unicode(errors))
         # self.assertEqual('', errors)
         self.assertInfoEqual(expected, output)
 
         expected, output, errors, exit_status = self._run_command('sum', action='execute', phase='map', protocol=1)
-        self.assertEqual(0, exit_status)
+        self.assertEqual(0, exit_status, msg=unicode(errors))
         # self.assertEqual('', errors)
         self.assertEqual(expected, output)
 
         expected, output, errors, exit_status = self._run_command('sum', action='execute', phase='reduce', protocol=1)
-        self.assertEqual(0, exit_status)
+        self.assertEqual(0, exit_status, msg=unicode(errors))
         # self.assertEqual('', errors)
         self.assertEqual(expected, output)
 
         expected, output, errors, exit_status = self._run_command('sum', phase='map')
-        self.assertEqual(0, exit_status)
+        self.assertEqual(0, exit_status, msg=unicode(errors))
         # self.assertEqual('', errors)
         self.assertEqual(expected, output)
 
         expected, output, errors, exit_status = self._run_command('sum', phase='reduce')
-        self.assertEqual(0, exit_status)
+        self.assertEqual(0, exit_status, msg=unicode(errors))
         # self.assertEqual('', errors)
         self.assertEqual(expected, output)
 
@@ -239,7 +248,8 @@ def assertInfoEqual(self, output, expected):
         self.assertDictEqual(expected, output)
 
     def _get_search_command_path(self, name):
-        path = os.path.join(project_root, 'examples', 'searchcommands_app', 'package', 'bin', name + '.py')
+        path = os.path.join(
+            project_root, 'examples', 'searchcommands_app', 'build', 'searchcommands_app', 'bin', name + '.py')
         self.assertTrue(path)
         return path
 

tests/searchcommands/test_validators.py

@@ -24,6 +24,7 @@
 import os
 import re
 import sys
+import tempfile
 
 # P2 [ ] TODO: Verify that all format methods produce 'None' when value is None
 
@@ -102,22 +103,23 @@ def test_file(self):
         # Create a file on $SPLUNK_HOME/var/run/splunk
 
         file_name = 'TestValidators.test_file'
-        full_path = os.path.join(validators.File._var_run_splunk, file_name)
+        tempdir = tempfile.gettempdir()
+        full_path = os.path.join(tempdir, file_name)
 
         try:
-            validator = validators.File(mode='w', buffering=4096)
+            validator = validators.File(mode='w', buffering=4096, directory=tempdir)
 
             with validator(file_name) as f:
                 f.write('some text')
 
-            validator = validators.File(mode='a')
+            validator = validators.File(mode='a', directory=tempdir)
 
             with validator(full_path) as f:
                 f.write('\nmore text')
 
-            # Verify that you can read the file from $SPLUNK_HOME/var/run/splunk using an absolute or relative path
+            # Verify that you can read the file from a file using an absolute or relative path
 
-            validator = validators.File()
+            validator = validators.File(directory=tempdir)
 
             for path in file_name, full_path:
                 with validator(path) as f:
@@ -138,8 +140,8 @@ def test_file(self):
 
     def test_integer(self):
 
-        maxsize = sys.maxsize
-        minsize = -(sys.maxsize - 1)
+        maxint = sys.maxint
+        minint = -(sys.maxint - 1)
 
         # The Integer validator should convert values in the range of a Python long which has unlimited precision
         # Anecdotal evidence: This portion of the test checks 5-10 K integer values and runs for less than 2-3 seconds
@@ -153,18 +155,18 @@ def test(integer):
                 self.assertIsInstance(value, long)
             self.assertEqual(validator.format(integer), unicode(integer))
 
-        test(2L * minsize)
-        test(minsize)
+        test(2L * minint)
+        test(minint)
         test(-1)
         test(0)
         test(1)
-        test(2L * maxsize)
+        test(2L * maxint)
 
         count = 3
 
-        start = -randint(0, maxsize - 1)
-        stop = sys.maxsize
-        step = randint(1000000000000000, 2000000000000000)
+        start = -randint(0, maxint - 1)
+        stop = maxint
+        step = randint(1000000, 2000000)
 
         for i in xrange(start, stop, step):
             test(i)
@@ -174,21 +176,21 @@ def test(integer):
 
         validator = validators.Integer(minimum=0)
         self.assertEqual(validator.__call__(0), 0)
-        self.assertEqual(validator.__call__(2L * maxsize), 2L * maxsize)
+        self.assertEqual(validator.__call__(2L * maxint), 2L * maxint)
         self.assertRaises(ValueError, validator.__call__, -1)
 
-        validator = validators.Integer(minimum=1, maximum=maxsize)
+        validator = validators.Integer(minimum=1, maximum=maxint)
         self.assertEqual(validator.__call__(1), 1)
-        self.assertEqual(validator.__call__(maxsize), maxsize)
+        self.assertEqual(validator.__call__(maxint), maxint)
         self.assertRaises(ValueError, validator.__call__, 0)
-        self.assertRaises(ValueError, validator.__call__, maxsize + 1)
+        self.assertRaises(ValueError, validator.__call__, maxint + 1)
 
-        validator = validators.Integer(minimum=minsize, maximum=maxsize)
-        self.assertEqual(validator.__call__(minsize), minsize)
+        validator = validators.Integer(minimum=minint, maximum=maxint)
+        self.assertEqual(validator.__call__(minint), minint)
         self.assertEqual(validator.__call__(0), 0)
-        self.assertEqual(validator.__call__(maxsize), maxsize)
-        self.assertRaises(ValueError, validator.__call__, minsize - 1L)
-        self.assertRaises(ValueError, validator.__call__, maxsize + 1L)
+        self.assertEqual(validator.__call__(maxint), maxint)
+        self.assertRaises(ValueError, validator.__call__, minint - 1L)
+        self.assertRaises(ValueError, validator.__call__, maxint + 1L)
 
         return