Merge pull request #145 from splunk/bugfix/python-2.6-compat

Fix issues with Python 2.6 support

Author: shakeelmohamed

examples/searchcommands_app/setup.py

@@ -57,7 +57,10 @@ def symlink(source, link_name):
     patch_os()
     del locals()['patch_os']  # since this function has done its job
 
-from collections import OrderedDict
+try:
+    from collections import OrderedDict
+except:
+    from splunklib.ordereddict import OrderedDict
 from glob import glob
 from itertools import chain
 from setuptools import setup, Command

splunklib/results.py

@@ -38,9 +38,9 @@
     import xml.etree.ElementTree as et
 
 try:
-    from collections import OrderedDict
-except:
-    from ordereddict import OrderedDict
+    from collections import OrderedDict  # must be python 2.7
+except ImportError:
+    from splunklib.ordereddict import OrderedDict
 
 try:
     from cStringIO import StringIO

splunklib/searchcommands/decorators.py

@@ -16,7 +16,11 @@
 
 from __future__ import absolute_import, division, print_function, unicode_literals
 
-from collections import OrderedDict  # must be python 2.7
+try:
+    from collections import OrderedDict  # must be python 2.7
+except ImportError:
+    from splunklib.ordereddict import OrderedDict
+
 from inspect import getmembers, isclass, isfunction
 from itertools import imap
 

splunklib/searchcommands/internals.py

@@ -16,7 +16,11 @@
 
 from __future__ import absolute_import, division, print_function, unicode_literals
 
-from collections import deque, namedtuple, OrderedDict
+from collections import deque, namedtuple
+try:
+    from collections import OrderedDict  # must be python 2.7
+except ImportError:
+    from splunklib.ordereddict import OrderedDict
 from cStringIO import StringIO
 from itertools import chain, imap
 from json import JSONDecoder, JSONEncoder
@@ -763,7 +767,7 @@ def _clear(self):
     def _write_chunk(self, metadata, body):
 
         if metadata:
-            metadata = str(''.join(self._iterencode_json({n: v for n, v in metadata if v is not None}, 0)))
+            metadata = str(''.join(self._iterencode_json(dict([(n, v) for n, v in metadata if v is not None]), 0)))
             metadata_length = len(metadata)
         else:
             metadata_length = 0

splunklib/searchcommands/search_command.py

@@ -20,12 +20,23 @@
 
 from splunklib.client import Service
 
-from collections import namedtuple, OrderedDict
+try:
+    __named_tuple_check = namedtuple
+except NameError:
+    from collections import namedtuple
+try:
+    from collections import OrderedDict  # must be python 2.7
+except ImportError:
+    from splunklib.ordereddict import OrderedDict
 from copy import deepcopy
 from cStringIO import StringIO
 from itertools import chain, ifilter, imap, islice, izip
 from logging import _levelNames, getLevelName, getLogger
-from shutil import make_archive
+try:
+    from shutil import make_archive
+except ImportError:
+    # Used for recording, skip on python 2.6
+    pass
 from time import time
 from urllib import unquote
 from urlparse import urlsplit
@@ -572,8 +583,8 @@ def _process_protocol_v1(self, argv, ifile, ofile):
                 debug('Writing configuration settings')
 
                 ifile = self._prepare_protocol_v1(argv, ifile, ofile)
-                self._record_writer.write_record({
-                    n: ','.join(v) if isinstance(v, (list, tuple)) else v for n, v in self._configuration.iteritems()})
+                self._record_writer.write_record(dict(
+                    (n, ','.join(v) if isinstance(v, (list, tuple)) else v) for n, v in self._configuration.iteritems()))
                 self.finish()
 
             elif argv[1] == '__EXECUTE__':
@@ -884,7 +895,7 @@ def _records_protocol_v1(self, ifile):
         except StopIteration:
             return
 
-        mv_fieldnames = {name: name[len('__mv_'):] for name in fieldnames if name.startswith('__mv_')}
+        mv_fieldnames = dict([(name, name[len('__mv_'):]) for name in fieldnames if name.startswith('__mv_')])
 
         if len(mv_fieldnames) == 0:
             for values in reader:
@@ -926,7 +937,7 @@ def _records_protocol_v2(self, ifile):
                 except StopIteration:
                     return
 
-                mv_fieldnames = {name: name[len('__mv_'):] for name in fieldnames if name.startswith('__mv_')}
+                mv_fieldnames = dict([(name, name[len('__mv_'):]) for name in fieldnames if name.startswith('__mv_')])
 
                 if len(mv_fieldnames) == 0:
                     for values in reader:

tests/searchcommands/test_builtin_options.py

@@ -18,7 +18,10 @@
 from __future__ import absolute_import, division, print_function, unicode_literals
 
 from cStringIO import StringIO
-from unittest import main, TestCase
+try:
+    from unittest2 import main, TestCase
+except ImportError:
+    from unittest import main, TestCase
 
 import os
 import sys
@@ -28,7 +31,13 @@
 from splunklib.searchcommands.decorators import Configuration
 from splunklib.searchcommands.search_command import SearchCommand
 
-from tests.searchcommands import package_directory, rebase_environment
+try:
+    from tests.searchcommands import rebase_environment, package_directory
+except:
+    # Skip on Python 2.6
+    def rebase_environment(ignore):
+        return
+    pass
 
 
 @Configuration()

tests/searchcommands/test_decorators.py

@@ -17,15 +17,22 @@
 
 from __future__ import absolute_import, division, print_function, unicode_literals
 
-from unittest import main, TestCase
+try:
+    from unittest2 import main, TestCase
+except ImportError:
+    from unittest import main, TestCase
 import sys
 
 from splunklib.searchcommands import Configuration, Option, environment, validators
 from splunklib.searchcommands.decorators import ConfigurationSetting
 from splunklib.searchcommands.internals import json_encode_string
 from splunklib.searchcommands.search_command import SearchCommand
 
-from tests.searchcommands import rebase_environment
+try:
+    from tests.searchcommands import rebase_environment
+except ImportError:
+    # Skip on Python 2.6
+    pass
 
 
 @Configuration()
@@ -227,7 +234,7 @@ def fix_up(cls, command_class):
              (True, False),
              (None, 'anything other than a bool')),
             ('required_fields',
-             (['field_1', 'field_2'], {'field_1', 'field_2'}, ('field_1', 'field_2')),
+             (['field_1', 'field_2'], set(['field_1', 'field_2']), ('field_1', 'field_2')),
              (None, 0xdead, {'foo': 1, 'bar': 2})),
             ('requires_preop',
              (True, False),

tests/searchcommands/test_internals_v2.py

@@ -19,7 +19,15 @@
 
 from splunklib.searchcommands.internals import MetadataDecoder, MetadataEncoder, Recorder, RecordWriterV2
 from splunklib.searchcommands import SearchMetric
-from collections import deque, namedtuple, OrderedDict
+try:
+    from collections import OrderedDict  # must be python 2.7
+except ImportError:
+    from splunklib.ordereddict import OrderedDict
+try:
+    __named_tuple_check = namedtuple
+except NameError:
+    # for Python 2.6
+    from collections import namedtuple
 from cStringIO import StringIO
 from functools import wraps
 from glob import iglob
@@ -28,7 +36,11 @@
 from tempfile import mktemp
 from time import time
 from types import MethodType
-from unittest import main, TestCase
+from sys import version_info as python_version
+try:
+    from unittest2 import main, TestCase
+except ImportError:
+    from unittest import main, TestCase
 
 import cPickle as pickle
 import gzip
@@ -106,13 +118,18 @@ def test_object_view(self):
 
     def test_recorder(self):
 
+        if (python_version[0] == 2 and python_version[1] < 7):
+            print("Skipping test since we're on {1}".format("".join(python_version)))
+            pass
+
         # Grab an input/output recording, the results of a prior countmatches run
 
         recording = os.path.join(self._package_path, 'recordings', 'scpv2', 'Splunk-6.3', 'countmatches.')
 
-        with gzip.open(recording + 'input.gz', 'rb') as file_1, io.open(recording + 'output', 'rb') as file_2:
-            ifile = StringIO(file_1.read())
-            result = StringIO(file_2.read())
+        with gzip.open(recording + 'input.gz', 'rb') as file_1:
+            with io.open(recording + 'output', 'rb') as file_2:
+                ifile = StringIO(file_1.read())
+                result = StringIO(file_2.read())
 
         # Set up the input/output recorders that are under test
 
@@ -138,9 +155,10 @@ def test_recorder(self):
                 ifile._recording.close()
                 ofile._recording.close()
 
-                with gzip.open(ifile._recording.name, 'rb') as file_1, gzip.open(ofile._recording.name, 'rb') as file_2:
-                    self.assertEqual(file_1.read(), ifile._file.getvalue())
-                    self.assertEqual(file_2.read(), ofile._file.getvalue())
+                with gzip.open(ifile._recording.name, 'rb') as file_1:
+                    with gzip.open(ofile._recording.name, 'rb') as file_2:
+                        self.assertEqual(file_1.read(), ifile._file.getvalue())
+                        self.assertEqual(file_2.read(), ofile._file.getvalue())
 
             finally:
                 ofile._recording.close()

tests/searchcommands/test_searchcommands_app.py

@@ -31,15 +31,23 @@
 from datetime import datetime
 from itertools import ifilter, imap, izip
 from subprocess import PIPE, Popen
-from unittest import main, skipUnless, TestCase
+
+try:
+    from unittest2 import main, skipUnless, TestCase
+except ImportError:
+    from unittest import main, skipUnless, TestCase
 
 import gzip
 import json
 import csv
 import io
 import os
 
-from tests.searchcommands import project_root
+try:
+    from tests.searchcommands import project_root
+except ImportError:
+    # Python 2.6
+    pass
 
 
 def pypy():
@@ -134,7 +142,11 @@ def __iter__(self):
 
 class TestSearchCommandsApp(TestCase):
 
-    app_root = os.path.join(project_root, 'examples', 'searchcommands_app', 'build', 'searchcommands_app')
+    try:
+        app_root = os.path.join(project_root, 'examples', 'searchcommands_app', 'build', 'searchcommands_app')
+    except NameError:
+        # SKip if Python 2.6
+        pass
 
     def setUp(self):
         if not os.path.isdir(TestSearchCommandsApp.app_root):
@@ -388,17 +400,18 @@ def _run_command(self, name, action=None, phase=None, protocol=2):
             compressed_file = recording.input_file
             uncompressed_file = os.path.splitext(recording.input_file)[0]
             try:
-                with gzip.open(compressed_file, 'rb') as ifile, io.open(uncompressed_file, 'wb') as ofile:
-                    b = bytearray(io.DEFAULT_BUFFER_SIZE)
-                    n = len(b)
-                    while True:
-                        count = ifile.readinto(b)
-                        if count == 0:
-                            break
-                        if count < n:
-                            ofile.write(b[:count])
-                            break
-                        ofile.write(b)
+                with gzip.open(compressed_file, 'rb') as ifile:
+                    with io.open(uncompressed_file, 'wb') as ofile:
+                        b = bytearray(io.DEFAULT_BUFFER_SIZE)
+                        n = len(b)
+                        while True:
+                            count = ifile.readinto(b)
+                            if count == 0:
+                                break
+                            if count < n:
+                                ofile.write(b[:count])
+                                break
+                            ofile.write(b)
                 with io.open(uncompressed_file, 'rb') as ifile:
                     process = Popen(recording.get_args(command), stdin=ifile, stderr=PIPE, stdout=PIPE)
                     output, errors = process.communicate()