Merge remote-tracking branch 'origin/smoke-tests' into use_output_redirect_for_modinput_tests

Author: zenmoto

.travis.yml

@@ -29,19 +29,18 @@ before_install:
     - export SPLUNK_HOME=`pwd`/splunk_home
     - mkdir -p $SPLUNK_HOME/var/log/splunk
 
+language: python
+
 env:
-    - SPLUNK_VERSION=7.0-sdk
-    - SPLUNK_VERSION=7.2-sdk
+    - SPLUNK_VERSION=7.3-sdk
     - SPLUNK_VERSION=8.0-sdk
 
-language: python
-
 python:
   - "2.7"
-  - "3.5"
+  - "3.7"
 
-install: "pip install unittest2"
+install: pip install tox-travis
 
 before_script: python setup.py build dist
 
-script: python setup.py test
+script: tox

Makefile

@@ -16,11 +16,16 @@ COMMITHASH := `git rev-parse --short HEAD 2>/dev/null`
 DATE := `date "+%FT%T%z"`
 
 .PHONY: all
-all: test
+all: build_app test
 
 init:
 	@echo "$(ATTN_COLOR)==> init $(NO_COLOR)"
 
+.PHONY: build_app
+build_app:
+	@echo "$(ATTN_COLOR)==> build_app $(NO_COLOR)"
+	@python setup.py build dist
+
 .PHONY: test
 test:
 	@echo "$(ATTN_COLOR)==> test $(NO_COLOR)"

README.md

@@ -161,7 +161,7 @@ To get help for an example, use the `--help` argument with an example:
 The Splunk SDK for Python contains a collection of unit tests. To run them, open a
 command prompt in the **/splunk-sdk-python** directory and enter:
 
-    make test
+    make
 
 You can also run individual test files, which are located in
 **/splunk-sdk-python/tests**. The following command explains how to run
@@ -172,7 +172,9 @@ a specific test:
 The test suite uses Python's standard library, the built-in `unittest`
 library, `pytest`, and `tox`.
 
-**Important Note:** The test run will fail unless the
+**Important Notes:**
+
+The test run will fail unless the
 [SDK App Collection](https://github.com/splunk/sdk-app-collection) is installed.
 
 You can exclude app-specific tests with the following command:
@@ -182,6 +184,10 @@ You can exclude app-specific tests with the following command:
 You can read more about our testing framework on
 [GitHub](https://github.com/splunk/splunk-sdk-python/tree/master/tests).
 
+In addition, the test run requires the searchcommands app to be built. The `make`
+command runs the tasks to do this, but more complex testing may require you to
+rebuild using `make build_app`.
+
 ## Repository
 
 <table>

examples/async/async.py

@@ -19,7 +19,6 @@
 # based systems like Eventlet.
 
 #### Main Code
-
 from __future__ import absolute_import
 from __future__ import print_function
 import sys, os, datetime
@@ -67,10 +66,10 @@ def main(argv):
     # of `urllib2`. Otherwise, import the stdlib version of `urllib2`.
     #
     # The reason for the funky import syntax is that Python imports
-    # are scoped to functions, and we need to make it global. 
+    # are scoped to functions, and we need to make it global.
     # In a real application, you would only import one of these.
     if is_async:
-        urllib2 = __import__('eventlet.green', globals(), locals(), 
+        urllib2 = __import__('eventlet.green', globals(), locals(),
                             ['urllib2'], -1).urllib2
     else:
         urllib2 = __import__("urllib2", globals(), locals(), [], -1)
@@ -143,12 +142,12 @@ def do_search(query):
         # and we can also ignore the result.
         for query in queries:
             do_search(query)
-    
+
     # Record the current time at the end of the benchmark,
     # and print the delta elapsed time.
     newtime = datetime.datetime.now()
     print("Elapsed Time: %s" % (newtime - oldtime))
-    
+
 
 ##### Custom `urllib2`-based HTTP handler
 
@@ -158,21 +157,21 @@ def request(url, message, **kwargs):
     body = message.get("body", "")
 
     # Setup the default headers.
-    head = { 
+    head = {
         "Content-Length": str(len(body)),
         "Host": host,
         "User-Agent": "http.py/1.0",
         "Accept": "*/*",
     }
 
     # Add in the passed in headers.
-    for key, value in message["headers"]: 
+    for key, value in message["headers"]:
         head[key] = value
 
     # Note the HTTP method we're using, defaulting
     # to `GET`.
     method = message.get("method", "GET")
-    
+
     # Note that we do not support proxies in this example
     # If running Python 2.7.9+, disable SSL certificate validation
     if sys.version_info >= (2, 7, 9):
@@ -181,7 +180,7 @@ def request(url, message, **kwargs):
     else:
         opener = urllib2.build_opener()
 
-    # Unfortunately, we need to use the hack of 
+    # Unfortunately, we need to use the hack of
     # "overriding" `request.get_method` to specify
     # a method other than `GET` or `POST`.
     request = urllib2.Request(url, body, head)
@@ -194,10 +193,10 @@ def request(url, message, **kwargs):
     except Exception as e:
         response = e
 
-    # Normalize the response to something the SDK expects, and 
+    # Normalize the response to something the SDK expects, and
     # return it.
     return {
-        'status': response.code, 
+        'status': response.code,
         'reason': response.msg,
         'headers': response.info().dict,
         'body': binding.ResponseReader(response)

examples/searchcommands_app/package/bin/countmatches.py

@@ -67,7 +67,7 @@ def stream(self, records):
         for record in records:
             count = 0
             for fieldname in self.fieldnames:
-                matches = pattern.findall(six.text_type(record[fieldname].decode("utf-8")))
+                matches = pattern.findall(six.text_type(six.ensure_binary(record[fieldname]).decode("utf-8")))
                 count += len(matches)
             record[self.fieldname] = count
             yield record

examples/searchcommands_app/package/default/logging.conf

@@ -71,16 +71,16 @@ propagate = 0
 keys = app, splunklib, stderr
 
 [handler_app]
-# Select this handler to log events to $SPLUNK_HOME/var/log/splunk/searchcommands_app.log
+# Select this handler to log events to searchcommands_app.log
 class = logging.handlers.RotatingFileHandler
 level = NOTSET
-args = ('%(SPLUNK_HOME)s/var/log/splunk/searchcommands_app.log', 'a', 524288000, 9, 'utf-8', True)
+args = ('searchcommands_app.log', 'a', 524288000, 9, 'utf-8', True)
 formatter = searchcommands
 
 [handler_splunklib]
-# Select this handler to log events to $SPLUNK_HOME/var/log/splunk/splunklib.log
+# Select this handler to log events to splunklib.log
 class = logging.handlers.RotatingFileHandler
-args = ('%(SPLUNK_HOME)s/var/log/splunk/splunklib.log', 'a', 524288000, 9, 'utf-8', True)
+args = ('splunklib.log', 'a', 524288000, 9, 'utf-8', True)
 level = NOTSET
 formatter = searchcommands
 

splunklib/searchcommands/reporting_command.py

@@ -253,7 +253,7 @@ def fix_up(cls, command):
                 cls._requires_preop = False
                 return
 
-            f = vars(command)[b'map']   # Function backing the map method
+            f = vars(command)['map']   # Function backing the map method
 
             # EXPLANATION OF PREVIOUS STATEMENT: There is no way to add custom attributes to methods. See [Why does
             # setattr fail on a method](http://stackoverflow.com/questions/7891277/why-does-setattr-fail-on-a-bound-method) for a discussion of this issue.
@@ -266,7 +266,7 @@ def fix_up(cls, command):
 
             # Create new StreamingCommand.ConfigurationSettings class
 
-            module = command.__module__ + b'.' + command.__name__ + b'.map'
+            module = command.__module__ + '.' + command.__name__ + '.map'
             name = b'ConfigurationSettings'
             bases = (StreamingCommand.ConfigurationSettings,)
 

tests/searchcommands/recordings/scpv1/Splunk-6.3/countmatches.execute.output.py3

@@ -0,0 +1 @@
+# TODO: Flesh this out

tests/searchcommands/recordings/scpv1/Splunk-6.3/sum.execute.map.output.py3

@@ -0,0 +1,3 @@
+
+total,__mv_total
+2147943.07810599,

tests/searchcommands/recordings/scpv1/Splunk-6.3/sum.execute.reduce.output.py3

@@ -0,0 +1,3 @@
+
+total,__mv_total
+2147943.07811,