Search command example/tests update + fix to boolean value conversion issue

Author: David Noble

examples/searchcommands_app/bin/countmatches.py

@@ -41,7 +41,7 @@ class CountMatchesCommand(StreamingCommand):
     ## Example
 
     ```
-    countmatches fieldname=word_count pattern="\w+" some_text_field
+    | inputcsv tweets.csv | countmatches fieldname=word_count pattern=\w+ text
     ```
 
     Counts the number of words in `some_text_field` and stores the result in

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>
+        duration=<execution-period> [seed=<
 
     ##Description
 
@@ -81,13 +81,14 @@ class SimulateCommand(GeneratingCommand):
 
     seed = Option(
         doc='''**Syntax:** **seed=***<string>*
-        **Description:** Value for initializing the random number generator ''',
-        require=False)
+        **Description:** Value for initializing the random number generator ''')
 
     def generate(self):
         """ Yields one random record at a time for the duration of `duration` """
         self.logger.debug('SimulateCommand: %s' % self)  # log command line
         if not self.records:
+            if self.seed is not None:
+                random.seed(self.seed)
             self.records = [record for record in csv.DictReader(self.csv_file)]
             self.lambda_value = 1.0 / (self.rate / float(self.interval))
         duration = self.duration

examples/searchcommands_scaffolding/default/commands.conf

@@ -4,3 +4,4 @@
 [%(command.lower()]
 filename = %(command.lower()).py
 supports_getinfo = true
+supports_rawargs = true

splunklib/searchcommands/search_command.py

@@ -156,8 +156,7 @@ def process(self, args=argv, input_file=stdin, output_file=stdout):
                 return
             self._configuration = ConfigurationSettings(self)
             if self.show_configuration:
-                self.logger.debug(str(self.configuration))
-                self.messages.append('info_message', str(self.configuration))
+                self.messages.append('info_message', str(self._configuration))
             writer = csv.DictWriter(
                 output_file, self, self.configuration.keys(), mv_delimiter=',')
             writer.writerow(self.configuration.items())

splunklib/searchcommands/validators.py

@@ -37,11 +37,11 @@ class Boolean(Validator):
         't': True, 'f': False,
         'true': True, 'false': False,
         'y': True, 'n': False,
-        'yes': True, 'No': False
+        'yes': True, 'no': False
     }
 
     def __call__(self, value):
-        if not isinstance(value, bool):
+        if not (value is None or isinstance(value, bool)):
             value = str(value).lower()
             if value not in Boolean.truth_values:
                 raise ValueError('Unrecognized truth value: %s' % value)
@@ -155,18 +155,8 @@ def __init__(self, *args):
         self.membership = args
 
     def __call__(self, value):
-        value = str(value)
-        if value not in self.membership:
-            raise ValueError('Unrecognized value: %s' % value)
+        if value is not None:
+            value = str(value)
+            if value not in self.membership:
+                raise ValueError('Unrecognized value: %s' % value)
         return value
-
-
-class String(Validator):
-    """ TODO: Documentation
-
-    """
-    def __call__(self, value):
-        return str(value)
-
-    def format(self, value):
-        return str(value)