Merge pull request #510 from zancas/registry_tools

Registry tools

Author: zancas

f5/bigip/tm/cm/device_group.py

@@ -37,7 +37,7 @@ def __init__(self, cm):
         super(Device_Groups, self).__init__(cm)
         self._meta_data['allowed_lazy_attributes'] = [Device_Group]
         self._meta_data['attribute_registry'] =\
-            {'tm:cm:device:device-groupstate': Device_Group}
+            {'tm:cm:device-group:device-groupstate': Device_Group}
 
 
 class Device_Group(Resource):

f5/bigip/tm/ltm/persistence.py

@@ -29,10 +29,11 @@
 
 
 from f5.bigip.resource import Collection
+from f5.bigip.resource import OrganizingCollection
 from f5.bigip.resource import Resource
 
 
-class Persistences(Collection):
+class Persistences(OrganizingCollection):
     '''A Collection concrete subclass docstring.'''
     def __init__(self, ltm):
         '''Auto generated constructor.'''

f5/bigip/tm/net/fdb.py

@@ -29,10 +29,11 @@
 
 
 from f5.bigip.resource import Collection
+from f5.bigip.resource import OrganizingCollection
 from f5.bigip.resource import Resource
 
 
-class Fdbs(Collection):
+class Fdbs(OrganizingCollection):
     '''A Collection concrete subclass docstring.'''
     def __init__(self, net):
         '''Auto generated constructor.'''

f5/bigip/tm/net/tunnels.py

@@ -28,10 +28,11 @@
 """
 
 from f5.bigip.resource import Collection
+from f5.bigip.resource import OrganizingCollection
 from f5.bigip.resource import Resource
 
 
-class Tunnels_s(Collection):
+class Tunnels_s(OrganizingCollection):
     """BIG-IP® network tunnels collection"""
     def __init__(self, net):
         super(Tunnels_s, self).__init__(net)

f5/bigip/tm/sys/application.py

@@ -29,12 +29,13 @@
 
 from f5.bigip.resource import Collection
 from f5.bigip.resource import KindTypeMismatch
+from f5.bigip.resource import OrganizingCollection
 from f5.bigip.resource import Resource
 
 from requests import HTTPError
 
 
-class Applications(Collection):
+class Applications(OrganizingCollection):
     """BIG-IP® iApp collection."""
     def __init__(self, sys):
         super(Applications, self).__init__(sys)

f5/utils/testutils/registrytools.py

@@ -0,0 +1,95 @@
+# Copyright 2016 F5 Networks Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+import logging
+from pprint import pprint as pp
+
+from f5.bigip.mixins import UnsupportedTmosVersion
+from f5.bigip.resource import Collection
+from f5.bigip.resource import OrganizingCollection
+
+
+def register_collection_atoms(collection):
+    '''Given a collection return a registry of all of its atoms (elements).
+
+    Registries are dictionaries with selfLink keys, and PathElement values.
+    A registry provides a snapshot of all resources of a type on the device.
+    '''
+    resource_registry = {}
+    try:
+        resources = collection.get_collection()
+    except Exception as ex:
+        logging.debug(ex)
+        return resource_registry
+    for resource in resources:
+            try:
+                resource_registry[resource.selfLink] = resource
+            except KeyError as ex:
+                pp(resource.raw)
+                raise ex
+    return resource_registry
+
+
+def register_OC_atoms(organizing_collection):
+    '''Given an OrganizingCollection (OC) return a registry of its atoms.
+
+    Registries are dictionaries with selfLink keys, and PathElement values.
+    A registry provides a snapshot of all resources of a type on the device.
+    '''
+    OC_atoms_registry = {}
+    OC_types = organizing_collection._meta_data['allowed_lazy_attributes']
+    for OC_type in OC_types:
+        try:
+            lazy_instance =\
+                getattr(organizing_collection, OC_type.__name__.lower())
+        except UnsupportedTmosVersion as ex:
+            logging.debug(ex)
+            continue
+        if isinstance(lazy_instance, Collection):
+            OC_atoms_registry.update(register_collection_atoms(lazy_instance))
+        elif isinstance(lazy_instance, OrganizingCollection):
+            OC_atoms_registry.update(register_OC_atoms(lazy_instance))
+    return OC_atoms_registry
+
+
+def register_device(mgmt_rt):
+    OCs = [getattr(mgmt_rt, c.__name__.lower())
+           for c in mgmt_rt._meta_data['allowed_lazy_attributes']]
+    grand_registry = {}
+    for OC in OCs:
+        grand_registry.update(register_OC_atoms(OC))
+    return grand_registry
+
+
+def register_loadbalancer_elements(mgmt_rt):
+    monitor_registry = register_OC_atoms(mgmt_rt.tm.ltm.monitor)
+    pool_registry = register_collection_atoms(mgmt_rt.tm.ltm.pools)
+    snat_registry = register_collection_atoms(mgmt_rt.tm.ltm.snats)
+    virtual_registry = register_collection_atoms(mgmt_rt.tm.ltm.virtuals)
+    virtual_address_s_registry =\
+        register_collection_atoms(mgmt_rt.tm.ltm.virtual_address_s)
+    member_registry = {}
+    for pool in pool_registry.values():
+        mc = pool.members_s
+        member_registry.update(register_collection_atoms(mc))
+    folder_registry = register_collection_atoms(mgmt_rt.tm.sys.folders)
+    registries = {'monitor_registry': monitor_registry,
+                  'pool_registry': pool_registry,
+                  'snat_registry': snat_registry,
+                  'virtual_registry': virtual_registry,
+                  'virtual_address_s_registry': virtual_address_s_registry,
+                  'member_registry': member_registry,
+                  'folder_registry': folder_registry}
+    return registries