[staticroutebfd] fix an error in error logging (#17043)

Why I did it
Fix an error in the log_err call.
this error can be triggered by an invalid static route key. usually the code cannot go here with normal config file. but hit this issue with an invalid key by manual testing with redis-cli directly. the file is scanned by Python lint to prevent such errors.

Work item tracking
Microsoft ADO ():26250268

How I did it
fix the format error.

How to verify it
1, ran pylint to check the design, make sure no such error in the design file.
2, wrote a separate python program to verify the log call.
In the current logging related testing, usually use patch/mock for logging. for this specific error, could not trigger it if we call mock function instead the real function in the design. so need to do lint checking for code change.
This commit is contained in:
Baorong Liu 2024-01-30 22:21:46 -08:00 committed by GitHub
parent c8439cdd4b
commit d1cce42f4a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 18 additions and 1 deletions

View File

@ -376,7 +376,7 @@ class StaticRouteBfd(object):
valid, is_ipv4, ip = check_ip(ip_prefix)
if not valid:
log_err("invalid ip prefix for static route: ", key)
log_err("invalid ip prefix for static route: '%s'"%(key))
return True
#use lower case if there is letter in IPv6 address string

View File

@ -171,6 +171,23 @@ def test_set_del_ipv6():
{'del_default:2603:10e2:400::4/128': { }}
)
@patch('staticroutebfd.main.log_err')
def test_invalid_key(mocked_log_err):
dut = constructor()
intf_setup(dut)
set_del_test(dut, "srt",
"SET",
("2.2.2/24", {
"bfd": "true",
"nexthop": "192.168.1.2 , 192.168.2.2, 192.168.3.2",
"ifname": "if1, if2, if3",
}),
{},
{}
)
mocked_log_err.assert_called_with("invalid ip prefix for static route: '2.2.2/24'")
def test_set_del():
dut = constructor()
intf_setup(dut)