Merge pull request #21 from copartit/master

1.3.0 Rules manipulation actions and aliases

Author: nmaludy

CHANGES.md

@@ -1,13 +1,18 @@
 # Change Log
 
+## 1.3.0
+
+- Added `st2.rules.enable`, `st2.rules.disable` actions and chatops commands.
+- Added reading `ST2_ACTION_AUTH_API_KEY` environment variable if API Key is not provided in the pack's config.
+
 ## 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`
-- Fixed cacert=True case in pack's configuration
+- Fixed `cacert=True` case in pack's configuration
 
 ## 1.0.7
 

README.md

@@ -71,9 +71,11 @@ 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
+* ``!st2 executions cancel <execution id>`` - Cancel a particular action
   execution.
 * ``!st2 executions pause <execution id>`` - Pause a particular action
   execution.
 * ``!st2 executions resume <execution id>`` - Resume a particular action
   execution.
+* ``!st2 disable rule <name> from pack <pack>`` - Disable a particular rule.
+* ``!st2 enable rule <name> from pack <pack>`` - Enable a particular rule.

actions/lib/action.py

@@ -6,7 +6,6 @@
 
 from lib.utils import filter_none_values
 
-
 __all__ = [
     'St2BaseAction'
 ]
@@ -60,6 +59,12 @@ def _get_st2_urls(self):
 
     def _get_api_key(self):
         api_key = self.config.get('api_key', None)
+
+        # not found look up from env vars. Assuming the pack is
+        # configuered to work with current StackStorm instance.
+        if not api_key:
+            api_key = os.environ.get('ST2_ACTION_AUTH_API_KEY', None)
+
         return api_key
 
     def _get_auth_token(self):
@@ -104,3 +109,31 @@ def _run_client_method(self, method, method_kwargs, format_func, format_kwargs=N
         result = method(**method_kwargs)
         result = format_func(result, **format_kwargs or {})
         return result
+
+    def _manipulate_rule(self, name, pack, enabled):
+        rule_name = '{}.{}'.format(pack, name)
+        failure_reason = None
+        rule = None
+        try:
+            rule = self.client.rules.get_by_name(name=name, pack=pack)
+            if not rule:
+                failure_reason = 'rule not found'
+        except Exception as exc:
+            failure_reason = exc
+
+        if failure_reason:
+            return 'Could not get rule {}: {}'.format(rule_name, failure_reason)
+
+        rule_enabled = rule.enabled
+
+        if isinstance(rule_enabled, bool) and rule_enabled == enabled:
+            # already enabled, so just return true and formatted results
+            return rule
+
+        rule.enabled = enabled
+        try:
+            self.client.rules.update(rule)
+        except Exception as exc:
+            return 'Could not update rule {}: {}'.format(rule_name, exc)
+
+        return rule

actions/lib/formatters.py

@@ -18,3 +18,7 @@ def format_client_list_result(result, exclude_attributes=None):
 
 def format_result(item):
     return item.to_dict() if item else None
+
+
+def format_rule_update_result(result, exclude_attributes):
+    return format_client_list_result(result=[result], exclude_attributes=exclude_attributes)[0]

actions/rules_disable.py

@@ -0,0 +1,18 @@
+from lib.action import St2BaseAction
+from lib.formatters import format_rule_update_result
+
+__all__ = [
+    'St2RulesDisableAction'
+]
+
+
+class St2RulesDisableAction(St2BaseAction):
+    def run(self, pack=None, name=None, exclude=None):
+
+        rule = self._manipulate_rule(pack=pack, name=name, enabled=False)
+        if rule is None or isinstance(rule, str):
+            # error happened
+            return False, rule
+        else:
+            # all good here
+            return True, format_rule_update_result(rule, exclude)

actions/rules_disable.yaml

@@ -0,0 +1,19 @@
+---
+name: "rules.disable"
+enabled: true
+description: "Disable an existing rule"
+runner_type: python-script
+entry_point: rules_disable.py
+parameters:
+  pack:
+    type: "string"
+    description: "Pack where the rule is in"
+    required: true
+  name:
+    type: "string"
+    description: "Rule name"
+    required: true
+  exclude:
+    type: "array"
+    description: "List of attributes to exclude from results"
+    default: []

actions/rules_enable.py

@@ -0,0 +1,18 @@
+from lib.action import St2BaseAction
+from lib.formatters import format_rule_update_result
+
+__all__ = [
+    'St2RulesEnableAction'
+]
+
+
+class St2RulesEnableAction(St2BaseAction):
+    def run(self, pack=None, name=None, exclude=None):
+
+        rule = self._manipulate_rule(pack=pack, name=name, enabled=True)
+        if rule is None or isinstance(rule, str):
+            # error happened
+            return False, rule
+        else:
+            # all good here
+            return True, format_rule_update_result(rule, exclude)

actions/rules_enable.yaml

@@ -0,0 +1,19 @@
+---
+name: "rules.enable"
+enabled: true
+description: "Enable an existing rule"
+runner_type: python-script
+entry_point: rules_enable.py
+parameters:
+  pack:
+    type: "string"
+    description: "Pack where the rule is in"
+    required: true
+  name:
+    type: "string"
+    description: "Rule name"
+    required: true
+  exclude:
+    type: "array"
+    description: "List of attributes to exclude from results"
+    default: []

aliases/rules_disable.yaml

@@ -0,0 +1,19 @@
+---
+name: "st2_rules_disable"
+action_ref: "st2.rules.disable"
+description: "Disable an existing rule."
+formats:
+  - "st2 disable rule {{ name }} from pack {{ pack }}"
+ack:
+  format: "Give me just a moment to disable the rule for you..."
+result:
+  extra:
+    slack:
+      color: "{% if execution.status == 'succeeded' %}#219939{% else %}#d80015{% endif %}"
+  format: |
+    {% set res = execution.result.result %}
+    {% if res is string %}
+    {{ res }}
+    {% else %}
+    Disabled: {{ res.ref }} ({{ res.trigger.ref }} -> {{ res.action.ref }}){{ res.description and ' - ' + res.description }}
+    {% endif %}

aliases/rules_enable.yaml

@@ -0,0 +1,19 @@
+---
+name: "st2_rules_enable"
+action_ref: "st2.rules.enable"
+description: "Enable an existing rule."
+formats:
+  - "st2 enable rule {{ name }} from pack {{ pack }}"
+ack:
+  format: "Give me just a moment to enable the rule for you..."
+result:
+  extra:
+    slack:
+      color: "{% if execution.status == 'succeeded' %}#219939{% else %}#d80015{% endif %}"
+  format: |
+    {% set res = execution.result.result %}
+    {% if res is string %}
+    {{ res }}
+    {% else %}
+    Enabled: {{ res.ref }} ({{ res.trigger.ref }} -> {{ res.action.ref }}){{ res.description and ' - ' + res.description }}
+    {% endif %}