SCPV1 Configuration settings must now be set explicitly from code

David Noble · David Noble · commit 10692ef4bd02 · 2015-10-10T17:33:58.000-07:00
This ensures that settings will be taken from conf unless explicitly overridden in code. Affected settings:

GeneratingCommand
* generates_timeorder
* local
* retainsevents
* streaming
StreamingCommand
* clear_required_fields
* local
diff --git a/splunklib/searchcommands/generating_command.py b/splunklib/searchcommands/generating_command.py
@@ -221,7 +221,7 @@ class ConfigurationSettings(SearchCommand.ConfigurationSettings):
 
         # region SCP v1 Properties
 
-        generates_timeorder = ConfigurationSetting(value=False, doc='''
+        generates_timeorder = ConfigurationSetting(doc='''
             :const:`True`, if the command generates new events.
 
             Default: :const:`False`
@@ -230,7 +230,7 @@ class ConfigurationSettings(SearchCommand.ConfigurationSettings):
 
             ''')
 
-        local = ConfigurationSetting(value=False, doc='''
+        local = ConfigurationSetting(doc='''
             :const:`True`, if the command should run locally on the search head.
 
             Default: :const:`False`
@@ -239,7 +239,7 @@ class ConfigurationSettings(SearchCommand.ConfigurationSettings):
 
             ''')
 
-        retainsevents = ConfigurationSetting(value=False, doc='''
+        retainsevents = ConfigurationSetting(doc='''
             :const:`True`, if the command retains events the way the sort, dedup, and cluster commands do, or whether it
             transforms them the way the stats command does.
 
@@ -249,7 +249,7 @@ class ConfigurationSettings(SearchCommand.ConfigurationSettings):
 
             ''')
 
-        streaming = ConfigurationSetting(value=True, doc='''
+        streaming = ConfigurationSetting(doc='''
             :const:`True`, if the command is streamable.
 
             Default: :const:`True`
diff --git a/splunklib/searchcommands/streaming_command.py b/splunklib/searchcommands/streaming_command.py
@@ -78,7 +78,7 @@ class ConfigurationSettings(SearchCommand.ConfigurationSettings):
 
         # region SCP v1 properties
 
-        clear_required_fields = ConfigurationSetting(value=False, doc='''
+        clear_required_fields = ConfigurationSetting(doc='''
             :const:`True`, if required_fields represent the *only* fields required.
 
             If :const:`False`, required_fields are additive to any fields that may be required by subsequent commands.
@@ -90,7 +90,7 @@ class ConfigurationSettings(SearchCommand.ConfigurationSettings):
 
             ''')
 
-        local = ConfigurationSetting(value=False, doc='''
+        local = ConfigurationSetting(doc='''
             :const:`True`, if the command should run locally on the search head.
 
             Default: :const:`False`
diff --git a/tests/searchcommands/recordings/scpv1/Splunk-6.3/countmatches.getinfo.output b/tests/searchcommands/recordings/scpv1/Splunk-6.3/countmatches.getinfo.output
@@ -1,3 +1,3 @@
 
-streaming,__mv_streaming,local,__mv_local
-1,,0,
+streaming,__mv_streaming
+1,
diff --git a/tests/searchcommands/recordings/scpv1/Splunk-6.3/generatehello.getinfo.output b/tests/searchcommands/recordings/scpv1/Splunk-6.3/generatehello.getinfo.output
@@ -1,3 +1,3 @@
 
-generates_timeorder,__mv_generates_timeorder,generating,__mv_generating,local,__mv_local,retainsevents,__mv_retainsevents,streaming,__mv_streaming
-0,,1,,0,,0,,1,
+generating,__mv_generating
+1,
diff --git a/tests/searchcommands/recordings/scpv1/Splunk-6.3/pypygeneratetext.getinfo.output b/tests/searchcommands/recordings/scpv1/Splunk-6.3/pypygeneratetext.getinfo.output
@@ -1,3 +1,3 @@
 
-generates_timeorder,__mv_generates_timeorder,generating,__mv_generating,local,__mv_local,retainsevents,__mv_retainsevents,streaming,__mv_streaming
-0,,1,,0,,0,,1,
+generating,__mv_generating
+1,
diff --git a/tests/searchcommands/recordings/scpv1/Splunk-6.3/sum.getinfo.map.output b/tests/searchcommands/recordings/scpv1/Splunk-6.3/sum.getinfo.map.output
@@ -1,3 +1,3 @@
 
-streaming,__mv_streaming,local,__mv_local
-1,,0,
+streaming,__mv_streaming
+1,
diff --git a/tests/searchcommands/test_configuration_settings.py b/tests/searchcommands/test_configuration_settings.py
@@ -46,14 +46,15 @@ def generate(self):
 
         self.assertTrue(
             [(name, value) for name, value in command.configuration.iteritems()],
-            [('generates_timeorder', False), ('generating', True), ('retainsevents', False), ('streaming', True)])
+            [('generating', True)])
 
-        self.assertIs(command.configuration.generates_timeorder, False)
+        self.assertIs(command.configuration.generates_timeorder, None)
         self.assertIs(command.configuration.generating, True)
-        self.assertIs(command.configuration.retainsevents, False)
-        self.assertIs(command.configuration.streaming, True)
+        self.assertIs(command.configuration.retainsevents, None)
+        self.assertIs(command.configuration.streaming, None)
 
         command.configuration.generates_timeorder = True
+        command.configuration.local = True
         command.configuration.retainsevents = True
         command.configuration.streaming = True
 
@@ -68,7 +69,7 @@ def generate(self):
 
         self.assertEqual(
             [(name, value) for name, value in command.configuration.iteritems()],
-            [('generates_timeorder', True), ('generating', True), ('local', False), ('retainsevents', True),
+            [('generates_timeorder', True), ('generating', True), ('local', True), ('retainsevents', True),
              ('streaming', True)])
 
         command = TestCommand()
@@ -114,10 +115,10 @@ def stream(self, records):
 
         self.assertEqual(
             [(name, value) for name, value in command.configuration.iteritems()],
-            [('local', False), ('streaming', True)])
+            [('streaming', True)])
 
-        self.assertIs(command.configuration.clear_required_fields, False)
-        self.assertIs(command.configuration.local, False)
+        self.assertIs(command.configuration.clear_required_fields, None)
+        self.assertIs(command.configuration.local, None)
         self.assertIs(command.configuration.overrides_timeorder, None)
         self.assertIs(command.configuration.required_fields, None)
         self.assertIs(command.configuration.streaming, True)

-Original file line number
+Diff line change
@@ @@ -1,3 +1,3 @@ @@
 -streaming,__mv_streaming,local,__mv_local
 -1,,0,
 +streaming,__mv_streaming
 +1,