Skip to content
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

Jump to bottom

[GCU] Add vlanintf-validator #2697

Merged
merged 5 commits into from
Mar 9, 2023
Merged

[GCU] Add vlanintf-validator #2697

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
debf318
[GCU] Add vlanintf-validator
wen587 Feb 28, 2023
3f087e0
Add comment
wen587 Mar 1, 2023
a802817
Merge branch 'master' into vlan_intf
wen587 Mar 3, 2023
bd89c7e
add test
wen587 Mar 3, 2023
aaeb467
Merge branch 'master' into vlan_intf
wen587 Mar 8, 2023
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
6 changes: 6 additions & 0 deletions generic_config_updater/generic_config_updater.conf.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,9 @@
},
"NTP_SERVER": {
"services_to_validate": [ "ntp-service" ]
},
"VLAN_INTERFACE": {
"services_to_validate": [ "vlanintf-service" ]
}
},
"services": {
Expand All @@ -71,6 +74,9 @@
},
"ntp-service": {
"validate_commands": [ "generic_config_updater.services_validator.ntp_validator" ]
},
"vlanintf-service": {
"validate_commands": [ "generic_config_updater.services_validator.vlanintf_validator" ]
}
}
}
Expand Down
21 changes: 21 additions & 0 deletions generic_config_updater/services_validator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,3 +101,24 @@ def caclmgrd_validator(old_config, upd_config, keys):

def ntp_validator(old_config, upd_config, keys):
return _service_restart("ntp-config")

def vlanintf_validator(old_config, upd_config, keys):
old_vlan_intf = old_config.get("VLAN_INTERFACE", {})
upd_vlan_intf = upd_config.get("VLAN_INTERFACE", {})

# Get the tuple with format (iface, iface_ip) then check deleted tuple
# Example:
# old_keys = [("Vlan1000", "192.168.0.1")]
# upd_keys = [("Vlan1000", "192.168.0.2")]
old_keys = [ tuple(key.split("|"))
wen587 marked this conversation as resolved.
Show resolved Hide resolved
for key in old_vlan_intf if len(key.split("|")) == 2 ]
upd_keys = [ tuple(key.split("|"))
for key in upd_vlan_intf if len(key.split("|")) == 2 ]

deleted_keys = list(set(old_keys) - set(upd_keys))
for key in deleted_keys:
iface, iface_ip = key
rc = os.system(f"ip neigh flush dev {iface} {iface_ip}")
Copy link
Contributor

@qiluo-msft qiluo-msft Mar 1, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

system

Add unit test if this is a bug fix. #Closed

if not rc:
return False
return True
51 changes: 50 additions & 1 deletion tests/generic_config_updater/service_validator_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
from collections import defaultdict
from unittest.mock import patch

from generic_config_updater.services_validator import vlan_validator, rsyslog_validator, caclmgrd_validator
from generic_config_updater.services_validator import vlan_validator, rsyslog_validator, caclmgrd_validator, vlanintf_validator
import generic_config_updater.gu_common


Expand Down Expand Up @@ -152,6 +152,46 @@ def mock_time_sleep_call(sleep_time):
{ "cmd": "systemctl restart rsyslog", "rc": 1 }, # restart again; fails
]

test_vlanintf_data = [
{ "old": {}, "upd": {}, "cmd": "" },
{
"old": { "VLAN_INTERFACE": {
"Vlan1000": {},
"Vlan1000|192.168.0.1/21": {} } },
"upd": { "VLAN_INTERFACE": {
"Vlan1000": {},
"Vlan1000|192.168.0.1/21": {} } },
"cmd": ""
},
{
"old": { "VLAN_INTERFACE": {
"Vlan1000": {},
"Vlan1000|192.168.0.1/21": {} } },
"upd": { "VLAN_INTERFACE": {
"Vlan1000": {},
"Vlan1000|192.168.0.2/21": {} } },
"cmd": "ip neigh flush dev Vlan1000 192.168.0.1/21"
},
{
"old": { "VLAN_INTERFACE": {
"Vlan1000": {},
"Vlan1000|192.168.0.1/21": {} } },
"upd": { "VLAN_INTERFACE": {
"Vlan1000": {},
"Vlan1000|192.168.0.1/21": {},
"Vlan1000|192.168.0.2/21": {} } },
"cmd": ""
},
{
"old": { "VLAN_INTERFACE": {
"Vlan1000": {},
"Vlan1000|192.168.0.1/21": {} } },
"upd": {},
"cmd": "ip neigh flush dev Vlan1000 192.168.0.1/21"
}
]


class TestServiceValidator(unittest.TestCase):

@patch("generic_config_updater.change_applier.os.system")
Expand All @@ -177,6 +217,15 @@ def test_change_apply_os_system(self, mock_os_sys):
rc = rsyslog_validator("", "", "")
assert not rc, "rsyslog_validator expected to fail"

os_system_calls = []
os_system_call_index = 0
for entry in test_vlanintf_data:
if entry["cmd"]:
os_system_calls.append({"cmd": entry["cmd"], "rc": 0 })
msg = "case failed: {}".format(str(entry))

vlanintf_validator(entry["old"], entry["upd"], None)

@patch("generic_config_updater.services_validator.time.sleep")
def test_change_apply_time_sleep(self, mock_time_sleep):
global time_sleep_calls, time_sleep_call_index
Expand Down