Workaround for bug in Splunk 5.0: restrictToHost is removed from a TCP input unless always specified on an update.

Now Input.update implicitly adds restrictToHost onto the dict of things to update if it's not already there and it needs to be.

Author: Frederick Ross

splunklib/client.py

@@ -1683,19 +1683,26 @@ def __init__(self, service, path, kind=None, **kwargs):
             self.kind = 'splunktcp'
 
     def update(self, **kwargs):
-        if 'restrictToHost' in kwargs and self.service.splunk_version < (5,):
+        if self.kind not in ['tcp', 'splunktcp', 'tcp/raw', 'tcp/cooked']:
+            result = super(Input, self).update(**kwargs)
+            return result
+        elif 'restrictToHost' in kwargs and self.service.splunk_version < (5,):
             raise IllegalOperationException("Updating restrictToHost has no effect before Splunk 5.0")
-        port = self.name.split(':', 1)[-1]
-        result = super(Input, self).update(**kwargs)
-        if 'restrictToHost' in kwargs:
+        else:
+            port = self.name.split(':', 1)[-1]
+            new_kwargs = kwargs.copy()
+            if 'restrictToHost' not in new_kwargs and ':' in self.name:
+                new_kwargs['restrictToHost'] = self['restrictToHost']
+            result = super(Input, self).update(**new_kwargs)
             if self.path.endswith('/'):
                 base_path, name = self.path.rsplit('/', 2)[:-1]
             else:
                 base_path, name = self.path.rsplit('/', 1)
-            self.path = base_path + '/' + kwargs['restrictToHost'] + ':' + port
-        return result
-
-
+            if 'restrictToHost' in new_kwargs:
+                self.path = base_path + '/' + new_kwargs['restrictToHost'] + ':' + port
+            else:
+                self.path = base_path + '/' + port
+            return result
 
 # Inputs is a "kinded" collection, which is a heterogenous collection where
 # each item is tagged with a kind, that provides a single merged view of all

tests/test_input.py

@@ -98,6 +98,13 @@ def test_update_restrictToHost(self):
                 self.check_entity(boris)
                 boris.delete()
 
+    def test_update_nonrestrictToHost(self):
+        for kind in ['tcp', 'splunktcp']:
+            input = self.service.inputs.create(kind, str(self.base_port), restrictToHost='boris')
+            input.update(host='meep')
+            input.refresh()
+            self.assertTrue(input.name.startswith('boris'))
+
 class TestRead(testlib.SDKTestCase):
     def test_read(self):
         inputs = self.service.inputs
@@ -165,14 +172,18 @@ def setUp(self):
         inputs = self.service.inputs
         tcp_port = str(highest_port(self.service, 10000, 'tcp', 'splunktcp')+1)
         udp_port = str(highest_port(self.service, 10000, 'udp')+1)
+        restricted_tcp_port = str(highest_port(self.service, int(tcp_port)+1, 'tcp', 'splunktcp')+1)
         test_inputs = [{'kind': 'tcp', 'name': tcp_port, 'host': 'sdk-test'},
-                       {'kind': 'udp', 'name': udp_port, 'host': 'sdk-test'}]
+                       {'kind': 'udp', 'name': udp_port, 'host': 'sdk-test'},
+                       {'kind': 'tcp', 'name': 'boris:' + restricted_tcp_port, 'host': 'sdk-test'}]
         self._test_entities = {}
 
         self._test_entities['tcp'] = \
             inputs.create('tcp', str(tcp_port), host='sdk-test')
         self._test_entities['udp'] = \
             inputs.create('udp', str(udp_port), host='sdk-test')
+        self._test_entities['restrictedTcp'] = \
+            inputs.create('tcp', restricted_tcp_port, restrictToHost='boris')
 
     def tearDown(self):
         super(TestInput, self).tearDown()
@@ -232,11 +243,10 @@ def test_update(self):
         inputs = self.service.inputs
         for entity in self._test_entities.itervalues():
             kind, name = entity.kind, entity.name
-            kwargs = {'host': 'foo', 'sourcetype': 'bar'}
+            kwargs = {'host': 'foo'}
             entity.update(**kwargs)
             entity.refresh()
             self.assertEqual(entity.host, kwargs['host'])
-            self.assertEqual(entity.sourcetype, kwargs['sourcetype'])
 
     def test_delete(self):
         inputs = self.service.inputs