facts generation that supports merging existing facts modules and introduces gather_network_resources

Signed-off-by: Trishna Guha <[email protected]>

Author: trishnaguha

roles/resource_module/templates/module_directory/network_os/network_os_facts.py.j2

@@ -33,30 +33,49 @@ options:
   gather_subset:
     description:
       - When supplied, this argument will restrict the facts collected
-        to a given subset.  Possible values for this argument include
-        all, and net_configuration_<resource_name>.  Can specify a
-        list of values to include a larger subset.  Values can also be used
+        to a given subset. Possible values for this argument include
+        all, min, hardware, config, legacy, and interfaces. Can specify a
+        list of values to include a larger subset. Values can also be used
         with an initial C(M(!)) to specify that a specific subset should
         not be collected.
     required: false
     default: 'all'
     version_added: "2.2"
+  gather_network_resources:
+    description:
+      - When supplied, this argument will restrict the facts collected
+        to a given subset. Possible values for this argument include
+        all and the resources like interfaces, vlans etc.
+        Can specify a list of values to include a larger subset. Values
+        can also be used with an initial C(M(!)) to specify that a
+        specific subset should not be collected.
+    required: false
+    version_added: "2.9"
 """
 
 EXAMPLES = """
 # Gather all facts
 - {{ network_os }}_facts:
     gather_subset: all
+    gather_network_resources: all
 
-# Collect only the {{ resource }} and default facts
+# Collect only the {{ resource }} facts
 - {{ network_os }}_facts:
     gather_subset:
-      - net_configuration_{{ resource }}
+      - !all
+      - !min
+    gather_network_resources:
+      - {{ resource }}
 
 # Do not collect {{ resource }} facts
 - {{ network_os }}_facts:
-    gather_subset:
-      - "!net_configuration_{{ resource }}"
+    gather_network_resources:
+      - "!{{ resource }}"
+
+# Collect {{ resource }} and minimal default facts
+- {{ network_os }}_facts:
+    gather_subset: min
+    gather_network_resources: {{ resource }}
 """
 
 RETURN = """
@@ -71,11 +90,19 @@ def main():
     """
     module = AnsibleModule(argument_spec=Facts.argument_spec,
                            supports_check_mode=True)
-    warnings = list()
+    warnings = ['default value for `gather_subset` will be changed to `min` from `!config` v2.11 onwards']
 
     connection = Connection(module._socket_path) #pylint: disable=W0212
     gather_subset = module.params['gather_subset']
-    ansible_facts = Facts().get_facts(module, connection, gather_subset)
+    gather_network_resources = module.params['gather_network_resources']
+    result = Facts().get_facts(module, connection, gather_subset, gather_network_resources)
+    
+    try:
+        ansible_facts, warning = result
+        warnings.extend(warning)
+    except TypeError, KeyError:
+        ansible_facts = result
+
     module.exit_json(ansible_facts=ansible_facts, warnings=warnings)
 
 if __name__ == '__main__':

roles/resource_module/templates/module_utils/network_os/argspec/facts/facts.py.j2

@@ -15,9 +15,10 @@ class FactsArgs(object): #pylint: disable=R0903
 
     choices = [
         'all',
-        'net_configuration_{{ resource }}',
+        '{{ resource }}',
     ]
 
     argument_spec = {
-        'gather_subset': dict(default=['all'], choices=choices, type='list')
+        'gather_subset': dict(default=['!config'], type='list'),
+        'gather_network_resources': dict(default=['all'], choices=choices, type='list'),
     }

roles/resource_module/templates/module_utils/network_os/config/resource/resource.py.j2

@@ -26,7 +26,12 @@ class {{ resource|capitalize }}(ConfigBase, {{ resource|capitalize }}Args):
     """
 
     gather_subset = [
-        'net_configuration_{{ resource }}',
+        '!all',
+        '!min',
+    ]
+
+    gather_network_resources = [
+        {{ resource }},
     ]
 
     def get_{{ resource }}_facts(self):
@@ -35,8 +40,12 @@ class {{ resource|capitalize }}(ConfigBase, {{ resource|capitalize }}Args):
         :rtype: A dictionary
         :returns: The current configuration as a dictionary
         """
-        facts = Facts().get_facts(self._module, self._connection, self.gather_subset)
-        {{ resource }}_facts = facts['net_configuration'].get('{{ resource }}')
+        result = Facts().get_facts(self._module, self._connection, self.gather_subset, self.gather_network_resources)
+        try:
+            facts = result[0]
+        except TypeError, KeyError:
+            facts = result
+        {{ resource }}_facts = facts['ansible_network_resources'].get('{{ resource }}')
         if not {{ resource }}_facts:
             return []
         return {{ resource }}_facts

roles/resource_module/templates/module_utils/network_os/facts/base.py.j2

@@ -17,7 +17,7 @@ class FactsBase(object): #pylint: disable=R0205
     The {{ network_os }} facts base class
     """
     generated_spec = {}
-    ansible_facts = {'net_configuration': {}}
+    ansible_facts = {'ansible_network_resources': {}}
 
     def __init__(self, argspec, subspec=None, options=None):
         spec = deepcopy(argspec)

roles/resource_module/templates/module_utils/network_os/facts/facts.py.j2

@@ -8,6 +8,7 @@ this file validates each subset of facts and selectively
 calls the appropriate facts gathering function
 """
 
+from ansible.module_utils.six import string_types, iteritems
 from {{ import_path }}. \
      {{ network_os }}.argspec.facts.facts import FactsArgs
 from {{ import_path }}. \
@@ -17,36 +18,34 @@ from {{ import_path }}. \
 from {{ import_path }}. \
      {{ network_os }}.facts.{{ resource }}.{{ resource }} import {{ resource|capitalize }}Facts
 
+
+FACT_SUBSETS = {}
+
 class Facts(FactsArgs, FactsBase): #pylint: disable=R0903
     """ The fact class for {{ network_os }}
     """
 
-    def get_facts(self, module, connection, gather_subset=['all']):
-        """ Collect the facts for {{ network_os }}
-
-        :param module: The module instance
-        :param connection: The device connection
-        :param gather_subset: The facts subset to collect
-        :rtype: dict
-        :returns: the facts gathered
-        """
-        valid_subsets = self.argument_spec['gather_subset'].get('choices', [])
-        if valid_subsets and 'all' in valid_subsets:
-            valid_subsets.remove('all')
+    VALID_GATHER_SUBSETS = frozenset(FACT_SUBSETS.keys())
 
+    def generate_runable_subsets(self, module, subsets, valid_subsets):
         runable_subsets = set()
         exclude_subsets = set()
-        if not gather_subset:
-            gather_subset = ['all']
+        minimal_gather_subset = frozenset(['default'])
 
-        for subset in gather_subset:
+        for subset in subsets:
             if subset == 'all':
                 runable_subsets.update(valid_subsets)
                 continue
+            if subset == 'min' and minimal_gather_subset:
+                runable_subsets.update(minimal_gather_subset)
+                continue
             if subset.startswith('!'):
                 subset = subset[1:]
+                if subset == 'min':
+                    exclude_subsets.update(minimal_gather_subset)
+                    continue
                 if subset == 'all':
-                    exclude_subsets.update(valid_subsets)
+                    exclude_subsets.update(valid_subsets - minimal_gather_subset)
                     continue
                 exclude = True
             else:
@@ -62,16 +61,61 @@ class Facts(FactsArgs, FactsBase): #pylint: disable=R0903
 
         if not runable_subsets:
             runable_subsets.update(valid_subsets)
-
         runable_subsets.difference_update(exclude_subsets)
-        self.ansible_facts['gather_subset'] = list(runable_subsets)
 
-        for attr in runable_subsets:
-            getattr(self, '_get_%s' % attr, {})(module, connection)
+        return runable_subsets
+
+    def get_facts(self, module, connection, gather_subset=['!config'], gather_network_resources=['all']):
+        """ Collect the facts for {{ network_os }}
+
+        :param module: The module instance
+        :param connection: The device connection
+        :param gather_subset: The facts subset to collect
+	:param gather_network_resources: The resource subset to collect
+        :rtype: dict
+        :returns: the facts gathered
+        """
+	self.ansible_facts['gather_network_resources'] = list()
+        self.ansible_facts['gather_subset'] = list()
+
+        valid_network_resources_subsets = self.argument_spec['gather_network_resources'].get('choices', [])
+        if valid_network_resources_subsets and 'all' in valid_network_resources_subsets:
+            valid_network_resources_subsets.remove('all')
+
+        if valid_network_resources_subsets:
+            resources_runable_subsets = self.generate_runable_subsets(module, gather_network_resources, valid_network_resources_subsets)
+            if resources_runable_subsets:
+                self.ansible_facts['gather_network_resources'] = list(resources_runable_subsets)
+                for attr in resources_runable_subsets:
+                    getattr(self, '_get_%s' % attr, {})(module, connection)
+
+        if self.VALID_GATHER_SUBSETS:
+            runable_subsets = self.generate_runable_subsets(module, gather_subset, self.VALID_GATHER_SUBSETS)
+
+            if runable_subsets:
+                facts = dict()
+                self.ansible_facts['gather_subset'] = list(runable_subsets)
+
+                instances = list()
+                for key in runable_subsets:
+                    instances.append(FACT_SUBSETS[key](module))
+
+                for inst in instances:
+                    inst.populate()
+                    facts.update(inst.facts)
+                    warnings.extend(inst.warnings)
+
+                for key, value in iteritems(facts):
+                    key = 'ansible_net_%s' % key
+                    self.ansible_facts[key] = value
+
+        if warnings:
+            return self.ansible_facts, warnings
+        else:
+            return self.ansible_facts
 
-        return self.ansible_facts
 
     @staticmethod
-    def _get_net_configuration_{{ resource }}(module, connection):
+    def _get_{{ resource }}(module, connection):
         return {{ resource|capitalize }}Facts({{ resource|capitalize }}Args. \
                argument_spec, 'config', 'options').populate_facts(module, connection)

roles/resource_module/templates/module_utils/network_os/facts/resource/resource.py.j2

@@ -44,7 +44,7 @@ class {{ resource|capitalize }}Facts(FactsBase):
         facts = {}
         if objs:
             facts['{{ resource }}'] = objs
-        self.ansible_facts['net_configuration'].update(facts)
+        self.ansible_facts['ansible_network_resources'].update(facts)
         return self.ansible_facts
 
     def render_config(self, spec, conf):