Merge pull request #20 from copartit/master

1.2.0 - executions pause and resume

Author: nmaludy

CHANGES.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 1.2.0
+
+- Added `st2.executions.pause`, `st2.executions.resume`, `st2.executions.cancel` actions.
+
 ## 1.1.0
 
 - Added decrypt and decompress parameters to `st2.kv.get_object`

README.md

@@ -71,3 +71,9 @@ sensors and more.
   action execution.
 * ``!st2 executions re-run <execution id>`` - Re-run a particular action
   execution.
+* ``!st2 executions cancel <execution id>`` - Pause a particular action
+  execution.
+* ``!st2 executions pause <execution id>`` - Pause a particular action
+  execution.
+* ``!st2 executions resume <execution id>`` - Resume a particular action
+  execution.

actions/executions_cancel.py

@@ -0,0 +1,22 @@
+from lib.action import St2BaseAction
+
+__all__ = [
+    'St2ExecutionsCancel'
+]
+
+
+class St2ExecutionsCancel(St2BaseAction):
+    def run(self, ids):
+        result = {}
+        success = True
+        for i in ids:
+            try:
+                res = self.client.executions.delete_by_id(instance_id=i)
+                if res.get('faultstring'):
+                    success = False
+            except Exception as exc:
+                result[i] = str(exc)
+                success = False
+            else:
+                result[i] = res
+        return success, result

actions/executions_cancel.yaml

@@ -0,0 +1,11 @@
+---
+name: "executions.cancel"
+enabled: true
+description: "Cancel action executions."
+runner_type: python-script
+entry_point: executions_cancel.py
+parameters:
+  ids:
+    type: "array"
+    description: "IDs of action executions to resume."
+    required: true

actions/executions_pause.py

@@ -0,0 +1,21 @@
+from lib.action import St2BaseAction
+from lib.formatters import format_result
+
+__all__ = [
+    'St2ExecutionsPause'
+]
+
+
+class St2ExecutionsPause(St2BaseAction):
+    def run(self, ids):
+        result = {}
+        success = True
+        for i in ids:
+            try:
+                res = self.client.liveactions.pause(execution_id=i)
+            except Exception as exc:
+                result[i] = str(exc)
+                success = False
+            else:
+                result[i] = format_result(item=res)
+        return success, result

actions/executions_pause.yaml

@@ -0,0 +1,11 @@
+---
+name: "executions.pause"
+enabled: true
+description: "Pause action executions (workflow executions only)."
+runner_type: python-script
+entry_point: executions_pause.py
+parameters:
+  ids:
+    type: "array"
+    description: "IDs of action executions to pause."
+    required: true

actions/executions_resume.py

@@ -0,0 +1,21 @@
+from lib.action import St2BaseAction
+from lib.formatters import format_result
+
+__all__ = [
+    'St2ExecutionsResume'
+]
+
+
+class St2ExecutionsResume(St2BaseAction):
+    def run(self, ids):
+        result = {}
+        success = True
+        for i in ids:
+            try:
+                res = self.client.liveactions.resume(execution_id=i)
+            except Exception as exc:
+                result[i] = str(exc)
+                success = False
+            else:
+                result[i] = format_result(item=res)
+        return success, result

actions/executions_resume.yaml

@@ -0,0 +1,11 @@
+---
+name: "executions.resume"
+enabled: true
+description: "Resume action executions (workflow executions only)."
+runner_type: python-script
+entry_point: executions_resume.py
+parameters:
+  ids:
+    type: "array"
+    description: "IDs of action executions to resume."
+    required: true

actions/lib/formatters.py

@@ -14,3 +14,7 @@ def format_client_list_result(result, exclude_attributes=None):
         formatted.append(value)
 
     return formatted
+
+
+def format_result(item):
+    return item.to_dict() if item else None

aliases/executions_cancel.yaml

@@ -0,0 +1,17 @@
+---
+name: "st2_executions_cancel"
+action_ref: "st2.executions.cancel"
+description: "Cancel action executions."
+formats:
+    - "st2 cancel execution {{ ids }}"
+    - "st2 executions cancel {{ ids }}"
+result:
+  extra:
+    slack:
+      color: "{% if execution.status == 'succeeded' %}#219939{% else %}#d80015{% endif %}"
+  format: |
+    {% for key,value in execution.result.result.items() %}
+      {{ key }} - {% if value is string %}{{ value }}
+      {% else %}{% if value["faultstring"] %}{{ value["faultstring"] }}{% else %}{{ value["status"] }}{% endif %}
+      {% endif %}
+    {% endfor %}