Merge pull request #221 from networktocode/develop

Develop

Author: jmcgill298

.travis.yml

@@ -8,14 +8,25 @@ python:
 
 install:
   # XXX: Migrate this to Poetry fully
-  - pip install virtualenv
+  - "pip install virtualenv"
+  - "virtualenv ./venv"
+  - "source ./venv/bin/activate"
+  - "python -m pip install -U pip"
+  - "pip install tox"
 
+jobs:
+  include:
+    - stage: "lint"
+      name: "Linting Tests"
+      script: "tox -e black"
+    - script: "tox -e flake8"
+    - script: "tox -e bandit"
+    - script: "tox -e pydocstyle"
+
+stages:
+  - "lint"
+  - "test"
 
 script:
-  # Activate virtualenv, install tox and run all tests.
-  - virtualenv ./venv
-  - source ./venv/bin/activate
-  - python -m pip install -U pip
-  - pip install tox
-  - tox
-  - tox -e coveralls
+  - "tox -e py46,py37,py38"
+  - "tox -e coveralls"

CHANGELOG.md

@@ -12,6 +12,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/)
 ### Fixed
 ### Security
 
+## [0.18.0]
+### Added
+- IOSXEWLCDevice device Driver.
+### Fixed
+- IOS `rollback()` method derives filesystem name using `_get_file_system()` method to discover it from system.
+
 ## [0.17.0]
 ### Added
 - ASADevice supports connecting to HA Peer

pyntc/__init__.py

@@ -1,5 +1,4 @@
-"""Kickoff functions for getting instancs of device objects.
-"""
+"""Kickoff functions for getting instancs of device objects."""
 
 import os
 import warnings
@@ -12,7 +11,7 @@
 except ImportError:
     from ConfigParser import SafeConfigParser
 
-__version__ = "0.17.0"
+__version__ = "0.18.0"
 
 LIB_PATH_ENV_VAR = "PYNTC_CONF"
 LIB_PATH_DEFAULT = "~/.ntc.conf"
@@ -22,9 +21,10 @@
 
 
 def ntc_device(device_type, *args, **kwargs):
-    """Instantiate and return an instance of a device subclassed
-    from ``pyntc.devices.BaseDevice``. ``*args`` and ``*kwargs`` are passed
-    directly to the device initializer.
+    """
+    Instantiate an instance of a ``pyntc.devices.BaseDevice`` by ``device_type``.
+
+    The ``*args`` and ``*kwargs`` are passed directly to the device initializer.
 
     Arguments:
         device_type (string): A valid device_type
@@ -36,7 +36,6 @@ def ntc_device(device_type, *args, **kwargs):
     Raises:
         UnsupportedDeviceError: if the device_type is unsupported.
     """
-
     try:
         device_class = supported_devices[device_type]
         return device_class(*args, **kwargs)
@@ -45,9 +44,8 @@ def ntc_device(device_type, *args, **kwargs):
 
 
 def ntc_device_by_name(name, filename=None):
-    """Instantiate and return an instance of a device subclassed
-    from ``pyntc.devices.BaseDevice`` based on its name in an
-    NTC configuration file.
+    """
+    Instantiate an instance of a ``pyntc.devices.BaseDevice`` from ntc.conf file.
 
     If no filename is given the environment variable PYNTC_CONF is checked
     for a path, and then ~/.ntc.conf.
@@ -58,9 +56,8 @@ def ntc_device_by_name(name, filename=None):
             the ``name`` argument as section header.
 
     Raises:
-        DeviceNameNotFoundError: if the name is not found in the
-            NTC configuration file.
-        ConfFileNotFoundError: if no NTC configuration can be found.
+        DeviceNameNotFoundError: If the name is not found in the NTC configuration file.
+        ConfFileNotFoundError: If no NTC configuration can be found.
     """
     config, filename = _get_config_from_file(filename=filename)
     sections = config.sections()

pyntc/devices/__init__.py

@@ -1,6 +1,4 @@
-"""Supported devices are stored here. Every supported device needs a
-device_type stored as a string, and a class subclassed from BaseDevice.
-"""
+"""Device drivers."""
 
 from .eos_device import EOSDevice
 from .nxos_device import NXOSDevice
@@ -9,6 +7,7 @@
 from .asa_device import ASADevice
 from .f5_device import F5Device
 from .aireos_device import AIREOSDevice
+from .iosxewlc_device import IOSXEWLCDevice
 
 
 supported_devices = {
@@ -19,4 +18,5 @@
     "juniper_junos_netconf": JunosDevice,
     "cisco_nxos_nxapi": NXOSDevice,
     "cisco_aireos_ssh": AIREOSDevice,
+    "cisco_iosxewlc_ssh": IOSXEWLCDevice,
 }

pyntc/devices/aireos_device.py

@@ -69,7 +69,7 @@ class AIREOSDevice(BaseDevice):
     vendor = "cisco"
     active_redundancy_states = {None, "active"}
 
-    def __init__(self, host, username, password, secret="", port=22, confirm_active=True, **kwargs):
+    def __init__(self, host, username, password, secret="", port=22, confirm_active=True, **kwargs):  # noqa: D403
         """
         PyNTC Device implementation for Cisco WLC.
 
@@ -388,7 +388,7 @@ def ap_boot_options(self):
     @property
     def ap_image_stats(self):
         """
-        The stats of downloading the the image to all APs.
+        Stats of downloading the the image to all APs.
 
         Returns:
             dict: The AP count, and the downloaded, unsupported, and failed APs.
@@ -417,12 +417,21 @@ def ap_image_stats(self):
         }
 
     def backup_running_config(self, filename):
+        """
+        Create backup of running config.
+
+        Args:
+            filename (str): Name of backup file.
+
+        Raises:
+            NotImplementedError: Function currently not implemented
+        """
         raise NotImplementedError
 
     @property
     def boot_options(self):
         """
-        The images that are candidates for booting on reload.
+        Images that are candidates for booting on reload.
 
         Returns:
             dict: The boot options on the device. The "sys" key is the expected image on reload.
@@ -458,6 +467,16 @@ def boot_options(self):
         return result
 
     def checkpoint(self, filename):
+        """
+        Create a checkpoint file of the current config.
+
+        Args:
+            checkpoint_file (str):  Saves a checkpoint file with the name provided to the function.
+
+        Raises:
+            NotImplementedError: Function currently not implemented
+
+        """
         raise NotImplementedError
 
     def close(self):
@@ -467,7 +486,7 @@ def close(self):
             self._connected = False
 
     def config(self, command, **netmiko_args):
-        """
+        r"""
         Send config commands to device.
 
         By default, entering and exiting config mode is handled automatically.
@@ -535,7 +554,7 @@ def config(self, command, **netmiko_args):
 
         return command_responses
 
-    def config_list(self, commands, **netmiko_args):
+    def config_list(self, commands, **netmiko_args):  # noqa: D401
         """
         DEPRECATED - Use the `config` method.
 
@@ -602,7 +621,7 @@ def confirm_is_active(self):
     @property
     def connected(self):
         """
-        The connection status of the device.
+        Get connection status of the device.
 
         Returns:
             bool: True if the device is connected, else False.
@@ -657,9 +676,9 @@ def disable_wlans(self, wlan_ids):
                 raise WLANDisableError(self.host, desired_wlans, post_disabled_wlans)
 
     @property
-    def disabled_wlans(self):
+    def disabled_wlans(self):  # noqa: D403
         """
-        The IDs for all disabled WLANs.
+        IDs for all disabled WLANs.
 
         Returns:
             list: Disabled WLAN IDs.
@@ -741,9 +760,9 @@ def enable_wlans(self, wlan_ids):
                 raise WLANEnableError(self.host, desired_wlans, post_enabled_wlans)
 
     @property
-    def enabled_wlans(self):
+    def enabled_wlans(self):  # noqa: D403
         """
-        The IDs for all enabled WLANs.
+        IDs for all enabled WLANs.
 
         Returns:
             list: Enabled WLAN IDs.
@@ -768,6 +787,12 @@ def enabled_wlans(self):
 
     @property
     def facts(self):
+        """
+        Get facts from device.
+
+        Raises:
+            NotImplementedError: Function currently not implemented.
+        """
         raise NotImplementedError
 
     def file_copy(
@@ -851,6 +876,17 @@ def file_copy(
         return True
 
     def file_copy_remote_exists(self, src, dest=None, **kwargs):
+        """
+        Copy 'src' file to remote device.
+
+        Args:
+            src (str): The path to the file to be copied to the device.
+            dest (str, optional): The name to use for storing the file on the device.
+                Defaults to use the name of the ``src`` file.
+
+        Raises:
+            NotImplementedError: Function currently not implemented.
+        """
         raise NotImplementedError
 
     def install_os(self, image_name, controller="both", save_config=True, disable_wlans=None, **vendor_specifics):
@@ -1056,7 +1092,7 @@ def handler(signum, frame):
     @property
     def redundancy_mode(self):
         """
-        The oprating redundancy mode of the controller.
+        Get operating redundancy mode of the controller.
 
         Returns:
             str: The redundancy mode the device is operating in.
@@ -1097,10 +1133,22 @@ def redundancy_state(self):
         return redundancy_state
 
     def rollback(self):
+        """
+        Rollback to stored file config.
+
+        Raises:
+            NotImplementedError: Function currently not implemented.
+        """
         raise NotImplementedError
 
     @property
     def running_config(self):
+        """
+        Show running config.
+
+        Raises:
+            NotImplementedError: Function currently not implemented.
+        """
         raise NotImplementedError
 
     def save(self):
@@ -1222,9 +1270,10 @@ def show(self, command, expect_string=None, **netmiko_args):
 
         return command_responses
 
-    def show_list(self, commands, **netmiko_args):
+    def show_list(self, commands, **netmiko_args):  # noqa: D401
         """
         DEPRECATED - Use the `show` method.
+
         Send operational commands to the device.
 
         Args:
@@ -1255,6 +1304,12 @@ def show_list(self, commands, **netmiko_args):
 
     @property
     def startup_config(self):
+        """
+        Get startup config.
+
+        Raises:
+            NotImplementedError: Function currently not implemented.
+        """
         raise NotImplementedError
 
     def transfer_image_to_ap(self, image, timeout=None):
@@ -1334,7 +1389,7 @@ def transfer_image_to_ap(self, image, timeout=None):
     @property
     def uptime(self):
         """
-        The uptime of the device in seconds.
+        Get uptime of the device in seconds.
 
         Returns:
             int: The number of seconds the device has been up.
@@ -1354,8 +1409,7 @@ def uptime(self):
     @property
     def uptime_string(self):
         """
-        The uptime of the device as a string.
-        The format is dd::hh::mm
+        Get uptime of the device as a string in the format is dd::hh::mm.
 
         Returns:
             str: The uptime of the device.