tests/test_searchcommands_app improvements + examples/searchcommands_app documentation update

Author: David Noble

examples/searchcommands_app/README.md

@@ -26,8 +26,7 @@ The app is tested on Splunk 5 and 6. Here is its manifest:
    │           └── default.xml ..
    ├── app.conf ................. Used by Splunk to maintain app state [1]
    ├── commands.conf ............ Search command configuration [2]
-   ├── logging.conf ............. Python logging[3] configuration in ConfigParser[4] format
-   └── logging.debug.conf ....... Logs to app root directory as well as the Splunk log file
+   └── logging.conf ............. Python logging[3] configuration in ConfigParser[4] format
 ```
 **References**  
 [1] [app.conf](http://docs.splunk.com/Documentation/Splunk/6.0.1/Admin/Appconf app.conf)  

examples/searchcommands_app/bin/simulate.py

@@ -31,7 +31,7 @@ class SimulateCommand(GeneratingCommand):
     ##Syntax
 
     simulate csv=<path> rate=<expected-event-count> interval=<sampling-period>
-        duration=<execution-period> [seed=<
+        duration=<execution-period> [seed=<string>]
 
     ##Description
 
@@ -44,8 +44,8 @@ class SimulateCommand(GeneratingCommand):
     ##Example
 
     ```
-    | simulate csv="tweets.csv" rate=200 interval=00:00:01 duration=00:00:30 |
-    countmatches fieldname=word_count pattern=\w+ text |
+    | simulate csv=population.csv rate=200 interval=00:00:01 duration=00:00:30 |
+    countmatches fieldname=word_count pattern="\\w+" text |
     stats mean(word_count) stdev(word_count)
     ```
 

examples/searchcommands_app/bin/sum.py

@@ -24,9 +24,23 @@
 class SumCommand(ReportingCommand):
     """ Computes the sum of a set of fields
 
-    **Syntax:** sum total=*<fieldname>* [*<fieldname>*]...
-    **Description:** The total produced is sum(sum(fieldname, 1, n), 1, N) where
-    n = number of fields, N = number of records.
+    ##Syntax
+
+    sum total=*<fieldname>* [*<fieldname>*]...
+
+    ##Description:
+
+    The total produced is sum(sum(fieldname, 1, n), 1, N) where n = number of
+    fields, N = number of records.
+
+    ##Example
+
+    ```
+    index = _internal | head 200 | sum total=lines linecount
+    ```
+
+    This example computes the total linecount in the first 200 records in the
+    _internal index.
 
     """
     total = Option(

examples/searchcommands_app/default/logging.debug.conf

@@ -120,6 +120,38 @@ def test_command_parser(self):
             command_line)
         return
 
+    def test_option_logging_configuration(self):
+        self._run(
+            'simulate', [
+                'csv=%s' % TestSearchCommandsApp._data_file(
+                    "input/population.csv"),
+                'duration=00:00:10',
+                'interval=00:00:01',
+                'rate=200',
+                'seed=%s' % TestSearchCommandsApp._seed,
+                'logging_configuration=logging.conf'],
+            __GETINFO__=(
+                'input/population.csv',
+                'output/test_option_logging_configuration.csv',
+                'log/test_option_logging_configuration.log'))
+        return
+
+    def test_option_logging_level(self):
+        self._run(
+            'simulate', [
+                'csv=%s' % TestSearchCommandsApp._data_file(
+                    "input/population.csv"),
+                'duration=00:00:10',
+                'interval=00:00:01',
+                'rate=200',
+                'seed=%s' % TestSearchCommandsApp._seed,
+                'logging_level=ERROR'],
+            __GETINFO__=(
+                'input/population.csv',
+                'output/test_option_logging_level.csv',
+                'log/test_option_logging_level.log'))
+        return
+
     def test_option_show_configuration(self):
         self._run(
             'simulate', [
@@ -132,8 +164,8 @@ def test_option_show_configuration(self):
                 'show_configuration=true'],
             __GETINFO__=(
                 'input/population.csv',
-                'output/samples.csv',
-                'log/test_show_configuration.log'))
+                'output/test_option_show_configuration.csv',
+                'log/test_option_show_configuration.log'))
         return
 
     def test_generating_command_in_isolation(self):