Merge pull request #159 from napalm-automation/develop

napalm-ansible release 1.0.0

Author: ktbyers

.travis.yml

@@ -6,14 +6,14 @@ python:
     - 3.6
 
 env:
-    - ANSIBLE_VERSION=2.3
-    - ANSIBLE_VERSION=2.4
     - ANSIBLE_VERSION=2.5
     - ANSIBLE_VERSION=2.6
+    - ANSIBLE_VERSION=2.7
+    - ANSIBLE_VERSION=2.8
 
 install:
     - pip install pylama
-    - pip install napalm
+    - pip install -r requirements.txt
     - pip install "ansible>=$ANSIBLE_VERSION.0,<$ANSIBLE_VERSION.99"
     - pip install -r requirements-dev.txt
     - pip install -e .

CHANGELOG.rst

@@ -1,6 +1,14 @@
-develop
+1.0.0
 =====
 
+    - Add support for ansible_network_os
+    - Fix minor documentation errors
+    - Expand filenames for `*_file` parameters
+    - Fix Ansible 2.8 backwards incompatible changes
+    - Removing support of legacy napalm_base
+    - Changing napalm_cli to cli_results; napalm_ping to ping_results
+    - Use yaml safe_load for tests
+
 0.10.0
 =====
 

README.md

@@ -105,7 +105,7 @@ Example to get compliance report
     validation_file: validate.yml
 ```
 
-Example to use default connection paramters:
+Example to use default connection parameters:
 ```
  - name: get facts from device
    napalm_get_facts:

napalm_ansible/modules/napalm_cli.py

@@ -1,5 +1,14 @@
 from __future__ import unicode_literals, print_function
-from ansible.module_utils.basic import AnsibleModule, return_values
+from ansible.module_utils.basic import AnsibleModule
+
+
+# FIX for Ansible 2.8 moving this function and making it private
+# greatly simplified for napalm-ansible's use
+def return_values(obj):
+    """ Return native stringified values from datastructures.
+
+    For use with removing sensitive values pre-jsonification."""
+    yield str(obj)
 
 
 DOCUMENTATION = '''
@@ -87,15 +96,6 @@
 except ImportError:
     pass
 
-# Legacy for pre-reunification napalm (remove in future)
-if not napalm_found:
-    try:
-        from napalm_base import get_network_driver   # noqa
-        from napalm_base import ModuleImportError    # noqa
-        napalm_found = True
-    except ImportError:
-        pass
-
 
 def main():
     module = AnsibleModule(
@@ -175,7 +175,7 @@ def main():
     except Exception as e:
         module.fail_json(msg="cannot close device connection: " + str(e))
 
-    module.exit_json(changed=False, results=cli_response)
+    module.exit_json(changed=False, cli_results=cli_response)
 
 
 if __name__ == '__main__':

napalm_ansible/modules/napalm_get_facts.py

@@ -3,8 +3,8 @@
 
 This file is part of Ansible
 
-Ansible is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
+Ansible is free software: you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.
 
@@ -17,7 +17,16 @@
 along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
 """
 from __future__ import unicode_literals, print_function
-from ansible.module_utils.basic import AnsibleModule, return_values
+from ansible.module_utils.basic import AnsibleModule
+
+
+# FIX for Ansible 2.8 moving this function and making it private
+# greatly simplified for napalm-ansible's use
+def return_values(obj):
+    """ Return native stringified values from datastructures.
+
+    For use with removing sensitive values pre-jsonification."""
+    yield str(obj)
 
 
 DOCUMENTATION = '''
@@ -145,15 +154,6 @@
 except ImportError:
     pass
 
-# Legacy for pre-reunification napalm (remove in future)
-if not napalm_found:
-    try:
-        from napalm_base import get_network_driver     # noqa
-        from napalm_base import ModuleImportError      # noqa
-        napalm_found = True
-    except ImportError:
-        pass
-
 
 def main():
     module = AnsibleModule(

napalm_ansible/modules/napalm_install_config.py

@@ -18,7 +18,17 @@
 along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
 """
 from __future__ import unicode_literals, print_function
-from ansible.module_utils.basic import AnsibleModule, return_values
+import os.path
+from ansible.module_utils.basic import AnsibleModule
+
+
+# FIX for Ansible 2.8 moving this function and making it private
+# greatly simplified for napalm-ansible's use
+def return_values(obj):
+    """ Return native stringified values from datastructures.
+
+    For use with removing sensitive values pre-jsonification."""
+    yield str(obj)
 
 
 DOCUMENTATION = '''
@@ -165,15 +175,6 @@
 except ImportError:
     pass
 
-# Legacy for pre-reunification napalm (remove in future)
-if not napalm_found:
-    try:
-        from napalm_base import get_network_driver   # noqa
-        from napalm_base import ModuleImportError    # noqa
-        napalm_found = True
-    except ImportError:
-        pass
-
 
 def save_to_file(content, filename):
     with open(filename, 'w') as f:
@@ -236,6 +237,14 @@ def main():
     get_diffs = module.params['get_diffs']
     archive_file = module.params['archive_file']
     candidate_file = module.params['candidate_file']
+    if config_file:
+        config_file = os.path.expanduser(os.path.expandvars(config_file))
+    if diff_file:
+        diff_file = os.path.expanduser(os.path.expandvars(diff_file))
+    if archive_file:
+        archive_file = os.path.expanduser(os.path.expandvars(archive_file))
+    if candidate_file:
+        candidate_file = os.path.expanduser(os.path.expandvars(candidate_file))
 
     argument_check = {'hostname': hostname, 'username': username, 'dev_os': dev_os}
     for key, val in argument_check.items():

napalm_ansible/modules/napalm_parse_yang.py

@@ -17,7 +17,7 @@
 along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
 """
 from __future__ import unicode_literals, print_function
-from ansible.module_utils.basic import AnsibleModule, return_values
+from ansible.module_utils.basic import AnsibleModule
 import json
 
 napalm_found = False
@@ -28,21 +28,21 @@
 except ImportError:
     pass
 
-# Legacy for pre-reunification napalm (remove in future)
-if not napalm_found:
-    try:
-        from napalm_base import get_network_driver    # noqa
-        from napalm_base import ModuleImportError    # noqa
-        napalm_found = True
-    except ImportError:
-        pass
-
 try:
     import napalm_yang
 except ImportError:
     napalm_yang = None
 
 
+# FIX for Ansible 2.8 moving this function and making it private
+# greatly simplified for napalm-ansible's use
+def return_values(obj):
+    """ Return native stringified values from datastructures.
+
+    For use with removing sensitive values pre-jsonification."""
+    yield str(obj)
+
+
 DOCUMENTATION = '''
 ---
 module: napalm_parse_yang

napalm_ansible/modules/napalm_ping.py

@@ -14,7 +14,16 @@
 along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
 """
 from __future__ import unicode_literals, print_function
-from ansible.module_utils.basic import AnsibleModule, return_values
+from ansible.module_utils.basic import AnsibleModule
+
+
+# FIX for Ansible 2.8 moving this function and making it private
+# greatly simplified for napalm-ansible's use
+def return_values(obj):
+    """ Return native stringified values from datastructures.
+
+    For use with removing sensitive values pre-jsonification."""
+    yield str(obj)
 
 
 DOCUMENTATION = '''
@@ -136,15 +145,6 @@
 except ImportError:
     pass
 
-# Legacy for pre-reunification napalm (remove in future)
-if not napalm_found:
-    try:
-        from napalm_base import get_network_driver   # noqa
-        from napalm_base import ModuleImportError    # noqa
-        napalm_found = True
-    except ImportError:
-        pass
-
 
 def main():
     module = AnsibleModule(
@@ -236,7 +236,7 @@ def main():
     except Exception as e:
         module.fail_json(msg="cannot close device connection: " + str(e))
 
-    module.exit_json(changed=False, results=ping_response)
+    module.exit_json(changed=False, ping_results=ping_response)
 
 
 if __name__ == '__main__':

napalm_ansible/modules/napalm_validate.py

@@ -1,5 +1,5 @@
 from __future__ import unicode_literals, print_function
-from ansible.module_utils.basic import AnsibleModule, return_values
+from ansible.module_utils.basic import AnsibleModule
 
 napalm_found = False
 try:
@@ -9,21 +9,21 @@
 except ImportError:
     pass
 
-# Legacy for pre-reunification napalm (remove in future)
-if not napalm_found:
-    try:
-        from napalm_base import get_network_driver  # noqa
-        from napalm_base import ModuleImportError   # noqa
-        napalm_found = True
-    except ImportError:
-        pass
-
 try:
     import napalm_yang
 except ImportError:
     napalm_yang = None
 
 
+# FIX for Ansible 2.8 moving this function and making it private
+# greatly simplified for napalm-ansible's use
+def return_values(obj):
+    """ Return native stringified values from datastructures.
+
+    For use with removing sensitive values pre-jsonification."""
+    yield str(obj)
+
+
 DOCUMENTATION = '''
 ---
 module: napalm_validate

napalm_ansible/plugins/action/napalm.py

@@ -18,6 +18,9 @@ def run(self, tmp=None, task_vars=None):
             # Timeout can't be passed via command-line as Ansible defaults to a 10 second timeout
             provider['timeout'] = provider.get('timeout', 60)
 
+            if hasattr(pc, 'network_os'):
+                provider['dev_os'] = provider.get('dev_os', pc.network_os)
+
             self._task.args['provider'] = provider
 
         result = super(ActionModule, self).run(tmp, task_vars)

requirements.txt

@@ -1 +1,2 @@
 napalm
+six

setup.py

@@ -6,7 +6,7 @@
 
 setup(
     name="napalm-ansible",
-    version='0.10.0',
+    version='1.0.0',
     packages=find_packages(exclude=("test*", "library")),
     author="David Barroso, Kirk Byers, Mircea Ulinic",
     author_email="[email protected], [email protected]",

tests/napalm_cli/multiple_commands.yaml

@@ -19,5 +19,5 @@
       register: result
     - assert:
         that:
-            - "{{ result.results['show version']|length > 10 }}"
-            - "{{ result.results['show interfaces']|length > 10 }}"
+            - "{{ result.cli_results['show version']|length > 10 }}"
+            - "{{ result.cli_results['show interfaces']|length > 10 }}"

tests/napalm_connection/connection_ansible_network_os.yaml

@@ -0,0 +1,13 @@
+---
+- name: Get facts
+  hosts: all
+  connection: local                       # code is run locally
+  gather_facts: no                        # don't gather facts
+  tasks:
+    - block:
+      - name: get facts from device
+        napalm_get_facts:                   # NAPALM plugin
+          optional_args:
+            path: "{{ playbook_dir }}/mocked"
+            profile: "{{ profile }}"
+          filter: ['facts']

tests/napalm_connection/hosts

@@ -1,5 +1,5 @@
 [all]
-dummy              os=mock   profile=[eos] password=vagrant
+dummy              os=mock   profile=[eos] password=vagrant ansible_network_os=mock
 
 [all:vars]
 ansible_python_interpreter="/usr/bin/env python"

tests/run_tests.sh

@@ -4,6 +4,7 @@ set -e
 ansible-playbook -i napalm_connection/hosts napalm_connection/connection_info_missing.yaml
 ansible-playbook -i napalm_connection/hosts napalm_connection/connection_info_in_vars.yaml
 ansible-playbook -i napalm_connection/hosts napalm_connection/connection_info_in_args.yaml -u vagrant
+ansible-playbook -i napalm_connection/hosts napalm_connection/connection_ansible_network_os.yaml -u vagrant
 ANSIBLE_REMOTE_USER=vagrant ansible-playbook -i napalm_connection/hosts napalm_connection/connection_info_in_env.yaml 
 
 ansible-playbook -i napalm_install_config/hosts -l "*.dry_run.*" napalm_install_config/config.yaml -C