Merge pull request #36 from ansible-network/bt_add_tests_and_sample

add tests, model changes and a little bit of code

Reviewed-by: Bradley A. Thornton
             https://github.com/cidrblock

Author: ansible-zuul[bot]

README.md

@@ -248,3 +248,14 @@ def main():
 `module_utils/<ansible_network_os>/utils`.
 
 - Utilities for the` <ansible_network_os>` platform.
+
+### Developer Notes
+
+The tests rely on a role generated by the resource module builder. After changes to the resource module builder, the role should be regenerated and the tests modified and run as needed.  To generate the role after changes:
+
+```
+ansible-playbook -e parent=./tests/roles/my_role \
+                 -e structure=role \
+                 -e model=models/myos/interfaces/myos_interfaces.yml \
+                 site.yml
+```

models/myos/interfaces/myos_interfaces.yml

@@ -26,11 +26,14 @@ DOCUMENTATION: |
       type: list
       elements: dict
       suboptions:
+        name:
+          type: str
+          description: The name of the <resource>
         some_string:
           type: str
           description:
           - The some_string_01
-          chocies:
+          choices:
           - choice_a
           - choice_b
           - choice_c

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

@@ -90,7 +90,8 @@ def main():
     """
     module = AnsibleModule(argument_spec=Facts.argument_spec,
                            supports_check_mode=True)
-    warnings = ['default value for `gather_subset` will be changed to `min` from `!config` v2.11 onwards']
+    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']

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

@@ -12,7 +12,7 @@ from copy import deepcopy
 from ansible.module_utils.six import iteritems
 
 
-class FactsBase(object): #pylint: disable=R0205
+class FactsBase(object):
     """
     The {{ network_os }} facts base class
     """
@@ -31,8 +31,7 @@ class FactsBase(object): #pylint: disable=R0205
 
         self.generated_spec = self.generate_dict(facts_argument_spec)
 
-    @staticmethod
-    def generate_dict(spec):
+    def generate_dict(self, spec):
         """
         Generate dictionary which is in sync with argspec
 
@@ -47,10 +46,11 @@ class FactsBase(object): #pylint: disable=R0205
         for key, val in iteritems(spec):
             if 'default' in val:
                 dct = {key: val['default']}
+            elif 'type' in val and val['type'] == 'dict':
+                dct = {key: self.generate_dict(val['options'])}
             else:
                 dct = {key: None}
             obj.update(dct)
-
         return obj
 
     @staticmethod
@@ -91,8 +91,7 @@ class FactsBase(object): #pylint: disable=R0205
                 return res2
         return None
 
-    @staticmethod
-    def generate_final_config(cfg_dict):
+    def generate_final_config(self, cfg_dict):
         """
         Generate final config dictionary
 
@@ -105,6 +104,13 @@ class FactsBase(object): #pylint: disable=R0205
             return final_cfg
 
         for key, val in iteritems(cfg_dict):
-            if val:
-                final_cfg.update({key:val})
+            dct = None
+            if isinstance(val, dict):
+                child_val = self.generate_final_config(val)
+                if child_val:
+                    dct = {key: child_val}
+            elif val:
+                dct = {key: val}
+            if dct:
+                final_cfg.update(dct)
         return final_cfg

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

@@ -8,6 +8,7 @@ It is in this file the configuration is collected from the device
 for a given resource, parsed, and the facts tree is populated
 based on the configuration.
 """
+import re
 from copy import deepcopy
 from {{ import_path }}. \
      {{ network_os }}.facts.base import FactsBase
@@ -18,7 +19,6 @@ class {{ resource|capitalize }}Facts(FactsBase):
 
     def populate_facts(self, module, connection, data=None):
         """ Populate the facts for {{ resource }}
-
         :param module: the module instance
         :param connection: the device connection
         :param data: previously collected conf
@@ -31,14 +31,26 @@ class {{ resource|capitalize }}Facts(FactsBase):
             pass
 
         if not data:
-            data = "foo" # connection.get('show running-config | section ^interface')
+            # typically data is populated from the current device configuration
+            # data = connection.get('show running-config | section ^interface')
+            # using mock data instead
+            data = ("resource rsrc_a\n"
+                    "  a_bool true\n"
+                    "  a_string choice_a\n"
+                    "  resource here\n"
+                    "resource rscrc_b\n"
+                    "  key is property01 value is value end\n"
+                    "  an_int 10\n")
+
+        # split the config into instances of the resource
+        resource_delim = 'resource'
+        find_pattern = r'(?:^|\n)%s.*?(?=(?:^|\n)%s|$)' % (resource_delim, resource_delim)
+        resources = [p.strip() for p in re.findall(find_pattern, data, re.DOTALL)]
 
-        # operate on a collection of resource x
-        config = [data] # data.split('interface ')
         objs = []
-        for conf in config:
-            if conf:
-                obj = self.render_config(self.generated_spec, conf)
+        for resource in resources:
+            if resource:
+                obj = self.render_config(self.generated_spec, resource)
                 if obj:
                     objs.append(obj)
         facts = {}
@@ -56,9 +68,23 @@ class {{ resource|capitalize }}Facts(FactsBase):
         :rtype: dictionary
         :returns: The generated config
         """
-        if conf:
-            pass
         config = deepcopy(spec)
-        # populate the facts from the configuration
-        config = {"some": "value"}
+
+        config['name'] = self.parse_conf_arg(conf, 'resource')
+        config['some_string'] = self.parse_conf_arg(conf, 'a_string')
+
+        match = re.match(r'.*key is property01 (\S+)', conf, re.MULTILINE|re.DOTALL)
+        if match:
+            config['some_dict']['property_01'] = match.groups()[0]
+
+        try:
+            config['some_bool'] = bool(self.parse_conf_arg(conf, 'a_bool'))
+        except TypeError:
+            config['some_bool'] = None
+
+        try:
+            config['some_int'] = int(self.parse_conf_arg(conf, 'an_int'))
+        except TypeError:
+            config['some_int'] = None
+
         return self.generate_final_config(config)

tests/ansible.cfg

@@ -0,0 +1,3 @@
+[defaults]
+host_key_checking = False
+stdout_callback = yaml

tests/inventory.yml

@@ -0,0 +1,15 @@
+all:
+  children:
+    eos:
+      hosts:
+        myos101:
+          ansible_host: vyos101
+      vars:
+        ansible_network_os: vyos
+        ansible_user: admin
+        ansible_connection: network_cli
+        ansible_password: password
+        ansible_become: True
+        ansible_become_method: enable
+        ansible_become_pass: password
+        ansible_facts_modules: myos_facts