diff --git a/config/main.py b/config/main.py index c8ec8bc86b..e3531f5a87 100644 --- a/config/main.py +++ b/config/main.py @@ -56,6 +56,7 @@ from .config_mgmt import ConfigMgmtDPB, ConfigMgmt from . import mclag from . import syslog +from . import switchport from . import dns # mock masic APIs for unit test @@ -101,6 +102,8 @@ CFG_PORTCHANNEL_NO="<0-9999>" PORT_MTU = "mtu" +PORT_MODE= "switchport_mode" + PORT_SPEED = "speed" PORT_TPID = "tpid" DEFAULT_TPID = "0x8100" @@ -1190,6 +1193,7 @@ def config(ctx): config.add_command(nat.nat) config.add_command(vlan.vlan) config.add_command(vxlan.vxlan) +config.add_command(switchport.switchport) #add mclag commands config.add_command(mclag.mclag) @@ -4489,19 +4493,39 @@ def add(ctx, interface_name, ip_addr, gw): if interface_name is None: ctx.fail("'interface_name' is None!") - # Add a validation to check this interface is not a member in vlan before - # changing it to a router port - vlan_member_table = config_db.get_table('VLAN_MEMBER') - if (interface_is_in_vlan(vlan_member_table, interface_name)): - click.echo("Interface {} is a member of vlan\nAborting!".format(interface_name)) - return - portchannel_member_table = config_db.get_table('PORTCHANNEL_MEMBER') if interface_is_in_portchannel(portchannel_member_table, interface_name): ctx.fail("{} is configured as a member of portchannel." .format(interface_name)) + + + # Add a validation to check this interface is in routed mode before + # assigning an IP address to it + + sub_intf = False + if clicommon.is_valid_port(config_db, interface_name): + is_port = True + elif clicommon.is_valid_portchannel(config_db, interface_name): + is_port = False + else: + sub_intf = True + + if not sub_intf: + interface_mode = "routed" + if is_port: + interface_data = config_db.get_entry('PORT',interface_name) + elif not is_port: + interface_data = config_db.get_entry('PORTCHANNEL',interface_name) + + if "mode" in interface_data: + interface_mode = interface_data["mode"] + + if interface_mode != "routed": + ctx.fail("Interface {} is not in routed mode!".format(interface_name)) + return + try: ip_address = ipaddress.ip_interface(ip_addr) except ValueError as err: diff --git a/config/switchport.py b/config/switchport.py new file mode 100644 index 0000000000..fe51ccaf79 --- /dev/null +++ b/config/switchport.py @@ -0,0 +1,138 @@ +import click +from .utils import log +import utilities_common.cli as clicommon + +# +# 'switchport' mode ('config switchport ...') +# + + +@click.group(cls=clicommon.AbbreviationGroup, name='switchport') +def switchport(): + """Switchport mode configuration tasks""" + pass + + +@switchport.command("mode") +@click.argument("type", metavar="", required=True, type=click.Choice(["access", "trunk", "routed"])) +@click.argument("port", metavar="port", required=True) +@clicommon.pass_db +def switchport_mode(db, type, port): + """switchport mode help commands.Mode_type can be access or trunk or routed""" + + ctx = click.get_current_context() + + log.log_info("'switchport mode {} {}' executing...".format(type, port)) + mode_exists_status = True + + # checking if port name with alias exists + if clicommon.get_interface_naming_mode() == "alias": + alias = port + iface_alias_converter = clicommon.InterfaceAliasConverter(db) + port = iface_alias_converter.alias_to_name(port) + if port is None: + ctx.fail("cannot find port name for alias {}".format(alias)) + + if clicommon.is_port_mirror_dst_port(db.cfgdb, port): + ctx.fail("{} is configured as mirror destination port".format(port)) + + + if clicommon.is_valid_port(db.cfgdb, port): + is_port = True + elif clicommon.is_valid_portchannel(db.cfgdb, port): + is_port = False + else: + ctx.fail("{} does not exist".format(port)) + + portchannel_member_table = db.cfgdb.get_table('PORTCHANNEL_MEMBER') + + if (is_port and clicommon.interface_is_in_portchannel(portchannel_member_table, port)): + ctx.fail("{} is part of portchannel!".format(port)) + + if is_port: + port_data = db.cfgdb.get_entry('PORT',port) + else: + port_data = db.cfgdb.get_entry('PORTCHANNEL',port) + + # mode type is either access or trunk + if type != "routed": + + if "mode" in port_data: + existing_mode = port_data["mode"] + else: + existing_mode = "routed" + mode_exists_status = False + if (is_port and clicommon.is_port_router_interface(db.cfgdb, port)) or \ + (not is_port and clicommon.is_pc_router_interface(db.cfgdb, port)): + ctx.fail("Remove IP from {} to change mode!".format(port)) + + if existing_mode == "routed": + if mode_exists_status: + # if the port in an interface + if is_port: + db.cfgdb.mod_entry("PORT", port, {"mode": "{}".format(type)}) + # if not port then is a port channel + elif not is_port: + db.cfgdb.mod_entry("PORTCHANNEL", port, {"mode": "{}".format(type)}) + + if not mode_exists_status: + port_data["mode"] = type + if is_port: + db.cfgdb.set_entry("PORT", port, port_data) + # if not port then is a port channel + elif not is_port: + db.cfgdb.set_entry("PORTCHANNEL", port, port_data) + + if existing_mode == type: + ctx.fail("{} is already in the {} mode".format(port,type)) + else: + if existing_mode == "access" and type == "trunk": + pass + if existing_mode == "trunk" and type == "access": + if clicommon.interface_is_tagged_member(db.cfgdb,port): + ctx.fail("{} is in {} mode and have tagged member(s).\nRemove tagged member(s) from {} to switch to {} mode".format(port,existing_mode,port,type)) + if is_port: + db.cfgdb.mod_entry("PORT", port, {"mode": "{}".format(type)}) + # if not port then is a port channel + elif not is_port: + db.cfgdb.mod_entry("PORTCHANNEL", port, {"mode": "{}".format(type)}) + + click.echo("{} switched from {} to {} mode".format(port, existing_mode, type)) + + # if mode type is routed + else: + + if clicommon.interface_is_tagged_member(db.cfgdb,port): + ctx.fail("{} has tagged member(s). \nRemove them to change mode to {}".format(port,type)) + + if clicommon.interface_is_untagged_member(db.cfgdb,port): + ctx.fail("{} has untagged member. \nRemove it to change mode to {}".format(port,type)) + + if "mode" in port_data: + existing_mode = port_data["mode"] + else: + existing_mode = "routed" + mode_exists_status = False + + if not mode_exists_status: + port_data["mode"] = type + if is_port: + db.cfgdb.set_entry("PORT", port, port_data) + + # if not port then is a port channel + elif not is_port: + db.cfgdb.set_entry("PORTCHANNEL", port, port_data) + pass + + elif mode_exists_status and existing_mode == type: + ctx.fail("{} is already in {} mode".format(port,type)) + + else: + if is_port: + db.cfgdb.mod_entry("PORT", port, {"mode": "{}".format(type)}) + # if not port then is a port channel + elif not is_port: + db.cfgdb.mod_entry("PORTCHANNEL", port, {"mode": "{}".format(type)}) + + click.echo("{} switched from {} to {} mode".format(port,existing_mode,type)) + diff --git a/config/vlan.py b/config/vlan.py index 03660ab0af..7206868db7 100644 --- a/config/vlan.py +++ b/config/vlan.py @@ -12,15 +12,19 @@ DHCP_RELAY_TABLE = "DHCP_RELAY" DHCPV6_SERVERS = "dhcpv6_servers" + # # 'vlan' group ('config vlan ...') # + + @click.group(cls=clicommon.AbbreviationGroup, name='vlan') def vlan(): """VLAN-related configuration tasks""" pass + def set_dhcp_relay_table(table, config_db, vlan_name, value): config_db.set_entry(table, vlan_name, value) @@ -29,41 +33,68 @@ def is_dhcp_relay_running(): out, _ = clicommon.run_command("systemctl show dhcp_relay.service --property ActiveState --value", return_cmd=True) return out.strip() == "active" +def is_dhcpv6_relay_config_exist(db, vlan_name): + keys = db.cfgdb.get_keys(DHCP_RELAY_TABLE) + if len(keys) == 0 or vlan_name not in keys: + return False + + table = db.cfgdb.get_entry("DHCP_RELAY", vlan_name) + dhcpv6_servers = table.get(DHCPV6_SERVERS, []) + if len(dhcpv6_servers) > 0: + return True + @vlan.command('add') -@click.argument('vid', metavar='', required=True, type=int) +@click.argument('vid', metavar='', required=True) +@click.option('-m', '--multiple', is_flag=True, help="Add Multiple Vlan(s) in Range or in Comma separated list") @clicommon.pass_db -def add_vlan(db, vid): +def add_vlan(db, vid, multiple): """Add VLAN""" ctx = click.get_current_context() - vlan = 'Vlan{}'.format(vid) - + config_db = ValidatedConfigDBConnector(db.cfgdb) + + vid_list = [] + # parser will parse the vid input if there are syntax errors it will throw error + if multiple: + vid_list = clicommon.multiple_vlan_parser(ctx, vid) + else: + if not vid.isdigit(): + ctx.fail("{} is not integer".format(vid)) + vid_list.append(int(vid)) + if ADHOC_VALIDATION: - if not clicommon.is_vlanid_in_range(vid): - ctx.fail("Invalid VLAN ID {} (1-4094)".format(vid)) - if vid == 1: - ctx.fail("{} is default VLAN".format(vlan)) # TODO: MISSING CONSTRAINT IN YANG MODEL + # loop will execute till an exception occurs + for vid in vid_list: - if clicommon.check_if_vlanid_exist(db.cfgdb, vlan): # TODO: MISSING CONSTRAINT IN YANG MODEL - ctx.fail("{} already exists".format(vlan)) - if clicommon.check_if_vlanid_exist(db.cfgdb, vlan, "DHCP_RELAY"): - ctx.fail("DHCPv6 relay config for {} already exists".format(vlan)) - # set dhcpv4_relay table - set_dhcp_relay_table('VLAN', config_db, vlan, {'vlanid': str(vid)}) + vlan = 'Vlan{}'.format(vid) + # default vlan checker + if vid == 1: + # TODO: MISSING CONSTRAINT IN YANG MODEL + ctx.fail("{} is default VLAN.".format(vlan)) -def is_dhcpv6_relay_config_exist(db, vlan_name): - keys = db.cfgdb.get_keys(DHCP_RELAY_TABLE) - if len(keys) == 0 or vlan_name not in keys: - return False + log.log_info("'vlan add {}' executing...".format(vid)) - table = db.cfgdb.get_entry("DHCP_RELAY", vlan_name) - dhcpv6_servers = table.get(DHCPV6_SERVERS, []) - if len(dhcpv6_servers) > 0: - return True + if not clicommon.is_vlanid_in_range(vid): + ctx.fail("Invalid VLAN ID {} (2-4094)".format(vid)) + + # TODO: MISSING CONSTRAINT IN YANG MODEL + if clicommon.check_if_vlanid_exist(db.cfgdb, vlan): + log.log_info("{} already exists".format(vlan)) + ctx.fail("{} already exists, Aborting!!!".format(vlan)) + + if clicommon.check_if_vlanid_exist(db.cfgdb, vlan, "DHCP_RELAY"): + ctx.fail("DHCPv6 relay config for {} already exists".format(vlan)) + + try: + # set dhcpv4_relay / VLAN table + config_db.set_entry('VLAN', vlan, {'vlanid': str(vid)}) + + except ValueError: + ctx.fail("Invalid VLAN ID {} (2-4094)".format(vid)) def delete_state_db_entry(entry_name): @@ -75,57 +106,74 @@ def delete_state_db_entry(entry_name): @vlan.command('del') -@click.argument('vid', metavar='', required=True, type=int) +@click.argument('vid', metavar='', required=True) +@click.option('-m', '--multiple', is_flag=True, help="Add Multiple Vlan(s) in Range or in Comma separated list") @click.option('--no_restart_dhcp_relay', is_flag=True, type=click.BOOL, required=False, default=False, help="If no_restart_dhcp_relay is True, do not restart dhcp_relay while del vlan and \ - require dhcpv6 relay of this is empty") + require dhcpv6 relay of this is empty") @clicommon.pass_db -def del_vlan(db, vid, no_restart_dhcp_relay): +def del_vlan(db, vid, multiple, no_restart_dhcp_relay): """Delete VLAN""" - log.log_info("'vlan del {}' executing...".format(vid)) - ctx = click.get_current_context() - vlan = 'Vlan{}'.format(vid) - if no_restart_dhcp_relay: - if is_dhcpv6_relay_config_exist(db, vlan): - ctx.fail("Can't delete {} because related DHCPv6 Relay config is exist".format(vlan)) - config_db = ValidatedConfigDBConnector(db.cfgdb) - if ADHOC_VALIDATION: - if not clicommon.is_vlanid_in_range(vid): - ctx.fail("Invalid VLAN ID {} (1-4094)".format(vid)) - - if clicommon.check_if_vlanid_exist(db.cfgdb, vlan) == False: - ctx.fail("{} does not exist".format(vlan)) - - intf_table = db.cfgdb.get_table('VLAN_INTERFACE') - for intf_key in intf_table: - if ((type(intf_key) is str and intf_key == 'Vlan{}'.format(vid)) or # TODO: MISSING CONSTRAINT IN YANG MODEL - (type(intf_key) is tuple and intf_key[0] == 'Vlan{}'.format(vid))): - ctx.fail("{} can not be removed. First remove IP addresses assigned to this VLAN".format(vlan)) - - keys = [ (k, v) for k, v in db.cfgdb.get_table('VLAN_MEMBER') if k == 'Vlan{}'.format(vid) ] - if keys: # TODO: MISSING CONSTRAINT IN YANG MODEL - ctx.fail("VLAN ID {} can not be removed. First remove all members assigned to this VLAN.".format(vid)) - - vxlan_table = db.cfgdb.get_table('VXLAN_TUNNEL_MAP') - for vxmap_key, vxmap_data in vxlan_table.items(): - if vxmap_data['vlan'] == 'Vlan{}'.format(vid): - ctx.fail("vlan: {} can not be removed. First remove vxlan mapping '{}' assigned to VLAN".format(vid, '|'.join(vxmap_key)) ) - - # set dhcpv4_relay table - set_dhcp_relay_table('VLAN', config_db, vlan, None) - - if not no_restart_dhcp_relay and is_dhcpv6_relay_config_exist(db, vlan): - # set dhcpv6_relay table - set_dhcp_relay_table('DHCP_RELAY', config_db, vlan, None) - # We need to restart dhcp_relay service after dhcpv6_relay config change - if is_dhcp_relay_running(): - dhcp_relay_util.handle_restart_dhcp_relay_service() - delete_state_db_entry(vlan) + vid_list = [] + # parser will parse the vid input if there are syntax errors it will throw error + if multiple: + vid_list = clicommon.multiple_vlan_parser(ctx, vid) + else: + if not vid.isdigit(): + ctx.fail("{} is not integer".format(vid)) + vid_list.append(int(vid)) + if ADHOC_VALIDATION: + # loop will execute till an exception occurs + for vid in vid_list: + + log.log_info("'vlan del {}' executing...".format(vid)) + + if not clicommon.is_vlanid_in_range(vid): + ctx.fail("Invalid VLAN ID {} (2-4094)".format(vid)) + + vlan = 'Vlan{}'.format(vid) + + if no_restart_dhcp_relay: + if is_dhcpv6_relay_config_exist(db, vlan): + ctx.fail("Can't delete {} because related DHCPv6 Relay config is exist".format(vlan)) + + if clicommon.check_if_vlanid_exist(db.cfgdb, vlan) == False: + log.log_info("{} does not exist".format(vlan)) + ctx.fail("{} does not exist, Aborting!!!".format(vlan)) + + intf_table = db.cfgdb.get_table('VLAN_INTERFACE') + for intf_key in intf_table: + if ((type(intf_key) is str and intf_key == 'Vlan{}'.format(vid)) or # TODO: MISSING CONSTRAINT IN YANG MODEL + (type(intf_key) is tuple and intf_key[0] == 'Vlan{}'.format(vid))): + ctx.fail("{} can not be removed. First remove IP addresses assigned to this VLAN".format(vlan)) + + keys = [(k, v) for k, v in db.cfgdb.get_table('VLAN_MEMBER') if k == 'Vlan{}'.format(vid)] + + if keys: # TODO: MISSING CONSTRAINT IN YANG MODEL + ctx.fail("VLAN ID {} can not be removed. First remove all members assigned to this VLAN.".format(vid)) + + vxlan_table = db.cfgdb.get_table('VXLAN_TUNNEL_MAP') + for vxmap_key, vxmap_data in vxlan_table.items(): + if vxmap_data['vlan'] == 'Vlan{}'.format(vid): + ctx.fail("vlan: {} can not be removed. First remove vxlan mapping '{}' assigned to VLAN".format(vid, '|'.join(vxmap_key))) + + # set dhcpv4_relay / VLAN table + config_db.set_entry('VLAN', 'Vlan{}'.format(vid), None) + + if not no_restart_dhcp_relay and is_dhcpv6_relay_config_exist(db, vlan): + # set dhcpv6_relay table + set_dhcp_relay_table('DHCP_RELAY', config_db, vlan, None) + # We need to restart dhcp_relay service after dhcpv6_relay config change + if is_dhcp_relay_running(): + dhcp_relay_util.handle_restart_dhcp_relay_service() + + delete_state_db_entry(vlan) + vlans = db.cfgdb.get_keys('VLAN') if not vlans: docker_exec_cmd = "docker exec -i swss {}" @@ -135,7 +183,7 @@ def del_vlan(db, vid, no_restart_dhcp_relay): clicommon.run_command(docker_exec_cmd.format("supervisorctl stop ndppd"), ignore_error=True, return_cmd=True) clicommon.run_command(docker_exec_cmd.format("rm -f /etc/supervisor/conf.d/ndppd.conf"), ignore_error=True, return_cmd=True) clicommon.run_command(docker_exec_cmd.format("supervisorctl update"), return_cmd=True) - + def restart_ndppd(): verify_swss_running_cmd = ['docker', 'container', 'inspect', '-f', '{{.State.Status}}', 'swss'] @@ -182,103 +230,162 @@ def config_proxy_arp(db, vid, mode): db.cfgdb.mod_entry('VLAN_INTERFACE', vlan, {"proxy_arp": mode}) click.echo('Proxy ARP setting saved to ConfigDB') restart_ndppd() + + # # 'member' group ('config vlan member ...') # + + @vlan.group(cls=clicommon.AbbreviationGroup, name='member') def vlan_member(): pass + @vlan_member.command('add') -@click.argument('vid', metavar='', required=True, type=int) +@click.argument('vid', metavar='', required=True) @click.argument('port', metavar='port', required=True) -@click.option('-u', '--untagged', is_flag=True) +@click.option('-u', '--untagged', is_flag=True, help="Untagged status") +@click.option('-m', '--multiple', is_flag=True, help="Add Multiple Vlan(s) in Range or in Comma separated list") +@click.option('-e', '--except_flag', is_flag=True, help="Skips the given vlans and adds all other existing vlans.") @clicommon.pass_db -def add_vlan_member(db, vid, port, untagged): +def add_vlan_member(db, vid, port, untagged, multiple, except_flag): """Add VLAN member""" ctx = click.get_current_context() - - log.log_info("'vlan member add {} {}' executing...".format(vid, port)) - - vlan = 'Vlan{}'.format(vid) - config_db = ValidatedConfigDBConnector(db.cfgdb) - if ADHOC_VALIDATION: - if not clicommon.is_vlanid_in_range(vid): - ctx.fail("Invalid VLAN ID {} (1-4094)".format(vid)) - - if clicommon.check_if_vlanid_exist(db.cfgdb, vlan) == False: - ctx.fail("{} does not exist".format(vlan)) - if clicommon.get_interface_naming_mode() == "alias": # TODO: MISSING CONSTRAINT IN YANG MODEL - alias = port - iface_alias_converter = clicommon.InterfaceAliasConverter(db) - port = iface_alias_converter.alias_to_name(alias) - if port is None: - ctx.fail("cannot find port name for alias {}".format(alias)) + # parser will parse the vid input if there are syntax errors it will throw error - if clicommon.is_port_mirror_dst_port(db.cfgdb, port): # TODO: MISSING CONSTRAINT IN YANG MODEL - ctx.fail("{} is configured as mirror destination port".format(port)) + vid_list = clicommon.vlan_member_input_parser(ctx, "add", db, except_flag, multiple, vid, port) - if clicommon.is_port_vlan_member(db.cfgdb, port, vlan): # TODO: MISSING CONSTRAINT IN YANG MODEL - ctx.fail("{} is already a member of {}".format(port, vlan)) + # multiple vlan command cannot be used to add multiple untagged vlan members + if untagged and (multiple or except_flag or vid == "all"): + ctx.fail("{} cannot have more than one untagged Vlan.".format(port)) - if clicommon.is_valid_port(db.cfgdb, port): - is_port = True - elif clicommon.is_valid_portchannel(db.cfgdb, port): - is_port = False - else: - ctx.fail("{} does not exist".format(port)) - - if (is_port and clicommon.is_port_router_interface(db.cfgdb, port)) or \ - (not is_port and clicommon.is_pc_router_interface(db.cfgdb, port)): # TODO: MISSING CONSTRAINT IN YANG MODEL - ctx.fail("{} is a router interface!".format(port)) - - portchannel_member_table = db.cfgdb.get_table('PORTCHANNEL_MEMBER') - - if (is_port and clicommon.interface_is_in_portchannel(portchannel_member_table, port)): # TODO: MISSING CONSTRAINT IN YANG MODEL - ctx.fail("{} is part of portchannel!".format(port)) - - if (clicommon.interface_is_untagged_member(db.cfgdb, port) and untagged): # TODO: MISSING CONSTRAINT IN YANG MODEL - ctx.fail("{} is already untagged member!".format(port)) + if ADHOC_VALIDATION: + for vid in vid_list: + + # default vlan checker + if vid == 1: + ctx.fail("{} is default VLAN".format(vlan)) + + log.log_info("'vlan member add {} {}' executing...".format(vid, port)) + + if not clicommon.is_vlanid_in_range(vid): + ctx.fail("Invalid VLAN ID {} (2-4094)".format(vid)) + + vlan = 'Vlan{}'.format(vid) + if clicommon.check_if_vlanid_exist(db.cfgdb, vlan) == False: + log.log_info("{} does not exist".format(vlan)) + ctx.fail("{} does not exist".format(vlan)) + + if clicommon.get_interface_naming_mode() == "alias": # TODO: MISSING CONSTRAINT IN YANG MODEL + alias = port + iface_alias_converter = clicommon.InterfaceAliasConverter(db) + port = iface_alias_converter.alias_to_name(alias) + if port is None: + ctx.fail("cannot find port name for alias {}".format(alias)) + + # TODO: MISSING CONSTRAINT IN YANG MODEL + if clicommon.is_port_mirror_dst_port(db.cfgdb, port): + ctx.fail("{} is configured as mirror destination port".format(port)) + + # TODO: MISSING CONSTRAINT IN YANG MODEL + if clicommon.is_port_vlan_member(db.cfgdb, port, vlan): + log.log_info("{} is already a member of {}, Aborting!!!".format(port, vlan)) + ctx.fail("{} is already a member of {}, Aborting!!!".format(port, vlan)) + + + if clicommon.is_valid_port(db.cfgdb, port): + is_port = True + elif clicommon.is_valid_portchannel(db.cfgdb, port): + is_port = False + else: + ctx.fail("{} does not exist".format(port)) + + portchannel_member_table = db.cfgdb.get_table('PORTCHANNEL_MEMBER') + + # TODO: MISSING CONSTRAINT IN YANG MODEL + if (is_port and clicommon.interface_is_in_portchannel(portchannel_member_table, port)): + ctx.fail("{} is part of portchannel!".format(port)) + + # TODO: MISSING CONSTRAINT IN YANG MODEL + if (clicommon.interface_is_untagged_member(db.cfgdb, port) and untagged): + ctx.fail("{} is already untagged member!".format(port)) + + # checking mode status of port if its access, trunk or routed + if is_port: + port_data = config_db.get_entry('PORT',port) + + # if not port then is a port channel + elif not is_port: + port_data = config_db.get_entry('PORTCHANNEL',port) + + if "mode" not in port_data: + ctx.fail("{} is in routed mode!\nUse switchport mode command to change port mode".format(port)) + else: + existing_mode = port_data["mode"] + + if existing_mode == "routed": + ctx.fail("{} is in routed mode!\nUse switchport mode command to change port mode".format(port)) + + mode_type = "access" if untagged else "trunk" + if existing_mode == "access" and mode_type == "trunk": # TODO: MISSING CONSTRAINT IN YANG MODEL + ctx.fail("{} is in access mode! Tagged Members cannot be added".format(port)) + + elif existing_mode == mode_type or (existing_mode == "trunk" and mode_type == "access"): + pass + + # in case of exception in list last added member will be shown to user + try: + config_db.set_entry('VLAN_MEMBER', (vlan, port), {'tagging_mode': "untagged" if untagged else "tagged"}) + except ValueError: + ctx.fail("{} invalid or does not exist, or {} invalid or does not exist".format(vlan, port)) - try: - config_db.set_entry('VLAN_MEMBER', (vlan, port), {'tagging_mode': "untagged" if untagged else "tagged" }) - except ValueError: - ctx.fail("{} invalid or does not exist, or {} invalid or does not exist".format(vlan, port)) @vlan_member.command('del') -@click.argument('vid', metavar='', required=True, type=int) +@click.argument('vid', metavar='', required=True) @click.argument('port', metavar='', required=True) +@click.option('-m', '--multiple', is_flag=True, help="Add Multiple Vlan(s) in Range or in Comma separated list") +@click.option('-e', '--except_flag', is_flag=True, help="Skips the given vlans and adds all other existing vlans.") @clicommon.pass_db -def del_vlan_member(db, vid, port): +def del_vlan_member(db, vid, port, multiple, except_flag): """Delete VLAN member""" ctx = click.get_current_context() - log.log_info("'vlan member del {} {}' executing...".format(vid, port)) - vlan = 'Vlan{}'.format(vid) - config_db = ValidatedConfigDBConnector(db.cfgdb) + + # parser will parse the vid input if there are syntax errors it will throw error + + vid_list = clicommon.vlan_member_input_parser(ctx,"del", db, except_flag, multiple, vid, port) + if ADHOC_VALIDATION: - if not clicommon.is_vlanid_in_range(vid): - ctx.fail("Invalid VLAN ID {} (1-4094)".format(vid)) + for vid in vid_list: + + log.log_info("'vlan member del {} {}' executing...".format(vid, port)) + + if not clicommon.is_vlanid_in_range(vid): + ctx.fail("Invalid VLAN ID {} (2-4094)".format(vid)) - if clicommon.check_if_vlanid_exist(db.cfgdb, vlan) == False: - ctx.fail("{} does not exist".format(vlan)) + vlan = 'Vlan{}'.format(vid) + if clicommon.check_if_vlanid_exist(db.cfgdb, vlan) == False: + log.log_info("{} does not exist, Aborting!!!".format(vlan)) + ctx.fail("{} does not exist, Aborting!!!".format(vlan)) - if clicommon.get_interface_naming_mode() == "alias": # TODO: MISSING CONSTRAINT IN YANG MODEL - alias = port - iface_alias_converter = clicommon.InterfaceAliasConverter(db) - port = iface_alias_converter.alias_to_name(alias) - if port is None: - ctx.fail("cannot find port name for alias {}".format(alias)) + if clicommon.get_interface_naming_mode() == "alias": # TODO: MISSING CONSTRAINT IN YANG MODEL + alias = port + iface_alias_converter = clicommon.InterfaceAliasConverter(db) + port = iface_alias_converter.alias_to_name(alias) + if port is None: + ctx.fail("cannot find port name for alias {}".format(alias)) - if not clicommon.is_port_vlan_member(db.cfgdb, port, vlan): # TODO: MISSING CONSTRAINT IN YANG MODEL - ctx.fail("{} is not a member of {}".format(port, vlan)) + # TODO: MISSING CONSTRAINT IN YANG MODEL + if not clicommon.is_port_vlan_member(db.cfgdb, port, vlan): + ctx.fail("{} is not a member of {}".format(port, vlan)) - try: - config_db.set_entry('VLAN_MEMBER', (vlan, port), None) - except JsonPatchConflict: - ctx.fail("{} invalid or does not exist, or {} is not a member of {}".format(vlan, port, vlan)) + try: + config_db.set_entry('VLAN_MEMBER', (vlan, port), None) + except JsonPatchConflict: + ctx.fail("{} invalid or does not exist, or {} is not a member of {}".format(vlan, port, vlan)) diff --git a/doc/Command-Reference.md b/doc/Command-Reference.md index 211074bc6c..8f1ad2f871 100644 --- a/doc/Command-Reference.md +++ b/doc/Command-Reference.md @@ -157,6 +157,8 @@ * [Subinterfaces](#subinterfaces) * [Subinterfaces Show Commands](#subinterfaces-show-commands) * [Subinterfaces Config Commands](#subinterfaces-config-commands) +* [Switchport Modes](#switchport-modes) + * [Switchport Mode config commands](#switchport modes-config-commands) * [Syslog](#syslog) * [Syslog show commands](#syslog-show-commands) * [Syslog config commands](#syslog-config-commands) @@ -2840,23 +2842,23 @@ This command is used to show ipv6 dhcp_relay counters. - Example: ``` admin@sonic:~$ sudo sonic-clear dhcp_relay counters -      Message Type    Vlan1000 - -------------------  ---------- -             Unknown           0 -             Solicit           0 -           Advertise           0 -             Request           5 -             Confirm           0 -               Renew           0 -              Rebind           0 -               Reply           0 -             Release           0 -             Decline           0 -         Reconfigure           0 - Information-Request           0 -       Relay-Forward           0 -         Relay-Reply           0 -           Malformed           0 + Message Type Vlan1000 + ------------------- ---------- + Unknown 0 + Solicit 0 + Advertise 0 + Request 5 + Confirm 0 + Renew 0 + Rebind 0 + Reply 0 + Release 0 + Decline 0 + Reconfigure 0 + Information-Request 0 + Relay-Forward 0 + Relay-Reply 0 + Malformed 0 ``` ### DHCP Relay clear commands @@ -4211,6 +4213,7 @@ Subsequent pages explain each of these commands in detail. neighbor Show neighbor related information portchannel Show PortChannel information status Show Interface status information + switchport Show Interface switchport information tpid Show Interface tpid information transceiver Show SFP Transceiver information ``` @@ -4653,6 +4656,50 @@ This command displays some more fields such as Lanes, Speed, MTU, Type, Asymmetr Ethernet180 105,106,107,108 100G 9100 hundredGigE46 down down N/A N/A ``` + +**show interface switchport status** + +This command displays switchport modes status of the interfaces + +- Usage: + ``` + show interfaces switchport status + ``` + +- Example (show interface switchport status of all interfaces): + ``` + admin@sonic:~$ show interfaces switchport status + Interface Mode + ----------- -------- + Ethernet0 access + Ethernet4 trunk + Ethernet8 routed + + ``` + +**show interface switchport config** + +This command displays switchport modes configuration of the interfaces + +- Usage: + ``` + show interfaces switchport config + ``` + +- Example (show interface switchport config of all interfaces): + ``` + admin@sonic:~$ show interfaces switchport config + Interface Mode Untagged Tagged + ----------- -------- -------- ------- + Ethernet0 access 2 + Ethernet4 trunk 3 4,5,6 + Ethernet8 routed + + ``` + + +For details please refer [Switchport Mode HLD](https://github.com/sonic-net/SONiC/pull/912/files#diff-03597c34684d527192f76a6e975792fcfc83f54e20dde63f159399232d148397) to know more about this command. + **show interfaces transceiver** This command is already explained [here](#Transceivers) @@ -9702,6 +9749,40 @@ This sub-section explains how to configure subinterfaces. Go Back To [Beginning of the document](#) or [Beginning of this section](#subinterfaces) +## Switchport Modes + +### Switchport Modes Config Commands + +This subsection explains how to configure switchport modes on Port/PortChannel. + +**config switchport** +mode +Usage: + ``` + config switchport mode + ``` + +- Example (Config switchport mode access on "Ethernet0): + ``` + admin@sonic:~$ sudo config switchport mode access Ethernet0 + ``` + +- Example (Config switchport mode trunk on "Ethernet4"): + ``` + admin@sonic:~$ sudo config switchport mode trunk Ethernet4 + ``` + +- Example (Config switchport mode routed on "Ethernet12"): + ``` + admin@sonic:~$ sudo config switchport mode routed Ethernet12 + ``` + + + +Go Back To [Beginning of the document](#) or [Beginning of this section](#switchport-modes) + + + ## Syslog ### Syslog Show Commands @@ -10387,6 +10468,29 @@ This command is used to add or delete the vlan. admin@sonic:~$ sudo config vlan add 100 ``` +**config vlan add/del -m** + +This command is used to add or delete multiple vlans via single command. + +- Usage: + ``` + config vlan (add | del) -m + ``` + +- Example01 (Create the VLAN "Vlan100, Vlan101, Vlan102, Vlan103" if these does not already exist) + + ``` + admin@sonic:~$ sudo config vlan add -m 100-103 + ``` + + +- Example02 (Create the VLAN "Vlan105, Vlan106, Vlan107, Vlan108" if these does not already exist): + + ``` + admin@sonic:~$ sudo config vlan add -m 105,106,107,108 + ``` + + **config vlan member add/del** This command is to add or delete a member port into the already created vlan. @@ -10408,6 +10512,48 @@ This command is to add or delete a member port into the already created vlan. This command will add Ethernet4 as member of the vlan 100. ``` + +**config vlan member add/del -m -e** + +This command is to add or delete a member port into multiple already created vlans. + +- Usage: + ``` + config vlan member add/del [-m] [-e] + ``` + +*NOTE: -m flag multiple Vlans in range or comma separted list can be added as a member port.* + + +*NOTE: -e is used as an except flag as explaied with examples below.* + + +- Example: + ``` + admin@sonic:~$ sudo config vlan member add -m 100-103 Ethernet0 + This command will add Ethernet0 as member of the vlan 100, vlan 101, vlan 102, vlan 103 + ``` + + ``` + admin@sonic:~$ sudo config vlan member add -m 100,101,102 Ethernet4 + This command will add Ethernet4 as member of the vlan 100, vlan 101, vlan 102 + ``` + + ``` + admin@sonic:~$ sudo config vlan member add -e -m 104,105 Ethernet8 + Suppose vlan 100, vlan 101, vlan 102, vlan 103, vlan 104, vlan 105 are exisiting vlans. This command will add Ethernet8 as member of vlan 100, vlan 101, vlan 102, vlan 103 + ``` + + ``` + admin@sonic:~$ sudo config vlan member add -e 100 Ethernet12 + Suppose vlan 100, vlan 101, vlan 102, vlan 103, vlan 104, vlan 105 are exisiting vlans. This command will add Ethernet12 as member of vlan 101, vlan 102, vlan 103, vlan 104, vlan 105 + ``` + + ``` + admin@sonic:~$ sudo config vlan member add all Ethernet20 + Suppose vlan 100, vlan 101, vlan 102, vlan 103, vlan 104, vlan 105 are exisiting vlans. This command will add Ethernet20 as member of vlan 100, vlan 101, vlan 102, vlan 103, vlan 104, vlan 105 + ``` + **config proxy_arp enabled/disabled** This command is used to enable or disable proxy ARP for a VLAN interface diff --git a/scripts/db_migrator.py b/scripts/db_migrator.py index cbb25e0a52..c2d0fd837a 100755 --- a/scripts/db_migrator.py +++ b/scripts/db_migrator.py @@ -455,6 +455,39 @@ def migrate_config_db_port_table_for_auto_neg(self): elif value['autoneg'] == '0': self.configDB.set(self.configDB.CONFIG_DB, '{}|{}'.format(table_name, key), 'autoneg', 'off') + + def migrate_config_db_switchport_mode(self): + port_table = self.configDB.get_table('PORT') + portchannel_table = self.configDB.get_table('PORTCHANNEL') + vlan_member_table = self.configDB.get_table('VLAN_MEMBER') + + vlan_member_keys= [] + for _,key in vlan_member_table: + vlan_member_keys.append(key) + + for p_key, p_value in port_table.items(): + if 'mode' in p_value: + self.configDB.set(self.configDB.CONFIG_DB, '{}|{}'.format("PORT", p_key), 'mode', p_value['mode']) + else: + if p_key in vlan_member_keys: + p_value["mode"] = "trunk" + self.configDB.set_entry("PORT", p_key, p_value) + else: + p_value["mode"] = "routed" + self.configDB.set_entry("PORT", p_key, p_value) + + for pc_key, pc_value in portchannel_table.items(): + if 'mode' in pc_value: + self.configDB.set(self.configDB.CONFIG_DB, '{}|{}'.format("PORTCHANNEL", pc_key), 'mode', pc_value['mode']) + else: + if pc_key in vlan_member_keys: + pc_value["mode"] = "trunk" + self.configDB.set_entry("PORTCHANNEL", pc_key, pc_value) + else: + pc_value["mode"] = "routed" + self.configDB.set_entry("PORTCHANNEL", pc_key, pc_value) + + def migrate_qos_db_fieldval_reference_remove(self, table_list, db, db_num, db_delimeter): for pair in table_list: table_name, fields_list = pair @@ -1018,7 +1051,7 @@ def version_4_0_1(self): self.migrate_feature_timer() self.set_version('version_4_0_2') return 'version_4_0_2' - + def version_4_0_2(self): """ Version 4_0_2. @@ -1045,9 +1078,19 @@ def version_4_0_3(self): def version_4_0_4(self): """ Version 4_0_4. - This is the latest version for master branch """ log.log_info('Handling version_4_0_4') + + self.migrate_config_db_switchport_mode() + self.set_version('version_4_0_4') + return 'version_4_0_5' + + def version_4_0_5(self): + """ + Version 4_0_5. + This is the latest version for master branch + """ + log.log_info('Handling version_4_0_5') return None def get_version(self): diff --git a/scripts/intfutil b/scripts/intfutil index 285863d7fb..5988b7f43d 100755 --- a/scripts/intfutil +++ b/scripts/intfutil @@ -833,4 +833,4 @@ def main(): sys.exit(0) if __name__ == "__main__": - main() + main() \ No newline at end of file diff --git a/show/interfaces/__init__.py b/show/interfaces/__init__.py index 5aeaef6bf5..8757d23aec 100644 --- a/show/interfaces/__init__.py +++ b/show/interfaces/__init__.py @@ -764,3 +764,70 @@ def link_training_status(interfacename, namespace, display, verbose): cmd += ['-n', str(namespace)] clicommon.run_command(cmd, display_cmd=verbose) + + +# +# switchport group (show interfaces switchport ...) +# +@interfaces.group(name='switchport', cls=clicommon.AliasedGroup) +def switchport(): + """Show interface switchport information""" + pass + + +@switchport.command(name="config") +@clicommon.pass_db +def switchport_mode_config(db): + """Show interface switchport config information""" + + port_data = list(db.cfgdb.get_table('PORT').keys()) + portchannel_data = list(db.cfgdb.get_table('PORTCHANNEL').keys()) + + portchannel_member_table = db.cfgdb.get_table('PORTCHANNEL_MEMBER') + + for interface in port_data: + if clicommon.interface_is_in_portchannel(portchannel_member_table,interface): + port_data.remove(interface) + + + keys = port_data + portchannel_data + + def tablelize(keys): + table = [] + + for key in natsorted(keys): + r = [clicommon.get_interface_name_for_display(db, key), clicommon.get_interface_switchport_mode(db,key), clicommon.get_interface_untagged_vlan_members(db,key), clicommon.get_interface_tagged_vlan_members(db,key)] + table.append(r) + + return table + + header = ['Interface', 'Mode', 'Untagged', 'Tagged'] + click.echo(tabulate(tablelize(keys), header, tablefmt="simple", stralign='left')) + +@switchport.command(name="status") +@clicommon.pass_db +def switchport_mode_status(db): + """Show interface switchport status information""" + + port_data = list(db.cfgdb.get_table('PORT').keys()) + portchannel_data = list(db.cfgdb.get_table('PORTCHANNEL').keys()) + + portchannel_member_table = db.cfgdb.get_table('PORTCHANNEL_MEMBER') + + for interface in port_data: + if clicommon.interface_is_in_portchannel(portchannel_member_table,interface): + port_data.remove(interface) + + keys = port_data + portchannel_data + + def tablelize(keys): + table = [] + + for key in natsorted(keys): + r = [clicommon.get_interface_name_for_display(db, key), clicommon.get_interface_switchport_mode(db,key)] + table.append(r) + + return table + + header = ['Interface', 'Mode'] + click.echo(tabulate(tablelize(keys), header,tablefmt="simple", stralign='left')) \ No newline at end of file diff --git a/tests/db_migrator_input/config_db/port-an-expected.json b/tests/db_migrator_input/config_db/port-an-expected.json index 1ef2cf4916..19fb6a80dd 100644 --- a/tests/db_migrator_input/config_db/port-an-expected.json +++ b/tests/db_migrator_input/config_db/port-an-expected.json @@ -3,6 +3,7 @@ "index": "0", "lanes": "0,1", "description": "etp1a", + "mode": "routed", "mtu": "9100", "alias": "etp1a", "pfc_asym": "off", @@ -16,6 +17,7 @@ "lanes": "2,3", "description": "Servers0:eth0", "admin_status": "up", + "mode": "routed", "mtu": "9100", "alias": "etp1b", "pfc_asym": "off", @@ -28,6 +30,7 @@ "lanes": "4,5", "description": "Servers1:eth0", "admin_status": "up", + "mode": "routed", "mtu": "9100", "alias": "etp2a", "pfc_asym": "off", diff --git a/tests/db_migrator_input/config_db/portchannel-expected.json b/tests/db_migrator_input/config_db/portchannel-expected.json index 2644e5f4e9..da97ad3f3d 100644 --- a/tests/db_migrator_input/config_db/portchannel-expected.json +++ b/tests/db_migrator_input/config_db/portchannel-expected.json @@ -3,6 +3,7 @@ "admin_status": "up", "members@": "Ethernet0,Ethernet4", "min_links": "2", + "mode": "routed", "mtu": "9100", "lacp_key": "auto" }, @@ -10,6 +11,7 @@ "admin_status": "up", "members@": "Ethernet8,Ethernet12", "min_links": "2", + "mode": "routed", "mtu": "9100", "lacp_key": "auto" }, @@ -17,6 +19,7 @@ "admin_status": "up", "members@": "Ethernet16", "min_links": "1", + "mode": "routed", "mtu": "9100", "lacp_key": "auto" }, @@ -24,11 +27,13 @@ "admin_status": "up", "members@": "Ethernet20,Ethernet24", "min_links": "2", + "mode": "routed", "mtu": "9100", "lacp_key": "auto" }, "PORTCHANNEL|PortChannel9999": { "admin_status": "up", + "mode": "routed", "mtu": "9100", "lacp_key": "auto" }, diff --git a/tests/db_migrator_input/config_db/switchport-expected.json b/tests/db_migrator_input/config_db/switchport-expected.json new file mode 100644 index 0000000000..0f49b5edf3 --- /dev/null +++ b/tests/db_migrator_input/config_db/switchport-expected.json @@ -0,0 +1,144 @@ +{ + "PORT|Ethernet0": { + "admin_status": "up", + "alias": "fortyGigE0/0", + "index": "0", + "lanes": "25,26,27,28", + "mode": "trunk", + "mtu": "9100", + "speed": "40000" + }, + "PORT|Ethernet4": { + "admin_status": "up", + "alias": "fortyGigE0/4", + "index": "1", + "lanes": "29,30,31,32", + "mode": "routed", + "mtu": "9100", + "speed": "40000" + }, + "PORT|Ethernet8": { + "admin_status": "up", + "alias": "fortyGigE0/8", + "index": "2", + "lanes": "33,34,35,36", + "mode": "trunk", + "mtu": "9100", + "speed": "40000" + }, + "PORT|Ethernet12": { + "admin_status": "up", + "alias": "fortyGigE0/12", + "index": "3", + "lanes": "37,38,39,40", + "mode": "access", + "mtu": "9100", + "speed": "40000" + }, + "PORT|Ethernet16": { + "admin_status": "up", + "alias": "fortyGigE0/16", + "index": "4", + "lanes": "45,46,47,48", + "mode": "routed", + "mtu": "9100", + "speed": "40000" + }, + "PORT|Ethernet20": { + "admin_status": "up", + "alias": "fortyGigE0/20", + "index": "5", + "lanes": "41,42,43,44", + "mode": "trunk", + "mtu": "9100", + "speed": "40000" + }, + + "VLAN|Vlan2": { + "vlanid": "2" + }, + "VLAN|Vlan3": { + "vlanid": "3" + }, + "VLAN|Vlan4": { + "vlanid": "4" + }, + "VLAN|Vlan5": { + "vlanid": "5" + }, + "VLAN|Vlan6": { + "vlanid": "6" + }, + "VLAN|Vlan7": { + "vlanid": "7" + }, + + + "VLAN_MEMBER|Vlan2|Ethernet0": { + "tagging_mode": "tagged" + }, + "VLAN_MEMBER|Vlan3|Ethernet8": { + "tagging_mode": "tagged" + }, + "VLAN_MEMBER|Vlan4|Ethernet0": { + "tagging_mode": "tagged" + }, + "VLAN_MEMBER|Vlan6|Ethernet0": { + "tagging_mode": "tagged" + }, + "VLAN_MEMBER|Vlan6|Ethernet8": { + "tagging_mode": "untagged" + }, + "VLAN_MEMBER|Vlan7|Ethernet8": { + "tagging_mode": "tagged" + }, + "VLAN_MEMBER|Vlan5|Ethernet8": { + "tagging_mode": "untagged" + }, + "VLAN_MEMBER|Vlan3|PortChannel0003": { + "tagging_mode": "untagged" + }, + "VLAN_MEMBER|Vlan8|PortChannel0002": { + "tagging_mode": "tagged" + }, + "VLAN_MEMBER|Vlan9|PortChannel0002": { + "tagging_mode": "tagged" + }, + + "PORTCHANNEL|PortChannel0001": { + "admin_status": "up", + "fast_rate": "false", + "lacp_key": "auto", + "min_links": "1", + "mode": "access", + "mtu": "9100" + }, + "PORTCHANNEL|PortChannel0002": { + "admin_status": "up", + "fast_rate": "false", + "lacp_key": "auto", + "min_links": "1", + "mode": "trunk", + "mtu": "9100" + }, + "PORTCHANNEL|PortChannel0003": { + "admin_status": "up", + "fast_rate": "false", + "lacp_key": "auto", + "min_links": "1", + "mode": "trunk", + "mtu": "9100" + }, + "PORTCHANNEL|PortChannel0004": { + "admin_status": "up", + "fast_rate": "false", + "lacp_key": "auto", + "min_links": "1", + "mode": "routed", + "mtu": "9100" + }, + + "VERSIONS|DATABASE": { + "VERSION": "version_4_0_1" + } +} \ No newline at end of file diff --git a/tests/db_migrator_input/config_db/switchport-input.json b/tests/db_migrator_input/config_db/switchport-input.json new file mode 100644 index 0000000000..9613f29e75 --- /dev/null +++ b/tests/db_migrator_input/config_db/switchport-input.json @@ -0,0 +1,138 @@ +{ + "PORT|Ethernet0": { + "admin_status": "up", + "alias": "fortyGigE0/0", + "index": "0", + "lanes": "25,26,27,28", + "mtu": "9100", + "speed": "40000" + }, + "PORT|Ethernet4": { + "admin_status": "up", + "alias": "fortyGigE0/4", + "index": "1", + "lanes": "29,30,31,32", + "mode": "routed", + "mtu": "9100", + "speed": "40000" + }, + "PORT|Ethernet8": { + "admin_status": "up", + "alias": "fortyGigE0/8", + "index": "2", + "lanes": "33,34,35,36", + "mtu": "9100", + "speed": "40000" + }, + "PORT|Ethernet12": { + "admin_status": "up", + "alias": "fortyGigE0/12", + "index": "3", + "lanes": "37,38,39,40", + "mode": "access", + "mtu": "9100", + "speed": "40000" + }, + "PORT|Ethernet16": { + "admin_status": "up", + "alias": "fortyGigE0/16", + "index": "4", + "lanes": "45,46,47,48", + "mtu": "9100", + "speed": "40000" + }, + "PORT|Ethernet20": { + "admin_status": "up", + "alias": "fortyGigE0/20", + "index": "5", + "lanes": "41,42,43,44", + "mode": "trunk", + "mtu": "9100", + "speed": "40000" + }, + "VLAN|Vlan2": { + "vlanid": "2" + }, + "VLAN|Vlan3": { + "vlanid": "3" + }, + "VLAN|Vlan4": { + "vlanid": "4" + }, + "VLAN|Vlan5": { + "vlanid": "5" + }, + "VLAN|Vlan6": { + "vlanid": "6" + }, + "VLAN|Vlan7": { + "vlanid": "7" + }, + + "VLAN_MEMBER|Vlan2|Ethernet0": { + "tagging_mode": "tagged" + }, + "VLAN_MEMBER|Vlan3|Ethernet8": { + "tagging_mode": "tagged" + }, + "VLAN_MEMBER|Vlan4|Ethernet0": { + "tagging_mode": "tagged" + }, + "VLAN_MEMBER|Vlan6|Ethernet0": { + "tagging_mode": "tagged" + }, + "VLAN_MEMBER|Vlan6|Ethernet8": { + "tagging_mode": "untagged" + }, + "VLAN_MEMBER|Vlan7|Ethernet8": { + "tagging_mode": "tagged" + }, + "VLAN_MEMBER|Vlan5|Ethernet8": { + "tagging_mode": "untagged" + }, + "VLAN_MEMBER|Vlan3|PortChannel0003": { + "tagging_mode": "untagged" + }, + "VLAN_MEMBER|Vlan8|PortChannel0002": { + "tagging_mode": "tagged" + }, + "VLAN_MEMBER|Vlan9|PortChannel0002": { + "tagging_mode": "tagged" + }, + + + "PORTCHANNEL|PortChannel0001": { + "admin_status": "up", + "fast_rate": "false", + "lacp_key": "auto", + "min_links": "1", + "mode": "access", + "mtu": "9100" + }, + "PORTCHANNEL|PortChannel0002": { + "admin_status": "up", + "fast_rate": "false", + "lacp_key": "auto", + "min_links": "1", + "mode": "trunk", + "mtu": "9100" + }, + "PORTCHANNEL|PortChannel0003": { + "admin_status": "up", + "fast_rate": "false", + "lacp_key": "auto", + "min_links": "1", + "mtu": "9100" + }, + "PORTCHANNEL|PortChannel0004": { + "admin_status": "up", + "fast_rate": "false", + "lacp_key": "auto", + "min_links": "1", + "mtu": "9100" + }, + + "VERSIONS|DATABASE": { + "VERSION": "version_4_0_0" + } +} \ No newline at end of file diff --git a/tests/db_migrator_test.py b/tests/db_migrator_test.py index ecd187aa88..7b4f842463 100644 --- a/tests/db_migrator_test.py +++ b/tests/db_migrator_test.py @@ -246,6 +246,30 @@ def test_port_autoneg_migrator(self): assert dbmgtr.configDB.get_table('PORT') == expected_db.cfgdb.get_table('PORT') assert dbmgtr.configDB.get_table('VERSIONS') == expected_db.cfgdb.get_table('VERSIONS') +class TestSwitchPortMigrator(object): + @classmethod + def setup_class(cls): + os.environ['UTILITIES_UNIT_TESTING'] = "2" + + @classmethod + def teardown_class(cls): + os.environ['UTILITIES_UNIT_TESTING'] = "0" + dbconnector.dedicated_dbs['CONFIG_DB'] = None + + def test_switchport_mode_migrator(self): + dbconnector.dedicated_dbs['CONFIG_DB'] = os.path.join(mock_db_path, 'config_db', 'switchport-input') + import db_migrator + dbmgtr = db_migrator.DBMigrator(None) + dbmgtr.migrate() + + dbconnector.dedicated_dbs['CONFIG_DB'] = os.path.join(mock_db_path, 'config_db', 'switchport-expected') + expected_db = Db() + advance_version_for_expected_database(dbmgtr.configDB, expected_db.cfgdb, 'version_4_0_1') + + assert dbmgtr.configDB.get_table('PORT') == expected_db.cfgdb.get_table('PORT') + assert dbmgtr.configDB.get_table('PORTCHANNEL') == expected_db.cfgdb.get_table('PORTCHANNEL') + assert dbmgtr.configDB.get_table('VERSIONS') == expected_db.cfgdb.get_table('VERSIONS') + class TestInitConfigMigrator(object): @classmethod def setup_class(cls): diff --git a/tests/interfaces_test.py b/tests/interfaces_test.py index c3246ba026..84940f0bca 100644 --- a/tests/interfaces_test.py +++ b/tests/interfaces_test.py @@ -144,6 +144,85 @@ 1001 PortChannel1001 N/A """ +show_interfaces_switchport_status_output="""\ +Interface Mode +--------------- ------ +Ethernet0 routed +Ethernet4 trunk +Ethernet8 routed +Ethernet12 routed +Ethernet16 trunk +Ethernet20 routed +Ethernet24 trunk +Ethernet28 trunk +Ethernet36 routed +Ethernet40 routed +Ethernet44 routed +Ethernet48 routed +Ethernet52 access +Ethernet56 access +Ethernet60 routed +Ethernet64 routed +Ethernet68 routed +Ethernet72 routed +Ethernet76 routed +Ethernet80 routed +Ethernet84 routed +Ethernet88 routed +Ethernet92 routed +Ethernet96 routed +Ethernet100 routed +Ethernet104 routed +Ethernet108 routed +Ethernet116 routed +Ethernet124 routed +PortChannel0001 routed +PortChannel0002 routed +PortChannel0003 routed +PortChannel0004 routed +PortChannel1001 trunk +""" + +show_interfaces_switchport_config_output = """\ +Interface Mode Untagged Tagged +--------------- ------ ---------- -------- +Ethernet0 routed +Ethernet4 trunk 1000 +Ethernet8 routed 1000 +Ethernet12 routed 1000 +Ethernet16 trunk 1000 +Ethernet20 routed +Ethernet24 trunk 2000 +Ethernet28 trunk 2000 +Ethernet36 routed +Ethernet40 routed +Ethernet44 routed +Ethernet48 routed +Ethernet52 access +Ethernet56 access +Ethernet60 routed +Ethernet64 routed +Ethernet68 routed +Ethernet72 routed +Ethernet76 routed +Ethernet80 routed +Ethernet84 routed +Ethernet88 routed +Ethernet92 routed +Ethernet96 routed +Ethernet100 routed +Ethernet104 routed +Ethernet108 routed +Ethernet116 routed +Ethernet124 routed +PortChannel0001 routed +PortChannel0002 routed +PortChannel0003 routed +PortChannel0004 routed +PortChannel1001 trunk 4000 +""" + + class TestInterfaces(object): @classmethod def setup_class(cls): @@ -337,6 +416,24 @@ def test_parse_interface_in_filter(self): assert len(intf_list) == 3 assert intf_list == ["Ethernet-BP10", "Ethernet-BP11", "Ethernet-BP12"] + def test_show_interfaces_switchport_status(self): + runner = CliRunner() + result = runner.invoke(show.cli.commands["interfaces"].commands["switchport"].commands["status"]) + print(result.exit_code) + print(result.output) + + assert result.exit_code == 0 + assert result.output == show_interfaces_switchport_status_output + + def test_show_interfaces_switchport_config(self): + runner = CliRunner() + result = runner.invoke(show.cli.commands["interfaces"].commands["switchport"].commands["config"]) + print(result.exit_code) + print(result.output) + + assert result.exit_code == 0 + assert result.output == show_interfaces_switchport_config_output + @classmethod def teardown_class(cls): print("TEARDOWN") diff --git a/tests/intfutil_test.py b/tests/intfutil_test.py index ef37199bfe..bb83dd31df 100644 --- a/tests/intfutil_test.py +++ b/tests/intfutil_test.py @@ -342,4 +342,4 @@ def test_show_interfaces_link_training_status(self): def teardown_class(cls): print("TEARDOWN") os.environ["PATH"] = os.pathsep.join(os.environ["PATH"].split(os.pathsep)[:-1]) - os.environ["UTILITIES_UNIT_TESTING"] = "0" + os.environ["UTILITIES_UNIT_TESTING"] = "0" \ No newline at end of file diff --git a/tests/ipv6_link_local_test.py b/tests/ipv6_link_local_test.py index 50b691be6b..bb9e53ac1a 100644 --- a/tests/ipv6_link_local_test.py +++ b/tests/ipv6_link_local_test.py @@ -232,7 +232,7 @@ def test_vlan_member_add_on_link_local_interface(self): result = runner.invoke(config.config.commands["vlan"].commands["member"].commands["add"], ["4000", "Ethernet40"], obj=obj) print(result.output) assert result.exit_code != 0 - assert 'Error: Ethernet40 is a router interface!' in result.output + assert 'Error: Ethernet40 is in routed mode!\nUse switchport mode command to change port mode' in result.output @classmethod def teardown_class(cls): diff --git a/tests/mock_tables/asic0/config_db.json b/tests/mock_tables/asic0/config_db.json index de20194a64..023e70299c 100644 --- a/tests/mock_tables/asic0/config_db.json +++ b/tests/mock_tables/asic0/config_db.json @@ -75,6 +75,7 @@ "admin_status": "up", "members@": "Ethernet0,Ethernet4", "min_links": "2", + "mode": "trunk", "mtu": "9100" }, "PORTCHANNEL|PortChannel4001": { diff --git a/tests/mock_tables/config_db.json b/tests/mock_tables/config_db.json index 8861d43a75..89879f916b 100644 --- a/tests/mock_tables/config_db.json +++ b/tests/mock_tables/config_db.json @@ -29,6 +29,7 @@ "lanes": "25,26,27,28", "mtu": "9100", "tpid": "0x8100", + "mode": "routed", "pfc_asym": "off", "speed": "40000" }, @@ -40,6 +41,7 @@ "lanes": "29,30,31,32", "mtu": "9100", "tpid": "0x8100", + "mode": "trunk", "pfc_asym": "off", "speed": "40000" }, @@ -51,6 +53,7 @@ "lanes": "33,34,35,36", "mtu": "9100", "tpid": "0x8100", + "mode": "routed", "pfc_asym": "off", "speed": "40000" }, @@ -62,6 +65,7 @@ "lanes": "37,38,39,40", "mtu": "9100", "tpid": "0x8100", + "mode": "routed", "pfc_asym": "off", "speed": "40000" }, @@ -73,6 +77,7 @@ "lanes": "16", "mtu": "9100", "tpid": "0x8100", + "mode": "trunk", "pfc_asym": "off", "speed": "100" }, @@ -84,6 +89,7 @@ "lanes": "41,42,43,44", "mtu": "9100", "tpid": "0x9200", + "mode": "routed", "pfc_asym": "off", "speed": "40000" }, @@ -95,6 +101,7 @@ "lanes": "1,2,3,4", "mtu": "9100", "tpid": "0x8100", + "mode": "trunk", "pfc_asym": "off", "speed": "1000" }, @@ -106,6 +113,7 @@ "lanes": "5,6,7,8", "mtu": "9100", "tpid": "0x8100", + "mode": "trunk", "pfc_asym": "off", "speed": "1000" }, @@ -117,6 +125,7 @@ "lanes": "13,14,15,16", "mtu": "9100", "tpid": "0x8100", + "mode": "routed", "pfc_asym": "off", "speed": "40000" }, @@ -128,6 +137,7 @@ "lanes": "9,10,11,12", "mtu": "9100", "tpid": "0x8100", + "mode": "routed", "pfc_asym": "off", "speed": "10" }, @@ -139,6 +149,7 @@ "lanes": "17,18,19,20", "mtu": "9100", "tpid": "0x8100", + "mode": "routed", "pfc_asym": "off", "speed": "40000" }, @@ -150,6 +161,7 @@ "lanes": "21,22,23,24", "mtu": "9100", "tpid": "0x8100", + "mode": "routed", "pfc_asym": "off", "speed": "40000" }, @@ -161,6 +173,7 @@ "lanes": "53,54,55,56", "mtu": "9100", "tpid": "0x8100", + "mode": "routed", "pfc_asym": "off", "speed": "40000" }, @@ -172,6 +185,7 @@ "lanes": "49,50,51,52", "mtu": "9100", "tpid": "0x8100", + "mode": "access", "pfc_asym": "off", "speed": "40000" }, @@ -183,6 +197,7 @@ "lanes": "57,58,59,60", "mtu": "9100", "tpid": "0x8100", + "mode": "access", "pfc_asym": "off", "speed": "40000" }, @@ -194,6 +209,7 @@ "lanes": "61,62,63,64", "mtu": "9100", "tpid": "0x8100", + "mode": "routed", "pfc_asym": "off", "speed": "40000" }, @@ -216,6 +232,7 @@ "lanes": "65,66,67,68", "mtu": "9100", "tpid": "0x8100", + "mode": "routed", "pfc_asym": "off", "speed": "40000" }, @@ -227,6 +244,7 @@ "lanes": "73,74,75,76", "mtu": "9100", "tpid": "0x8100", + "mode": "routed", "pfc_asym": "off", "speed": "40000" }, @@ -238,6 +256,7 @@ "lanes": "77,78,79,80", "mtu": "9100", "tpid": "0x8100", + "mode": "routed", "pfc_asym": "off", "speed": "40000" }, @@ -249,6 +268,7 @@ "lanes": "109,110,111,112", "mtu": "9100", "tpid": "0x8100", + "mode": "routed", "pfc_asym": "off", "speed": "40000" }, @@ -260,6 +280,7 @@ "lanes": "105,106,107,108", "mtu": "9100", "tpid": "0x8100", + "mode": "routed", "pfc_asym": "off", "speed": "40000" }, @@ -271,6 +292,7 @@ "lanes": "113,114,115,116", "mtu": "9100", "tpid": "0x8100", + "mode": "routed", "pfc_asym": "off", "speed": "40000" }, @@ -282,6 +304,7 @@ "lanes": "117,118,119,120", "mtu": "9100", "tpid": "0x8100", + "mode": "routed", "pfc_asym": "off", "speed": "40000" }, @@ -293,6 +316,7 @@ "lanes": "125,126,127,128", "mtu": "9100", "tpid": "0x8100", + "mode": "routed", "pfc_asym": "off", "speed": "40000" }, @@ -303,6 +327,7 @@ "lanes": "121,122,123,124", "mtu": "9100", "tpid": "0x8100", + "mode": "routed", "pfc_asym": "off", "speed": "40000" }, @@ -313,6 +338,7 @@ "lanes": "81,82,83,84", "mtu": "9100", "tpid": "0x8100", + "mode": "routed", "pfc_asym": "off", "speed": "40000" }, @@ -323,6 +349,7 @@ "lanes": "85,86,87,88", "mtu": "9100", "tpid": "0x8100", + "mode": "routed", "pfc_asym": "off", "speed": "40000" }, @@ -334,6 +361,7 @@ "lanes": "93,94,95,96", "mtu": "9100", "tpid": "0x8100", + "mode": "routed", "pfc_asym": "off", "speed": "40000" }, @@ -345,6 +373,7 @@ "lanes": "89,90,91,92", "mtu": "9100", "tpid": "0x8100", + "mode": "routed", "pfc_asym": "off", "speed": "40000" }, @@ -356,6 +385,7 @@ "lanes": "101,102,103,104", "mtu": "9100", "tpid": "0x8100", + "mode": "routed", "pfc_asym": "off", "speed": "40000" }, @@ -367,6 +397,7 @@ "lanes": "97,98,99,100", "mtu": "9100", "tpid": "0x8100", + "mode": "routed", "pfc_asym": "off", "speed": "40000" }, @@ -668,6 +699,7 @@ "admin_status": "up", "members@": "Ethernet32", "min_links": "1", + "mode":"trunk", "tpid": "0x8100", "mtu": "9100" }, diff --git a/tests/vlan_test.py b/tests/vlan_test.py index 13364f76e6..e00d3c40a8 100644 --- a/tests/vlan_test.py +++ b/tests/vlan_test.py @@ -134,6 +134,124 @@ +-----------+-----------------+-----------------+----------------+-------------+ """ +test_config_add_del_multiple_vlan_and_vlan_member_output="""\ ++-----------+-----------------+-----------------+----------------+-------------+ +| VLAN ID | IP Address | Ports | Port Tagging | Proxy ARP | ++===========+=================+=================+================+=============+ +| 1000 | 192.168.0.1/21 | Ethernet4 | untagged | disabled | +| | fc02:1000::1/64 | Ethernet8 | untagged | | +| | | Ethernet12 | untagged | | +| | | Ethernet16 | untagged | | ++-----------+-----------------+-----------------+----------------+-------------+ +| 1001 | | Ethernet20 | tagged | disabled | ++-----------+-----------------+-----------------+----------------+-------------+ +| 1002 | | Ethernet20 | tagged | disabled | ++-----------+-----------------+-----------------+----------------+-------------+ +| 1003 | | Ethernet20 | tagged | disabled | ++-----------+-----------------+-----------------+----------------+-------------+ +| 2000 | 192.168.0.10/21 | Ethernet24 | untagged | enabled | +| | fc02:1011::1/64 | Ethernet28 | untagged | | ++-----------+-----------------+-----------------+----------------+-------------+ +| 3000 | | | | disabled | ++-----------+-----------------+-----------------+----------------+-------------+ +| 4000 | | PortChannel1001 | tagged | disabled | ++-----------+-----------------+-----------------+----------------+-------------+ +""" + +test_config_add_del_add_vlans_and_add_all_vlan_member_output="""\ ++-----------+-----------------+-----------------+----------------+-------------+ +| VLAN ID | IP Address | Ports | Port Tagging | Proxy ARP | ++===========+=================+=================+================+=============+ +| 1000 | 192.168.0.1/21 | Ethernet4 | untagged | disabled | +| | fc02:1000::1/64 | Ethernet8 | untagged | | +| | | Ethernet12 | untagged | | +| | | Ethernet16 | untagged | | +| | | Ethernet20 | tagged | | ++-----------+-----------------+-----------------+----------------+-------------+ +| 1001 | | Ethernet20 | tagged | disabled | ++-----------+-----------------+-----------------+----------------+-------------+ +| 1002 | | Ethernet20 | tagged | disabled | ++-----------+-----------------+-----------------+----------------+-------------+ +| 1003 | | Ethernet20 | tagged | disabled | ++-----------+-----------------+-----------------+----------------+-------------+ +| 2000 | 192.168.0.10/21 | Ethernet20 | tagged | enabled | +| | fc02:1011::1/64 | Ethernet24 | untagged | | +| | | Ethernet28 | untagged | | ++-----------+-----------------+-----------------+----------------+-------------+ +| 3000 | | Ethernet20 | tagged | disabled | ++-----------+-----------------+-----------------+----------------+-------------+ +| 4000 | | Ethernet20 | tagged | disabled | +| | | PortChannel1001 | tagged | | ++-----------+-----------------+-----------------+----------------+-------------+ +""" + +test_config_add_del_add_vlans_and_add_vlans_member_except_vlan_output = """\ ++-----------+-----------------+-----------------+----------------+-------------+ +| VLAN ID | IP Address | Ports | Port Tagging | Proxy ARP | ++===========+=================+=================+================+=============+ +| 1000 | 192.168.0.1/21 | Ethernet4 | untagged | disabled | +| | fc02:1000::1/64 | Ethernet8 | untagged | | +| | | Ethernet12 | untagged | | +| | | Ethernet16 | untagged | | ++-----------+-----------------+-----------------+----------------+-------------+ +| 1001 | | Ethernet20 | tagged | disabled | ++-----------+-----------------+-----------------+----------------+-------------+ +| 1002 | | Ethernet20 | tagged | disabled | ++-----------+-----------------+-----------------+----------------+-------------+ +| 2000 | 192.168.0.10/21 | Ethernet20 | tagged | enabled | +| | fc02:1011::1/64 | Ethernet24 | untagged | | +| | | Ethernet28 | untagged | | ++-----------+-----------------+-----------------+----------------+-------------+ +| 3000 | | Ethernet20 | tagged | disabled | ++-----------+-----------------+-----------------+----------------+-------------+ +| 4000 | | PortChannel1001 | tagged | disabled | ++-----------+-----------------+-----------------+----------------+-------------+ +""" + +test_config_add_del_add_vlans_and_add_vlans_member_except_vlan__after_del_member_output = """\ ++-----------+-----------------+-----------------+----------------+-------------+ +| VLAN ID | IP Address | Ports | Port Tagging | Proxy ARP | ++===========+=================+=================+================+=============+ +| 1000 | 192.168.0.1/21 | Ethernet4 | untagged | disabled | +| | fc02:1000::1/64 | Ethernet8 | untagged | | +| | | Ethernet12 | untagged | | +| | | Ethernet16 | untagged | | ++-----------+-----------------+-----------------+----------------+-------------+ +| 1001 | | Ethernet20 | tagged | disabled | ++-----------+-----------------+-----------------+----------------+-------------+ +| 1002 | | Ethernet20 | tagged | disabled | ++-----------+-----------------+-----------------+----------------+-------------+ +| 2000 | 192.168.0.10/21 | Ethernet24 | untagged | enabled | +| | fc02:1011::1/64 | Ethernet28 | untagged | | ++-----------+-----------------+-----------------+----------------+-------------+ +| 3000 | | | | disabled | ++-----------+-----------------+-----------------+----------------+-------------+ +| 4000 | | PortChannel1001 | tagged | disabled | ++-----------+-----------------+-----------------+----------------+-------------+ +""" + +test_config_add_del_vlan_and_vlan_member_with_switchport_modes_output = """\ ++-----------+-----------------+-----------------+----------------+-------------+ +| VLAN ID | IP Address | Ports | Port Tagging | Proxy ARP | ++===========+=================+=================+================+=============+ +| 1000 | 192.168.0.1/21 | Ethernet4 | untagged | disabled | +| | fc02:1000::1/64 | Ethernet8 | untagged | | +| | | Ethernet12 | untagged | | +| | | Ethernet16 | untagged | | +| | | Ethernet20 | tagged | | ++-----------+-----------------+-----------------+----------------+-------------+ +| 1001 | | Ethernet20 | untagged | disabled | ++-----------+-----------------+-----------------+----------------+-------------+ +| 2000 | 192.168.0.10/21 | Ethernet24 | untagged | enabled | +| | fc02:1011::1/64 | Ethernet28 | untagged | | ++-----------+-----------------+-----------------+----------------+-------------+ +| 3000 | | | | disabled | ++-----------+-----------------+-----------------+----------------+-------------+ +| 4000 | | PortChannel1001 | tagged | disabled | ++-----------+-----------------+-----------------+----------------+-------------+ +""" + + config_add_del_vlan_and_vlan_member_in_alias_mode_output="""\ +-----------+-----------------+-----------------+----------------+-------------+ | VLAN ID | IP Address | Ports | Port Tagging | Proxy ARP | @@ -154,6 +272,27 @@ +-----------+-----------------+-----------------+----------------+-------------+ """ +test_config_add_del_vlan_and_vlan_member_with_switchport_modes_and_change_mode_types_output = """\ ++-----------+-----------------+-----------------+----------------+-------------+ +| VLAN ID | IP Address | Ports | Port Tagging | Proxy ARP | ++===========+=================+=================+================+=============+ +| 1000 | 192.168.0.1/21 | Ethernet4 | untagged | disabled | +| | fc02:1000::1/64 | Ethernet8 | untagged | | +| | | Ethernet12 | untagged | | +| | | Ethernet16 | untagged | | ++-----------+-----------------+-----------------+----------------+-------------+ +| 1001 | | | | disabled | ++-----------+-----------------+-----------------+----------------+-------------+ +| 2000 | 192.168.0.10/21 | Ethernet24 | untagged | enabled | +| | fc02:1011::1/64 | Ethernet28 | untagged | | ++-----------+-----------------+-----------------+----------------+-------------+ +| 3000 | | | | disabled | ++-----------+-----------------+-----------------+----------------+-------------+ +| 4000 | | PortChannel1001 | tagged | disabled | ++-----------+-----------------+-----------------+----------------+-------------+ +""" + + class TestVlan(object): _old_run_bgp_command = None @@ -236,7 +375,7 @@ def test_config_vlan_add_vlan_with_invalid_vlanid(self): print(result.exit_code) print(result.output) assert result.exit_code != 0 - assert "Error: Invalid VLAN ID 4096 (1-4094)" in result.output + assert "Error: Invalid VLAN ID 4096 (2-4094)" in result.output def test_config_vlan_add_vlan_with_exist_vlanid(self): runner = CliRunner() @@ -252,7 +391,7 @@ def test_config_vlan_del_vlan_with_invalid_vlanid(self): print(result.exit_code) print(result.output) assert result.exit_code != 0 - assert "Error: Invalid VLAN ID 4096 (1-4094)" in result.output + assert "Error: Invalid VLAN ID 4096 (2-4094)" in result.output def test_config_vlan_del_vlan_with_nonexist_vlanid(self): runner = CliRunner() @@ -262,13 +401,79 @@ def test_config_vlan_del_vlan_with_nonexist_vlanid(self): assert result.exit_code != 0 assert "Error: Vlan1001 does not exist" in result.output + def test_config_vlan_add_vlan_with_multiple_vlanids(self, mock_restart_dhcp_relay_service): + runner = CliRunner() + result = runner.invoke(config.config.commands["vlan"].commands["add"], ["10,20,30,40", "--multiple"]) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + + def test_config_vlan_add_vlan_with_multiple_vlanids_with_range(self, mock_restart_dhcp_relay_service): + runner = CliRunner() + result = runner.invoke(config.config.commands["vlan"].commands["add"], ["10-20", "--multiple"]) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + + def test_config_vlan_add_vlan_with_multiple_vlanids_with_range_and_multiple_ids(self, mock_restart_dhcp_relay_service): + runner = CliRunner() + result = runner.invoke(config.config.commands["vlan"].commands["add"], ["10-15,20,25,30", "--multiple"]) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + + def test_config_vlan_add_vlan_with_wrong_range(self): + runner = CliRunner() + result = runner.invoke(config.config.commands["vlan"].commands["add"], ["15-10", "--multiple"]) + print(result.exit_code) + print(result.output) + assert result.exit_code != 0 + assert "15 is greater than 10. List cannot be generated" in result.output + + def test_config_vlan_add_vlan_range_with_default_vlan(self): + runner = CliRunner() + result = runner.invoke(config.config.commands["vlan"].commands["add"], ["1-10", "--multiple"]) + print(result.exit_code) + print(result.output) + assert result.exit_code != 0 + assert "Vlan1 is default vlan" in result.output + + def test_config_vlan_add_vlan_is_digit_fail(self): + runner = CliRunner() + vid = "test_fail_case" + result = runner.invoke(config.config.commands["vlan"].commands["add"], [vid]) + print(result.exit_code) + print(result.output) + assert result.exit_code != 0 + assert "{} is not integer".format(vid) in result.output + + def test_config_vlan_add_vlan_is_default_vlan(self): + runner = CliRunner() + default_vid = "1" + vlan = "Vlan{}".format(default_vid) + result = runner.invoke(config.config.commands["vlan"].commands["add"], [default_vid]) + print(result.exit_code) + print(result.output) + assert result.exit_code != 0 + assert "{} is default VLAN.".format(vlan) in result.output + + def test_config_vlan_del_vlan_does_not_exist(self): + runner = CliRunner() + vid = "3010" + vlan = "Vlan{}".format(vid) + result = runner.invoke(config.config.commands["vlan"].commands["del"], [vid]) + print(result.exit_code) + print(result.output) + assert result.exit_code != 0 + assert "{} does not exist".format(vlan) in result.output + def test_config_vlan_add_member_with_invalid_vlanid(self): runner = CliRunner() result = runner.invoke(config.config.commands["vlan"].commands["member"].commands["add"], ["4096", "Ethernet4"]) print(result.exit_code) print(result.output) assert result.exit_code != 0 - assert "Error: Invalid VLAN ID 4096 (1-4094)" in result.output + assert "Error: Invalid VLAN ID 4096 (2-4094)" in result.output def test_config_vlan_add_member_with_nonexist_vlanid(self): runner = CliRunner() @@ -296,6 +501,13 @@ def test_config_vlan_add_nonexist_port_member(self): def test_config_vlan_add_nonexist_portchannel_member(self): runner = CliRunner() + #switch port mode for PortChannel1011 to trunk mode + result = runner.invoke(config.config.commands["switchport"].commands["mode"],["trunk", "PortChannel1011"]) + print(result.exit_code) + print(result.output) + assert result.exit_code != 0 + assert "Error: PortChannel1011 does not exist" in result.output + result = runner.invoke(config.config.commands["vlan"].commands["member"].commands["add"], \ ["1000", "PortChannel1011"]) print(result.exit_code) @@ -306,7 +518,6 @@ def test_config_vlan_add_nonexist_portchannel_member(self): def test_config_vlan_add_portchannel_member(self): runner = CliRunner() db = Db() - result = runner.invoke(config.config.commands["vlan"].commands["member"].commands["add"], \ ["1000", "PortChannel1001", "--untagged"], obj=db) print(result.exit_code) @@ -329,7 +540,7 @@ def test_config_vlan_add_rif_portchannel_member(self): print(result.exit_code) print(result.output) assert result.exit_code != 0 - assert "Error: PortChannel0001 is a router interface!" in result.output + assert "Error: PortChannel0001 is in routed mode!\nUse switchport mode command to change port mode" in result.output def test_config_vlan_with_vxlanmap_del_vlan(self, mock_restart_dhcp_relay_service): runner = CliRunner() @@ -446,6 +657,22 @@ def test_config_add_del_vlan_and_vlan_member(self, mock_restart_dhcp_relay_servi print(result.output) assert result.exit_code == 0 + # add Ethernet20 to vlan 1001 but Ethernet20 is in routed mode will give error + result = runner.invoke(config.config.commands["vlan"].commands["member"].commands["add"], + ["1001", "Ethernet20", "--untagged"], obj=db) + print(result.exit_code) + print(result.output) + traceback.print_tb(result.exc_info[2]) + assert result.exit_code != 0 + assert "Ethernet20 is in routed mode!\nUse switchport mode command to change port mode" in result.output + + # configure Ethernet20 from routed to access mode + result = runner.invoke(config.config.commands["switchport"].commands["mode"],["access", "Ethernet20"], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + assert "Ethernet20 switched from routed to access mode" in result.output + # add Ethernet20 to vlan 1001 result = runner.invoke(config.config.commands["vlan"].commands["member"].commands["add"], ["1001", "Ethernet20", "--untagged"], obj=db) @@ -491,6 +718,22 @@ def test_config_add_del_vlan_and_vlan_member_in_alias_mode(self, mock_restart_dh print(result.output) assert result.exit_code == 0 + # add etp6 to vlan 1001 but etp6 is in routed mode will give error + result = runner.invoke(config.config.commands["vlan"].commands["member"].commands["add"], + ["1001", "etp6", "--untagged"], obj=db) + print(result.exit_code) + print(result.output) + traceback.print_tb(result.exc_info[2]) + assert result.exit_code != 0 + assert "Ethernet20 is in routed mode!\nUse switchport mode command to change port mode" in result.output + + # configure etp6 from routed to access mode + result = runner.invoke(config.config.commands["switchport"].commands["mode"],["access", "etp6"], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + assert "Ethernet20 switched from routed to access mode" in result.output + # add etp6 to vlan 1001 result = runner.invoke(config.config.commands["vlan"].commands["member"].commands["add"], ["1001", "etp6", "--untagged"], obj=db) @@ -527,6 +770,380 @@ def test_config_add_del_vlan_and_vlan_member_in_alias_mode(self, mock_restart_dh os.environ['SONIC_CLI_IFACE_MODE'] = "default" + def test_config_add_del_multiple_vlan_and_vlan_member(self,mock_restart_dhcp_relay_service): + runner = CliRunner() + db = Db() + + # add vlan 1001 + result = runner.invoke(config.config.commands["vlan"].commands["add"], ["1001,1002,1003","--multiple"], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + + # add Ethernet20 to vlan1001, vlan1002, vlan1003 multiple flag but Ethernet20 is in routed mode will give error + result = runner.invoke(config.config.commands["vlan"].commands["member"].commands["add"], + ["1001,1002,1003", "Ethernet20", "--multiple"], obj=db) + print(result.exit_code) + print(result.output) + traceback.print_tb(result.exc_info[2]) + assert result.exit_code != 0 + assert "Ethernet20 is in routed mode!\nUse switchport mode command to change port mode" in result.output + + # configure Ethernet20 from routed to access mode + result = runner.invoke(config.config.commands["switchport"].commands["mode"],["trunk", "Ethernet20"], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + assert "Ethernet20 switched from routed to trunk mode" in result.output + + # add Ethernet20 to vlan 1001 + result = runner.invoke(config.config.commands["vlan"].commands["member"].commands["add"], + ["1001,1002,1003", "Ethernet20", "--multiple"], obj=db) + print(result.exit_code) + print(result.output) + traceback.print_tb(result.exc_info[2]) + assert result.exit_code == 0 + + # show output + result = runner.invoke(show.cli.commands["vlan"].commands["brief"], [], obj=db) + print(result.output) + assert result.output == test_config_add_del_multiple_vlan_and_vlan_member_output + + # remove vlan member + result = runner.invoke(config.config.commands["vlan"].commands["member"].commands["del"], + ["1001-1003", "Ethernet20", "--multiple"], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + + # add del 1001 + result = runner.invoke(config.config.commands["vlan"].commands["del"], ["1001-1003","--multiple"], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + + # show output + result = runner.invoke(show.cli.commands["vlan"].commands["brief"], [], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + assert result.output == show_vlan_brief_output + + def test_config_add_del_add_vlans_and_add_vlans_member_except_vlan(self, mock_restart_dhcp_relay_service): + runner = CliRunner() + db = Db() + + # add vlan 1001 + result = runner.invoke(config.config.commands["vlan"].commands["add"], ["1001,1002","--multiple"], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + + # add Ethernet20 to vlan1001, vlan1002, vlan1003 multiple flag but Ethernet20 is in routed mode will give error + result = runner.invoke(config.config.commands["vlan"].commands["member"].commands["add"], + ["1000,4000", "Ethernet20", "--multiple", "--except_flag"], obj=db) + print(result.exit_code) + print(result.output) + traceback.print_tb(result.exc_info[2]) + assert result.exit_code != 0 + assert "Ethernet20 is in routed mode!\nUse switchport mode command to change port mode" in result.output + + # configure Ethernet20 from routed to access mode + result = runner.invoke(config.config.commands["switchport"].commands["mode"],["trunk", "Ethernet20"], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + assert "Ethernet20 switched from routed to trunk mode" in result.output + + # add Ethernet20 to vlan 1001 + result = runner.invoke(config.config.commands["vlan"].commands["member"].commands["add"], + ["1000,4000", "Ethernet20", "--multiple", "--except_flag"], obj=db) + print(result.exit_code) + print(result.output) + traceback.print_tb(result.exc_info[2]) + assert result.exit_code == 0 + + # show output + result = runner.invoke(show.cli.commands["vlan"].commands["brief"], [], obj=db) + print(result.output) + assert result.output == test_config_add_del_add_vlans_and_add_vlans_member_except_vlan_output + + # remove vlan member except some + result = runner.invoke(config.config.commands["vlan"].commands["member"].commands["del"], + ["1001,1002", "Ethernet20", "--multiple", "--except_flag"], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + + # show output + result = runner.invoke(show.cli.commands["vlan"].commands["brief"], [], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + assert result.output == test_config_add_del_add_vlans_and_add_vlans_member_except_vlan__after_del_member_output + + # remove vlan member + result = runner.invoke(config.config.commands["vlan"].commands["member"].commands["del"], + ["1001,1002", "Ethernet20", "--multiple"], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + + # add del 1001 + result = runner.invoke(config.config.commands["vlan"].commands["del"], ["1001-1002","--multiple"], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + + # show output + result = runner.invoke(show.cli.commands["vlan"].commands["brief"], [], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + assert result.output == show_vlan_brief_output + + + def test_config_add_del_add_vlans_and_add_all_vlan_member(self, mock_restart_dhcp_relay_service): + runner = CliRunner() + db = Db() + + # add vlan 1001 + result = runner.invoke(config.config.commands["vlan"].commands["add"], ["1001,1002,1003","--multiple"], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + + # add Ethernet20 to vlan1001, vlan1002, vlan1003 multiple flag but Ethernet20 is in routed mode will give error + result = runner.invoke(config.config.commands["vlan"].commands["member"].commands["add"], + ["all", "Ethernet20"], obj=db) + print(result.exit_code) + print(result.output) + traceback.print_tb(result.exc_info[2]) + assert result.exit_code != 0 + assert "Ethernet20 is in routed mode!\nUse switchport mode command to change port mode" in result.output + + # configure Ethernet20 from routed to access mode + result = runner.invoke(config.config.commands["switchport"].commands["mode"],["trunk", "Ethernet20"], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + assert "Ethernet20 switched from routed to trunk mode" in result.output + + # add Ethernet20 to vlan 1001 + result = runner.invoke(config.config.commands["vlan"].commands["member"].commands["add"], + ["all", "Ethernet20"], obj=db) + print(result.exit_code) + print(result.output) + traceback.print_tb(result.exc_info[2]) + assert result.exit_code == 0 + + # show output + result = runner.invoke(show.cli.commands["vlan"].commands["brief"], [], obj=db) + print(result.output) + assert result.output == test_config_add_del_add_vlans_and_add_all_vlan_member_output + + # remove vlan member + result = runner.invoke(config.config.commands["vlan"].commands["member"].commands["del"], + ["all", "Ethernet20"], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + + # add del 1001 + result = runner.invoke(config.config.commands["vlan"].commands["del"], ["1001-1003","--multiple"], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + + # show output + result = runner.invoke(show.cli.commands["vlan"].commands["brief"], [], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + assert result.output == show_vlan_brief_output + + def test_config_add_del_vlan_and_vlan_member_with_switchport_modes(self, mock_restart_dhcp_relay_service): + runner = CliRunner() + db = Db() + + # add vlan 1001 + result = runner.invoke(config.config.commands["vlan"].commands["add"], ["1001"], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + + # add Ethernet20 to vlan 1001 but Ethernet20 is in routed mode will give error + result = runner.invoke(config.config.commands["vlan"].commands["member"].commands["add"], + ["1001", "Ethernet20", "--untagged"], obj=db) + print(result.exit_code) + print(result.output) + traceback.print_tb(result.exc_info[2]) + assert result.exit_code != 0 + assert "Ethernet20 is in routed mode!\nUse switchport mode command to change port mode" in result.output + + + # configure Ethernet20 from routed to access mode + result = runner.invoke(config.config.commands["switchport"].commands["mode"],["access", "Ethernet20"], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + assert "Ethernet20 switched from routed to access mode" in result.output + + # add Ethernet20 to vlan 1001 + result = runner.invoke(config.config.commands["vlan"].commands["member"].commands["add"], + ["1001", "Ethernet20", "--untagged"], obj=db) + print(result.exit_code) + print(result.output) + traceback.print_tb(result.exc_info[2]) + assert result.exit_code == 0 + + # add Ethernet20 to vlan 1001 as tagged member + result = runner.invoke(config.config.commands["vlan"].commands["member"].commands["add"], + ["1000", "Ethernet20"], obj=db) + print(result.exit_code) + print(result.output) + traceback.print_tb(result.exc_info[2]) + assert result.exit_code != 0 + assert "Ethernet20 is in access mode! Tagged Members cannot be added" in result.output + + # configure Ethernet20 from access to trunk mode + result = runner.invoke(config.config.commands["switchport"].commands["mode"],["trunk", "Ethernet20"], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + assert "Ethernet20 switched from access to trunk mode" in result.output + + # add Ethernet20 to vlan 1001 as tagged member + result = runner.invoke(config.config.commands["vlan"].commands["member"].commands["add"], + ["1000", "Ethernet20"], obj=db) + print(result.exit_code) + print(result.output) + traceback.print_tb(result.exc_info[2]) + assert result.exit_code == 0 + + # show output + result = runner.invoke(show.cli.commands["vlan"].commands["brief"], [], obj=db) + print(result.output) + assert result.output == test_config_add_del_vlan_and_vlan_member_with_switchport_modes_output + + # configure Ethernet20 from trunk to routed mode + result = runner.invoke(config.config.commands["switchport"].commands["mode"],["routed", "Ethernet20"], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code != 0 + assert "Ethernet20 has tagged member(s). \nRemove them to change mode to routed" in result.output + + # remove vlan member + result = runner.invoke(config.config.commands["vlan"].commands["member"].commands["del"], + ["1000", "Ethernet20"], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + + # configure Ethernet20 from trunk to routed mode + result = runner.invoke(config.config.commands["switchport"].commands["mode"],["routed", "Ethernet20"], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code != 0 + assert "Ethernet20 has untagged member. \nRemove it to change mode to routed" in result.output + + # remove vlan member + result = runner.invoke(config.config.commands["vlan"].commands["member"].commands["del"], + ["1001", "Ethernet20"], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + + # configure Ethernet20 from trunk to routed mode + result = runner.invoke(config.config.commands["switchport"].commands["mode"],["routed", "Ethernet20"], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + assert "Ethernet20 switched from trunk to routed mode" in result.output + + # add del 1001 + result = runner.invoke(config.config.commands["vlan"].commands["del"], ["1001"], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + + # show output + result = runner.invoke(show.cli.commands["vlan"].commands["brief"], [], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + assert result.output == show_vlan_brief_output + + + def test_config_add_del_vlan_and_vlan_member_with_switchport_modes_and_change_mode_types(self, mock_restart_dhcp_relay_service): + runner = CliRunner() + db = Db() + + # add vlan 1001 + result = runner.invoke(config.config.commands["vlan"].commands["add"], ["1001"], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + + + # configure Ethernet64 to routed mode + result = runner.invoke(config.config.commands["switchport"].commands["mode"],["routed", "Ethernet64"], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + + # add Ethernet64 to vlan 1001 but Ethernet64 is in routed mode will give error + result = runner.invoke(config.config.commands["vlan"].commands["member"].commands["add"], + ["1001", "Ethernet64"], obj=db) + print(result.exit_code) + print(result.output) + traceback.print_tb(result.exc_info[2]) + assert result.exit_code != 0 + assert "Ethernet64 is in routed mode!\nUse switchport mode command to change port mode" in result.output + + # configure Ethernet64 from routed to trunk mode + result = runner.invoke(config.config.commands["switchport"].commands["mode"],["trunk", "Ethernet64"], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + assert "Ethernet64 switched from routed to trunk mode" in result.output + + # add Ethernet64 to vlan 1001 + result = runner.invoke(config.config.commands["vlan"].commands["member"].commands["add"], + ["1001", "Ethernet64"], obj=db) + print(result.exit_code) + print(result.output) + traceback.print_tb(result.exc_info[2]) + assert result.exit_code == 0 + + # configure Ethernet64 from routed to access mode + result = runner.invoke(config.config.commands["switchport"].commands["mode"],["access", "Ethernet64"], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code != 0 + assert "Ethernet64 is in trunk mode and have tagged member(s).\nRemove tagged member(s) from Ethernet64 to switch to access mode" in result.output + + # remove vlan member + result = runner.invoke(config.config.commands["vlan"].commands["member"].commands["del"], + ["1001", "Ethernet64"], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + + # configure Ethernet64 from routed to access mode + result = runner.invoke(config.config.commands["switchport"].commands["mode"],["access", "Ethernet64"], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + assert "Ethernet64 switched from trunk to access mode" in result.output + + # show output + result = runner.invoke(show.cli.commands["vlan"].commands["brief"], [], obj=db) + print(result.exit_code) + print(result.output) + assert result.exit_code == 0 + assert result.output == test_config_add_del_vlan_and_vlan_member_with_switchport_modes_and_change_mode_types_output + def test_config_vlan_proxy_arp_with_nonexist_vlan_intf_table(self): modes = ["enabled", "disabled"] runner = CliRunner() @@ -615,8 +1232,8 @@ def test_config_set_router_port_on_member_interface(self): result = runner.invoke(config.config.commands["interface"].commands["ip"].commands["add"], ["Ethernet4", "10.10.10.1/24"], obj=obj) print(result.exit_code, result.output) - assert result.exit_code == 0 - assert 'Interface Ethernet4 is a member of vlan' in result.output + assert result.exit_code != 0 + assert 'Interface Ethernet4 is not in routed mode!' in result.output def test_config_vlan_add_member_of_portchannel(self): runner = CliRunner() diff --git a/utilities_common/cli.py b/utilities_common/cli.py index 9d3cdae710..54e867c610 100644 --- a/utilities_common/cli.py +++ b/utilities_common/cli.py @@ -20,6 +20,7 @@ pass_db = click.make_pass_decorator(Db, ensure=True) + class AbbreviationGroup(click.Group): """This subclass of click.Group supports abbreviated subgroup/subcommand names """ @@ -76,9 +77,11 @@ def read_config(self, filename): except configparser.NoSectionError: pass + # Global Config object _config = None + class AliasedGroup(click.Group): """This subclass of click.Group supports abbreviations and looking up aliases in a config file with a bit of magic. @@ -117,6 +120,7 @@ def get_command(self, ctx, cmd_name): return click.Group.get_command(self, ctx, matches[0]) ctx.fail('Too many matches: %s' % ', '.join(sorted(matches))) + class InterfaceAliasConverter(object): """Class which handles conversion between interface name and alias""" @@ -131,7 +135,6 @@ def __init__(self, db=None): self.port_dict = self.config_db.get_table('PORT') self.alias_max_length = 0 - if not self.port_dict: self.port_dict = {} @@ -139,7 +142,7 @@ def __init__(self, db=None): try: if self.alias_max_length < len( self.port_dict[port_name]['alias']): - self.alias_max_length = len( + self.alias_max_length = len( self.port_dict[port_name]['alias']) except KeyError: break @@ -151,7 +154,8 @@ def name_to_alias(self, interface_name): vlan_id = '' sub_intf_sep_idx = -1 if interface_name is not None: - sub_intf_sep_idx = interface_name.find(VLAN_SUB_INTERFACE_SEPARATOR) + sub_intf_sep_idx = interface_name.find( + VLAN_SUB_INTERFACE_SEPARATOR) if sub_intf_sep_idx != -1: vlan_id = interface_name[sub_intf_sep_idx + 1:] # interface_name holds the parent port name @@ -160,7 +164,7 @@ def name_to_alias(self, interface_name): for port_name in self.port_dict: if interface_name == port_name: return self.port_dict[port_name]['alias'] if sub_intf_sep_idx == -1 \ - else self.port_dict[port_name]['alias'] + VLAN_SUB_INTERFACE_SEPARATOR + vlan_id + else self.port_dict[port_name]['alias'] + VLAN_SUB_INTERFACE_SEPARATOR + vlan_id # interface_name not in port_dict. Just return interface_name return interface_name if sub_intf_sep_idx == -1 else interface_name + VLAN_SUB_INTERFACE_SEPARATOR + vlan_id @@ -172,7 +176,8 @@ def alias_to_name(self, interface_alias): vlan_id = '' sub_intf_sep_idx = -1 if interface_alias is not None: - sub_intf_sep_idx = interface_alias.find(VLAN_SUB_INTERFACE_SEPARATOR) + sub_intf_sep_idx = interface_alias.find( + VLAN_SUB_INTERFACE_SEPARATOR) if sub_intf_sep_idx != -1: vlan_id = interface_alias[sub_intf_sep_idx + 1:] # interface_alias holds the parent port alias @@ -185,8 +190,11 @@ def alias_to_name(self, interface_alias): # interface_alias not in port_dict. Just return interface_alias return interface_alias if sub_intf_sep_idx == -1 else interface_alias + VLAN_SUB_INTERFACE_SEPARATOR + vlan_id + # Lazy global class instance for SONiC interface name to alias conversion -iface_alias_converter = lazy_object_proxy.Proxy(lambda: InterfaceAliasConverter()) +iface_alias_converter = lazy_object_proxy.Proxy( + lambda: InterfaceAliasConverter()) + def get_interface_naming_mode(): mode = os.getenv('SONIC_CLI_IFACE_MODE') @@ -194,6 +202,7 @@ def get_interface_naming_mode(): mode = "default" return mode + def is_ipaddress(val): """ Validate if an entry is a valid IP """ import netaddr @@ -205,6 +214,7 @@ def is_ipaddress(val): return False return True + def ipaddress_type(val): """ Return the IP address type """ if not val: @@ -217,6 +227,7 @@ def ipaddress_type(val): return ip_version.version + def is_ip_prefix_in_key(key): ''' Function to check if IP address is present in the key. If it @@ -225,6 +236,7 @@ def is_ip_prefix_in_key(key): ''' return (isinstance(key, tuple)) + def is_valid_port(config_db, port): """Check if port is in PORT table""" @@ -234,6 +246,7 @@ def is_valid_port(config_db, port): return False + def is_valid_portchannel(config_db, port): """Check if port is in PORT_CHANNEL table""" @@ -243,6 +256,7 @@ def is_valid_portchannel(config_db, port): return False + def is_vlanid_in_range(vid): """Check if vlan id is valid or not""" @@ -251,6 +265,7 @@ def is_vlanid_in_range(vid): return False + def check_if_vlanid_exist(config_db, vlan, table_name='VLAN'): """Check if vlan id exits in the config db or ot""" @@ -259,6 +274,7 @@ def check_if_vlanid_exist(config_db, vlan, table_name='VLAN'): return False + def is_port_vlan_member(config_db, port, vlan): """Check if port is a member of vlan""" @@ -269,26 +285,134 @@ def is_port_vlan_member(config_db, port, vlan): return False + +def vlan_range_list(ctx, vid_range: str) -> list: + + vid1, vid2 = map(int, vid_range.split("-")) + + if vid1 == 1 or vid2 == 1: + ctx.fail("Vlan1 is default vlan") + + if vid1 >= vid2: + ctx.fail("{} is greater than {}. List cannot be generated".format(vid1,vid2)) + + if is_vlanid_in_range(vid1) and is_vlanid_in_range(vid2): + return list(range(vid1, vid2+1)) + else: + ctx.fail("Invalid VLAN ID must be in (2-4094)") + + +def multiple_vlan_parser(ctx, s_input: str) -> list: + + vlan_list = [] + + vlan_map = map(str, s_input.replace(" ", "").split(",")) + for vlan in vlan_map: + if "-" in vlan: + vlan_list += vlan_range_list(ctx, vlan) + elif vlan.isdigit() and int(vlan) not in vlan_list: + vlan_list.append(int(vlan)) + elif not vlan.isdigit(): + ctx.fail("{} is not integer".format(vlan)) + + vlan_list.sort() + return vlan_list + + +def get_existing_vlan_id(db) -> list: + existing_vlans = [] + vlan_data = db.cfgdb.get_table('VLAN') + + for i in vlan_data.keys(): + existing_vlans.append(int(i.strip("Vlan"))) + + return sorted(existing_vlans) + +def get_existing_vlan_id_on_interface(db,port) -> list: + intf_vlans = [] + vlan_member_data = db.cfgdb.get_table('VLAN_MEMBER') + + for (k,v) in vlan_member_data.keys(): + if v == port: + intf_vlans.append(int(k.strip("Vlan"))) + + return sorted(intf_vlans) + + +def vlan_member_input_parser(ctx, command_mode, db, except_flag, multiple, vid, port) -> list: + vid_list = [] + if vid == "all": + if command_mode == "add": + return get_existing_vlan_id(db) # config vlan member add + if command_mode == "del": + return get_existing_vlan_id_on_interface(db,port) # config vlan member del + + if multiple: + vid_list = multiple_vlan_parser(ctx, vid) + + if except_flag: + if command_mode == "add": + comp_list = get_existing_vlan_id(db) # config vlan member add + + elif command_mode == "del": + comp_list = get_existing_vlan_id_on_interface(db,port) # config vlan member del + + if multiple: + for i in vid_list: + if i in comp_list: + comp_list.remove(i) + + else: + if not vid.isdigit(): + ctx.fail("Vlan is not integer.") + vid = int(vid) + if vid in comp_list: + comp_list.remove(vid) + vid_list = comp_list + + elif not multiple: + # if entered vlan is not a integer + if not vid.isdigit(): + ctx.fail("Vlan is not integer.") + vid_list.append(int(vid)) + + # sorting the vid_list + vid_list.sort() + return vid_list + +def interface_is_tagged_member(db, interface_name): + """ Check if interface has tagged members i.e. is in trunk mode""" + vlan_member_table = db.get_table('VLAN_MEMBER') + + for key, val in vlan_member_table.items(): + if(key[1] == interface_name): + if (val['tagging_mode'] == 'tagged'): + return True + return False + def interface_is_in_vlan(vlan_member_table, interface_name): """ Check if an interface is in a vlan """ - for _,intf in vlan_member_table: + for _, intf in vlan_member_table: if intf == interface_name: return True return False + def is_valid_vlan_interface(config_db, interface): """ Check an interface is a valid VLAN interface """ return interface in config_db.get_table("VLAN_INTERFACE") + def interface_is_in_portchannel(portchannel_member_table, interface_name): """ Check if an interface is part of portchannel """ - for _,intf in portchannel_member_table: + for _, intf in portchannel_member_table: if intf == interface_name: return True return False + def is_port_router_interface(config_db, port): """Check if port is a router interface""" @@ -299,6 +423,7 @@ def is_port_router_interface(config_db, port): return False + def is_pc_router_interface(config_db, pc): """Check if portchannel is a router interface""" @@ -309,15 +434,65 @@ def is_pc_router_interface(config_db, pc): return False +def get_vlan_id(vlan): + vlan_prefix, vid = vlan.split('Vlan') + return vid + +def get_interface_name_for_display(db ,interface): + interface_naming_mode = get_interface_naming_mode() + iface_alias_converter = InterfaceAliasConverter(db) + if interface_naming_mode == "alias" and interface: + return iface_alias_converter.name_to_alias(interface) + return interface + +def get_interface_untagged_vlan_members(db,interface): + untagged_vlans = [] + vlan_member = db.cfgdb.get_table('VLAN_MEMBER') + + for member in natsorted(list(vlan_member.keys())): + interface_vlan, interface_name = member + + if interface == interface_name and vlan_member[member]['tagging_mode'] == 'untagged': + untagged_vlans.append(get_vlan_id(interface_vlan)) + + return "\n".join(untagged_vlans) + +def get_interface_tagged_vlan_members(db,interface): + tagged_vlans = [] + formatted_tagged_vlans = [] + vlan_member = db.cfgdb.get_table('VLAN_MEMBER') + + for member in natsorted(list(vlan_member.keys())): + interface_vlan, interface_name = member + + if interface == interface_name and vlan_member[member]['tagging_mode'] == 'tagged': + tagged_vlans.append(get_vlan_id(interface_vlan)) + + for i in range(len(tagged_vlans)//5+1): + formatted_tagged_vlans.append(" ,".join([str(x) for x in tagged_vlans[i*5:(i+1)*5]])) + + return "\n".join(formatted_tagged_vlans) + +def get_interface_switchport_mode(db, interface): + port = db.cfgdb.get_entry('PORT',interface) + portchannel = db.cfgdb.get_entry('PORTCHANNEL',interface) + switchport_mode = 'routed' + if "mode" in port: + switchport_mode = port['mode'] + elif "mode" in portchannel: + switchport_mode = portchannel['mode'] + return switchport_mode + def is_port_mirror_dst_port(config_db, port): """Check if port is already configured as mirror destination port """ mirror_table = config_db.get_table('MIRROR_SESSION') - for _,v in mirror_table.items(): + for _, v in mirror_table.items(): if 'dst_port' in v and v['dst_port'] == port: return True return False + def vni_id_is_valid(vni): """Check if the vni id is in acceptable range (between 1 and 2^24) """ @@ -327,6 +502,7 @@ def vni_id_is_valid(vni): return True + def is_vni_vrf_mapped(db, vni): """Check if the vni is mapped to vrf """ @@ -335,20 +511,22 @@ def is_vni_vrf_mapped(db, vni): vrf_table = db.cfgdb.get_table('VRF') vrf_keys = vrf_table.keys() if vrf_keys is not None: - for vrf_key in vrf_keys: - if ('vni' in vrf_table[vrf_key] and vrf_table[vrf_key]['vni'] == vni): - found = 1 - break + for vrf_key in vrf_keys: + if ('vni' in vrf_table[vrf_key] and vrf_table[vrf_key]['vni'] == vni): + found = 1 + break if (found == 1): - print("VNI {} mapped to Vrf {}, Please remove VRF VNI mapping".format(vni, vrf_key)) + print("VNI {} mapped to Vrf {}, Please remove VRF VNI mapping".format( + vni, vrf_key)) return False return True + def interface_has_mirror_config(mirror_table, interface_name): """Check if port is already configured with mirror config """ - for _,v in mirror_table.items(): + for _, v in mirror_table.items(): if 'src_port' in v and v['src_port'] == interface_name: return True if 'dst_port' in v and v['dst_port'] == interface_name: @@ -356,6 +534,7 @@ def interface_has_mirror_config(mirror_table, interface_name): return False + def print_output_in_alias_mode(output, index): """Convert and print all instances of SONiC interface name to vendor-sepecific interface aliases. @@ -381,12 +560,12 @@ def print_output_in_alias_mode(output, index): interface_name = word[index] interface_name = interface_name.replace(':', '') for port_name in natsorted(list(iface_alias_converter.port_dict.keys())): - if interface_name == port_name: - alias_name = iface_alias_converter.port_dict[port_name]['alias'] + if interface_name == port_name: + alias_name = iface_alias_converter.port_dict[port_name]['alias'] if alias_name: if len(alias_name) < iface_alias_converter.alias_max_length: alias_name = alias_name.rjust( - iface_alias_converter.alias_max_length) + iface_alias_converter.alias_max_length) output = output.replace(interface_name, alias_name, 1) click.echo(output.rstrip('\n')) @@ -416,7 +595,7 @@ def run_command_in_alias_mode(command, shell=False): index = 0 if output.startswith("IFACE"): output = output.replace("IFACE", "IFACE".rjust( - iface_alias_converter.alias_max_length)) + iface_alias_converter.alias_max_length)) print_output_in_alias_mode(output, index) elif command_str.startswith("intfstat"): @@ -424,7 +603,7 @@ def run_command_in_alias_mode(command, shell=False): index = 0 if output.startswith("IFACE"): output = output.replace("IFACE", "IFACE".rjust( - iface_alias_converter.alias_max_length)) + iface_alias_converter.alias_max_length)) print_output_in_alias_mode(output, index) elif command_str == "pfcstat": @@ -432,11 +611,11 @@ def run_command_in_alias_mode(command, shell=False): index = 0 if output.startswith("Port Tx"): output = output.replace("Port Tx", "Port Tx".rjust( - iface_alias_converter.alias_max_length)) + iface_alias_converter.alias_max_length)) elif output.startswith("Port Rx"): output = output.replace("Port Rx", "Port Rx".rjust( - iface_alias_converter.alias_max_length)) + iface_alias_converter.alias_max_length)) print_output_in_alias_mode(output, index) elif (command_str.startswith("sudo sfputil show eeprom")): @@ -451,7 +630,7 @@ def run_command_in_alias_mode(command, shell=False): index = 0 if output.startswith("Port"): output = output.replace("Port", "Port".rjust( - iface_alias_converter.alias_max_length)) + iface_alias_converter.alias_max_length)) print_output_in_alias_mode(output, index) elif command_str == "sudo lldpshow": @@ -459,7 +638,7 @@ def run_command_in_alias_mode(command, shell=False): index = 0 if output.startswith("LocalPort"): output = output.replace("LocalPort", "LocalPort".rjust( - iface_alias_converter.alias_max_length)) + iface_alias_converter.alias_max_length)) print_output_in_alias_mode(output, index) elif command_str.startswith("queuestat"): @@ -467,7 +646,7 @@ def run_command_in_alias_mode(command, shell=False): index = 0 if output.startswith("Port"): output = output.replace("Port", "Port".rjust( - iface_alias_converter.alias_max_length)) + iface_alias_converter.alias_max_length)) print_output_in_alias_mode(output, index) elif command_str == "fdbshow": @@ -476,7 +655,7 @@ def run_command_in_alias_mode(command, shell=False): if output.startswith("No."): output = " " + output output = re.sub( - 'Type', ' Type', output) + 'Type', ' Type', output) elif output[0].isdigit(): output = " " + output print_output_in_alias_mode(output, index) @@ -491,8 +670,8 @@ def run_command_in_alias_mode(command, shell=False): """Show ip(v6) int""" index = 0 if output.startswith("Interface"): - output = output.replace("Interface", "Interface".rjust( - iface_alias_converter.alias_max_length)) + output = output.replace("Interface", "Interface".rjust( + iface_alias_converter.alias_max_length)) print_output_in_alias_mode(output, index) else: @@ -505,8 +684,9 @@ def run_command_in_alias_mode(command, shell=False): converted_output = raw_output for port_name in iface_alias_converter.port_dict: converted_output = re.sub(r"(^|\s){}($|,{{0,1}}\s)".format(port_name), - r"\1{}\2".format(iface_alias_converter.name_to_alias(port_name)), - converted_output) + r"\1{}\2".format( + iface_alias_converter.name_to_alias(port_name)), + converted_output) click.echo(converted_output.rstrip('\n')) rc = process.poll() @@ -541,7 +721,7 @@ def run_command(command, display_cmd=False, ignore_error=False, return_cmd=False if get_interface_naming_mode() == "alias" and not command_str.startswith("intfutil") and not re.search("show ip|ipv6 route", command_str): run_command_in_alias_mode(command, shell=shell) sys.exit(0) - + proc = subprocess.Popen(command, shell=shell, text=True, stdout=subprocess.PIPE) if return_cmd: @@ -593,20 +773,21 @@ def interface_is_untagged_member(db, interface_name): """ Check if interface is already untagged member""" vlan_member_table = db.get_table('VLAN_MEMBER') - for key,val in vlan_member_table.items(): + for key, val in vlan_member_table.items(): if(key[1] == interface_name): if (val['tagging_mode'] == 'untagged'): return True return False + def is_interface_in_config_db(config_db, interface_name): """ Check if an interface is in CONFIG DB """ if (not interface_name in config_db.get_keys('VLAN_INTERFACE') and not interface_name in config_db.get_keys('INTERFACE') and not interface_name in config_db.get_keys('PORTCHANNEL_INTERFACE') and not interface_name in config_db.get_keys('VLAN_SUB_INTERFACE') and - not interface_name == 'null'): - return False + not interface_name == 'null'): + return False return True @@ -623,9 +804,11 @@ def __init__(self, *args, **kwargs): def get_help_record(self, ctx): """Return help string with mutually_exclusive list added.""" - help_record = list(super(MutuallyExclusiveOption, self).get_help_record(ctx)) + help_record = list( + super(MutuallyExclusiveOption, self).get_help_record(ctx)) if self.mutually_exclusive: - mutually_exclusive_str = 'NOTE: this argument is mutually exclusive with arguments: %s' % ', '.join(self.mutually_exclusive) + mutually_exclusive_str = 'NOTE: this argument is mutually exclusive with arguments: %s' % ', '.join( + self.mutually_exclusive) if help_record[-1]: help_record[-1] += ' ' + mutually_exclusive_str else: @@ -637,8 +820,9 @@ def handle_parse_result(self, ctx, opts, args): for opt_name in self.mutually_exclusive: if opt_name in opts and opts[opt_name] is not None: raise click.UsageError( - "Illegal usage: %s is mutually exclusive with arguments %s" % (self.name, ', '.join(self.mutually_exclusive)) - ) + "Illegal usage: %s is mutually exclusive with arguments %s" % ( + self.name, ', '.join(self.mutually_exclusive)) + ) return super(MutuallyExclusiveOption, self).handle_parse_result(ctx, opts, args) @@ -687,8 +871,10 @@ def __init__(self, app_name=None, tag=None): tag (str): Tag the user cache. Different tags correspond to different cache directories even for the same user. """ self.uid = os.getuid() - self.app_name = os.path.basename(sys.argv[0]) if app_name is None else app_name - self.cache_directory_suffix = str(self.uid) if tag is None else f"{self.uid}-{tag}" + self.app_name = os.path.basename( + sys.argv[0]) if app_name is None else app_name + self.cache_directory_suffix = str( + self.uid) if tag is None else f"{self.uid}-{tag}" self.cache_directory_app = os.path.join(self.CACHE_DIR, self.app_name) prev_umask = os.umask(0) @@ -697,7 +883,8 @@ def __init__(self, app_name=None, tag=None): finally: os.umask(prev_umask) - self.cache_directory = os.path.join(self.cache_directory_app, self.cache_directory_suffix) + self.cache_directory = os.path.join( + self.cache_directory_app, self.cache_directory_suffix) os.makedirs(self.cache_directory, exist_ok=True) def get_directory(self):