Skip alerts on failed actions (#192)

Author: satterly

alertaclient/commands/cmd_ack.py

@@ -1,6 +1,6 @@
 import click
 
-from alertaclient.utils import build_query
+from alertaclient.utils import action_progressbar, build_query
 
 
 @click.command('ack', short_help='Acknowledge alerts')
@@ -22,6 +22,4 @@ def cli(obj, ids, query, filters, text):
         total, _, _ = client.get_count(query)
         ids = [a.id for a in client.get_alerts(query)]
 
-    with click.progressbar(ids, label='Acking {} alerts'.format(total)) as bar:
-        for id in bar:
-            client.action(id, action='ack', text=text or 'status changed using CLI')
+    action_progressbar(client, action='ack', ids=ids, label='Acking {} alerts'.format(total), text=text)

alertaclient/commands/cmd_action.py

@@ -2,7 +2,7 @@
 
 import click
 
-from alertaclient.utils import build_query
+from alertaclient.utils import action_progressbar, build_query
 
 
 @click.command('action', short_help='Action alerts')
@@ -26,6 +26,6 @@ def cli(obj, action, ids, query, filters, text):
         ids = [a.id for a in client.get_alerts(query)]
 
     action_text = re.sub('([A-Z])', r' \1', action).title()  # 'createIssue' => 'Create Issue'
-    with click.progressbar(ids, label='Action {} {} alerts'.format(action, total)) as bar:
-        for id in bar:
-            client.action(id, action=action, text=text or '{} using CLI'.format(action_text))
+    label = 'Action {} {} alerts'.format(action, total)
+    text = text or '{} using CLI'.format(action_text)
+    action_progressbar(client, action=action, ids=ids, label=label, text=text)

alertaclient/commands/cmd_close.py

@@ -1,6 +1,6 @@
 import click
 
-from alertaclient.utils import build_query
+from alertaclient.utils import action_progressbar, build_query
 
 
 @click.command('ack', short_help='Close alerts')
@@ -22,6 +22,4 @@ def cli(obj, ids, query, filters, text):
         total, _, _ = client.get_count(query)
         ids = [a.id for a in client.get_alerts(query)]
 
-    with click.progressbar(ids, label='Closing {} alerts'.format(total)) as bar:
-        for id in bar:
-            client.action(id, action='close', text=text or 'status changed using CLI')
+    action_progressbar(client, action='close', ids=ids, label='Closing {} alerts'.format(total), text=text)

alertaclient/commands/cmd_shelve.py

@@ -1,13 +1,13 @@
 import click
 
-from alertaclient.utils import build_query
+from alertaclient.utils import action_progressbar, build_query
 
 
 @click.command('shelve', short_help='Shelve 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('--timeout', metavar='SECONDS', type=int, help='Seconds before alert auto-unshelved.')
+@click.option('--timeout', metavar='SECONDS', type=int, help='Seconds before alert auto-unshelved.', default=7200, show_default=True)
 @click.option('--text', help='Message associated with status change')
 @click.pass_obj
 def cli(obj, ids, query, filters, timeout, text):
@@ -23,6 +23,5 @@ def cli(obj, ids, query, filters, timeout, text):
         total, _, _ = client.get_count(query)
         ids = [a.id for a in client.get_alerts(query)]
 
-    with click.progressbar(ids, label='Shelving {} alerts'.format(total)) as bar:
-        for id in bar:
-            client.action(id, action='shelve', text=text or 'status changed using CLI', timeout=timeout)
+    action_progressbar(client, action='shelve', ids=ids,
+                       label='Shelving {} alerts'.format(total), text=text, timeout=timeout)

alertaclient/commands/cmd_unack.py

@@ -1,6 +1,6 @@
 import click
 
-from alertaclient.utils import build_query
+from alertaclient.utils import action_progressbar, build_query
 
 
 @click.command('unack', short_help='Un-acknowledge alerts')
@@ -22,6 +22,4 @@ def cli(obj, ids, query, filters, text):
         total, _, _ = client.get_count(query)
         ids = [a.id for a in client.get_alerts(query)]
 
-    with click.progressbar(ids, label='Un-acking {} alerts'.format(total)) as bar:
-        for id in bar:
-            client.action(id, action='unack', text=text or 'status changed using CLI')
+    action_progressbar(client, action='unack', ids=ids, label='Un-acking {} alerts'.format(total), text=text)

alertaclient/commands/cmd_unshelve.py

@@ -1,6 +1,6 @@
 import click
 
-from alertaclient.utils import build_query
+from alertaclient.utils import action_progressbar, build_query
 
 
 @click.command('unshelve', short_help='Un-shelve alerts')
@@ -22,6 +22,4 @@ def cli(obj, ids, query, filters, text):
         total, _, _ = client.get_count(query)
         ids = [a.id for a in client.get_alerts(query)]
 
-    with click.progressbar(ids, label='Un-shelving {} alerts'.format(total)) as bar:
-        for id in bar:
-            client.action(id, action='unshelve', text=text or 'status changed using CLI')
+    action_progressbar(client, 'unshelve', ids, label='Un-shelving {} alerts'.format(total), text=text)

alertaclient/utils.py

@@ -2,6 +2,7 @@
 import datetime
 import json
 
+import click
 import pytz
 import six
 
@@ -41,3 +42,18 @@ def localtime(dt, timezone=None, fmt='%Y/%m/%d %H:%M:%S'):
 
 def build_query(filters):
     return [tuple(f.split('=', 1)) for f in filters if '=' in f]
+
+
+def action_progressbar(client, action, ids, label, text=None, timeout=None):
+    skipped = 0
+
+    def show_skipped(id):
+        if not id and skipped:
+            return '(skipped {})'.format(skipped)
+
+    with click.progressbar(ids, label=label, show_eta=True, item_show_func=show_skipped) as bar:
+        for id in bar:
+            try:
+                client.action(id, action=action, text=text or 'status changed using CLI', timeout=timeout)
+            except Exception as e:
+                skipped += 1