Update base code to support http return status.

Author: nzlosh

actions/lib/action.py

@@ -2,21 +2,17 @@
 from st2common.runners.base_action import Action
 
 
-__all__ = [
-    "NetboxBaseAction"
-]
+__all__ = ["NetboxBaseAction"]
 
 
 class NetboxBaseAction(Action):
-    """Base Action for all Netbox API based actions
-    """
+    """Base Action for all Netbox API based actions"""
 
     def __init__(self, config):
         super(NetboxBaseAction, self).__init__(config)
 
     def make_request(self, endpoint_uri, http_action, **kwargs):
-        """Logic to make all types of requests
-        """
+        """Logic to make all types of requests"""
 
         if self.config["use_https"]:
             url = "https://"
@@ -38,7 +34,7 @@ def make_request(self, endpoint_uri, http_action, **kwargs):
 
         # transform `tags` if present
         if kwargs.get("tags"):
-            if http_action in ['post', 'put', 'patch']:
+            if http_action in ["post", "put", "patch"]:
                 kwargs["tags"] = [{"slug": x} for x in kwargs["tags"]]
             else:
                 kwargs["tags"] = ",".join(kwargs["tags"])
@@ -51,31 +47,25 @@ def make_request(self, endpoint_uri, http_action, **kwargs):
         self.logger.debug("Calling base {} with kwargs: {}".format(http_action, kwargs))
         verify = self.config["ssl_verify"]
 
-        r = None
-
         if http_action == "get":
             r = requests.get(url, verify=verify, headers=headers, params=kwargs)
-
         elif http_action == "post":
             r = requests.post(url, verify=verify, headers=headers, json=kwargs)
-
         elif http_action == "put":
             r = requests.put(url, verify=verify, headers=headers, json=kwargs)
-
         elif http_action == "patch":
             r = requests.patch(url, verify=verify, headers=headers, json=kwargs)
-
         elif http_action == "delete":
             r = requests.delete(url, verify=verify, headers=headers)
-            self.logger.info("Delete of ID {} returned status code {}".format(
-                kwargs["id"],
-                r.status_code)
+            self.logger.info(
+                "Delete of ID {} returned status code {}".format(kwargs["id"], r.status_code)
             )
+        else:
+            raise ValueError(f"Unsupported http verb '{http_action}'")
+
+        try:
+            raw = r.json()
+        except ValueError:
+            raw = r.text
 
-        if r:
-            try:
-                raw = r.json()
-            except ValueError:
-                raw = r.text
-            return {"raw": raw, "status": r.status_code}
-        return {"raw": {}, "status": 404}
+        return {"raw": raw, "status": r.status_code}

actions/run.py

@@ -6,35 +6,54 @@
 
 
 class NetboxHTTPAction(NetboxBaseAction):
-    """Base run action"""
+    """
+    Action to call netbox api and return response.
+    """
 
-    def run(self, endpoint_uri, http_verb, get_detail_route_eligible, **kwargs):
-        """Base run action
+    def run(self, endpoint_uri, http_verb, get_detail_route_eligible, fail_non_2xx, **kwargs):
         """
-
-        if http_verb == 'get':
-            if kwargs.get('id', False) and get_detail_route_eligible:
+        StackStorm action entry point.
+        """
+        if http_verb == "get":
+            if kwargs.get("id", False) and get_detail_route_eligible:
                 # modify the `endpoint_uri` to use the detail route
-                endpoint_uri = '{}{}/'.format(endpoint_uri, str(kwargs.pop('id')))
+                endpoint_uri = "{}{}/".format(endpoint_uri, str(kwargs.pop("id")))
                 self.logger.debug(
-                    'endpoint_uri transformed to {} because id was passed'.format(endpoint_uri)
+                    "endpoint_uri transformed to {} because id was passed".format(endpoint_uri)
                 )
 
-            if kwargs.get('save_in_key_store') and not kwargs.get('save_in_key_store_key_name'):
-                return (False, 'save_in_key_store_key_name MUST be used with save_in_key_store!')
+            if kwargs.get("save_in_key_store") and not kwargs.get("save_in_key_store_key_name"):
+                return (False, "save_in_key_store_key_name MUST be used with save_in_key_store!")
 
             result = self.make_request(endpoint_uri, http_verb, **kwargs)
 
-            if kwargs['save_in_key_store']:
+            if fail_non_2xx:
+                # Return error rather than storing it in the keystone.
+                if result["status"] not in range(200, 300):
+                    return (False, result)
+
+            if kwargs["save_in_key_store"]:
                 # save the result in the st2 keystore
-                client = Client(base_url='http://localhost')
-                key_name = kwargs['save_in_key_store_key_name']
-                client.keys.update(KeyValuePair(name=key_name, value=json.dumps(result),
-                                                ttl=kwargs['save_in_key_store_ttl']))
+                client = Client(base_url="http://localhost")
+                key_name = kwargs["save_in_key_store_key_name"]
+                client.keys.update(
+                    KeyValuePair(
+                        name=key_name, value=json.dumps(result), ttl=kwargs["save_in_key_store_ttl"]
+                    )
+                )
 
                 return (True, "Result stored in st2 key {}".format(key_name))
 
         else:
             result = self.make_request(endpoint_uri, http_verb, **kwargs)
 
-        return result
+        # To maintain backward compatibility, this action always returns True (success) event
+        # when the netbox http return status is not OK.  action_succeeded is set to True and
+        # will only be set to False if the `fail_non_2xx` argument is set to True _and_ netbox
+        # http return code is not 2xx.
+        action_succeeded = True
+
+        if fail_non_2xx:
+            action_succeeded = result.get("status") in range(200, 300)
+
+        return (action_succeeded, result)

bin/action-template.jinja2

@@ -17,6 +17,10 @@ parameters:
     default: {{ get_detail_route_eligible | lower }}
     immutable: true
     type: boolean
+  fail_non_2xx:
+    default: false
+    type: boolean
+    description: Set action as failed when http return reponse status isn't 2xx.
   {%- for parameter in parameters %}
   {{ parameter.name }}:
     required: {{ parameter.required | lower }}