Skip to content

[action] [PR:4448] Show vnet route cli update on 202511 #313

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mssonicbld merged 1 commit into from
Apr 17, 2026
Merged

[action] [PR:4448] Show vnet route cli update on 202511 #313

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 56 additions & 41 deletions show/vnet.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -441,7 +441,8 @@ def routes():
"""Show vnet routes related information"""
pass

def pretty_print(table, r, epval, mac_addr, vni, state):

def pretty_print(table, r, epval, mac_addr, vni, metric, state):
endpoints = epval.split(',')
row_width = 3
max_len = 0
Expand All @@ -458,87 +459,101 @@ def pretty_print(table, r, epval, mac_addr, vni, state):
if iter == 0:
r.append(mac_addr)
r.append(vni)
r.append(metric)
r.append(state)
else:
r.extend(["", "", ""])
r.extend(["", "", "", ""])
iter += row_width
table.append(r)
r = ["",""]

@routes.command()
def all():
@click.argument('vnet_name', required=False)
def all(vnet_name):
"""Show all vnet routes"""

appl_db = SonicV2Connector()
appl_db.connect(appl_db.APPL_DB)
state_db = SonicV2Connector()
state_db.connect(state_db.STATE_DB)
header = ['vnet name', 'prefix', 'nexthop', 'interface']

# Fetching data from appl_db for VNET ROUTES
_show_local_helper(vnet_name=vnet_name, appl_db=appl_db)
click.echo()
_show_tunnel_helper(vnet_name=vnet_name, appl_db=appl_db, state_db=state_db)


@routes.command()
@click.argument('vnet_name', required=False)
def local(vnet_name):
"""Show local vnet routes"""

appl_db = SonicV2Connector()

_show_local_helper(vnet_name=vnet_name, appl_db=appl_db)


@routes.command()
@click.argument('vnet_name', required=False)
def tunnel(vnet_name):
"""Show vnet tunnel routes"""

appl_db = SonicV2Connector()
state_db = SonicV2Connector()

_show_tunnel_helper(vnet_name=vnet_name, appl_db=appl_db, state_db=state_db)


def _show_local_helper(vnet_name=None, appl_db=None):
route_header = ['vnet name', 'prefix', 'nexthop', 'interface']

appl_db.connect(appl_db.APPL_DB)

# VNET routes
table = []
vnet_rt_keys = appl_db.keys(appl_db.APPL_DB, "VNET_ROUTE_TABLE:*")
vnet_rt_keys = natsorted(vnet_rt_keys) if vnet_rt_keys else []

table = []
for k in vnet_rt_keys:
if vnet_name and k.split(":")[1] != vnet_name:
continue
r = []
r.extend(k.split(":", 2)[1:])
val = appl_db.get_all(appl_db.APPL_DB, k)
r.append(val.get('nexthop'))
r.append(val.get('ifname'))
table.append(r)

click.echo(tabulate(table, header))
click.echo(tabulate(table, route_header))

click.echo()

header = ['vnet name', 'prefix', 'endpoint', 'mac address', 'vni', 'status']
def _show_tunnel_helper(vnet_name=None, appl_db=None, state_db=None):
tunnel_header = ['vnet name', 'prefix', 'endpoint', 'mac address', 'vni', 'metric', 'status']

# Fetching data from appl_db for VNET TUNNEL ROUTES
appl_db.connect(appl_db.APPL_DB)
state_db.connect(state_db.STATE_DB)

# VNET tunnel routes
table = []
vnet_rt_keys = appl_db.keys(appl_db.APPL_DB, "VNET_ROUTE_TUNNEL_TABLE:*")
vnet_rt_keys = natsorted(vnet_rt_keys) if vnet_rt_keys else []

table = []
for k in vnet_rt_keys:
if vnet_name and k.split(":")[1] != vnet_name:
continue
r = []
r.extend(k.split(":", 2)[1:])
state_db_key = '|'.join(k.split(":",2))
state_db_key = '|'.join(k.split(":", 2))
val = appl_db.get_all(appl_db.APPL_DB, k)
val_state = state_db.get_all(state_db.STATE_DB, state_db_key)
epval = val.get('endpoint')
if len(epval) < 40:
r.append(epval)
r.append(val.get('mac_address'))
r.append(val.get('vni'))
r.append(val.get('metric'))
if val_state:
r.append(val_state.get('state'))
table.append(r)
continue
state = val_state.get('state') if val_state else ""
pretty_print(table, r, epval, val.get('mac_address'), val.get('vni'), state )

click.echo(tabulate(table, header))


@routes.command()
def tunnel():
"""Show vnet tunnel routes"""
appl_db = SonicV2Connector()
appl_db.connect(appl_db.APPL_DB)

header = ['vnet name', 'prefix', 'endpoint', 'mac address', 'vni']

# Fetching data from appl_db for VNET TUNNEL ROUTES
vnet_rt_keys = appl_db.keys(appl_db.APPL_DB, "VNET_ROUTE_TUNNEL_TABLE:*")
vnet_rt_keys = natsorted(vnet_rt_keys) if vnet_rt_keys else []

table = []
for k in vnet_rt_keys:
r = []
r.extend(k.split(":", 2)[1:])
val = appl_db.get_all(appl_db.APPL_DB, k)
r.append(val.get('endpoint'))
r.append(val.get('mac_address'))
r.append(val.get('vni'))
table.append(r)
pretty_print(table, r, epval, val.get('mac_address'), val.get('vni'), val.get('metric'), state)

click.echo(tabulate(table, header))
click.echo(tabulate(table, tunnel_header))
19 changes: 18 additions & 1 deletion tests/mock_tables/appl_db.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -371,9 +371,26 @@
"TUNNEL_ROUTE_TABLE:10.3.1.1": {
"alias": "Vlan1000"
},
"VNET_ROUTE_TABLE:test_v4_in_v4-0:160.162.191.1/32": {
"nexthop": "100.100.4.1",
"ifname": "Ethernet1"
},
"VNET_ROUTE_TABLE:test_v4_in_v4-0:160.163.191.1/32": {
"nexthop": "100.101.4.1, 100.101.4.2",
"ifname": "Ethernet1, Ethernet2"
},
"VNET_ROUTE_TABLE:test_v4_in_v4-0:160.164.191.1/32": {
"nexthop": "100.102.4.1, 100.102.4.2, 100.102.4.3",
"ifname": "Ethernet1, Ethernet2, Ethernet3"
},
"VNET_ROUTE_TABLE:test_v4_in_v4-1:160.165.191.1/32": {
"nexthop": "100.103.4.1, 100.103.4.2, 100.103.4.3",
"ifname": "Ethernet1, Ethernet2, Ethernet3"
},
"VNET_ROUTE_TUNNEL_TABLE:test_v4_in_v4-0:160.163.191.1/32": {
"endpoint":"100.251.7.1",
"endpoint_monitor":"100.251.7.1"
"endpoint_monitor":"100.251.7.1",
"metric": "0"
},
"VNET_ROUTE_TUNNEL_TABLE:Vnet_v6_in_v6-0:fddd:a156:a251::a6:1/128": {
"endpoint": "fddd:a100:a251::a10:1,fddd:a101:a251::a10:1,fddd:a102:a251::a10:1,fddd:a103:a251::a10:1",
Expand Down
135 changes: 114 additions & 21 deletions tests/show_vnet_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# flake8: noqa: E501
import os
from click.testing import CliRunner
from utilities_common.db import Db
Expand All @@ -15,42 +16,43 @@ def test_Preety_print(self):
row = ["Vnet_v6_in_v6-0", "fddd:a156:a251::a6:1/128"]
mac_addr = ""
vni = ""
metric = "0"
state = "active"
epval = "fddd:a100:a251::a10:1,fddd:a101:a251::a10:1"

vnet.pretty_print(table, row, epval, mac_addr, vni, state)
expected_output = [['Vnet_v6_in_v6-0', 'fddd:a156:a251::a6:1/128', 'fddd:a100:a251::a10:1,fddd:a101:a251::a10:1', '', '', 'active']]
vnet.pretty_print(table, row, epval, mac_addr, vni, metric, state)
expected_output = [['Vnet_v6_in_v6-0', 'fddd:a156:a251::a6:1/128', 'fddd:a100:a251::a10:1,fddd:a101:a251::a10:1', '', '', '0', 'active']]
assert table == expected_output

table =[]
row = ["Vnet_v6_in_v6-0", "fddd:a156:a251::a6:1/128"]
epval = "fddd:a100:a251::a10:1,fddd:a101:a251::a10:1,fddd:a100:a251::a11:1,fddd:a100:a251::a12:1,fddd:a100:a251::a13:1"
vnet.pretty_print(table, row, epval, mac_addr, vni, state)
vnet.pretty_print(table, row, epval, mac_addr, vni, metric, state)
expected_output = [
['Vnet_v6_in_v6-0', 'fddd:a156:a251::a6:1/128', 'fddd:a100:a251::a10:1,fddd:a101:a251::a10:1', '', '', 'active'],
['', '', 'fddd:a100:a251::a11:1,fddd:a100:a251::a12:1', '', '', ''],
['', '', 'fddd:a100:a251::a13:1', '', '', '']
['Vnet_v6_in_v6-0', 'fddd:a156:a251::a6:1/128', 'fddd:a100:a251::a10:1,fddd:a101:a251::a10:1', '', '', '0', 'active'],
['', '', 'fddd:a100:a251::a11:1,fddd:a100:a251::a12:1', '', '', '', ''],
['', '', 'fddd:a100:a251::a13:1', '', '', '', '']
]
assert table == expected_output

table =[]
row = ["Vnet_v6_in_v6-0", "fddd:a156:a251::a6:1/128"]
epval = "192.168.1.1,192.168.1.2,192.168.1.3,192.168.1.4,192.168.1.5,192.168.1.6,192.168.1.7,192.168.1.8,192.168.1.9,192.168.1.10,192.168.1.11,192.168.1.12,192.168.1.13,192.168.1.14,192.168.1.15"
vnet.pretty_print(table, row, epval, mac_addr, vni, state)
vnet.pretty_print(table, row, epval, mac_addr, vni, metric, state)
expected_output =[
['Vnet_v6_in_v6-0', 'fddd:a156:a251::a6:1/128', '192.168.1.1,192.168.1.2,192.168.1.3', '', '', 'active'],
['', '', '192.168.1.4,192.168.1.5,192.168.1.6', '', '', ''],
['', '', '192.168.1.7,192.168.1.8,192.168.1.9', '', '', ''],
['', '', '192.168.1.10,192.168.1.11,192.168.1.12', '', '', ''],
['', '', '192.168.1.13,192.168.1.14,192.168.1.15', '', '', '']]
['Vnet_v6_in_v6-0', 'fddd:a156:a251::a6:1/128', '192.168.1.1,192.168.1.2,192.168.1.3', '', '', '0', 'active'],
['', '', '192.168.1.4,192.168.1.5,192.168.1.6', '', '', '', ''],
['', '', '192.168.1.7,192.168.1.8,192.168.1.9', '', '', '', ''],
['', '', '192.168.1.10,192.168.1.11,192.168.1.12', '', '', '', ''],
['', '', '192.168.1.13,192.168.1.14,192.168.1.15', '', '', '', '']]
assert table == expected_output

table =[]
row = ["Vnet_v6_in_v6-0", "fddd:a156:a251::a6:1/128"]
epval = "192.168.1.1"
vnet.pretty_print(table, row, epval, mac_addr, vni, state)
vnet.pretty_print(table, row, epval, mac_addr, vni, metric, state)
expected_output =[
['Vnet_v6_in_v6-0', 'fddd:a156:a251::a6:1/128', '192.168.1.1', '', '', 'active']]
['Vnet_v6_in_v6-0', 'fddd:a156:a251::a6:1/128', '192.168.1.1', '', '', '0', 'active']]
assert table == expected_output

def test_show_vnet_routes_all_basic(self):
Expand All @@ -60,16 +62,107 @@ def test_show_vnet_routes_all_basic(self):
result = runner.invoke(show.cli.commands['vnet'].commands['routes'].commands['all'], [], obj=db)
assert result.exit_code == 0
expected_output = """\
vnet name prefix nexthop interface
----------- -------- --------- -----------
vnet name prefix nexthop interface
--------------- ---------------- ------------------------------------- -------------------------------
test_v4_in_v4-0 160.162.191.1/32 100.100.4.1 Ethernet1
test_v4_in_v4-0 160.163.191.1/32 100.101.4.1, 100.101.4.2 Ethernet1, Ethernet2
test_v4_in_v4-0 160.164.191.1/32 100.102.4.1, 100.102.4.2, 100.102.4.3 Ethernet1, Ethernet2, Ethernet3
test_v4_in_v4-1 160.165.191.1/32 100.103.4.1, 100.103.4.2, 100.103.4.3 Ethernet1, Ethernet2, Ethernet3

vnet name prefix endpoint mac address vni status
--------------- ------------------------ ------------------------------------------- ------------- ----- --------
Vnet_v6_in_v6-0 fddd:a156:a251::a6:1/128 fddd:a100:a251::a10:1,fddd:a101:a251::a10:1 active
vnet name prefix endpoint mac address vni metric status
--------------- ------------------------ ------------------------------------------- ------------- ----- -------- --------
Vnet_v6_in_v6-0 fddd:a156:a251::a6:1/128 fddd:a100:a251::a10:1,fddd:a101:a251::a10:1 active
fddd:a102:a251::a10:1,fddd:a103:a251::a10:1
test_v4_in_v4-0 160.162.191.1/32 100.251.7.1 active
test_v4_in_v4-0 160.163.191.1/32 100.251.7.1 active
test_v4_in_v4-0 160.162.191.1/32 100.251.7.1 active
test_v4_in_v4-0 160.163.191.1/32 100.251.7.1 0 active
test_v4_in_v4-0 160.164.191.1/32 100.251.7.1
"""
assert result.output == expected_output

def test_show_vnet_routes_all_vnetname(self):
runner = CliRunner()
db = Db()

result = runner.invoke(show.cli.commands['vnet'].commands['routes'].commands['all'],
['test_v4_in_v4-0'], obj=db)
assert result.exit_code == 0
expected_output = """\
vnet name prefix nexthop interface
--------------- ---------------- ------------------------------------- -------------------------------
test_v4_in_v4-0 160.162.191.1/32 100.100.4.1 Ethernet1
test_v4_in_v4-0 160.163.191.1/32 100.101.4.1, 100.101.4.2 Ethernet1, Ethernet2
test_v4_in_v4-0 160.164.191.1/32 100.102.4.1, 100.102.4.2, 100.102.4.3 Ethernet1, Ethernet2, Ethernet3

vnet name prefix endpoint mac address vni metric status
--------------- ---------------- ----------- ------------- ----- -------- --------
test_v4_in_v4-0 160.162.191.1/32 100.251.7.1 active
test_v4_in_v4-0 160.163.191.1/32 100.251.7.1 0 active
test_v4_in_v4-0 160.164.191.1/32 100.251.7.1
"""
assert result.output == expected_output

def test_show_vnet_routes_tunnel_basic(self):
runner = CliRunner()
db = Db()

result = runner.invoke(show.cli.commands['vnet'].commands['routes'].commands['tunnel'], [], obj=db)
assert result.exit_code == 0
expected_output = """\
vnet name prefix endpoint mac address vni metric status
--------------- ------------------------ ------------------------------------------- ------------- ----- -------- --------
Vnet_v6_in_v6-0 fddd:a156:a251::a6:1/128 fddd:a100:a251::a10:1,fddd:a101:a251::a10:1 active
fddd:a102:a251::a10:1,fddd:a103:a251::a10:1
test_v4_in_v4-0 160.162.191.1/32 100.251.7.1 active
test_v4_in_v4-0 160.163.191.1/32 100.251.7.1 0 active
test_v4_in_v4-0 160.164.191.1/32 100.251.7.1
"""
assert result.output == expected_output

def test_show_vnet_routes_tunnel_vnetname(self):
runner = CliRunner()
db = Db()

result = runner.invoke(show.cli.commands['vnet'].commands['routes'].commands['tunnel'],
['test_v4_in_v4-0'], obj=db)
assert result.exit_code == 0
expected_output = """\
vnet name prefix endpoint mac address vni metric status
--------------- ---------------- ----------- ------------- ----- -------- --------
test_v4_in_v4-0 160.162.191.1/32 100.251.7.1 active
test_v4_in_v4-0 160.163.191.1/32 100.251.7.1 0 active
test_v4_in_v4-0 160.164.191.1/32 100.251.7.1
"""
assert result.output == expected_output

def test_show_vnet_routes_local_basic(self):
runner = CliRunner()
db = Db()

result = runner.invoke(show.cli.commands['vnet'].commands['routes'].commands['local'], [], obj=db)
assert result.exit_code == 0
expected_output = """\
vnet name prefix nexthop interface
--------------- ---------------- ------------------------------------- -------------------------------
test_v4_in_v4-0 160.162.191.1/32 100.100.4.1 Ethernet1
test_v4_in_v4-0 160.163.191.1/32 100.101.4.1, 100.101.4.2 Ethernet1, Ethernet2
test_v4_in_v4-0 160.164.191.1/32 100.102.4.1, 100.102.4.2, 100.102.4.3 Ethernet1, Ethernet2, Ethernet3
test_v4_in_v4-1 160.165.191.1/32 100.103.4.1, 100.103.4.2, 100.103.4.3 Ethernet1, Ethernet2, Ethernet3
"""
assert result.output == expected_output

def test_show_vnet_routes_local_vnetname(self):
runner = CliRunner()
db = Db()

result = runner.invoke(show.cli.commands['vnet'].commands['routes'].commands['local'],
['test_v4_in_v4-0'], obj=db)
assert result.exit_code == 0
expected_output = """\
vnet name prefix nexthop interface
--------------- ---------------- ------------------------------------- -------------------------------
test_v4_in_v4-0 160.162.191.1/32 100.100.4.1 Ethernet1
test_v4_in_v4-0 160.163.191.1/32 100.101.4.1, 100.101.4.2 Ethernet1, Ethernet2
test_v4_in_v4-0 160.164.191.1/32 100.102.4.1, 100.102.4.2, 100.102.4.3 Ethernet1, Ethernet2, Ethernet3
"""
assert result.output == expected_output

Expand Down
Loading