Refactored pack to use a consistent formatter and field sets, support…

packs/libcloud/actions/balancer_attach_member.py

@@ -6,10 +6,6 @@
     'BalancerAttachMemberAction'
 ]
 
-RECORD_ATTRIBUTES = [
-    'id'
-]
-
 
 class BalancerAttachMemberAction(BaseAction):
     api_type = 'loadbalancer'
@@ -20,11 +16,4 @@ def run(self, credentials, balancer_id, member_ip, member_port):
         member = Member(id=None, ip=member_ip, port=member_port)
         record = driver.balancer_attach_member(balancer=balancer,
                                                member=member)
-        result = []
-
-        values = record.__dict__
-        item = dict([(k, v) for k, v in values.items()
-                     if k in RECORD_ATTRIBUTES])
-        result.append(item)
-
-        return result
+        return self.resultsets.formatter(record)

packs/libcloud/actions/balancer_list_members.py

@@ -4,13 +4,6 @@
     'BalancerListMembersAction'
 ]
 
-RECORD_ATTRIBUTES = [
-    'id',
-    'ip',
-    'port',
-    'extra',
-]
-
 
 class BalancerListMembersAction(BaseAction):
     api_type = 'loadbalancer'
@@ -19,12 +12,4 @@ def run(self, credentials, balancer_id):
         driver = self._get_driver_for_credentials(credentials=credentials)
         balancer = driver.get_balancer(balancer_id)
         members = driver.balancer_list_members(balancer=balancer)
-        result = []
-
-        for record in members:
-            values = record.__dict__
-            item = dict([(k, v) for k, v in values.items()
-                         if k in RECORD_ATTRIBUTES])
-            result.append(item)
-
-        return result
+        return self.resultsets.formatter(members)

packs/libcloud/actions/create_balancer.py

@@ -6,10 +6,6 @@
     'CreateBalancerAction'
 ]
 
-RECORD_ATTRIBUTES = [
-    'id'
-]
-
 
 class CreateBalancerAction(BaseAction):
     api_type = 'loadbalancer'
@@ -34,12 +30,4 @@ def run(self, credentials, name, port, protocol,
                                         protocol=protocol,
                                         algorithm=algorithm,
                                         members=None)
-
-        result = []
-
-        values = record.__dict__
-        item = dict([(k, v) for k, v in values.items()
-                     if k in RECORD_ATTRIBUTES])
-        result.append(item)
-
-        return result
+        return self.resultsets.formatter(record)

packs/libcloud/actions/lib/actions.py

@@ -12,6 +12,8 @@
 from libcloud.loadbalancer.providers import get_driver as get_lb_driver
 from libcloud.compute.base import Node
 
+from libcloud_parsers import ResultSets
+
 from st2actions.runners.pythonrunner import Action
 
 __all__ = [
@@ -23,6 +25,10 @@
 class BaseAction(Action):
     api_type = None
 
+    def __init__(self, config):
+        super(BaseAction, self).__init__(config)
+        self.resultsets = ResultSets()
+
     def _get_driver_for_credentials(self, credentials):
         """
         Retrieve Libcloud provider driver instance for a particular credentials

packs/libcloud/actions/lib/libcloud_parsers.py

@@ -0,0 +1,70 @@
+#!/usr/bin/env python
+
+import libcloud.compute.base as compute_base
+import libcloud.dns.base as dns_base
+import libcloud.loadbalancer.base as lb_base
+
+
+class FieldLists():
+    """
+    The lists of fields we want to return for each class
+    """
+    NODE = ['id', 'name', 'state', 'public_ips', 'private_ips', 'size', 'image']
+    NODE_SIZE = ['id', 'name', 'ram', 'disk', 'bandwidth', 'price']
+    NODE_IMAGE = ['id', 'name']
+    LOCATION = ['id', 'name', 'country']
+    NODE_KEY = ['pubkey']
+    NODE_PASSWORD = ['password', 'generated']
+    STORAGE_VOLUME = ['id', 'name', 'size', 'state']
+    VOLUME_SNAPSHOT = ['id', 'size', 'state']
+    ZONE = ['id', 'domain', 'type', 'ttl']
+    RECORD = ['id', 'name', 'type', 'data', 'zone']
+    MEMBER = ['id', 'ip', 'port', 'balancer']
+    BALANCER = ['id', 'name', 'state', 'port']
+
+
+class ResultSets(object):
+
+    def selector(self, output):
+        if isinstance(output, compute_base.Node):
+            return self.parse(output, FieldLists.NODE)
+        elif isinstance(output, compute_base.NodeSize):
+            return self.parse(output, FieldLists.NODE_SIZE)
+        elif isinstance(output, compute_base.NodeImage):
+            return self.parse(output, FieldLists.NODE_IMAGE)
+        elif isinstance(output, compute_base.NodeLocation):
+            return self.parse(output, FieldLists.LOCATION)
+        elif isinstance(output, compute_base.NodeAuthSSHKey):
+            return self.parse(output, FieldLists.NODE_KEY)
+        elif isinstance(output, compute_base.NodeAuthPassword):
+            return self.parse(output, FieldLists.NODE_PASSWORD)
+        elif isinstance(output, compute_base.StorageVolume):
+            return self.parse(output, FieldLists.STORAGE_VOLUME)
+        elif isinstance(output, compute_base.VolumeSnapshot):
+            return self.parse(output, FieldLists.VOLUME_SNAPSHOT)
+        elif isinstance(output, dns_base.Zone):
+            return self.parse(output, FieldLists.ZONE)
+        elif isinstance(output, dns_base.Record):
+            return self.parse(output, FieldLists.RECORD)
+        elif isinstance(output, lb_base.Member):
+            return self.parse(output, FieldLists.MEMBER)
+        elif isinstance(output, lb_base.LoadBalancer):
+            return self.parse(output, FieldLists.BALANCER)
+        else:
+            return output
+
+    def formatter(self, output):
+        formatted = []
+        if isinstance(output, list):
+            for o in output:
+                formatted.append(self.selector(o))
+        else:
+            formatted = self.selector(output)
+        return formatted
+
+    def _getval(self, obj, field):
+        return self.selector(getattr(obj, field))
+
+    def parse(self, output, field_list):
+        instance_data = {field: self._getval(output, field) for field in field_list}
+        return instance_data

packs/libcloud/actions/list_balancers.py

@@ -4,28 +4,11 @@
     'ListBalancersAction'
 ]
 
-RECORD_ATTRIBUTES = [
-    'id',
-    'name',
-    'state',
-    'ip',
-    'port',
-    'extra'
-]
-
 
 class ListBalancersAction(BaseAction):
     api_type = 'loadbalancer'
 
     def run(self, credentials):
         driver = self._get_driver_for_credentials(credentials=credentials)
         members = driver.list_balancers()
-        result = []
-
-        for record in members:
-            values = record.__dict__
-            item = dict([(k, v) for k, v in values.items()
-                         if k in RECORD_ATTRIBUTES])
-            result.append(item)
-
-        return result
+        return self.resultsets.formatter(members)

packs/libcloud/actions/list_dns_records.py

@@ -6,13 +6,6 @@
     'ListDNSRecordsAction'
 ]
 
-RECORD_ATTRIBUTES = [
-    'id',
-    'name',
-    'type',
-    'data',
-]
-
 
 class ListDNSRecordsAction(BaseAction):
     api_type = 'dns'
@@ -21,12 +14,4 @@ def run(self, credentials, zone_id):
         driver = self._get_driver_for_credentials(credentials=credentials)
         zone = Zone(id=zone_id, domain=None, type=None, ttl=None, driver=None)
         records = driver.list_records(zone=zone)
-        result = []
-
-        for record in records:
-            values = record.__dict__
-            item = dict([(k, v) for k, v in values.items()
-                         if k in RECORD_ATTRIBUTES])
-            result.append(item)
-
-        return result
+        return self.resultsets.formatter(records)

packs/libcloud/actions/list_dns_zones.py

@@ -4,26 +4,11 @@
     'ListDNSZonesAction'
 ]
 
-ZONE_ATTRIBUTES = [
-    'id',
-    'domain',
-    'type',
-    'ttl'
-]
-
 
 class ListDNSZonesAction(BaseAction):
     api_type = 'dns'
 
     def run(self, credentials):
         driver = self._get_driver_for_credentials(credentials=credentials)
         zones = driver.list_zones()
-        result = []
-
-        for zone in zones:
-            values = zone.__dict__
-            item = dict([(k, v) for k, v in values.items()
-                         if k in ZONE_ATTRIBUTES])
-            result.append(item)
-
-        return result
+        return self.resultsets.formatter(zones)

packs/libcloud/actions/list_images.py

@@ -0,0 +1,14 @@
+from lib.actions import BaseAction
+
+__all__ = [
+    'ListImagesAction'
+]
+
+
+class ListImagesAction(BaseAction):
+    api_type = 'compute'
+
+    def run(self, credentials):
+        driver = self._get_driver_for_credentials(credentials=credentials)
+        images = driver.list_images()
+        return self.resultsets.formatter(images)

packs/libcloud/actions/list_images.yaml

@@ -0,0 +1,11 @@
+---
+name: list_images
+runner_type: run-python
+description: List available node images.
+enabled: true
+entry_point: list_images.py
+parameters:
+  credentials:
+    type: string
+    description: Name of the credentials set (as defined in the config) to use.
+    required: true

packs/libcloud/actions/list_sizes.py

@@ -0,0 +1,14 @@
+from lib.actions import BaseAction
+
+__all__ = [
+    'ListSizesAction'
+]
+
+
+class ListSizesAction(BaseAction):
+    api_type = 'compute'
+
+    def run(self, credentials):
+        driver = self._get_driver_for_credentials(credentials=credentials)
+        sizes = driver.list_sizes()
+        return self.resultsets.formatter(sizes)

packs/libcloud/actions/list_sizes.yaml

@@ -0,0 +1,11 @@
+---
+name: list_sizes
+runner_type: run-python
+description: List available node sizes.
+enabled: true
+entry_point: list_sizes.py
+parameters:
+  credentials:
+    type: string
+    description: Name of the credentials set (as defined in the config) to use.
+    required: true

packs/libcloud/actions/list_vms.py

@@ -4,27 +4,12 @@
     'ListVMsAction'
 ]
 
-NODE_ATTRIBUTES = [
-    'id',
-    'name',
-    'state',
-    'public_ips',
-    'private_ips'
-]
-
 
 class ListVMsAction(BaseAction):
     api_type = 'compute'
 
     def run(self, credentials):
         driver = self._get_driver_for_credentials(credentials=credentials)
         vms = driver.list_nodes()
-        result = []
-
-        for vm in vms:
-            values = vm.__dict__
-            item = dict([(k, v) for k, v in values.items()
-                         if k in NODE_ATTRIBUTES])
-            result.append(item)
 
-        return result
+        return self.resultsets.formatter(vms)