Tox and pytest

Author: amysutedja

.gitignore

@@ -28,4 +28,6 @@ examples/searchcommands_app/package/default/commands.conf
 examples/searchcommands_app/package/lib/splunklib
 tests/searchcommands/apps/app_with_logging_configuration/*.log
 *.observed
-venv/
+venv/
+.tox
+test-reports/

setup.py

@@ -36,7 +36,7 @@ def run_test_suite():
     def mark_failed():
         global failed
         failed = True
-    
+
     class _TrackingTextTestResult(unittest._TextTestResult):
         def addError(self, test, err):
             unittest._TextTestResult.addError(self, test, err)
@@ -50,14 +50,14 @@ class TrackingTextTestRunner(unittest.TextTestRunner):
         def _makeResult(self):
             return _TrackingTextTestResult(
                 self.stream, self.descriptions, self.verbosity)
-        
+
     original_cwd = os.path.abspath(os.getcwd())
     os.chdir('tests')
     suite = unittest.defaultTestLoader.discover('.')
     runner = TrackingTextTestRunner(verbosity=2)
     runner.run(suite)
     os.chdir(original_cwd)
-    
+
     return failed
 
 
@@ -205,7 +205,7 @@ def run(self):
             target = os.path.join('build', tarball)
 
             shutil.copyfile(source, target)
-            
+
         return
 
 setup(

tests/searchcommands/test_internals_v1.py

@@ -24,7 +24,12 @@
 
 from contextlib import closing
 from splunklib.six.moves import cStringIO as StringIO
-from itertools import izip
+
+try:
+    from itertools import izip  # python 2
+except ImportError:
+    from builtins import zip as izip  # python 3
+
 from unittest import main, TestCase
 
 import os

tests/searchcommands/test_searchcommands_app.py

@@ -29,7 +29,22 @@
 from collections import namedtuple
 from splunklib.six.moves import cStringIO as StringIO
 from datetime import datetime
-from itertools import ifilter, imap, izip
+
+try:
+    from itertools import ifilter  # python 2
+except ImportError:
+    from builtins import filter as ifilter  # python 3
+
+try:
+    from itertools import imap  # python 2
+except ImportError:
+    from builtins import map as imap  # python 3
+
+try:
+    from itertools import izip  # python 2
+except ImportError:
+    from builtins import zip as izip  # python 3
+
 from subprocess import PIPE, Popen
 from splunklib import six
 
@@ -190,7 +205,7 @@ def test_generatehello_as_unit(self):
         self.assertEqual(0, exit_status, msg=six.text_type(errors))
         self.assertEqual('', errors)
         self._compare_chunks(expected, output, time_sensitive=False)
- 
+
         return
 
     @skipUnless(pypy(), 'Skipping TestSearchCommandsApp.test_pypygeneratetext_as_unit because pypy is not on PATH.')
@@ -426,7 +441,7 @@ def _run_command(self, name, action=None, phase=None, protocol=2):
 
         return expected, output, errors, process.returncode
 
-    _Chunk = namedtuple('Chunk', (b'metadata', b'body'))
+    _Chunk = namedtuple('Chunk', 'metadata body')
 
 
 if __name__ == "__main__":

tests/test_examples.py

@@ -22,7 +22,10 @@
 
 import io
 
-import unittest2
+try:
+    import unittest
+except ImportError:
+    import unittest2 as unittest
 
 from tests import testlib
 
@@ -32,9 +35,9 @@
 
 def check_multiline(testcase, first, second, message=None):
     """Assert that two multi-line strings are equal."""
-    testcase.assertTrue(isinstance(first, six.string_types), 
+    testcase.assertTrue(isinstance(first, six.string_types),
         'First argument is not a string')
-    testcase.assertTrue(isinstance(second, six.string_types), 
+    testcase.assertTrue(isinstance(second, six.string_types),
         'Second argument is not a string')
     # Unix-ize Windows EOL
     first = first.replace("\r", "")
@@ -43,7 +46,7 @@ def check_multiline(testcase, first, second, message=None):
         testcase.fail("Multiline strings are not equal: %s" % message)
 
 
-# Run the given python script and return its exit code. 
+# Run the given python script and return its exit code.
 def run(script, stdin=None, stdout=PIPE, stderr=None):
     process = start(script, stdin, stdout, stderr)
     process.communicate()
@@ -74,7 +77,7 @@ def setUp(self):
         # Ignore result, it might already exist
         run("index.py create sdk-tests")
 
-    @unittest2.skipIf(six.PY3, "Async needs work to support Python 3")
+    @unittest.skipIf(six.PY3, "Async needs work to support Python 3")
     def test_async(self):
         result = run("async/async.py sync")
         self.assertEquals(result, 0)
@@ -121,12 +124,12 @@ def test_event_types(self):
         self.check_commands(
             "event_types.py --help",
             "event_types.py")
-        
+
     def test_fired_alerts(self):
         self.check_commands(
             "fired_alerts.py --help",
             "fired_alerts.py")
-        
+
     def test_follow(self):
         self.check_commands("follow.py --help")
 
@@ -140,7 +143,7 @@ def test_handlers(self):
 
         # Run the cert handler example with a bad cert file, should error.
         result = run(
-            "handlers/handlers_certs.py --ca_file=handlers/cacert.bad.pem", 
+            "handlers/handlers_certs.py --ca_file=handlers/cacert.bad.pem",
             stderr=PIPE)
         self.assertNotEquals(result, 0)
 
@@ -185,7 +188,7 @@ def test_inputs(self):
         self.check_commands(
             "inputs.py --help",
             "inputs.py")
-        
+
     def test_job(self):
         self.check_commands(
             "job.py --help",
@@ -197,7 +200,7 @@ def test_kvstore(self):
         self.check_commands(
             "kvstore.py --help",
             "kvstore.py")
-        
+
     def test_loggers(self):
         self.check_commands(
             "loggers.py --help",
@@ -210,7 +213,7 @@ def test_saved_searches(self):
         self.check_commands(
             "saved_searches.py --help",
             "saved_searches.py")
-    
+
     def test_saved_search(self):
         temp_name = testlib.tmpname()
         self.check_commands(
@@ -227,7 +230,7 @@ def test_search(self):
         self.check_commands(
             "search.py --help",
             ["search.py", "search * | head 10"],
-            ["search.py", 
+            ["search.py",
              "search * | head 10 | stats count", '--output_mode=csv'])
 
     def test_spcmd(self):
@@ -271,7 +274,7 @@ def test_analytics(self):
         # Before we start, we'll clean the index
         index = service.indexes["sdk-test"]
         index.clean()
-        
+
         tracker.track("test_event", distinct_id="abc123", foo="bar", abc="123")
         tracker.track("test_event", distinct_id="123abc", abc="12345")
 
@@ -280,8 +283,8 @@ def test_analytics(self):
 
         # Now, we create a retriever to retrieve the events
         retriever = analytics.output.AnalyticsRetriever(
-            "sdk-test", self.opts.kwargs, index = "sdk-test")    
-        
+            "sdk-test", self.opts.kwargs, index = "sdk-test")
+
         # Assert applications
         applications = retriever.applications()
         self.assertEquals(len(applications), 1)
@@ -319,17 +322,17 @@ def test_analytics(self):
             count = value["count"]
             self.assertTrue(name in list(expected_property_values.keys()))
             self.assertEqual(count, expected_property_values[name])
-            
+
         # Assert event over time
         over_time = retriever.events_over_time(
             time_range = analytics.output.TimeRange.MONTH)
         self.assertEquals(len(over_time), 1)
         self.assertEquals(len(over_time["test_event"]), 1)
         self.assertEquals(over_time["test_event"][0]["count"], 2)
 
-        # Now that we're done, we'll clean the index 
+        # Now that we're done, we'll clean the index
         index.clean()
- 
+
 if __name__ == "__main__":
     os.chdir("../examples")
     try:

tox.ini

@@ -0,0 +1,39 @@
+[tox]
+envlist = py27,py35,py36,py37,py38
+skipsdist = {env:TOXBUILD:false}
+
+[testenv:pep8]
+deps = flake8
+       flake8-import-order
+       flake8-blind-except
+       flake8-builtins
+       flake8-docstrings
+       flake8-rst-docstrings
+       flake8-logging-format
+       six
+commands = flake8
+
+[flake8]
+exclude = .tox
+# If you need to ignore some error codes in the whole source code
+# you can write them here
+# ignore = D100,D101
+show-source = true
+enable-extensions=G
+application-import-names = splunk-sdk-python
+
+[testenv]
+passenv = LANG
+setenv = SPLUNK_HOME=/opt/splunk
+         INPUT_EXAMPLE_UPLOAD=/opt/splunk/var/log/splunk/splunkd_ui_access.log
+whitelist_externals = true
+deps = pytest
+       xmlrunner
+       unittest2
+       unittest-xml-reporting
+
+distdir = build
+#changedir = tests
+#commands_pre = python setup.py dist build
+commands =
+    {env:TOXBUILD:python -m pytest --junitxml=../test-reports/junit-{envname}.xml}