Resolves DVPL-3352

splunklib.searchcommands | Eliminate field name existence checking

CHANGE
Code elimination verified against unit tests

Signed-off-by: David Noble <[email protected]>

Author: David Noble

examples/searchcommands_app/bin/countmatches.py

@@ -19,6 +19,7 @@
 from splunklib.searchcommands import \
     dispatch, StreamingCommand, Configuration, Option, validators
 
+
 @Configuration()
 class CountMatchesCommand(StreamingCommand):
     """ Counts the number of non-overlapping matches to a regular expression in

splunklib/searchcommands/search_command.py

@@ -154,7 +154,7 @@ def process(self, args=argv, input_file=stdin, output_file=stdout):
             ConfigurationSettings, operation, args, reader = self._prepare(
                 args, input_file=None)
             try:
-                self.parser.parse(args, self, 'ANY')
+                self.parser.parse(args, self)
             except (SyntaxError, ValueError) as e:
                 writer = csv.DictWriter(output_file, self, fieldnames=['ERROR'])
                 writer.writerow({'ERROR': e})
@@ -174,7 +174,7 @@ def process(self, args=argv, input_file=stdin, output_file=stdout):
                 args, input_file)
 
             try:
-                self.parser.parse(args, self, 'ANY')
+                self.parser.parse(args, self)
             except (SyntaxError, ValueError) as e:
                 self.messages.append("error_message", e)
                 self.messages.write(output_file)

splunklib/searchcommands/search_command_internals.py

@@ -209,7 +209,7 @@ class SearchCommandParser(object):
     setting the built-in `log_level` immediately changes the `log_level`.
 
     """
-    def parse(self, argv, command, fieldnames='ANY'):
+    def parse(self, argv, command):
         """ Splits an argument list into an options dictionary and a fieldname
         list.
 
@@ -266,33 +266,8 @@ def parse(self, argv, command, fieldnames='ANY'):
 
         # Parse field names
 
-        selected_fields = command_args.group('fieldnames').split()
-
-        if isinstance(fieldnames, str):
-            if fieldnames != 'ANY':
-                raise ValueError(
-                    'Illegal argument to %s.parse method: fieldnames=%s' %
-                    (type(self).__name__, fieldnames))
-            command.fieldnames = selected_fields
-
-        elif fieldnames:
-            undefined_fields = []
-            for name in selected_fields:
-                if not name in fieldnames:
-                    undefined_fields += [name]
-            if len(undefined_fields) > 0:
-                raise ValueError(
-                    'Unrecognized field(s): %s' % ', '.join(undefined_fields))
-            command.fieldnames = selected_fields
-
-        elif len(selected_fields) > 0:
-            raise ValueError(
-                'Command does not accept field names, but %s found: %s' % (
-                    'one was' if len(selected_fields) == 1 else 'some were',
-                    ', '.join(selected_fields)))
-
-        command.logger.debug(
-            'Parsed %s: %s' % (type(command).__name__, command))
+        command.fieldnames = command_args.group('fieldnames').split()
+        command.logger.debug('%s: %s' % (type(command).__name__, command))
         return
 
     @classmethod

tests/test_searchcommands_app.py

@@ -224,15 +224,16 @@ def test_command_parser(self):
             'integer=10',
             'optionname=foo_bar',
             'regularexpression="\\\\w+"',
-            'set=foo']
+            'set=foo',
+            'show_configuration=true']
         fields = ['field_1', 'field_2', 'field_3']
 
         command = StubbedStreamingCommand()  # All options are required
         parser.parse(options + fields, command)
         command_line = str(command)
 
         self.assertEqual(
-            'stubbedstreaming boolean=true duration=10 fieldname="word_count" file=%s integer=10 optionname="foo_bar" regularexpression="\\\\w+" set="foo" field_1 field_2 field_3' % encoder.encode(file_path),
+            'stubbedstreaming boolean=true duration=10 fieldname="word_count" file=%s integer=10 optionname="foo_bar" regularexpression="\\\\w+" set="foo" show_configuration=true field_1 field_2 field_3' % encoder.encode(file_path),
             command_line)
 
         for option in options: