Refactor query output formats to support single-line option

alertaclient/commands/cmd_query.py

@@ -21,9 +21,9 @@
 @click.option('--ids', '-i', metavar='UUID', multiple=True, help='List of alert IDs (can use short 8-char id)')
 @click.option('--query', '-q', 'query', metavar='QUERY', help='severity:"warning" AND resource:web')
 @click.option('--filter', '-f', 'filters', metavar='FILTER', multiple=True, help='KEY=VALUE eg. serverity=warning resource=web')
-@click.option('--tabular', 'display', flag_value='tabular', default=True, help='Tabular output')
-@click.option('--compact', 'display', flag_value='compact', help='Compact output')
-@click.option('--details', 'display', flag_value='details', help='Compact output with details')
+@click.option('--oneline', 'display', flag_value='oneline', default=True, help='Show alerts using table format')
+@click.option('--medium', 'display', flag_value='medium', help='Show important alert attributes')
+@click.option('--full', 'display', flag_value='full', help='Show full alert details')
 @click.pass_obj
 def cli(obj, ids, query, filters, display, from_date=None):
     """Query for alerts based on search filter criteria."""
@@ -50,13 +50,15 @@ def cli(obj, ids, query, filters, display, from_date=None):
         last_time = r['lastTime']
         auto_refresh = r['autoRefresh']
 
-        if display == 'tabular':
+        if display == 'oneline':
             headers = {'id': 'ID', 'lastReceiveTime': 'LAST RECEIVED', 'severity': 'SEVERITY', 'status': 'STATUS',
                        'duplicateCount': 'DUPL', 'customer': 'CUSTOMER', 'environment': 'ENVIRONMENT', 'service': 'SERVICE',
-                       'resource': 'RESOURCE', 'group': 'GROUP', 'event': 'EVENT', 'value': 'VALUE', 'text': 'TEXT'}
-            click.echo(tabulate([a.tabular('summary', timezone)
-                                 for a in alerts], headers=headers, tablefmt=obj['output']))
-        elif display in ['compact', 'details']:
+                       'resource': 'RESOURCE', 'group': 'GROUP', 'event': 'EVENT', 'value': 'VALUE', 'text': 'DESCRIPTION'}
+
+            data = [{k: v for k, v in a.tabular(timezone).items() if k in headers.keys()} for a in alerts]
+            click.echo(tabulate(data, headers=headers, tablefmt=obj['output']))
+
+        else:
             for alert in reversed(alerts):
                 color = COLOR_MAP.get(alert.severity, {'fg': 'white'})
                 click.secho('{}|{}|{}|{:5d}|{}|{:<5s}|{:<10s}|{:<18s}|{:12s}|{:16s}|{:12s}'.format(
@@ -73,7 +75,7 @@ def cli(obj, ids, query, filters, display, from_date=None):
                     alert.value or 'n/a'), fg=color['fg'])
                 click.secho('   |{}'.format(alert.text), fg=color['fg'])
 
-                if display == 'details':
+                if display == 'full':
                     click.secho('    severity   | {} -> {}'.format(alert.previous_severity,
                                                                    alert.severity), fg=color['fg'])
                     click.secho('    trend      | {}'.format(alert.trend_indication), fg=color['fg'])

alertaclient/models/alert.py

@@ -97,61 +97,33 @@ def parse(cls, json):
     def get_id(self, short=False):
         return self.id[:8] if short else self.id
 
-    def tabular(self, fields='all', timezone=None):
-        if fields == 'summary':
-            return {
-                'id': self.get_id(short=True),
-                'lastReceiveTime': DateTime.localtime(self.last_receive_time, timezone),
-                'severity': self.severity,
-                'status': self.status,
-                'duplicateCount': self.duplicate_count,
-                'customer': self.customer,
-                'environment': self.environment,
-                'service': ','.join(self.service),
-                'resource': self.resource,
-                'group': self.group,
-                'event': self.event,
-                'value': self.value,
-                'text': self.text
-            }
-        elif fields == 'details':
-            return {
-                'severity': '{} -> {}'.format(self.previous_severity, self.severity),
-                'trend': self.trend_indication,
-                'status': self.status,
-                'resource': self.resource,
-                'group': self.group,
-                'event': self.event,
-                'value': self.value,
-                'tags': ','.join(self.tags)
-            }
-        else:
-            return {
-                'id': self.id,
-                'resource': self.resource,
-                'event': self.event,
-                'environment': self.environment,
-                'severity': self.severity,
-                'correlate': self.correlate,
-                'status': self.status,
-                'service': ','.join(self.service),
-                'group': self.group,
-                'value': self.value,
-                'text': self.text,
-                'tags': ','.join(self.tags),
-                'attributes': self.attributes,
-                'origin': self.origin,
-                'type': self.event_type,
-                'createTime': DateTime.localtime(self.create_time, timezone),
-                'timeout': self.timeout,
-                'rawData': self.raw_data,
-                'customer': self.customer,
-                'duplicateCount': self.duplicate_count,
-                'repeat': self.repeat,
-                'previousSeverity': self.previous_severity,
-                'trendIndication': self.trend_indication,
-                'receiveTime': DateTime.localtime(self.receive_time, timezone),
-                'lastReceiveId': self.last_receive_id,
-                'lastReceiveTime': DateTime.localtime(self.last_receive_time, timezone),
-                'history': self.history
-            }
+    def tabular(self, timezone=None):
+        return {
+            'id': self.get_id(short=True),
+            'lastReceiveTime': DateTime.localtime(self.last_receive_time, timezone),
+            'severity': self.severity,
+            'status': self.status,
+            'duplicateCount': self.duplicate_count,
+            'customer': self.customer,
+            'environment': self.environment,
+            'service': ','.join(self.service),
+            'resource': self.resource,
+            'group': self.group,
+            'event': self.event,
+            'correlate': self.correlate,
+            'value': self.value,
+            'text': self.text,
+            'tags': ','.join(self.tags),
+            'attributes': self.attributes,
+            'origin': self.origin,
+            'type': self.event_type,
+            'createTime': DateTime.localtime(self.create_time, timezone),
+            'timeout': self.timeout,
+            'rawData': self.raw_data,
+            'repeat': self.repeat,
+            'previousSeverity': self.previous_severity,
+            'trendIndication': self.trend_indication,
+            'receiveTime': DateTime.localtime(self.receive_time, timezone),
+            'lastReceiveId': self.last_receive_id,
+            'history': self.history
+        }

alertaclient/models/history.py

@@ -12,9 +12,10 @@ def __init__(self, id, event, **kwargs):
         self.severity = kwargs.get('severity', None)
         self.status = kwargs.get('status', None)
         self.value = kwargs.get('value', None)
-        self.change_type = kwargs.get('change_type', kwargs.get('type', None)) or ''
         self.text = kwargs.get('text', None)
+        self.change_type = kwargs.get('change_type', kwargs.get('type', None)) or ''
         self.update_time = kwargs.get('update_time', None) or datetime.utcnow()
+        self.user = kwargs.get('user', None)
 
     def __repr__(self):
         return 'History(id={!r}, event={!r}, severity={!r}, status={!r}, type={!r})'.format(
@@ -39,6 +40,7 @@ def __init__(self, resource, event, **kwargs):
         self.attributes = kwargs.get('attributes', None) or dict()
         self.origin = kwargs.get('origin', None)
         self.update_time = kwargs.get('update_time', None)
+        self.user = kwargs.get('user', None)
         self.change_type = kwargs.get('change_type', kwargs.get('type', None))
         self.customer = kwargs.get('customer', None)