matthew/sonic-buildimage
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[dhcp_server] improve show dhcp server output (#17734)

Browse Source 
* fix show dhcp_server semantics
* show dhcp_server table format
This commit is contained in:
Xichen96 2024-01-11 02:34:22 +08:00 committed by GitHub
parent 0ecab6cfbc
commit 24e995024b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 124 additions and 90 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

184
dockers/docker-dhcp-server/cli-plugin-tests/test_show_dhcp_server.py
View File

@ -16,11 +16,15 @@ class TestShowDHCPServer(object):
def test_show_dhcp_server_ipv4_lease_without_dhcpintf(self, mock_db): def test_show_dhcp_server_ipv4_lease_without_dhcpintf(self, mock_db):
expected_stdout = """\ expected_stdout = """\
Interface MAC Address IP Lease Start Lease End +---------------------+-------------------+-------------+---------------------+---------------------+
------------------- ----------------- ----------- ------------------- ------------------- | Interface | MAC Address | IP | Lease Start | Lease End |
Vlan1000|Ethernet10 10:70:fd:b6:13:00 192.168.0.1 2023-03-01 03:16:21 2023-03-01 03:31:21 +=====================+===================+=============+=====================+=====================+
Vlan1000|Ethernet11 10:70:fd:b6:13:01 192.168.0.2 2023-03-01 03:16:21 2023-03-01 03:31:21 | Vlan1000|Ethernet10 | 10:70:fd:b6:13:00 | 192.168.0.1 | 2023-03-01 03:16:21 | 2023-03-01 03:31:21 |
Vlan1001|<Unknown> 10:70:fd:b6:13:02 192.168.0.3 2023-03-01 03:16:21 2023-03-01 03:31:21 +---------------------+-------------------+-------------+---------------------+---------------------+
| Vlan1000|Ethernet11 | 10:70:fd:b6:13:01 | 192.168.0.2 | 2023-03-01 03:16:21 | 2023-03-01 03:31:21 |
+---------------------+-------------------+-------------+---------------------+---------------------+
| Vlan1001|<Unknown> | 10:70:fd:b6:13:02 | 192.168.0.3 | 2023-03-01 03:16:21 | 2023-03-01 03:31:21 |
+---------------------+-------------------+-------------+---------------------+---------------------+
""" """
runner = CliRunner() runner = CliRunner()
db = clicommon.Db() db = clicommon.Db()
@ -31,10 +35,13 @@ Vlan1001|<Unknown> 10:70:fd:b6:13:02 192.168.0.3 2023-03-01 03:16:21 2023-0
def test_show_dhcp_server_ipv4_lease_with_dhcpintf(self, mock_db): def test_show_dhcp_server_ipv4_lease_with_dhcpintf(self, mock_db):
expected_stdout = """\ expected_stdout = """\
Interface MAC Address IP Lease Start Lease End +---------------------+-------------------+-------------+---------------------+---------------------+
------------------- ----------------- ----------- ------------------- ------------------- | Interface | MAC Address | IP | Lease Start | Lease End |
Vlan1000|Ethernet10 10:70:fd:b6:13:00 192.168.0.1 2023-03-01 03:16:21 2023-03-01 03:31:21 +=====================+===================+=============+=====================+=====================+
Vlan1000|Ethernet11 10:70:fd:b6:13:01 192.168.0.2 2023-03-01 03:16:21 2023-03-01 03:31:21 | Vlan1000|Ethernet10 | 10:70:fd:b6:13:00 | 192.168.0.1 | 2023-03-01 03:16:21 | 2023-03-01 03:31:21 |
+---------------------+-------------------+-------------+---------------------+---------------------+
| Vlan1000|Ethernet11 | 10:70:fd:b6:13:01 | 192.168.0.2 | 2023-03-01 03:16:21 | 2023-03-01 03:31:21 |
+---------------------+-------------------+-------------+---------------------+---------------------+
""" """
runner = CliRunner() runner = CliRunner()
db = clicommon.Db() db = clicommon.Db()
@ -45,9 +52,11 @@ Vlan1000|Ethernet11 10:70:fd:b6:13:01 192.168.0.2 2023-03-01 03:16:21 2023-0
def test_show_dhcp_server_ipv4_lease_client_not_in_fdb(self, mock_db): def test_show_dhcp_server_ipv4_lease_client_not_in_fdb(self, mock_db):
expected_stdout = """\ expected_stdout = """\
Interface MAC Address IP Lease Start Lease End +--------------------+-------------------+-------------+---------------------+---------------------+
------------------ ----------------- ----------- ------------------- ------------------- | Interface | MAC Address | IP | Lease Start | Lease End |
Vlan1001|<Unknown> 10:70:fd:b6:13:02 192.168.0.3 2023-03-01 03:16:21 2023-03-01 03:31:21 +====================+===================+=============+=====================+=====================+
| Vlan1001|<Unknown> | 10:70:fd:b6:13:02 | 192.168.0.3 | 2023-03-01 03:16:21 | 2023-03-01 03:31:21 |
+--------------------+-------------------+-------------+---------------------+---------------------+
""" """
runner = CliRunner() runner = CliRunner()
db = clicommon.Db() db = clicommon.Db()
@ -58,11 +67,15 @@ Vlan1001|<Unknown> 10:70:fd:b6:13:02 192.168.0.3 2023-03-01 03:16:21 2023-03
def test_show_dhcp_server_ipv4_range_without_name(self, mock_db): def test_show_dhcp_server_ipv4_range_without_name(self, mock_db):
expected_stdout = """\ expected_stdout = """\
Range IP Start IP End IP Count +---------+------------+------------+------------------------+
------- ---------- ---------- ---------------------- | Range | IP Start | IP End | IP Count |
range1 100.1.1.3 100.1.1.5 3 +=========+============+============+========================+
range2 100.1.1.9 100.1.1.8 range value is illegal | range1 | 100.1.1.3 | 100.1.1.5 | 3 |
range3 100.1.1.10 100.1.1.10 1 +---------+------------+------------+------------------------+
| range2 | 100.1.1.9 | 100.1.1.8 | range value is illegal |
+---------+------------+------------+------------------------+
| range3 | 100.1.1.10 | 100.1.1.10 | 1 |
+---------+------------+------------+------------------------+
""" """
runner = CliRunner() runner = CliRunner()
db = clicommon.Db() db = clicommon.Db()
@ -73,9 +86,11 @@ range3 100.1.1.10 100.1.1.10 1
def test_show_dhcp_server_ipv4_range_with_name(self, mock_db): def test_show_dhcp_server_ipv4_range_with_name(self, mock_db):
expected_stdout = """\ expected_stdout = """\
Range IP Start IP End IP Count +---------+------------+-----------+------------+
------- ---------- --------- ---------- | Range | IP Start | IP End | IP Count |
range1 100.1.1.3 100.1.1.5 3 +=========+============+===========+============+
| range1 | 100.1.1.3 | 100.1.1.5 | 3 |
+---------+------------+-----------+------------+
""" """
runner = CliRunner() runner = CliRunner()
db = clicommon.Db() db = clicommon.Db()
@ -86,9 +101,11 @@ range1 100.1.1.3 100.1.1.5 3
def test_show_dhcp_server_ipv4_range_wrong_data(self, mock_db): def test_show_dhcp_server_ipv4_range_wrong_data(self, mock_db):
expected_stdout = """\ expected_stdout = """\
Range IP Start IP End IP Count +---------+------------+-----------+------------------------+
------- ---------- --------- ---------------------- | Range | IP Start | IP End | IP Count |
range2 100.1.1.9 100.1.1.8 range value is illegal +=========+============+===========+========================+
| range2 | 100.1.1.9 | 100.1.1.8 | range value is illegal |
+---------+------------+-----------+------------------------+
""" """
runner = CliRunner() runner = CliRunner()
db = clicommon.Db() db = clicommon.Db()
@ -99,9 +116,11 @@ range2 100.1.1.9 100.1.1.8 range value is illegal
def test_show_dhcp_server_ipv4_range_single_ip(self, mock_db): def test_show_dhcp_server_ipv4_range_single_ip(self, mock_db):
expected_stdout = """\ expected_stdout = """\
Range IP Start IP End IP Count +---------+------------+------------+------------+
------- ---------- ---------- ---------- | Range | IP Start | IP End | IP Count |
range3 100.1.1.10 100.1.1.10 1 +=========+============+============+============+
| range3 | 100.1.1.10 | 100.1.1.10 | 1 |
+---------+------------+------------+------------+
""" """
runner = CliRunner() runner = CliRunner()
db = clicommon.Db() db = clicommon.Db()
@ -112,10 +131,13 @@ range3 100.1.1.10 100.1.1.10 1
def test_show_dhcp_server_ipv4_info_without_intf(self, mock_db): def test_show_dhcp_server_ipv4_info_without_intf(self, mock_db):
expected_stdout = """\ expected_stdout = """\
Interface Mode Gateway Netmask Lease Time(s) State +-------------+--------+-----------+---------------+-----------------+----------+
----------- ------ --------- ------------- --------------- -------- | Interface | Mode | Gateway | Netmask | Lease Time(s) | State |
Vlan100 PORT 100.1.1.1 255.255.255.0 3600 enabled +=============+========+===========+===============+=================+==========+
Vlan300 PORT 100.1.1.1 255.255.255.0 3600 disabled | Vlan100 | PORT | 100.1.1.1 | 255.255.255.0 | 3600 | enabled |
+-------------+--------+-----------+---------------+-----------------+----------+
| Vlan300 | PORT | 100.1.1.1 | 255.255.255.0 | 3600 | disabled |
+-------------+--------+-----------+---------------+-----------------+----------+
""" """
runner = CliRunner() runner = CliRunner()
db = clicommon.Db() db = clicommon.Db()
@ -126,9 +148,11 @@ Vlan300 PORT 100.1.1.1 255.255.255.0 3600 disabled
def test_show_dhcp_server_ipv4_info_with_intf(self, mock_db): def test_show_dhcp_server_ipv4_info_with_intf(self, mock_db):
expected_stdout = """\ expected_stdout = """\
Interface Mode Gateway Netmask Lease Time(s) State +-------------+--------+-----------+---------------+-----------------+---------+
----------- ------ --------- ------------- --------------- ------- | Interface | Mode | Gateway | Netmask | Lease Time(s) | State |
Vlan100 PORT 100.1.1.1 255.255.255.0 3600 enabled +=============+========+===========+===============+=================+=========+
| Vlan100 | PORT | 100.1.1.1 | 255.255.255.0 | 3600 | enabled |
+-------------+--------+-----------+---------------+-----------------+---------+
""" """
runner = CliRunner() runner = CliRunner()
db = clicommon.Db() db = clicommon.Db()
@ -139,9 +163,11 @@ Vlan100 PORT 100.1.1.1 255.255.255.0 3600 enabled
def test_show_dhcp_server_ipv4_info_with_customized_options(self, mock_db): def test_show_dhcp_server_ipv4_info_with_customized_options(self, mock_db):
expected_stdout = """\ expected_stdout = """\
Interface Mode Gateway Netmask Lease Time(s) State Customized Options +-------------+--------+-----------+---------------+-----------------+---------+----------------------+
----------- ------ --------- ------------- --------------- ------- -------------------- | Interface | Mode | Gateway | Netmask | Lease Time(s) | State | Customized Options |
Vlan100 PORT 100.1.1.1 255.255.255.0 3600 enabled option60 +=============+========+===========+===============+=================+=========+======================+
| Vlan100 | PORT | 100.1.1.1 | 255.255.255.0 | 3600 | enabled | option60 |
+-------------+--------+-----------+---------------+-----------------+---------+----------------------+
""" """
runner = CliRunner() runner = CliRunner()
db = clicommon.Db() db = clicommon.Db()
@ -152,9 +178,11 @@ Vlan100 PORT 100.1.1.1 255.255.255.0 3600 enabled option6
def test_show_dhcp_server_ipv4_option_without_name(self, mock_db): def test_show_dhcp_server_ipv4_option_without_name(self, mock_db):
expected_stdout = """\ expected_stdout = """\
Option Name Option ID Value Type +---------------+-------------+-------------+--------+
------------- ----------- ----------- ------ | Option Name | Option ID | Value | Type |
option60 60 dummy_value string +===============+=============+=============+========+
| option60 | 60 | dummy_value | string |
+---------------+-------------+-------------+--------+
""" """
runner = CliRunner() runner = CliRunner()
db = clicommon.Db() db = clicommon.Db()
@ -165,9 +193,11 @@ option60 60 dummy_value string
def test_show_dhcp_server_ipv4_option_with_name(self, mock_db): def test_show_dhcp_server_ipv4_option_with_name(self, mock_db):
expected_stdout = """\ expected_stdout = """\
Option Name Option ID Value Type +---------------+-------------+-------------+--------+
------------- ----------- ----------- ------ | Option Name | Option ID | Value | Type |
option60 60 dummy_value string +===============+=============+=============+========+
| option60 | 60 | dummy_value | string |
+---------------+-------------+-------------+--------+
""" """
runner = CliRunner() runner = CliRunner()
db = clicommon.Db() db = clicommon.Db()
@ -178,16 +208,21 @@ option60 60 dummy_value string
def test_show_dhcp_server_ipv4_port_without_intf(self, mock_db): def test_show_dhcp_server_ipv4_port_without_intf(self, mock_db):
expected_stdout = """\ expected_stdout = """\
Interface Bind +-------------------+------------+
----------------- ---------- | Interface | Bind |
Vlan100|Ethernet4 100.1.1.10 +===================+============+
10.1.1.11 | Vlan100|Ethernet4 | 100.1.1.10 |
Vlan100|Ethernet7 range1 | | 10.1.1.11 |
range2 +-------------------+------------+
Vlan200|Ethernet8 range3 | Vlan100|Ethernet7 | range1 |
range4 | | range2 |
Ethernet9 range5 +-------------------+------------+
range6 | Vlan200|Ethernet8 | range3 |
| | range4 |
+-------------------+------------+
| Ethernet9 | range5 |
| | range6 |
+-------------------+------------+
""" """
runner = CliRunner() runner = CliRunner()
db = clicommon.Db() db = clicommon.Db()
@ -198,10 +233,12 @@ Ethernet9 range5
def test_show_dhcp_server_ipv4_port_with_port(self, mock_db): def test_show_dhcp_server_ipv4_port_with_port(self, mock_db):
expected_stdout = """\ expected_stdout = """\
Interface Bind +-------------------+--------+
----------------- ------ | Interface | Bind |
Vlan100|Ethernet7 range1 +===================+========+
range2 | Vlan100|Ethernet7 | range1 |
| | range2 |
+-------------------+--------+
""" """
runner = CliRunner() runner = CliRunner()
db = clicommon.Db() db = clicommon.Db()
@ -212,12 +249,15 @@ Vlan100|Ethernet7 range1
def test_show_dhcp_server_ipv4_port_with_vlan(self, mock_db): def test_show_dhcp_server_ipv4_port_with_vlan(self, mock_db):
expected_stdout = """\ expected_stdout = """\
Interface Bind +-------------------+------------+
----------------- ---------- | Interface | Bind |
Vlan100|Ethernet4 100.1.1.10 +===================+============+
10.1.1.11 | Vlan100|Ethernet4 | 100.1.1.10 |
Vlan100|Ethernet7 range1 | | 10.1.1.11 |
range2 +-------------------+------------+
| Vlan100|Ethernet7 | range1 |
| | range2 |
+-------------------+------------+
""" """
runner = CliRunner() runner = CliRunner()
db = clicommon.Db() db = clicommon.Db()
@ -228,10 +268,12 @@ Vlan100|Ethernet7 range1
def test_show_dhcp_server_ipv4_port_with_port_and_vlan(self, mock_db): def test_show_dhcp_server_ipv4_port_with_port_and_vlan(self, mock_db):
expected_stdout = """\ expected_stdout = """\
Interface Bind +-------------------+--------+
----------------- ------ | Interface | Bind |
Vlan200|Ethernet8 range3 +===================+========+
range4 | Vlan200|Ethernet8 | range3 |
| | range4 |
+-------------------+--------+
""" """
runner = CliRunner() runner = CliRunner()
db = clicommon.Db() db = clicommon.Db()
@ -242,10 +284,12 @@ Vlan200|Ethernet8 range3
def test_show_dhcp_server_ipv4_port_with_single_port(self, mock_db): def test_show_dhcp_server_ipv4_port_with_single_port(self, mock_db):
expected_stdout = """\ expected_stdout = """\
Interface Bind +-------------+--------+
----------- ------ | Interface | Bind |
Ethernet9 range5 +=============+========+
range6 | Ethernet9 | range5 |
| | range6 |
+-------------+--------+
""" """
runner = CliRunner() runner = CliRunner()
db = clicommon.Db() db = clicommon.Db()

30
dockers/docker-dhcp-server/cli/show/plugins/show_dhcp_server.py
View File

@ -30,11 +30,9 @@ def ipv4():
@ipv4.command() @ipv4.command()
@click.argument('dhcp_interface', required=False) @click.argument('dhcp_interface', required=False, default="*")
@clicommon.pass_db @clicommon.pass_db
def lease(db, dhcp_interface): def lease(db, dhcp_interface):
if not dhcp_interface:
dhcp_interface = "*"
headers = ["Interface", "MAC Address", "IP", "Lease Start", "Lease End"] headers = ["Interface", "MAC Address", "IP", "Lease Start", "Lease End"]
table = [] table = []
dbconn = db.db dbconn = db.db
@ -45,7 +43,7 @@ def lease(db, dhcp_interface):
if not port: if not port:
port = "<Unknown>" port = "<Unknown>"
table.append([interface + "|" + port, mac, entry["ip"], ts_to_str(entry["lease_start"]), ts_to_str(entry["lease_end"])]) table.append([interface + "|" + port, mac, entry["ip"], ts_to_str(entry["lease_start"]), ts_to_str(entry["lease_end"])])
click.echo(tabulate(table, headers=headers)) click.echo(tabulate(table, headers=headers, tablefmt="grid"))
def count_ipv4(start, end): def count_ipv4(start, end):
@ -55,11 +53,9 @@ def count_ipv4(start, end):
@ipv4.command() @ipv4.command()
@click.argument('range_name', required=False) @click.argument('range_name', required=False, default="*")
@clicommon.pass_db @clicommon.pass_db
def range(db, range_name): def range(db, range_name):
if not range_name:
range_name = "*"
headers = ["Range", "IP Start", "IP End", "IP Count"] headers = ["Range", "IP Start", "IP End", "IP Count"]
table = [] table = []
dbconn = db.db dbconn = db.db
@ -78,7 +74,7 @@ def range(db, range_name):
if count < 1: if count < 1:
count = "range value is illegal" count = "range value is illegal"
table.append([name, start, end, count]) table.append([name, start, end, count])
click.echo(tabulate(table, headers=headers)) click.echo(tabulate(table, headers=headers, tablefmt="grid"))
def dhcp_interface_is_match(input_, key): def dhcp_interface_is_match(input_, key):
@ -93,12 +89,10 @@ def dhcp_interface_is_match(input_, key):
@ipv4.command() @ipv4.command()
@click.argument('dhcp_interface', required=False) @click.argument('dhcp_interface', required=False, default="*")
@click.option('--with_customized_options', default=False, is_flag=True) @click.option('--with_customized_options', default=False, is_flag=True)
@clicommon.pass_db @clicommon.pass_db
def info(db, dhcp_interface, with_customized_options): def info(db, dhcp_interface, with_customized_options):
if not dhcp_interface:
dhcp_interface = "*"
headers = ["Interface", "Mode", "Gateway", "Netmask", "Lease Time(s)", "State"] headers = ["Interface", "Mode", "Gateway", "Netmask", "Lease Time(s)", "State"]
if with_customized_options: if with_customized_options:
headers.append("Customized Options") headers.append("Customized Options")
@ -110,15 +104,13 @@ def info(db, dhcp_interface, with_customized_options):
table.append([interface, entry["mode"], entry["gateway"], entry["netmask"], entry["lease_time"], entry["state"]]) table.append([interface, entry["mode"], entry["gateway"], entry["netmask"], entry["lease_time"], entry["state"]])
if with_customized_options: if with_customized_options:
table[-1].append(entry["customized_options"]) table[-1].append(entry["customized_options"])
click.echo(tabulate(table, headers=headers)) click.echo(tabulate(table, headers=headers, tablefmt="grid"))
@ipv4.command() @ipv4.command()
@click.argument("option_name", required=False) @click.argument("option_name", required=False, default="*")
@clicommon.pass_db @clicommon.pass_db
def option(db, option_name): def option(db, option_name):
if not option_name:
option_name = "*"
headers = ["Option Name", "Option ID", "Value", "Type"] headers = ["Option Name", "Option ID", "Value", "Type"]
table = [] table = []
dbconn = db.db dbconn = db.db
@ -126,15 +118,13 @@ def option(db, option_name):
entry = dbconn.get_all("CONFIG_DB", key) entry = dbconn.get_all("CONFIG_DB", key)
name = key.split("|")[1] name = key.split("|")[1]
table.append([name, entry["id"], entry["value"], entry["type"]]) table.append([name, entry["id"], entry["value"], entry["type"]])
click.echo(tabulate(table, headers=headers)) click.echo(tabulate(table, headers=headers, tablefmt="grid"))
@ipv4.command() @ipv4.command()
@click.argument('interface', required=False) @click.argument('interface', required=False, default="*")
@clicommon.pass_db @clicommon.pass_db
def port(db, interface): def port(db, interface):
if not interface:
interface = "*"
headers = ["Interface", "Bind"] headers = ["Interface", "Bind"]
table = [] table = []
dbconn = db.db dbconn = db.db
@ -146,7 +136,7 @@ def port(db, interface):
table.append([intf, entry["ranges"].replace(",", "\n")]) table.append([intf, entry["ranges"].replace(",", "\n")])
if "ips" in entry: if "ips" in entry:
table.append([intf, entry["ips"].replace(",", "\n")]) table.append([intf, entry["ips"].replace(",", "\n")])
click.echo(tabulate(table, headers=headers)) click.echo(tabulate(table, headers=headers, tablefmt="grid"))
def register(cli): def register(cli):