Add note and user groups commands (#185)

Author: satterly

alertaclient/commands/cmd_group.py

@@ -0,0 +1,22 @@
+import sys
+
+import click
+
+
+@click.command('group', short_help='Create user group')
+@click.option('--name', help='Group name')
+@click.option('--text', help='Description of user group')
+@click.option('--delete', '-D', metavar='ID', help='Delete user group using ID')
+@click.pass_obj
+def cli(obj, name, text, delete):
+    """Create or delete a user group."""
+    client = obj['client']
+    if delete:
+        client.delete_group(delete)
+    else:
+        try:
+            group = client.create_group(name, text)
+        except Exception as e:
+            click.echo('ERROR: {}'.format(e))
+            sys.exit(1)
+        click.echo(group.id)

alertaclient/commands/cmd_groups.py

@@ -0,0 +1,19 @@
+
+import json
+
+import click
+from tabulate import tabulate
+
+
+@click.command('groups', short_help='List user groups')
+@click.pass_obj
+def cli(obj):
+    """List groups."""
+    client = obj['client']
+
+    if obj['output'] == 'json':
+        r = client.http.get('/groups')
+        click.echo(json.dumps(r['groups'], sort_keys=True, indent=4, ensure_ascii=False))
+    else:
+        headers = {'id': 'ID', 'name': 'NAME', 'count': 'USERS', 'text': 'DESCRIPTION'}
+        click.echo(tabulate([g.tabular() for g in client.get_users_groups()], headers=headers, tablefmt=obj['output']))

alertaclient/commands/cmd_note.py

@@ -0,0 +1,27 @@
+import click
+
+from alertaclient.utils import build_query
+
+
+@click.command('note', short_help='Add note to alerts')
+@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('--text', required=True, help='Note or message')
+@click.pass_obj
+def cli(obj, ids, query, filters, text):
+    """Add note to alerts."""
+    client = obj['client']
+    if ids:
+        total = len(ids)
+    else:
+        if query:
+            query = [('q', query)]
+        else:
+            query = build_query(filters)
+        total, _, _ = client.get_count(query)
+        ids = [a.id for a in client.get_alerts(query)]
+
+    with click.progressbar(ids, label='Add note to {} alerts'.format(total)) as bar:
+        for id in bar:
+            client.add_note(id, note=text)

alertaclient/models/group.py

@@ -1,5 +1,5 @@
 
-from typing import Any, Dict, List, Optional, Tuple, Union
+from typing import Any, Dict
 from uuid import uuid4
 
 JSON = Dict[str, Any]
@@ -42,6 +42,16 @@ def __repr__(self) -> str:
     @classmethod
     def parse(cls, json: JSON) -> 'Group':
         return Group(
+            id=json.get('id', None),
             name=json.get('name', None),
-            text=json.get('text', None)
+            text=json.get('text', None),
+            count=json.get('count', 0)
         )
+
+    def tabular(self):
+        return {
+            'id': self.id,
+            'name': self.name,
+            'text': self.text,
+            'count': self.count
+        }