Merge pull request #39 from marcushoff/get_config

Add get_config method

.travis.yml

@@ -1,8 +1,8 @@
 language: python
 python:
-- 2.7
-- 3.4
-- 3.5
+- 3.6
+- 3.7
+- 3.8
 install:
 - pip install tox-travis
 - pip install coveralls

napalm_vyos/vyos.py

@@ -32,7 +32,6 @@ from netmiko import SCPConn
 
 # NAPALM base
 import napalm.base.constants as C
-from napalm.base.utils import py23_compat
 from napalm.base.base import NetworkDriver
 from napalm.base.exceptions import ConnectionException, MergeConfigException, \
                                    ReplaceConfigException, CommitError, \
@@ -127,7 +126,7 @@ class VyOSDriver(NetworkDriver):
             raise ReplaceConfigException('filename or config param must be provided.')
 
         if filename is None:
-            temp_file = tempfile.NamedTemporaryFile()
+            temp_file = tempfile.NamedTemporaryFile(mode='w+')
             temp_file.write(config)
             temp_file.flush()
             cfg_filename = temp_file.name
@@ -166,7 +165,7 @@ class VyOSDriver(NetworkDriver):
             raise MergeConfigException('filename or config param must be provided.')
 
         if filename is None:
-            temp_file = tempfile.NamedTemporaryFile()
+            temp_file = tempfile.NamedTemporaryFile(mode='w+')
             temp_file.write(config)
             temp_file.flush()
             cfg_filename = temp_file.name
@@ -179,7 +178,7 @@ class VyOSDriver(NetworkDriver):
                 self.device.send_command("cp "+self._BOOT_FILENAME+" "
                                          + self._BACKUP_FILENAME)
                 self._new_config = f.read()
-                cfg = [x for x in self._new_config.split("\n") if x is not ""]
+                cfg = [x for x in self._new_config.split("\n") if x]
                 output_loadcmd = self.device.send_config_set(cfg)
                 match_setfailed = re.findall("Delete failed", output_loadcmd)
                 match_delfailed = re.findall("Set failed", output_loadcmd)
@@ -309,7 +308,7 @@ class VyOSDriver(NetworkDriver):
         output_iface = self.device.send_command("show interfaces")
 
         # Collect all interfaces' name and status
-        match = re.findall("(\S+)\s+[:\-\d/\.]+\s+([uAD])/([uAD])", output_iface)
+        match = re.findall(r"(\S+)\s+[:\-\d/\.]+\s+([uAD])/([uAD])", output_iface)
 
         # 'match' example:
         # [("br0", "u", "D"), ("eth0", "u", "u"), ("eth1", "u", "u")...]
@@ -328,17 +327,12 @@ class VyOSDriver(NetworkDriver):
             ifaces_detail = config["interfaces"][iface_type]
 
             for iface_name in ifaces_detail:
-                description = self._get_value("description", ifaces_detail[iface_name])
-                if description is None:
-                    description = ""
-                speed = self._get_value("speed", ifaces_detail[iface_name])
-                if speed is None:
-                    speed = 0
+                details = ifaces_detail[iface_name]
+                description = details.get("description", "")
+                speed = details.get("speed", "0")
                 if speed == "auto":
                     speed = 0
-                hw_id = self._get_value("hw-id", ifaces_detail[iface_name])
-                if hw_id is None:
-                    hw_id = "00:00:00:00:00:00"
+                hw_id = details.get("hw-id", "00:00:00:00:00:00")
 
                 is_up = (iface_state[iface_name]["Link"] == "u")
                 is_enabled = (iface_state[iface_name]["State"] == "u")
@@ -347,22 +341,16 @@ class VyOSDriver(NetworkDriver):
                   iface_name: {
                     "is_up": bool(is_up),
                     "is_enabled": bool(is_enabled),
-                    "description": py23_compat.text_type(description),
+                    "description": description,
                     "last_flapped": float(-1),
+                    "mtu": -1,
                     "speed": int(speed),
-                    "mac_address": py23_compat.text_type(hw_id)
+                    "mac_address": hw_id,
                   }
                 })
 
         return iface_dict
 
-    @staticmethod
-    def _get_value(key, target_dict):
-        if key in target_dict:
-            return target_dict[key]
-        else:
-            return None
-
     def get_arp_table(self, vrf=""):
         # 'age' is not implemented yet
 
@@ -376,7 +364,7 @@ class VyOSDriver(NetworkDriver):
         192.168.1.3              ether   00:50:56:86:7b:06   C                     eth1
         """
 
-        if vrf:              
+        if vrf:
             raise NotImplementedError(
                 "VRF support has not been added for this getter on this platform."
             )
@@ -395,16 +383,16 @@ class VyOSDriver(NetworkDriver):
             # ["10.129.2.254", "ether", "00:50:56:97:af:b1", "C", "eth0"]
             # [u'10.0.12.33', u'(incomplete)', u'eth1']
             if "incomplete" in line[1]:
-                macaddr = py23_compat.text_type("00:00:00:00:00:00")
+                macaddr = "00:00:00:00:00:00"
             else:
-                macaddr = py23_compat.text_type(line[2])
+                macaddr = line[2]
 
             arp_table.append(
                 {
-                    'interface': py23_compat.text_type(line[-1]),
+                    'interface': line[-1],
                     'mac': macaddr,
-                    'ip': py23_compat.text_type(line[0]),
-                    'age': 0.0
+                    'ip': line[0],
+                    'age': 0.0,
                 }
             )
 
@@ -432,23 +420,23 @@ class VyOSDriver(NetworkDriver):
                 # 'remote' contains '*' if the machine synchronized with NTP server
                 synchronized = "*" in remote
 
-                match = re.search("(\d+\.\d+\.\d+\.\d+)", remote)
+                match = re.search(r"(\d+\.\d+\.\d+\.\d+)", remote)
                 ip = match.group(1)
 
                 when = when if when != '-' else 0
 
                 ntp_stats.append({
-                    "remote": py23_compat.text_type(ip),
-                    "referenceid": py23_compat.text_type(refid),
+                    "remote": ip,
+                    "referenceid": refid,
                     "synchronized": bool(synchronized),
                     "stratum": int(st),
-                    "type": py23_compat.text_type(t),
-                    "when": py23_compat.text_type(when),
+                    "type": t,
+                    "when": when,
                     "hostpoll": int(hostpoll),
                     "reachability": int(reachability),
                     "delay": float(delay),
                     "offset": float(offset),
-                    "jitter": float(jitter)
+                    "jitter": float(jitter),
                 })
 
         return ntp_stats
@@ -460,9 +448,9 @@ class VyOSDriver(NetworkDriver):
 
         for line in output_peers:
             if len(line) > 0:
-                match = re.search("(\d+\.\d+\.\d+\.\d+)\s+", line)
+                match = re.search(r"(\d+\.\d+\.\d+\.\d+)\s+", line)
                 ntp_peers.update({
-                    py23_compat.text_type(match.group(1)): {}
+                    match.group(1): {}
                 })
 
         return ntp_peers
@@ -486,11 +474,11 @@ class VyOSDriver(NetworkDriver):
         output = self.device.send_command("show ip bgp summary")
         output = output.split("\n")
 
-        match = re.search(".* router identifier (\d+\.\d+\.\d+\.\d+), local AS number (\d+)",
+        match = re.search(r".* router identifier (\d+\.\d+\.\d+\.\d+), local AS number (\d+)",
                           output[0])
         if not match:
             return {}
-        router_id = py23_compat.text_type(match.group(1))
+        router_id = match.group(1)
         local_as = int(match.group(2))
 
         bgp_neighbor_data = dict()
@@ -499,7 +487,7 @@ class VyOSDriver(NetworkDriver):
         bgp_neighbor_data["global"]["peers"] = {}
 
         # delete the header and empty element
-        bgp_info = [i.strip() for i in output[6:-2] if i is not ""]
+        bgp_info = [i.strip() for i in output[6:-2] if i]
 
         for i in bgp_info:
             if len(i) > 0:
@@ -538,19 +526,19 @@ class VyOSDriver(NetworkDriver):
                 """
                 bgp_detail = self.device.send_command("show ip bgp neighbors %s" % peer_id)
 
-                match_rid = re.search("remote router ID (\d+\.\d+\.\d+\.\d+).*", bgp_detail)
+                match_rid = re.search(r"remote router ID (\d+\.\d+\.\d+\.\d+).*", bgp_detail)
                 remote_rid = match_rid.group(1)
 
-                match_prefix_accepted = re.search("(\d+) accepted prefixes", bgp_detail)
+                match_prefix_accepted = re.search(r"(\d+) accepted prefixes", bgp_detail)
                 accepted_prefixes = match_prefix_accepted.group(1)
 
                 bgp_neighbor_data["global"]["peers"].setdefault(peer_id, {})
                 peer_dict = {
-                    "description": py23_compat.text_type(""),
+                    "description": "",
                     "is_enabled": bool(is_enabled),
                     "local_as": int(local_as),
                     "is_up": bool(is_up),
-                    "remote_id": py23_compat.text_type(remote_rid),
+                    "remote_id": remote_rid,
                     "uptime": int(self._bgp_time_conversion(up_time)),
                     "remote_as": int(remote_as)
                 }
@@ -574,19 +562,19 @@ class VyOSDriver(NetworkDriver):
             return -1
         else:
             if "y" in bgp_uptime:
-                match = re.search("(\d+)(\w)(\d+)(\w)(\d+)(\w)", bgp_uptime)
+                match = re.search(r"(\d+)(\w)(\d+)(\w)(\d+)(\w)", bgp_uptime)
                 uptime = ((int(match.group(1)) * self._YEAR_SECONDS) +
                           (int(match.group(3)) * self._WEEK_SECONDS) +
                           (int(match.group(5)) * self._DAY_SECONDS))
                 return uptime
             elif "w" in bgp_uptime:
-                match = re.search("(\d+)(\w)(\d+)(\w)(\d+)(\w)", bgp_uptime)
+                match = re.search(r"(\d+)(\w)(\d+)(\w)(\d+)(\w)", bgp_uptime)
                 uptime = ((int(match.group(1)) * self._WEEK_SECONDS) +
                           (int(match.group(3)) * self._DAY_SECONDS) +
                           (int(match.group(5)) * self._HOUR_SECONDS))
                 return uptime
             elif "d" in bgp_uptime:
-                match = re.search("(\d+)(\w)(\d+)(\w)(\d+)(\w)", bgp_uptime)
+                match = re.search(r"(\d+)(\w)(\d+)(\w)(\d+)(\w)", bgp_uptime)
                 uptime = ((int(match.group(1)) * self._DAY_SECONDS) +
                           (int(match.group(3)) * self._HOUR_SECONDS) +
                           (int(match.group(5)) * self._MINUTE_SECONDS))
@@ -597,6 +585,29 @@ class VyOSDriver(NetworkDriver):
                           (minutes * self._MINUTE_SECONDS) + seconds)
                 return uptime
 
+    def get_lldp_neighbors(self):
+        # Multiple neighbors per port are not implemented
+        # The show lldp neighbors commands lists port descriptions, not IDs
+        output = self.device.send_command("show lldp neighbors detail")
+        pattern = r'''(?s)Interface: +(?P<interface>\S+), [^\n]+
+.+?
+ +SysName: +(?P<hostname>\S+)
+.+?
+ +PortID: +ifname (?P<port>\S+)'''
+
+        def _get_interface(match):
+            return [
+                {
+                    'hostname': match.group('hostname'),
+                    'port': match.group('port'),
+                }
+            ]
+
+        return {
+            match.group('interface'): _get_interface(match)
+            for match in re.finditer(pattern, output)
+        }
+
     def get_interfaces_counters(self):
         # 'rx_unicast_packet', 'rx_broadcast_packets', 'tx_unicast_packets',
         # 'tx_multicast_packets' and 'tx_broadcast_packets' are not implemented yet
@@ -613,9 +624,9 @@ class VyOSDriver(NetworkDriver):
           32776498     279273          0          0          0          0
         """
         output = self.device.send_command("show interfaces detail")
-        interfaces = re.findall("(\S+): <.*", output)
+        interfaces = re.findall(r"(\S+): <.*", output)
         # count = re.findall("(\d+)\s+(\d+)\s+(\d+)\s+(\d+)\s+(\d+)\s+(\d+)\s+", output)
-        count = re.findall("(\d+)\s+(\d+)\s+(\d+)\s+(\d+)\s+(\d+)\s+(\d+)", output)
+        count = re.findall(r"(\d+)\s+(\d+)\s+(\d+)\s+(\d+)\s+(\d+)\s+(\d+)", output)
         counters = dict()
 
         j = 0
@@ -663,15 +674,15 @@ class VyOSDriver(NetworkDriver):
             for i in config["service"]["snmp"]["community"]:
                 snmp["community"].update({
                     i: {
-                        "acl": py23_compat.text_type(""),
-                        "mode": py23_compat.text_type(config["service"]["snmp"]["community"][i]["authorization"])
+                        "acl": "",
+                        "mode": config["service"]["snmp"]["community"][i]["authorization"],
                     }
                 })
 
             snmp.update({
-              "chassis_id": py23_compat.text_type(""),
-              "contact": py23_compat.text_type(config["service"]["snmp"]["contact"]),
-              "location": py23_compat.text_type(config["service"]["snmp"]["location"])
+              "chassis_id": "",
+              "contact": config["service"]["snmp"]["contact"],
+              "location": config["service"]["snmp"]["location"],
             })
 
             return snmp
@@ -687,10 +698,15 @@ class VyOSDriver(NetworkDriver):
         ver_str = [line for line in output if "Version" in line][0]
         version = self.parse_version(ver_str)
 
-        sn_str = [line for line in output if "S/N" in line][0]
-        snumber = self.parse_snumber(sn_str)
+        above_1_1 = False if version.startswith('1.0') or version.startswith('1.1') else True
+        if above_1_1:
+            sn_str = [line for line in output if "Hardware S/N" in line][0]
+            hwmodel_str = [line for line in output if "Hardware model" in line][0]
+        else:
+            sn_str = [line for line in output if "S/N" in line][0]
+            hwmodel_str = [line for line in output if "HW model" in line][0]
 
-        hwmodel_str = [line for line in output if "HW model" in line][0]
+        snumber = self.parse_snumber(sn_str)
         hwmodel = self.parse_hwmodel(hwmodel_str)
 
         output = self.device.send_command("show configuration")
@@ -713,13 +729,13 @@ class VyOSDriver(NetworkDriver):
 
         facts = {
           "uptime": int(uptime),
-          "vendor": py23_compat.text_type("VyOS"),
-          "os_version": py23_compat.text_type(version),
-          "serial_number": py23_compat.text_type(snumber),
-          "model": py23_compat.text_type(hwmodel),
-          "hostname": py23_compat.text_type(hostname),
-          "fqdn": py23_compat.text_type(fqdn),
-          "interface_list": iface_list
+          "vendor": "VyOS",
+          "os_version": version,
+          "serial_number": snumber,
+          "model": hwmodel,
+          "hostname": hostname,
+          "fqdn": fqdn,
+          "interface_list": iface_list,
         }
 
         return facts
@@ -850,7 +866,7 @@ class VyOSDriver(NetworkDriver):
         else:
             err = ""
 
-        if err is not "":
+        if err:
             ping_result["error"] = err
         else:
             # 'packet_info' example:
@@ -878,7 +894,7 @@ class VyOSDriver(NetworkDriver):
             else:
                 rtt_info = rtt_info[-2]
 
-            match = re.search("([\d\.]+)/([\d\.]+)/([\d\.]+)/([\d\.]+)", rtt_info)
+            match = re.search(r"([\d\.]+)/([\d\.]+)/([\d\.]+)/([\d\.]+)", rtt_info)
 
             if match is not None:
                 rtt_min = float(match.group(1))
@@ -903,3 +919,42 @@ class VyOSDriver(NetworkDriver):
             }
 
             return ping_result
+
+    def get_config(self, retrieve="all", full=False, sanitized=False):
+        """
+        Return the configuration of a device.
+        :param retrieve: String to determine which configuration type you want to retrieve, default is all of them.
+                              The rest will be set to "".
+        :param full: Boolean to retrieve all the configuration. (Not supported)
+        :param sanitized: Boolean to remove secret data. (Only supported for 'running')
+        :return: The object returned is a dictionary with a key for each configuration store:
+            - running(string) - Representation of the native running configuration
+            - candidate(string) - Representation of the candidate configuration.
+            - startup(string) - Representation of the native startup configuration.
+        """
+        if retrieve not in ["running", "candidate", "startup", "all"]:
+            raise Exception("ERROR: Not a valid option to retrieve.\nPlease select from 'running', 'candidate', "
+                            "'startup', or 'all'")
+        else:
+            config_dict = {
+                "running": "",
+                "startup": "",
+                "candidate": ""
+            }
+            if retrieve in ["running", "all"]:
+                config_dict['running'] = self._get_running_config(sanitized)
+            if retrieve in ["startup", "all"]:
+                config_dict['startup'] = self.device.send_command(f"cat {self._BOOT_FILENAME}")
+            if retrieve in ["candidate", "all"]:
+                config_dict['candidate'] = self._new_config or ""
+
+        return config_dict
+
+    def _get_running_config(self, sanitized):
+        if sanitized:
+            return self.device.send_command("show configuration")
+        self.device.config_mode()
+        config = self.device.send_command("show")
+        config = config[:config.rfind('\n')]
+        self.device.exit_config_mode()
+        return config

requirements-dev.txt

@@ -1,4 +1,3 @@
-future
 coveralls
 pytest
 pytest-cov

requirements.txt

@@ -1,4 +1,4 @@
-napalm==2.*
+napalm>=3.0
 paramiko
-netmiko>=1.1.0
+netmiko>=3.1.0
 vyattaconfparser

setup.py

@@ -11,7 +11,7 @@ __author__ = 'Piotr Pieprzycki <piotr.pieprzycki@dreamlab.pl>'
 
 setup(
     name="napalm-vyos",
-    version="0.1.6",
+    version="0.2.1",
     packages=find_packages(),
     author="Piotr Pieprzycki",
     author_email="piotr.pieprzycki@dreamlab.pl",
@@ -19,12 +19,10 @@ setup(
     classifiers=[
         'Topic :: Utilities',
         'Programming Language :: Python',
-        'Programming Language :: Python :: 2',
-        'Programming Language :: Python :: 2.7',
         'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.4',
-        'Programming Language :: Python :: 3.5',
         'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
         'Operating System :: POSIX :: Linux',
         'Operating System :: MacOS',
     ],

test/unit/conftest.py

@@ -5,7 +5,6 @@ import pytest
 from napalm.base.test import conftest as parent_conftest
 
 from napalm.base.test.double import BaseTestDouble
-from napalm.base.utils import py23_compat
 
 from napalm_vyos import vyos
 
@@ -52,8 +51,16 @@ class PatchedVyOSDriver(vyos.VyOSDriver):
 class FakeVyOSDevice(BaseTestDouble):
     """VyOS device test double."""
 
+    def __init__(self):
+        self.mode_config = False
+
     def send_command(self, command, **kwargs):
         filename = '{}.text'.format(self.sanitize_text(command))
         full_path = self.find_file(filename)
-        result = self.read_txt_file(full_path)
-        return py23_compat.text_type(result)
+        return self.read_txt_file(full_path)
+
+    def config_mode(self):
+        self.mode_config = True
+
+    def exit_config_mode(self):
+        self.mode_config = False

test/unit/mocked_data/test_get_config/normal/cat__config_config_boot.text

@@ -0,0 +1,123 @@
+interfaces {
+    ethernet eth0 {
+        address dhcp
+    }
+    ethernet eth1 {
+        address 10.0.1.222/24
+    }
+    loopback lo {
+        address 10.2.2.2/32
+        address 8.8.8.8/32
+    }
+}
+policy {
+    prefix-list EXPORT {
+        rule 1 {
+            action permit
+            prefix 172.16.2.0/24
+        }
+        rule 65535 {
+            action permit
+            prefix 10.2.2.2/32
+        }
+    }
+    route-map EXPORT-POLICY {
+        rule 1 {
+            action permit
+            match {
+                ip {
+                    address {
+                        prefix-list EXPORT
+                    }
+                }
+            }
+        }
+    }
+}
+protocols {
+    bgp 65002 {
+        neighbor 10.0.1.100 {
+            remote-as 65001
+            route-map {
+                export EXPORT-POLICY
+            }
+        }
+        redistribute {
+            connected {
+                route-map EXPORT-POLICY
+            }
+        }
+    }
+}
+service {
+    snmp {
+        community commro {
+            authorization ro
+        }
+        contact admin@foo.corp
+        location PL,Krakow
+    }
+    ssh {
+        disable-host-validation
+        port 22
+    }
+}
+system {
+    config-management {
+        commit-revisions 20
+    }
+    host-name vyos2
+    login {
+        banner {
+            pre-login "My banner for all devices"
+        }
+        user vagrant {
+            authentication {
+                encrypted-password $6$fcHhBu3T$WLmiu6/txlEfWK5uh4mKE8v7qocuftsoAN1oHqPIIoogXAX8zS.SKhB105EExYU6yBy4cKHUD/Q6Mm7CUbVTr.
+                plaintext-password ""
+                public-keys vagrant {
+                    key AAAAB3NzaC1yc2EAAAABIwAAAQEA6NF8iallvQVp22WDkTkyrtvp9eWW6A8YVr+kz4TjGYe7gHzIw+niNltGEFHzD8+v1I2YJ6oXevct1YeS0o9HZyN1Q9qgCgzUFtdOKLv6IedplqoPkcmF0aYet2PkEDo3MlTBckFXPITAMzF8dJSIFo9D8HfdOV0IAdx4O7PtixWKn5y2hMNG0zQPyUecp4pzC6kivAIhyfHilFR61RGL+GPXQ2MWZWFYbAGjyiYJnAmCP3NOTd0jMZEnDkbUvxhMmBYSdETk1rRgm+R4LOzFUGaHqHDLKLX+FIPKcF96hrucXzcWyLbIbEgE98OHlnVYCzRdK8jlqm8tehUc9c9WhQ==
+                    type ssh-rsa
+                }
+            }
+            level admin
+        }
+        user vyos {
+            authentication {
+                encrypted-password $1$yHIMnG/J$aWDkd3oDYSYps8twB5vpw1
+                plaintext-password ""
+            }
+            level admin
+        }
+    }
+    ntp {
+        server 10.0.1.100 {
+        }
+    }
+    package {
+        auto-sync 1
+        repository community {
+            components main
+            distribution helium
+            password ""
+            url http://packages.vyos.net/vyos
+            username ""
+        }
+    }
+    syslog {
+        global {
+            facility all {
+                level notice
+            }
+            facility protocols {
+                level debug
+            }
+        }
+    }
+    time-zone UTC
+}
+
+
+/* Warning: Do not remove the following line. */
+/* === vyatta-config-version: "cluster@1:config-management@1:conntrack-sync@1:conntrack@1:cron@1:dhcp-relay@1:dhcp-server@4:firewall@5:ipsec@4:nat@4:qos@1:quagga@2:system@6:vrrp@1:wanloadbalance@3:webgui@1:webproxy@1:zone-policy@1" === */
+/* Release version: VyOS 1.1.7 */

test/unit/mocked_data/test_get_config/normal/show.text

@@ -0,0 +1,125 @@
+interfaces {
+    ethernet eth0 {
+        address dhcp
+        duplex auto
+        smp_affinity auto
+        speed auto
+    }
+    ethernet eth1 {
+        address 10.0.1.222/24
+        duplex auto
+        smp_affinity auto
+        speed auto
+    }
+    loopback lo {
+        address 10.2.2.2/32
+        address 8.8.8.8/32
+    }
+}
+policy {
+    prefix-list EXPORT {
+        rule 1 {
+            action permit
+            prefix 172.16.2.0/24
+        }
+        rule 65535 {
+            action permit
+            prefix 10.2.2.2/32
+        }
+    }
+    route-map EXPORT-POLICY {
+        rule 1 {
+            action permit
+            match {
+                ip {
+                    address {
+                        prefix-list EXPORT
+                    }
+                }
+            }
+        }
+    }
+}
+protocols {
+    bgp 65002 {
+        neighbor 10.0.1.100 {
+            remote-as 65001
+            route-map {
+                export EXPORT-POLICY
+            }
+        }
+        redistribute {
+            connected {
+                route-map EXPORT-POLICY
+            }
+        }
+    }
+}
+service {
+    snmp {
+        community commro {
+            authorization ro
+        }
+        contact admin@foo.corp
+        location PL,Krakow
+    }
+    ssh {
+        disable-host-validation
+        port 22
+    }
+}
+system {
+    config-management {
+        commit-revisions 20
+    }
+    host-name vyos2
+    login {
+        banner {
+            pre-login "My banner for all devices"
+        }
+        user vagrant {
+            authentication {
+                encrypted-password $6$fcHhBu3T$WLmiu6/txlEfWK5uh4mKE8v7qocuftsoAN1oHqPIIoogXAX8zS.SKhB105EExYU6yBy4cKHUD/Q6Mm7CUbVTr.
+                plaintext-password ""
+                public-keys vagrant {
+                    key AAAAB3NzaC1yc2EAAAABIwAAAQEA6NF8iallvQVp22WDkTkyrtvp9eWW6A8YVr+kz4TjGYe7gHzIw+niNltGEFHzD8+v1I2YJ6oXevct1YeS0o9HZyN1Q9qgCgzUFtdOKLv6IedplqoPkcmF0aYet2PkEDo3MlTBckFXPITAMzF8dJSIFo9D8HfdOV0IAdx4O7PtixWKn5y2hMNG0zQPyUecp4pzC6kivAIhyfHilFR61RGL+GPXQ2MWZWFYbAGjyiYJnAmCP3NOTd0jMZEnDkbUvxhMmBYSdETk1rRgm+R4LOzFUGaHqHDLKLX+FIPKcF96hrucXzcWyLbIbEgE98OHlnVYCzRdK8jlqm8tehUc9c9WhQ==
+                    type ssh-rsa
+                }
+            }
+            level admin
+        }
+        user vyos {
+            authentication {
+                encrypted-password $1$yHIMnG/J$aWDkd3oDYSYps8twB5vpw1
+                plaintext-password ""
+            }
+            level admin
+        }
+    }
+    ntp {
+        server 10.0.1.100 {
+        }
+    }
+    package {
+        auto-sync 1
+        repository community {
+            components main
+            distribution helium
+            password ""
+            url http://packages.vyos.net/vyos
+            username ""
+        }
+    }
+    syslog {
+        global {
+            facility all {
+                level notice
+            }
+            facility protocols {
+                level debug
+            }
+        }
+    }
+    time-zone UTC
+}
+[edit]

test/unit/mocked_data/test_get_config_filtered/normal/cat__config_config_boot.text

@@ -0,0 +1,123 @@
+interfaces {
+    ethernet eth0 {
+        address dhcp
+    }
+    ethernet eth1 {
+        address 10.0.1.222/24
+    }
+    loopback lo {
+        address 10.2.2.2/32
+        address 8.8.8.8/32
+    }
+}
+policy {
+    prefix-list EXPORT {
+        rule 1 {
+            action permit
+            prefix 172.16.2.0/24
+        }
+        rule 65535 {
+            action permit
+            prefix 10.2.2.2/32
+        }
+    }
+    route-map EXPORT-POLICY {
+        rule 1 {
+            action permit
+            match {
+                ip {
+                    address {
+                        prefix-list EXPORT
+                    }
+                }
+            }
+        }
+    }
+}
+protocols {
+    bgp 65002 {
+        neighbor 10.0.1.100 {
+            remote-as 65001
+            route-map {
+                export EXPORT-POLICY
+            }
+        }
+        redistribute {
+            connected {
+                route-map EXPORT-POLICY
+            }
+        }
+    }
+}
+service {
+    snmp {
+        community commro {
+            authorization ro
+        }
+        contact admin@foo.corp
+        location PL,Krakow
+    }
+    ssh {
+        disable-host-validation
+        port 22
+    }
+}
+system {
+    config-management {
+        commit-revisions 20
+    }
+    host-name vyos2
+    login {
+        banner {
+            pre-login "My banner for all devices"
+        }
+        user vagrant {
+            authentication {
+                encrypted-password $6$fcHhBu3T$WLmiu6/txlEfWK5uh4mKE8v7qocuftsoAN1oHqPIIoogXAX8zS.SKhB105EExYU6yBy4cKHUD/Q6Mm7CUbVTr.
+                plaintext-password ""
+                public-keys vagrant {
+                    key AAAAB3NzaC1yc2EAAAABIwAAAQEA6NF8iallvQVp22WDkTkyrtvp9eWW6A8YVr+kz4TjGYe7gHzIw+niNltGEFHzD8+v1I2YJ6oXevct1YeS0o9HZyN1Q9qgCgzUFtdOKLv6IedplqoPkcmF0aYet2PkEDo3MlTBckFXPITAMzF8dJSIFo9D8HfdOV0IAdx4O7PtixWKn5y2hMNG0zQPyUecp4pzC6kivAIhyfHilFR61RGL+GPXQ2MWZWFYbAGjyiYJnAmCP3NOTd0jMZEnDkbUvxhMmBYSdETk1rRgm+R4LOzFUGaHqHDLKLX+FIPKcF96hrucXzcWyLbIbEgE98OHlnVYCzRdK8jlqm8tehUc9c9WhQ==
+                    type ssh-rsa
+                }
+            }
+            level admin
+        }
+        user vyos {
+            authentication {
+                encrypted-password $1$yHIMnG/J$aWDkd3oDYSYps8twB5vpw1
+                plaintext-password ""
+            }
+            level admin
+        }
+    }
+    ntp {
+        server 10.0.1.100 {
+        }
+    }
+    package {
+        auto-sync 1
+        repository community {
+            components main
+            distribution helium
+            password ""
+            url http://packages.vyos.net/vyos
+            username ""
+        }
+    }
+    syslog {
+        global {
+            facility all {
+                level notice
+            }
+            facility protocols {
+                level debug
+            }
+        }
+    }
+    time-zone UTC
+}
+
+
+/* Warning: Do not remove the following line. */
+/* === vyatta-config-version: "cluster@1:config-management@1:conntrack-sync@1:conntrack@1:cron@1:dhcp-relay@1:dhcp-server@4:firewall@5:ipsec@4:nat@4:qos@1:quagga@2:system@6:vrrp@1:wanloadbalance@3:webgui@1:webproxy@1:zone-policy@1" === */
+/* Release version: VyOS 1.1.7 */

test/unit/mocked_data/test_get_config_filtered/normal/expected_result.json

@@ -0,0 +1 @@
+{"running": "", "startup": "", "candidate": ""}

test/unit/mocked_data/test_get_config_filtered/normal/show.text

@@ -0,0 +1,125 @@
+interfaces {
+    ethernet eth0 {
+        address dhcp
+        duplex auto
+        smp_affinity auto
+        speed auto
+    }
+    ethernet eth1 {
+        address 10.0.1.222/24
+        duplex auto
+        smp_affinity auto
+        speed auto
+    }
+    loopback lo {
+        address 10.2.2.2/32
+        address 8.8.8.8/32
+    }
+}
+policy {
+    prefix-list EXPORT {
+        rule 1 {
+            action permit
+            prefix 172.16.2.0/24
+        }
+        rule 65535 {
+            action permit
+            prefix 10.2.2.2/32
+        }
+    }
+    route-map EXPORT-POLICY {
+        rule 1 {
+            action permit
+            match {
+                ip {
+                    address {
+                        prefix-list EXPORT
+                    }
+                }
+            }
+        }
+    }
+}
+protocols {
+    bgp 65002 {
+        neighbor 10.0.1.100 {
+            remote-as 65001
+            route-map {
+                export EXPORT-POLICY
+            }
+        }
+        redistribute {
+            connected {
+                route-map EXPORT-POLICY
+            }
+        }
+    }
+}
+service {
+    snmp {
+        community commro {
+            authorization ro
+        }
+        contact admin@foo.corp
+        location PL,Krakow
+    }
+    ssh {
+        disable-host-validation
+        port 22
+    }
+}
+system {
+    config-management {
+        commit-revisions 20
+    }
+    host-name vyos2
+    login {
+        banner {
+            pre-login "My banner for all devices"
+        }
+        user vagrant {
+            authentication {
+                encrypted-password $6$fcHhBu3T$WLmiu6/txlEfWK5uh4mKE8v7qocuftsoAN1oHqPIIoogXAX8zS.SKhB105EExYU6yBy4cKHUD/Q6Mm7CUbVTr.
+                plaintext-password ""
+                public-keys vagrant {
+                    key AAAAB3NzaC1yc2EAAAABIwAAAQEA6NF8iallvQVp22WDkTkyrtvp9eWW6A8YVr+kz4TjGYe7gHzIw+niNltGEFHzD8+v1I2YJ6oXevct1YeS0o9HZyN1Q9qgCgzUFtdOKLv6IedplqoPkcmF0aYet2PkEDo3MlTBckFXPITAMzF8dJSIFo9D8HfdOV0IAdx4O7PtixWKn5y2hMNG0zQPyUecp4pzC6kivAIhyfHilFR61RGL+GPXQ2MWZWFYbAGjyiYJnAmCP3NOTd0jMZEnDkbUvxhMmBYSdETk1rRgm+R4LOzFUGaHqHDLKLX+FIPKcF96hrucXzcWyLbIbEgE98OHlnVYCzRdK8jlqm8tehUc9c9WhQ==
+                    type ssh-rsa
+                }
+            }
+            level admin
+        }
+        user vyos {
+            authentication {
+                encrypted-password $1$yHIMnG/J$aWDkd3oDYSYps8twB5vpw1
+                plaintext-password ""
+            }
+            level admin
+        }
+    }
+    ntp {
+        server 10.0.1.100 {
+        }
+    }
+    package {
+        auto-sync 1
+        repository community {
+            components main
+            distribution helium
+            password ""
+            url http://packages.vyos.net/vyos
+            username ""
+        }
+    }
+    syslog {
+        global {
+            facility all {
+                level notice
+            }
+            facility protocols {
+                level debug
+            }
+        }
+    }
+    time-zone UTC
+}
+[edit]

test/unit/mocked_data/test_get_config_sanitized/normal/cat__config_config_boot.text

@@ -0,0 +1,123 @@
+interfaces {
+    ethernet eth0 {
+        address dhcp
+    }
+    ethernet eth1 {
+        address 10.0.1.222/24
+    }
+    loopback lo {
+        address 10.2.2.2/32
+        address 8.8.8.8/32
+    }
+}
+policy {
+    prefix-list EXPORT {
+        rule 1 {
+            action permit
+            prefix 172.16.2.0/24
+        }
+        rule 65535 {
+            action permit
+            prefix 10.2.2.2/32
+        }
+    }
+    route-map EXPORT-POLICY {
+        rule 1 {
+            action permit
+            match {
+                ip {
+                    address {
+                        prefix-list EXPORT
+                    }
+                }
+            }
+        }
+    }
+}
+protocols {
+    bgp 65002 {
+        neighbor 10.0.1.100 {
+            remote-as 65001
+            route-map {
+                export EXPORT-POLICY
+            }
+        }
+        redistribute {
+            connected {
+                route-map EXPORT-POLICY
+            }
+        }
+    }
+}
+service {
+    snmp {
+        community commro {
+            authorization ro
+        }
+        contact admin@foo.corp
+        location PL,Krakow
+    }
+    ssh {
+        disable-host-validation
+        port 22
+    }
+}
+system {
+    config-management {
+        commit-revisions 20
+    }
+    host-name vyos2
+    login {
+        banner {
+            pre-login "My banner for all devices"
+        }
+        user vagrant {
+            authentication {
+                encrypted-password $6$fcHhBu3T$WLmiu6/txlEfWK5uh4mKE8v7qocuftsoAN1oHqPIIoogXAX8zS.SKhB105EExYU6yBy4cKHUD/Q6Mm7CUbVTr.
+                plaintext-password ""
+                public-keys vagrant {
+                    key AAAAB3NzaC1yc2EAAAABIwAAAQEA6NF8iallvQVp22WDkTkyrtvp9eWW6A8YVr+kz4TjGYe7gHzIw+niNltGEFHzD8+v1I2YJ6oXevct1YeS0o9HZyN1Q9qgCgzUFtdOKLv6IedplqoPkcmF0aYet2PkEDo3MlTBckFXPITAMzF8dJSIFo9D8HfdOV0IAdx4O7PtixWKn5y2hMNG0zQPyUecp4pzC6kivAIhyfHilFR61RGL+GPXQ2MWZWFYbAGjyiYJnAmCP3NOTd0jMZEnDkbUvxhMmBYSdETk1rRgm+R4LOzFUGaHqHDLKLX+FIPKcF96hrucXzcWyLbIbEgE98OHlnVYCzRdK8jlqm8tehUc9c9WhQ==
+                    type ssh-rsa
+                }
+            }
+            level admin
+        }
+        user vyos {
+            authentication {
+                encrypted-password $1$yHIMnG/J$aWDkd3oDYSYps8twB5vpw1
+                plaintext-password ""
+            }
+            level admin
+        }
+    }
+    ntp {
+        server 10.0.1.100 {
+        }
+    }
+    package {
+        auto-sync 1
+        repository community {
+            components main
+            distribution helium
+            password ""
+            url http://packages.vyos.net/vyos
+            username ""
+        }
+    }
+    syslog {
+        global {
+            facility all {
+                level notice
+            }
+            facility protocols {
+                level debug
+            }
+        }
+    }
+    time-zone UTC
+}
+
+
+/* Warning: Do not remove the following line. */
+/* === vyatta-config-version: "cluster@1:config-management@1:conntrack-sync@1:conntrack@1:cron@1:dhcp-relay@1:dhcp-server@4:firewall@5:ipsec@4:nat@4:qos@1:quagga@2:system@6:vrrp@1:wanloadbalance@3:webgui@1:webproxy@1:zone-policy@1" === */
+/* Release version: VyOS 1.1.7 */

test/unit/mocked_data/test_get_config_sanitized/normal/show_configuration.text

@@ -0,0 +1,124 @@
+interfaces {
+    ethernet eth0 {
+        address dhcp
+        duplex auto
+        smp_affinity auto
+        speed auto
+    }
+    ethernet eth1 {
+        address 10.0.1.222/24
+        duplex auto
+        smp_affinity auto
+        speed auto
+    }
+    loopback lo {
+        address 10.2.2.2/32
+        address 8.8.8.8/32
+    }
+}
+policy {
+    prefix-list EXPORT {
+        rule 1 {
+            action permit
+            prefix 172.16.2.0/24
+        }
+        rule 65535 {
+            action permit
+            prefix 10.2.2.2/32
+        }
+    }
+    route-map EXPORT-POLICY {
+        rule 1 {
+            action permit
+            match {
+                ip {
+                    address {
+                        prefix-list EXPORT
+                    }
+                }
+            }
+        }
+    }
+}
+protocols {
+    bgp 65002 {
+        neighbor 10.0.1.100 {
+            remote-as 65001
+            route-map {
+                export EXPORT-POLICY
+            }
+        }
+        redistribute {
+            connected {
+                route-map EXPORT-POLICY
+            }
+        }
+    }
+}
+service {
+    snmp {
+        community commro {
+            authorization ro
+        }
+        contact admin@foo.corp
+        location PL,Krakow
+    }
+    ssh {
+        disable-host-validation
+        port 22
+    }
+}
+system {
+    config-management {
+        commit-revisions 20
+    }
+    host-name vyos2
+    login {
+        banner {
+            pre-login "My banner for all devices"
+        }
+        user vagrant {
+            authentication {
+                encrypted-password **********
+                plaintext-password ""
+                public-keys vagrant {
+                    key AAAAB3NzaC1yc2EAAAABIwAAAQEA6NF8iallvQVp22WDkTkyrtvp9eWW6A8YVr+kz4TjGYe7gHzIw+niNltGEFHzD8+v1I2YJ6oXevct1YeS0o9HZyN1Q9qgCgzUFtdOKLv6IedplqoPkcmF0aYet2PkEDo3MlTBckFXPITAMzF8dJSIFo9D8HfdOV0IAdx4O7PtixWKn5y2hMNG0zQPyUecp4pzC6kivAIhyfHilFR61RGL+GPXQ2MWZWFYbAGjyiYJnAmCP3NOTd0jMZEnDkbUvxhMmBYSdETk1rRgm+R4LOzFUGaHqHDLKLX+FIPKcF96hrucXzcWyLbIbEgE98OHlnVYCzRdK8jlqm8tehUc9c9WhQ==
+                    type ssh-rsa
+                }
+            }
+            level admin
+        }
+        user vyos {
+            authentication {
+                encrypted-password **********
+                plaintext-password ""
+            }
+            level admin
+        }
+    }
+    ntp {
+        server 10.0.1.100 {
+        }
+    }
+    package {
+        auto-sync 1
+        repository community {
+            components main
+            distribution helium
+            password ""
+            url http://packages.vyos.net/vyos
+            username ""
+        }
+    }
+    syslog {
+        global {
+            facility all {
+                level notice
+            }
+            facility protocols {
+                level debug
+            }
+        }
+    }
+    time-zone UTC
+}

test/unit/mocked_data/test_get_interfaces/normal/expected_result.json

@@ -1 +1 @@
-{"lo": {"is_enabled": true, "description": "", "last_flapped": -1.0, "is_up": true, "mac_address": "00:00:00:00:00:00", "speed": 0}, "eth1": {"is_enabled": true, "description": "", "last_flapped": -1.0, "is_up": true, "mac_address": "...", "speed": 0}, "eth0": {"is_enabled": true, "description": "", "last_flapped": -1.0, "is_up": true, "mac_address": "...", "speed": 0}}
+{"lo": {"is_enabled": true, "description": "", "last_flapped": -1.0, "is_up": true, "mac_address": "00:00:00:00:00:00", "mtu": -1, "speed": 0}, "eth1": {"is_enabled": true, "description": "", "last_flapped": -1.0, "is_up": true, "mac_address": "...", "mtu": -1, "speed": 0}, "eth0": {"is_enabled": true, "description": "", "last_flapped": -1.0, "is_up": true, "mac_address": "...", "mtu": -1, "speed": 0}}

test/unit/mocked_data/test_get_lldp_neighbors/normal/expected_result.json

@@ -0,0 +1 @@
+{"eth1": [{"hostname": "branch", "port": "eth0"}], "eth2": [{"hostname": "dmz", "port": "eth0"}]}

test/unit/mocked_data/test_get_lldp_neighbors/normal/show_lldp_neighbors_detail.text

@@ -0,0 +1,69 @@
+-------------------------------------------------------------------------------
+LLDP neighbors:
+-------------------------------------------------------------------------------
+Interface:    eth1, via: LLDP, RID: 2, Time: 1 day, 18:17:44
+  Chassis:     
+    ChassisID:    mac 52:54:00:99:84:8a
+    SysName:      branch
+    SysDescr:     VyOS 1.3-rolling-202005151915
+    MgmtIP:       10.0.0.3
+    Capability:   Bridge, off
+    Capability:   Router, on
+    Capability:   Wlan, off
+    Capability:   Station, off
+  Port:        
+    PortID:       ifname eth0
+    PortDescr:    to DC
+    TTL:          120
+    PMD autoneg:  supported: yes, enabled: yes
+      Adv:          10Base-T, HD: yes, FD: yes
+      Adv:          100Base-TX, HD: yes, FD: yes
+      MAU oper type: 100BaseTXFD - 2 pair category 5 UTP, full duplex mode
+  LLDP-MED:    
+    Device Type:  Network Connectivity Device
+    Capability:   Capabilities, yes
+    Capability:   Policy, yes
+    Capability:   Location, yes
+    Capability:   MDI/PSE, yes
+    Capability:   MDI/PD, yes
+    Capability:   Inventory, yes
+    Inventory:   
+      Hardware Revision: pc-i440fx-4.2
+      Software Revision: 4.19.122-amd64-vyos
+      Firmware Revision: 1.13.0-1ubuntu1
+      Manufacturer: QEMU
+      Model:        Standard PC (i440FX + PIIX, 1996
+-------------------------------------------------------------------------------
+Interface:    eth2, via: LLDP, RID: 1, Time: 1 day, 18:17:45
+  Chassis:     
+    ChassisID:    mac 52:54:00:98:e5:9f
+    SysName:      dmz
+    SysDescr:     VyOS 1.3-rolling-202005151915
+    MgmtIP:       10.0.0.2
+    Capability:   Bridge, off
+    Capability:   Router, on
+    Capability:   Wlan, off
+    Capability:   Station, off
+  Port:        
+    PortID:       ifname eth0
+    PortDescr:    to DC
+    TTL:          120
+    PMD autoneg:  supported: yes, enabled: yes
+      Adv:          10Base-T, HD: yes, FD: yes
+      Adv:          100Base-TX, HD: yes, FD: yes
+      MAU oper type: 100BaseTXFD - 2 pair category 5 UTP, full duplex mode
+  LLDP-MED:    
+    Device Type:  Network Connectivity Device
+    Capability:   Capabilities, yes
+    Capability:   Policy, yes
+    Capability:   Location, yes
+    Capability:   MDI/PSE, yes
+    Capability:   MDI/PD, yes
+    Capability:   Inventory, yes
+    Inventory:   
+      Hardware Revision: pc-i440fx-4.2
+      Software Revision: 4.19.122-amd64-vyos
+      Firmware Revision: 1.13.0-1ubuntu1
+      Manufacturer: QEMU
+      Model:        Standard PC (i440FX + PIIX, 1996
+-------------------------------------------------------------------------------

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = py27,py35
+envlist = py36,py37,py38
 
 [testenv]
 deps =