Merge pull request #139 from napalm-automation/develop

Release 0.10.0

.gitignore

@@ -33,6 +33,7 @@ htmlcov/
 .cache
 nosetests.xml
 coverage.xml
+.pytest_cache/
 
 # Translations
 *.mo

.travis.yml

@@ -2,11 +2,14 @@ language: python
 
 python:
     - 2.7
+    - 3.5
+    - 3.6
 
 env:
-    - ANSIBLE_VERSION=2.2
     - ANSIBLE_VERSION=2.3
     - ANSIBLE_VERSION=2.4
+    - ANSIBLE_VERSION=2.5
+    - ANSIBLE_VERSION=2.6
 
 install:
     - pip install pylama

CHANGELOG.rst

@@ -1,6 +1,16 @@
 develop
 =====
 
+0.10.0
+=====
+
+    - Python3 support
+    - Fix issue with an exception in napalm_install_config
+
+0.9.1
+=====
+
+    - Fix PIP10 compatibility issue
     - Add support for saving `candidate_file` during the config install
 
 0.9.0

napalm_ansible/__init__.py

@@ -1,3 +1,4 @@
+from __future__ import unicode_literals, print_function
 import os
 import ansible
 from distutils.version import LooseVersion

napalm_ansible/modules/napalm_cli.py

@@ -1,14 +1,15 @@
+from __future__ import unicode_literals, print_function
 from ansible.module_utils.basic import AnsibleModule, return_values
 
 
 DOCUMENTATION = '''
 ---
 module: napalm_cli
-author: "Charlie Allom - based on napalm_ping Jason Edelman (@jedelman8)"
+author: "Charlie Allom"
 version_added: "2.2"
-short_description: "Executes CLI commands and returns response using NAPALM"
+short_description: "Executes network device CLI commands and returns response using NAPALM"
 description:
-    - "This module logs into the device, issues a ping request, and returns the response"
+    - "Executes network device CLI commands and returns response using NAPALM"
 requirements:
     - napalm
 options:
@@ -32,8 +33,6 @@
         description:
           - OS of the device
         required: False
-        choices: ['eos', 'junos', 'iosxr', 'fortios', 'ios', 'mock', 'nxos', 'nxos_ssh', 'panos',
-        'vyos']
     provider:
         description:
           - Dictionary which acts as a collection of arguments used to define the characteristics
@@ -83,6 +82,7 @@
 napalm_found = False
 try:
     from napalm import get_network_driver
+    from napalm.base import ModuleImportError
     napalm_found = True
 except ImportError:
     pass
@@ -91,22 +91,21 @@
 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():
-    os_choices = ['eos', 'junos', 'iosxr', 'fortios',
-                  'ios', 'mock', 'nxos', 'nxos_ssh', 'panos', 'vyos', 'ros']
     module = AnsibleModule(
         argument_spec=dict(
             hostname=dict(type='str', required=False, aliases=['host']),
             username=dict(type='str', required=False),
             password=dict(type='str', required=False, no_log=True),
             provider=dict(type='dict', required=False),
             timeout=dict(type='int', required=False, default=60),
-            dev_os=dict(type='str', required=False, choices=os_choices),
+            dev_os=dict(type='str', required=False),
             optional_args=dict(required=False, type='dict', default=None),
             args=dict(required=True, type='dict', default=None),
         ),
@@ -146,17 +145,17 @@ def main():
         if val is None:
             module.fail_json(msg=str(key) + " is required")
 
-    # use checks outside of ansible defined checks, since params come can come from provider
-    if dev_os not in os_choices:
-        module.fail_json(msg="dev_os is not set to " + str(os_choices))
-
     if module.params['optional_args'] is None:
         optional_args = {}
     else:
         optional_args = module.params['optional_args']
 
     try:
         network_driver = get_network_driver(dev_os)
+    except ModuleImportError as e:
+        module.fail_json(msg="Failed to import napalm driver: " + str(e))
+
+    try:
         device = network_driver(hostname=hostname,
                                 username=username,
                                 password=password,

napalm_ansible/modules/napalm_diff_yang.py

@@ -1,6 +1,5 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
-
 """
 (c) 2017 David Barroso <[email protected]>
 
@@ -19,6 +18,7 @@
 You should have received a copy of the GNU General Public License
 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
 
 try:

napalm_ansible/modules/napalm_get_facts.py

@@ -16,6 +16,7 @@
 You should have received a copy of the GNU General Public License
 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
 
 
@@ -46,8 +47,6 @@
         description:
           - OS of the device
         required: False
-        choices: ['eos', 'junos', 'iosxr', 'fortios', 'ios', 'mock', 'nxos', 'nxos_ssh', 'panos',
-        'vyos']
     provider:
         description:
           - Dictionary which acts as a collection of arguments used to define the characteristics
@@ -141,6 +140,7 @@
 napalm_found = False
 try:
     from napalm import get_network_driver
+    from napalm.base import ModuleImportError
     napalm_found = True
 except ImportError:
     pass
@@ -149,21 +149,20 @@
 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():
-    os_choices = ['eos', 'junos', 'iosxr', 'fortios', 'ios', 'mock', 'nxos', 'nxos_ssh', 'panos',
-                  'vyos', 'ros']
     module = AnsibleModule(
         argument_spec=dict(
             hostname=dict(type='str', required=False, aliases=['host']),
             username=dict(type='str', required=False),
             password=dict(type='str', required=False, no_log=True),
             provider=dict(type='dict', required=False),
-            dev_os=dict(type='str', required=False, choices=os_choices),
+            dev_os=dict(type='str', required=False),
             timeout=dict(type='int', required=False, default=60),
             ignore_notimplemented=dict(type='bool', required=False, default=False),
             args=dict(type='dict', required=False, default=None),
@@ -210,18 +209,17 @@ def main():
         if val is None:
             module.fail_json(msg=str(key) + " is required")
 
-    # use checks outside of ansible defined checks, since params come can come from provider
-    if dev_os not in os_choices:
-        module.fail_json(msg="dev_os is not set to " + str(os_choices))
-
     if module.params['optional_args'] is None:
         optional_args = {}
     else:
         optional_args = module.params['optional_args']
 
-    # open device connection
     try:
         network_driver = get_network_driver(dev_os)
+    except ModuleImportError as e:
+        module.fail_json(msg="Failed to import napalm driver: " + str(e))
+
+    try:
         device = network_driver(hostname=hostname,
                                 username=username,
                                 password=password,

napalm_ansible/modules/napalm_install_config.py

@@ -17,6 +17,7 @@
 You should have received a copy of the GNU General Public License
 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
 
 
@@ -56,8 +57,6 @@
         description:
           - OS of the device
         required: False
-        choices: ['eos', 'junos', 'iosxr', 'fortios', 'ios', 'mock', 'nxos', 'nxos_ssh', 'panos',
-        'vyos']
     timeout:
         description:
           - Time in seconds to wait for the device to respond
@@ -161,6 +160,7 @@
 napalm_found = False
 try:
     from napalm import get_network_driver
+    from napalm.base import ModuleImportError
     napalm_found = True
 except ImportError:
     pass
@@ -169,22 +169,18 @@
 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):
-    f = open(filename, 'w')
-    try:
+    with open(filename, 'w') as f:
         f.write(content)
-    finally:
-        f.close()
 
 
 def main():
-    os_choices = ['eos', 'junos', 'iosxr', 'fortios', 'ios', 'mock', 'nxos',
-                  'nxos_ssh', 'panos', 'vyos', 'ros']
     module = AnsibleModule(
         argument_spec=dict(
             hostname=dict(type='str', required=False, aliases=['host']),
@@ -195,7 +191,7 @@ def main():
             optional_args=dict(required=False, type='dict', default=None),
             config_file=dict(type='str', required=False),
             config=dict(type='str', required=False),
-            dev_os=dict(type='str', required=False, choices=os_choices),
+            dev_os=dict(type='str', required=False),
             commit_changes=dict(type='bool', required=True),
             replace_config=dict(type='bool', required=False, default=False),
             diff_file=dict(type='str', required=False, default=None),
@@ -246,17 +242,17 @@ def main():
         if val is None:
             module.fail_json(msg=str(key) + " is required")
 
-    # use checks outside of ansible defined checks, since params come can come from provider
-    if dev_os not in os_choices:
-        module.fail_json(msg="dev_os is not set to " + str(os_choices))
-
     if module.params['optional_args'] is None:
         optional_args = {}
     else:
         optional_args = module.params['optional_args']
 
     try:
         network_driver = get_network_driver(dev_os)
+    except ModuleImportError as e:
+        module.fail_json(msg="Failed to import napalm driver: " + str(e))
+
+    try:
         device = network_driver(hostname=hostname,
                                 username=username,
                                 password=password,
@@ -290,7 +286,7 @@ def main():
 
     try:
         if get_diffs:
-            diff = device.compare_config().encode('utf-8')
+            diff = device.compare_config()
             changed = len(diff) > 0
         else:
             changed = True
@@ -304,7 +300,7 @@ def main():
         if candidate_file is not None:
             running_config = device.get_config(retrieve="candidate")["candidate"]
             save_to_file(running_config, candidate_file)
-    except Exception, e:
+    except Exception as e:
         module.fail_json(msg="cannot retrieve running config:" + str(e))
 
     try: