syntax repair by 'black' and 'pylama'

This commit is contained in:
Petr Klima committed 2021-03-08 14:38:03 +01:00
1 parent 66c79822af
commit e24ba606ba
3 files changed
+203 -215

No files matched your search

+1 -1
View File
@@ -15,4 +15,4 @@
"""napalm-s350 package."""
from napalm_s350.s350 import S350Driver # noqa
__all__ = ('S350Driver',)
__all__ = ("S350Driver",)
+192 -204
View File
@@ -40,9 +40,9 @@ import napalm.base.canonical_map
# make may own base_interfaces for s350
s350_base_interfaces = {
**napalm.base.canonical_map.base_interfaces,
'fa': 'FastEthernet',
'gi': 'GigabitEthernet',
'te': 'TengigabitEthernet'
"fa": "FastEthernet",
"gi": "GigabitEthernet",
"te": "TengigabitEthernet",
}
@@ -60,23 +60,23 @@ class S350Driver(NetworkDriver):
if optional_args is None:
optional_args = {}
self._dest_file_system = optional_args.get('dest_file_system', None)
self._dest_file_system = optional_args.get("dest_file_system", None)
# Netmiko possible arguments
netmiko_argument_map = {
'port': None,
'secret': '',
'verbose': False,
'keepalive': 30,
'global_delay_factor': 1,
'use_keys': False,
'key_file': None,
'ssh_strict': False,
'system_host_keys': False,
'alt_host_keys': False,
'alt_key_file': '',
'ssh_config_file': None,
'allow_agent': False,
"port": None,
"secret": "",
"verbose": False,
"keepalive": 30,
"global_delay_factor": 1,
"use_keys": False,
"key_file": None,
"ssh_strict": False,
"system_host_keys": False,
"alt_host_keys": False,
"alt_key_file": "",
"ssh_config_file": None,
"allow_agent": False,
}
# Allow for passing additional Netmiko arguments
@@ -87,24 +87,28 @@ class S350Driver(NetworkDriver):
except KeyError:
pass
self.port = optional_args.get('port', 22)
self.port = optional_args.get("port", 22)
self.device = None
def open(self):
"""Open a connection to the device."""
self.device = ConnectHandler(device_type='cisco_s300',
host=self.hostname,
username=self.username,
password=self.password,
**self.netmiko_optional_args)
self.device = ConnectHandler(
device_type="cisco_s300",
host=self.hostname,
username=self.username,
password=self.password,
**self.netmiko_optional_args,
)
self.device.enable()
def _discover_file_system(self):
try:
return self.device._autodetect_fs()
except Exception:
msg = "Netmiko _autodetect_fs failed (to work around specify " \
"dest_file_system in optional_args)."
msg = (
"Netmiko _autodetect_fs failed (to work around specify "
"dest_file_system in optional_args)."
)
raise CommandErrorException(msg)
def close(self):
@@ -141,9 +145,9 @@ class S350Driver(NetworkDriver):
def _parse_uptime(self, uptime_str):
"""Parse an uptime string into number of seconds"""
uptime_str = uptime_str.strip()
days, timespec = uptime_str.split(',')
days, timespec = uptime_str.split(",")
hours, minutes, seconds = timespec.split(':')
hours, minutes, seconds = timespec.split(":")
uptime_sec = (int(days) * 86400) + (int(hours) * 3600) + (int(minutes) * 60) + int(seconds)
return uptime_sec
@@ -157,11 +161,11 @@ class S350Driver(NetworkDriver):
arp_table = []
output = self._send_command('show arp')
output = self._send_command("show arp")
for line in output.splitlines():
# A VLAN may not be set for the entry
if 'vlan' not in line:
if "vlan" not in line:
continue
if len(line.split()) == 4:
interface, ip, mac, _ = line.split()
@@ -171,45 +175,42 @@ class S350Driver(NetworkDriver):
elif len(line.split()) == 6:
_, _, interface, ip, mac, _ = line.split()
else:
raise ValueError('Unexpected output: {}'.format(line.split()))
raise ValueError("Unexpected output: {}".format(line.split()))
interface = canonical_interface_name(
interface,
s350_base_interfaces
)
interface = canonical_interface_name(interface, s350_base_interfaces)
entry = {
'interface': interface,
'mac': napalm.base.helpers.mac(mac),
'ip': ip,
'age': 0.0,
"interface": interface,
"mac": napalm.base.helpers.mac(mac),
"ip": ip,
"age": 0.0,
}
arp_table.append(entry)
return arp_table
def get_config(self, retrieve='all', full=False, sanitized=False):
def get_config(self, retrieve="all", full=False, sanitized=False):
"""
get_config for S350. Since this firmware doesn't support a candidate
configuration we leave it empty.
"""
configs = {
'startup': '',
'running': '',
'candidate': '',
"startup": "",
"running": "",
"candidate": "",
}
if retrieve in ('all', 'startup'):
startup = self._send_command('show startup-config')
configs['startup'] = self._get_config_filter(startup)
if retrieve in ("all", "startup"):
startup = self._send_command("show startup-config")
configs["startup"] = self._get_config_filter(startup)
if retrieve in ('all', 'running'):
if retrieve in ("all", "running"):
# IOS supports "full" only on "show running-config"
run_full = " detailed" if full else ""
running = self._send_command('show running-config' + run_full)
configs['running'] = self._get_config_filter(running)
running = self._send_command("show running-config" + run_full)
configs["running"] = self._get_config_filter(running)
if sanitized:
configs = self._get_config_sanitized(configs)
@@ -247,89 +248,84 @@ class S350Driver(NetworkDriver):
def get_facts(self):
"""Return a set of facts from the device."""
serial_number, fqdn, os_version, hostname, domainname = ('Unknown',) * 5
serial_number, fqdn, os_version, hostname, domainname = ("Unknown",) * 5
# Submit commands to the device.
show_ver = self._send_command('show version')
show_sys = self._send_command('show system')
show_inv = self._send_command('show inventory')
show_hosts = self._send_command('show hosts')
show_int_st = self._send_command('show interface status')
show_ver = self._send_command("show version")
show_sys = self._send_command("show system")
show_inv = self._send_command("show inventory")
show_hosts = self._send_command("show hosts")
show_int_st = self._send_command("show interface status")
os_version = self._get_facts_parse_os_version(show_ver)
# hostname
hostname = self._get_facts_hostname(show_sys)
# special case for SG500 fw v1.4.x
if hostname == 'Unknown':
if hostname == "Unknown":
hostname = self._get_facts_hostname_from_config(
self._send_command('show running-config')
)
self._send_command("show running-config")
)
# uptime
uptime_str = self._get_facts_uptime(show_sys)
uptime = self._parse_uptime(uptime_str)
# serial_number and model
inventory = self._get_facts_parse_inventory(show_inv)['1']
serial_number = inventory['sn']
model = inventory['pid']
inventory = self._get_facts_parse_inventory(show_inv)["1"]
serial_number = inventory["sn"]
model = inventory["pid"]
# fqdn
domainname = napalm.base.helpers.textfsm_extractor(self, 'hosts',
show_hosts)[0]
domainname = domainname['domain_name']
if domainname == 'Domain':
domainname = 'Unknown'
domainname = napalm.base.helpers.textfsm_extractor(self, "hosts", show_hosts)[0]
domainname = domainname["domain_name"]
if domainname == "Domain":
domainname = "Unknown"
if domainname != "Unknown" and hostname != "Unknown":
fqdn = '{0}.{1}'.format(hostname, domainname)
fqdn = "{0}.{1}".format(hostname, domainname)
# interface_list
interfaces = []
show_int_st = show_int_st.strip()
# remove the header information
show_int_st = re.sub(
r"(^-.*$|^Port .*$|^Ch .*$)|^\s.*$|^.*Flow.*$", "", show_int_st,
flags=re.M
r"(^-.*$|^Port .*$|^Ch .*$)|^\s.*$|^.*Flow.*$", "", show_int_st, flags=re.M
)
for line in show_int_st.splitlines():
if not line:
continue
interface = line.split()[0]
interface = canonical_interface_name(
interface,
s350_base_interfaces
)
interface = canonical_interface_name(interface, s350_base_interfaces)
interfaces.append(str(interface))
return {
'fqdn': str(fqdn),
'hostname': str(hostname),
'interface_list': interfaces,
'model': str(model),
'os_version': str(os_version),
'serial_number': str(serial_number),
'uptime': uptime,
'vendor': u'Cisco',
"fqdn": str(fqdn),
"hostname": str(hostname),
"interface_list": interfaces,
"model": str(model),
"os_version": str(os_version),
"serial_number": str(serial_number),
"uptime": uptime,
"vendor": "Cisco",
}
def _get_facts_hostname_from_config(self, show_running):
# special case for SG500 fw v1.4.x
hostname = 'Unknown'
hostname = "Unknown"
for line in show_running.splitlines():
if line.startswith('hostname '):
_, hostname = line.split('hostname')
if line.startswith("hostname "):
_, hostname = line.split("hostname")
hostname = hostname.strip()
break
return hostname
def _get_facts_hostname(self, show_sys):
hostname = 'Unknown'
hostname = "Unknown"
for line in show_sys.splitlines():
if line.startswith('System Name:'):
_, hostname = line.split('System Name:')
if line.startswith("System Name:"):
_, hostname = line.split("System Name:")
hostname = hostname.strip()
break
@@ -343,49 +339,53 @@ class S350Driver(NetworkDriver):
uptime_str = None
for line in show_sys.splitlines():
# All models except SG500 fw 1.4.x
if line.startswith('System Up Time (days,hour:min:sec):'):
_, uptime_str = line.split('System Up Time (days,hour:min:sec):')
if line.startswith("System Up Time (days,hour:min:sec):"):
_, uptime_str = line.split("System Up Time (days,hour:min:sec):")
break
line = re.sub(r' *', ' ', line, re.M)
line = re.sub(r" *", " ", line, re.M)
line = line.strip()
fields = line.split(' ')
fields = line.split(" ")
syslines.append(fields)
if 'Unit' in syslines[i] and 'time' in syslines[i]:
if "Unit" in syslines[i] and "time" in syslines[i]:
uptime_header_lineNo = i
i += 1
# SG500 fw 1.4.x
if not uptime_str:
uptime_str = syslines[uptime_header_lineNo+2][1]
uptime_str = syslines[uptime_header_lineNo + 2][1]
return uptime_str
def _get_facts_parse_inventory(self, show_inventory):
""" inventory can list more modules/devices """
# make 1 module 1 line
show_inventory = re.sub(r'\nPID', ' PID', show_inventory, re.M)
show_inventory = re.sub(r"\nPID", " PID", show_inventory, re.M)
# delete empty lines
show_inventory = re.sub(r'^\n', '', show_inventory, re.M)
show_inventory = re.sub(r'\n\n', '', show_inventory, re.M)
show_inventory = re.sub(r'\n\s*\n', r'\n', show_inventory, re.M)
show_inventory = re.sub(r"^\n", "", show_inventory, re.M)
show_inventory = re.sub(r"\n\n", "", show_inventory, re.M)
show_inventory = re.sub(r"\n\s*\n", r"\n", show_inventory, re.M)
lines = show_inventory.splitlines()
modules = {}
for line in lines:
match = re.search(r"""
match = re.search(
r"""
^
NAME:\s"(?P<name>\S+)"\s*
DESCR:\s"(?P<descr>[^"]+)"\s*
PID:\s(?P<pid>\S+)\s*
VID:\s(?P<vid>.+\S)\s*
SN:\s(?P<sn>\S+)\s*
""", line, re.X)
""",
line,
re.X,
)
module = match.groupdict()
modules[module['name']] = module
modules[module["name"]] = module
if modules:
return modules
@@ -397,21 +397,21 @@ class S350Driver(NetworkDriver):
for line in show_ver.splitlines():
# First version line is the active version
if re.search(r"Version:", line):
_, os_version = line.split('Version: ')
_, os_version = line.split("Version: ")
break
elif re.search(r"^SW version", show_ver):
for line in show_ver.splitlines():
if re.search(r"^SW version", line):
_, ver = line.split(' ')
os_version, _ = ver.split(' (')
_, ver = line.split(" ")
os_version, _ = ver.split(" (")
break
else:
# show_ver = re.sub(r'^\n', '', show_ver, re.M)
for line in show_ver.splitlines():
line = re.sub(r' *', ' ', line, re.M)
line = re.sub(r" *", " ", line, re.M)
line = line.strip()
line_comps = line.split(' ')
if line_comps[0] == '1':
line_comps = line.split(" ")
if line_comps[0] == "1":
os_version = line_comps[1]
break
@@ -423,21 +423,21 @@ class S350Driver(NetworkDriver):
"""
interfaces = {}
show_status_output = self._send_command('show interfaces status')
show_description_output = self._send_command('show interfaces description')
show_status_output = self._send_command("show interfaces status")
show_description_output = self._send_command("show interfaces description")
# by documentation SG350
show_jumbo_frame = self._send_command('show ports jumbo-frame')
match = re.search(r'Jumbo frames are enabled', show_jumbo_frame, re.M)
show_jumbo_frame = self._send_command("show ports jumbo-frame")
match = re.search(r"Jumbo frames are enabled", show_jumbo_frame, re.M)
if match:
mtu = 9000
else:
mtu = 1518
mac = '0'
mac = "0"
for status_line in show_status_output.splitlines():
if 'Up' in status_line or 'Down' in status_line:
if "Up" in status_line or "Down" in status_line:
if "Po" in status_line:
interface, _, _, speed, _, _, link_state = status_line.split()
else:
@@ -445,40 +445,37 @@ class S350Driver(NetworkDriver):
# Since the MAC address for all the local ports are equal, get the address
# from the first port and use it everywhere.
if mac == '0':
show_system_output = self._send_command('show lldp local ' + interface)
mac = show_system_output.splitlines()[0].split(':', maxsplit=1)[1].strip()
if mac == "0":
show_system_output = self._send_command("show lldp local " + interface)
mac = show_system_output.splitlines()[0].split(":", maxsplit=1)[1].strip()
if speed == '--':
if speed == "--":
is_enabled = False
speed = 0
else:
is_enabled = True
speed = int(speed)
is_up = (link_state == 'Up')
is_up = link_state == "Up"
for descr_line in show_description_output.splitlines():
description = 0
if descr_line.startswith(interface):
description = ' '.join(descr_line.split()[1:])
description = " ".join(descr_line.split()[1:])
break
# last_flapped can not be get - setting to default
entry = {
'is_up': is_up,
'is_enabled': is_enabled,
'speed': speed,
'mtu': mtu,
'last_flapped': -1.0,
'description': description,
'mac_address': napalm.base.helpers.mac(mac)
"is_up": is_up,
"is_enabled": is_enabled,
"speed": speed,
"mtu": mtu,
"last_flapped": -1.0,
"description": description,
"mac_address": napalm.base.helpers.mac(mac),
}
interface = canonical_interface_name(
interface,
s350_base_interfaces
)
interface = canonical_interface_name(interface, s350_base_interfaces)
interfaces[interface] = entry
@@ -487,47 +484,38 @@ class S350Driver(NetworkDriver):
def get_interfaces_ip(self):
"""Returns all configured interface IP addresses."""
interfaces = {}
show_ip_int = self._send_command('show ip int')
show_ip_int = self._send_command("show ip int")
header = True # cycle trought header
header = True # cycle trought header
for line in show_ip_int.splitlines():
if header:
# last line of first header
match = re.match(r'^---+ -+ .*$', line)
match = re.match(r"^---+ -+ .*$", line)
if match:
header = False
fields_end = self._get_ip_int_fields_end(line)
continue
# next header, stop processing text
if re.match(r'^---+ -+ .*$', line):
if re.match(r"^---+ -+ .*$", line):
break
line_elems = self._get_ip_int_line_to_fields(line, fields_end)
# only valid interfaces
# in diferent firmwares there is 'Status' field allwais on last place
if line_elems[len(line_elems) - 1] != 'Valid':
if line_elems[len(line_elems) - 1] != "Valid":
continue
cidr = line_elems[0]
interface = line_elems[1]
ip = netaddr.IPNetwork(cidr)
family = 'ipv{0}'.format(ip.version)
family = "ipv{0}".format(ip.version)
interface = canonical_interface_name(
interface,
s350_base_interfaces
)
interface = canonical_interface_name(interface, s350_base_interfaces)
interfaces[interface] = {
family: {
str(ip.ip): {
'prefix_length': ip.prefixlen
}
}
}
interfaces[interface] = {family: {str(ip.ip): {"prefix_length": ip.prefixlen}}}
return interfaces
@@ -545,7 +533,7 @@ class S350Driver(NetworkDriver):
def _get_ip_int_fields_end(self, dashline):
""" fields length are diferent device to device, detect them on horizontal lin """
fields_end = [m.start() for m in re.finditer(' ', dashline.strip())]
fields_end = [m.start() for m in re.finditer(" ", dashline.strip())]
# fields_position.insert(0,0)
fields_end.append(len(dashline))
@@ -554,16 +542,16 @@ class S350Driver(NetworkDriver):
def get_lldp_neighbors(self):
"""get_lldp_neighbors implementation for s350"""
neighbors = {}
output = self._send_command('show lldp neighbors')
output = self._send_command("show lldp neighbors")
header = True # cycle trought header
local_port = '' # keep previous context - multiline syname
remote_port = ''
remote_name = ''
header = True # cycle trought header
local_port = "" # keep previous context - multiline syname
remote_port = ""
remote_name = ""
for line in output.splitlines():
if header:
# last line of header
match = re.match(r'^--------- -+ .*$', line)
match = re.match(r"^--------- -+ .*$", line)
if match:
header = False
fields_end = self._get_lldp_neighbors_fields_end(line)
@@ -572,7 +560,7 @@ class S350Driver(NetworkDriver):
line_elems = self._get_lldp_neighbors_line_to_fields(line, fields_end)
# info owerflow to the other line
if line_elems[0] == '' or line_elems[4] == '' or line_elems[5] == '' :
if line_elems[0] == "" or line_elems[4] == "" or line_elems[5] == "":
# complete owerflown fields
local_port = local_port + line_elems[0]
remote_port = remote_port + line_elems[2]
@@ -583,16 +571,15 @@ class S350Driver(NetworkDriver):
remote_port = line_elems[2]
remote_name = line_elems[3]
local_port = canonical_interface_name(
local_port,
s350_base_interfaces
)
local_port = canonical_interface_name(local_port, s350_base_interfaces)
neighbor = {
'hostname': remote_name,
'port': remote_port,
"hostname": remote_name,
"port": remote_port,
}
neighbor_list = [neighbor, ]
neighbor_list = [
neighbor,
]
neighbors[local_port] = neighbor_list
return neighbors
@@ -611,7 +598,7 @@ class S350Driver(NetworkDriver):
def _get_lldp_neighbors_fields_end(self, dashline):
""" fields length are diferent device to device, detect them on horizontal lin """
fields_end = [m.start() for m in re.finditer(' ', dashline)]
fields_end = [m.start() for m in re.finditer(" ", dashline)]
fields_end.append(len(dashline))
return fields_end
@@ -621,9 +608,9 @@ class S350Driver(NetworkDriver):
Safe-ish method to get the value from an 'lldp neighbors $IF' line.
"""
try:
value = line.split(':')[1:][0].strip()
value = line.split(":")[1:][0].strip()
except KeyError:
value = u'N/A'
value = "N/A"
return value
@@ -638,58 +625,59 @@ class S350Driver(NetworkDriver):
if interface:
if interface == local_port:
entry = self._get_lldp_neighbors_detail_parse(local_port)
local_port = canonical_interface_name(
local_port,
s350_base_interfaces
)
details[local_port] = [entry, ]
local_port = canonical_interface_name(local_port, s350_base_interfaces)
details[local_port] = [
entry,
]
else:
entry = self._get_lldp_neighbors_detail_parse(local_port)
local_port = canonical_interface_name(
local_port,
s350_base_interfaces
)
details[local_port] = [entry, ]
local_port = canonical_interface_name(local_port, s350_base_interfaces)
details[local_port] = [
entry,
]
return details
def _get_lldp_neighbors_detail_parse(self, local_port):
# Set defaults, just in case the remote fails to provide a field.
remote_port_id, remote_port_description, remote_chassis_id, \
remote_system_name, remote_system_description, \
remote_system_capab, remote_system_enable_capab = (u'N/A',) * 7
(
remote_port_id,
remote_port_description,
remote_chassis_id,
remote_system_name,
remote_system_description,
remote_system_capab,
remote_system_enable_capab,
) = ("N/A",) * 7
output = self._send_command('show lldp neighbors {}'.format(local_port))
output = self._send_command("show lldp neighbors {}".format(local_port))
for line in output.splitlines():
if line.startswith('Port ID'):
if line.startswith("Port ID"):
remote_port_id = line.split()[-1]
elif line.startswith('Device ID'):
elif line.startswith("Device ID"):
remote_chassis_id = line.split()[-1]
elif line.startswith('Port description'):
elif line.startswith("Port description"):
remote_port_description = self._get_lldp_line_value(line)
elif line.startswith('System Name'):
elif line.startswith("System Name"):
remote_system_name = self._get_lldp_line_value(line)
elif line.startswith('System description'):
elif line.startswith("System description"):
remote_system_description = self._get_lldp_line_value(line)
elif line.startswith('Capabilities'):
elif line.startswith("Capabilities"):
caps = self._get_lldp_neighbors_detail_capabilities_parse(line)
remote_port_id = canonical_interface_name(
remote_port_id,
s350_base_interfaces
)
remote_port_id = canonical_interface_name(remote_port_id, s350_base_interfaces)
entry = {
'parent_interface': u'N/A',
'remote_port': remote_port_id,
'remote_port_description': remote_port_description,
'remote_chassis_id': remote_chassis_id,
'remote_system_name': remote_system_name,
'remote_system_description': remote_system_description,
'remote_system_capab': caps,
'remote_system_enable_capab': caps,
"parent_interface": "N/A",
"remote_port": remote_port_id,
"remote_port_description": remote_port_description,
"remote_chassis_id": remote_chassis_id,
"remote_system_name": remote_system_name,
"remote_system_description": remote_system_description,
"remote_system_capab": caps,
"remote_system_enable_capab": caps,
}
return entry
@@ -698,7 +686,7 @@ class S350Driver(NetworkDriver):
# Only the enabled capabilities are displayed.
try:
# Split a line like 'Capabilities: Bridge, Router, Wlan-Access-Point'
capabilities = line.split(':')[1:][0].split(',')
capabilities = line.split(":")[1:][0].split(",")
except KeyError:
capabilities = []
@@ -707,8 +695,8 @@ class S350Driver(NetworkDriver):
# is the first character.
for cap in capabilities:
cap = cap.strip()
if cap == 'Repeater':
caps.append('r')
if cap == "Repeater":
caps.append("r")
else:
caps.append(cap[0])
@@ -717,9 +705,9 @@ class S350Driver(NetworkDriver):
def get_ntp_servers(self):
"""Returns NTP servers."""
ntp_servers = {}
output = self._send_command('show sntp status')
output = self._send_command("show sntp status")
servers = re.findall(r'^Server\s*:\s*(\S+)\s*.*$', output, re.M)
servers = re.findall(r"^Server\s*:\s*(\S+)\s*.*$", output, re.M)
for server in servers:
ntp_servers[server] = {}
@@ -731,18 +719,18 @@ class S350Driver(NetworkDriver):
null = chr(0)
if self.device is None:
return {'is_alive': False}
return {"is_alive": False}
# Send a NUL byte to keep the connection alive.
try:
self.device.write_channel(null)
return {'is_alive': self.device.remote_conn.transport.is_active()}
return {"is_alive": self.device.remote_conn.transport.is_active()}
except (socket.error, EOFError):
# If we couldn't send it, the connection is not available.
return {'is_alive': False}
return {"is_alive": False}
# If we made it here, assume the worst.
return {'is_alive': False}
return {"is_alive": False}
@property
def dest_file_system(self):