Modify create_event() to only return fields that are set on event message

Author: borntyping

README.rst

@@ -70,6 +70,12 @@ Requirements
 Changelog
 ---------
 
+Version 6.0.0
+^^^^^^^^^^^^^
+
+* ``riemann_client.client.Client.create_dict`` only returns event fields that are set on the Protocol Buffers ``Event`` object
+* ``riemann-client send ...``` only outputs fields that were set on the sent message
+
 Version 5.1.0
 ^^^^^^^^^^^^^
 

riemann_client/__init__.py

@@ -1,4 +1,4 @@
 """A Python Riemann client and command line tool"""
 
-__version__ = '5.1.1'
+__version__ = '6.0.0'
 __author__ = 'Sam Clements <sam.clements@datasift.com>'

riemann_client/client.py

@@ -124,19 +124,17 @@ def create_dict(event):
         :param event: A protocol buffer ``Event`` object
         :returns: A dictionary of event attributes
         """
-        return {
-            'time': event.time,
-            'state': event.state,
-            'host': event.host,
-            'description': event.description,
-            'service': event.service,
-            'tags': list(event.tags),
-            'ttl': event.ttl,
-            'attributes': dict(((a.key, a.value) for a in event.attributes)),
-            'metric_f': event.metric_f,
-            'metric_d': event.metric_d,
-            'metric_sint64': event.metric_sint64
-        }
+
+        data = dict()
+
+        for descriptor, value in event.ListFields():
+            if descriptor.name == 'tags':
+                value = list(value)
+            elif descriptor.name == 'attributes':
+                value = dict(((a.key, a.value) for a in value))
+            data[descriptor.name] = value
+
+        return data
 
     def send_query(self, query):
         """Sends a query to the Riemann server

riemann_client/tests/test_riemann_command.py

@@ -16,34 +16,16 @@ def run_cli(args):
     return result
 
 
-def strip_whitespace(string):
+def strip(string):
     return re.sub('\s+', '', string)
 
 
-def compare_output(args, expected):
-    output = strip_whitespace(run_cli(args).output)
-    expected_output = strip_whitespace(expected)
-    return output == expected_output
+def assert_output_eq(args, expected):
+    assert strip(run_cli(args).output) == strip(expected)
 
 
-EMPTY_MESSAGE = """{
-  "attributes": {},
-  "description": "",
-  "host": "%s",
-  "metric_d": 0,
-  "metric_f": 0,
-  "metric_sint64": 0,
-  "service": "",
-  "state": "",
-  "tags": [],
-  "time": 0,
-  "ttl": 0
-}
-"""
-
-
-def test_send_blank():
-    assert compare_output(['send'], EMPTY_MESSAGE % socket.gethostname())
+def test_send_empty_message():
+    assert_output_eq(['send'], '{"host": "%s"}' % socket.gethostname())
 
 
 POPULATED_MESSAGE = """{
@@ -52,9 +34,7 @@ def test_send_blank():
   },
   "description": "description",
   "host": "%s",
-  "metric_d": 0,
   "metric_f": 11.1,
-  "metric_sint64": 0,
   "service": "service",
   "state": "state",
   "tags": [
@@ -63,11 +43,11 @@ def test_send_blank():
   "time": 1408030991,
   "ttl": 120
 }
-"""
+""" % socket.gethostname()
 
 
 def test_send():
-    assert compare_output([
+    assert_output_eq([
         'send',
         '--attribute', 'key=value',
         '--description', 'description',
@@ -77,11 +57,11 @@ def test_send():
         '--tag', 'tag',
         '--time', '1408030991',
         '--ttl', '120'
-    ], POPULATED_MESSAGE % socket.gethostname())
+    ], POPULATED_MESSAGE)
 
 
 def test_send_short():
-    assert compare_output([
+    assert_output_eq([
         'send',
         '-a', 'key=value',
         '-d', 'description',
@@ -91,8 +71,8 @@ def test_send_short():
         '-t', 'tag',
         '-T', '1408030991',
         '-l', '120'
-    ], POPULATED_MESSAGE % socket.gethostname())
+    ], POPULATED_MESSAGE)
 
 
 def test_query():
-    assert compare_output(['query', 'true'], '[]')
+    assert_output_eq(['query', 'true'], '[]')

setup.py

@@ -11,7 +11,7 @@
 
 setuptools.setup(
     name='riemann-client',
-    version='5.1.1',
+    version='6.0.0',
 
     author="Sam Clements",
     author_email="sam.clements@datasift.com",