Skip to content

[strict yang] Add YANG enforcemnet for CONFIG_DB tables set ops #987

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

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

[strict yang] Add YANG enforcemnet for CONFIG_DB tables set ops #987

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
45 changes: 45 additions & 0 deletions common/configdb.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ func NewConfigDBConnector(a ...interface{}) *ConfigDBConnector {
## Note: callback is difficult to implement by SWIG C++, so keep in python
self.handlers = {}
self.fire_init_data = {}
self.supported_tables = []

def __enter__(self):
return self
Expand Down Expand Up @@ -216,14 +217,57 @@ func NewConfigDBConnector(a ...interface{}) *ConfigDBConnector {
if table in self.handlers:
self.handlers.pop(table)

def load_yang_tables(self):
if not self.supported_tables:
import sonic_yang
sy = sonic_yang.SonicYang("/usr/local/yang-models")
sy.loadYangModel()
yang_tables = [k for k, v in sy.confDbYangMap.items() if "container" in v]
non_yang_tables = [
"DEBUG_COUNTER",
"DEBUG_COUNTER_DROP_REASON",
"DTEL",
"DTEL_REPORT_SESSION",
"DTEL_INT_SESSION",
"DTEL_QUEUE_REPORT",
"DTEL_EVENT",
"FDB",
"GEARBOX",
"LOGGING",
"PASS_THROUGH_ROUTE_TABLE",
"SEND_TO_INGRESS_PORT",
"STP",
"STP_PORT",
"STP_VLAN_PORT",
"STP_VLAN",
"TC_TO_DOT1P_MAP",
"TWAMP_SESSION",
"VNET_ROUTE",
"VNET_ROUTE_TUNNEL",
"VRRP",
"VRRP6",
"WATERMARK_TABLE"
]
self.supported_tables = yang_tables + non_yang_tables

def check_table_support(self, table):
if self.db_name != "CONFIG_DB":
return

self.load_yang_tables()
if table not in self.supported_tables:
raise ValueError("{} is not supported due to missing YANG model".format(table))

def set_entry(self, table, key, data):
self.check_table_support(table)
key = self.serialize_key(key)
raw_data = self.typed_to_raw(data)
super(ConfigDBConnector, self).set_entry(table, key, raw_data)

def mod_config(self, data):
raw_config = {}
for table_name, table_data in data.items():
self.check_table_support(table_name)
if table_data == {}:
# When table data is {}, no action.
continue
Expand All @@ -238,6 +282,7 @@ func NewConfigDBConnector(a ...interface{}) *ConfigDBConnector {
super(ConfigDBConnector, self).mod_config(raw_config)

def mod_entry(self, table, key, data):
self.check_table_support(table)
key = self.serialize_key(key)
raw_data = self.typed_to_raw(data)
super(ConfigDBConnector, self).mod_entry(table, key, raw_data)
Expand Down
108 changes: 59 additions & 49 deletions tests/test_redis_ut.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -375,16 +375,16 @@ def test_ConfigDBConnector():
assert config_db.db_name == "CONFIG_DB"
assert config_db.TABLE_NAME_SEPARATOR == "|"
config_db.get_redis_client(config_db.CONFIG_DB).flushdb()
config_db.set_entry("TEST_PORT", "Ethernet111", {"alias": "etp1x"})
config_db.set_entry("PORT", "Ethernet111", {"alias": "etp1x"})
allconfig = config_db.get_config()
assert allconfig["TEST_PORT"]["Ethernet111"]["alias"] == "etp1x"
assert allconfig["PORT"]["Ethernet111"]["alias"] == "etp1x"

config_db.set_entry("TEST_PORT", "Ethernet111", {"mtu": "12345"})
config_db.set_entry("PORT", "Ethernet111", {"mtu": "12345"})
allconfig = config_db.get_config()
assert "alias" not in allconfig["TEST_PORT"]["Ethernet111"]
assert allconfig["TEST_PORT"]["Ethernet111"]["mtu"] == "12345"
assert "alias" not in allconfig["PORT"]["Ethernet111"]
assert allconfig["PORT"]["Ethernet111"]["mtu"] == "12345"

config_db.delete_table("TEST_PORT")
config_db.delete_table("PORT")
allconfig = config_db.get_config()
assert len(allconfig) == 0

Expand Down Expand Up @@ -418,27 +418,27 @@ def test_ConfigDBPipeConnector():
#

# Verify entry set
config_db.set_entry("PORT_TABLE", "Ethernet1", {"alias": "etp1x"})
config_db.set_entry("PORT", "Ethernet1", {"alias": "etp1x"})
allconfig = config_db.get_config()
assert allconfig["PORT_TABLE"]["Ethernet1"]["alias"] == "etp1x"
assert allconfig["PORT"]["Ethernet1"]["alias"] == "etp1x"

config_db.set_entry("ACL_TABLE", "EVERFLOW", {"ports": ["Ethernet0", "Ethernet4", "Ethernet8", "Ethernet12"]})
allconfig = config_db.get_config()
assert allconfig["ACL_TABLE"]["EVERFLOW"]["ports"] == ["Ethernet0", "Ethernet4", "Ethernet8", "Ethernet12"]

# Verify entry update
config_db.set_entry("PORT_TABLE", "Ethernet1", {"mtu": "12345"})
config_db.set_entry("PORT", "Ethernet1", {"mtu": "12345"})
allconfig = config_db.get_config()
assert "alias" not in allconfig["PORT_TABLE"]["Ethernet1"]
assert allconfig["PORT_TABLE"]["Ethernet1"]["mtu"] == "12345"
assert "alias" not in allconfig["PORT"]["Ethernet1"]
assert allconfig["PORT"]["Ethernet1"]["mtu"] == "12345"

# Verify entry clear
config_db.set_entry("PORT_TABLE", "Ethernet1", {})
config_db.set_entry("PORT", "Ethernet1", {})
allconfig = config_db.get_config()
assert len(allconfig["PORT_TABLE"]["Ethernet1"]) == 0
assert len(allconfig["PORT"]["Ethernet1"]) == 0

# Verify entry delete
config_db.set_entry("PORT_TABLE", "Ethernet1", None)
config_db.set_entry("PORT", "Ethernet1", None)
config_db.set_entry("ACL_TABLE", "EVERFLOW", None)
allconfig = config_db.get_config()
assert len(allconfig) == 0
Expand All @@ -448,17 +448,17 @@ def test_ConfigDBPipeConnector():
#

# Verify entry set
allconfig.setdefault("PORT_TABLE", {}).setdefault("Ethernet1", {})
allconfig["PORT_TABLE"]["Ethernet1"]["alias"] = "etp1x"
allconfig.setdefault("PORT", {}).setdefault("Ethernet1", {})
allconfig["PORT"]["Ethernet1"]["alias"] = "etp1x"
config_db.mod_config(allconfig)
allconfig = config_db.get_config()
assert allconfig["PORT_TABLE"]["Ethernet1"]["alias"] == "etp1x"
assert allconfig["PORT"]["Ethernet1"]["alias"] == "etp1x"

allconfig.setdefault("VLAN_TABLE", {})
allconfig["VLAN_TABLE"]["Vlan1"] = {}
allconfig.setdefault("VLAN", {})
allconfig["VLAN"]["Vlan1"] = {}
config_db.mod_config(allconfig)
allconfig = config_db.get_config()
assert len(allconfig["VLAN_TABLE"]["Vlan1"]) == 0
assert len(allconfig["VLAN"]["Vlan1"]) == 0

allconfig.setdefault("ACL_TABLE", {}).setdefault("EVERFLOW", {})
allconfig["ACL_TABLE"]["EVERFLOW"]["ports"] = ["Ethernet0", "Ethernet4", "Ethernet8", "Ethernet12"]
Expand All @@ -467,8 +467,8 @@ def test_ConfigDBPipeConnector():
assert allconfig["ACL_TABLE"]["EVERFLOW"]["ports"] == ["Ethernet0", "Ethernet4", "Ethernet8", "Ethernet12"]

# Verify entry delete
allconfig["PORT_TABLE"]["Ethernet1"] = None
allconfig["VLAN_TABLE"]["Vlan1"] = None
allconfig["PORT"]["Ethernet1"] = None
allconfig["VLAN"]["Vlan1"] = None
allconfig["ACL_TABLE"]["EVERFLOW"] = None
config_db.mod_config(allconfig)
allconfig = config_db.get_config()
Expand All @@ -477,20 +477,20 @@ def test_ConfigDBPipeConnector():
# Verify table delete
for i in range(1, 1001, 1):
# Make sure we have enough entries to trigger REDIS_SCAN_BATCH_SIZE
allconfig.setdefault("PORT_TABLE", {}).setdefault("Ethernet{}".format(i), {})
allconfig["PORT_TABLE"]["Ethernet{}".format(i)]["alias"] = "etp{}x".format(i)
allconfig.setdefault("PORT", {}).setdefault("Ethernet{}".format(i), {})
allconfig["PORT"]["Ethernet{}".format(i)]["alias"] = "etp{}x".format(i)

config_db.mod_config(allconfig)
allconfig = config_db.get_config()
assert len(allconfig["PORT_TABLE"]) == 1000
assert len(allconfig["PORT"]) == 1000

# Verify modify config with {} will no action
config_db.mod_config({'PORT_TABLE':{}})
config_db.mod_config({'PORT':{}})
allconfig = config_db.get_config()
assert len(allconfig["PORT_TABLE"]) == 1000
assert len(allconfig["PORT"]) == 1000

# Verify modify config with None will delete table
allconfig["PORT_TABLE"] = None
allconfig["PORT"] = None
config_db.mod_config(allconfig)
allconfig = config_db.get_config()
assert len(allconfig) == 0
Expand All @@ -514,16 +514,16 @@ def test_ConfigDBPipeConnectorSeparator():
config_db = ConfigDBPipeConnector()
config_db.db_connect("CONFIG_DB", False, False)
config_db.get_redis_client(config_db.CONFIG_DB).flushdb()
config_db.set_entry("TEST_PORT", "Ethernet222", {"alias": "etp2x"})
config_db.set_entry("PORT", "Ethernet222", {"alias": "etp2x"})
db.set("ItemWithoutSeparator", "item11")
allconfig = config_db.get_config()
assert "TEST_PORT" in allconfig
assert "PORT" in allconfig
assert "ItemWithoutSeparator" not in allconfig

alltable = config_db.get_table("*")
assert "Ethernet222" in alltable

config_db.delete_table("TEST_PORT")
config_db.delete_table("PORT")
db.delete("ItemWithoutSeparator")
allconfig = config_db.get_config()
assert len(allconfig) == 0
Expand All @@ -532,10 +532,11 @@ def test_ConfigDBScan():
config_db = ConfigDBPipeConnector()
config_db.connect(wait_for_init=False)
config_db.get_redis_client(config_db.CONFIG_DB).flushdb()
n = 1000
tables = ["CRM", "DEVICE_METADATA", "FEATURE", "PORT", "SNMP"]
n = len(tables)
for i in range(0, n):
s = str(i)
config_db.mod_entry("TEST_TYPE" + s, "Ethernet" + s, {"alias" + s: "etp" + s})
config_db.mod_entry(tables[i], "key" + s, {"alias" + s: "etp" + s})

allconfig = config_db.get_config()
assert len(allconfig) == n
Expand All @@ -547,12 +548,21 @@ def test_ConfigDBScan():

for i in range(0, n):
s = str(i)
config_db.delete_table("TEST_TYPE" + s)
config_db.delete_table(tables[i])


def test_ConfigDB_non_yang_table_raise_error():
config_db = ConfigDBConnector()
config_db.connect(wait_for_init=False)
with pytest.raises(ValueError) as excinfo:
config_db.set_entry("TEST_PORT", "Ethernet111", {"alias": "etp1x"})
assert str(excinfo.value) == "TEST_PORT is not supported due to missing YANG model"


def test_ConfigDBFlush():
config_db = ConfigDBConnector()
config_db.connect(wait_for_init=False)
config_db.set_entry("TEST_PORT", "Ethernet111", {"alias": "etp1x"})
config_db.set_entry("PORT", "Ethernet111", {"alias": "etp1x"})
client = config_db.get_redis_client(config_db.CONFIG_DB)

assert ConfigDBConnector.INIT_INDICATOR == "CONFIG_DB_INITIALIZED"
Expand Down Expand Up @@ -585,7 +595,7 @@ def test_multidb_ConfigDBConnector():


def test_ConfigDBSubscribe():
table_name = 'TEST_TABLE'
table_name = 'PORT'
test_key = 'key1'
test_data = {'field1': 'value1'}
global output_data
Expand Down Expand Up @@ -642,9 +652,9 @@ def thread_coming_entry():
assert table_name not in config_db.handlers

def test_ConfigDBInit():
table_name_1 = 'TEST_TABLE_1'
table_name_2 = 'TEST_TABLE_2'
table_name_3 = 'TEST_TABLE_3'
table_name_1 = 'DEVICE_METADATA'
table_name_2 = 'FEATURE'
table_name_3 = 'PORT'
test_key = 'key1'
test_data = {'field1': 'value1', 'field2': 'value2'}

Expand Down Expand Up @@ -777,9 +787,9 @@ def test_ConfigDBWaitInit():
config_db = ConfigDBConnector()
config_db.db_connect(config_db.CONFIG_DB, True, False)

config_db.set_entry("TEST_PORT", "Ethernet111", {"alias": "etp1x"})
config_db.set_entry("PORT", "Ethernet111", {"alias": "etp1x"})
allconfig = config_db.get_config()
assert allconfig["TEST_PORT"]["Ethernet111"]["alias"] == "etp1x"
assert allconfig["PORT"]["Ethernet111"]["alias"] == "etp1x"


def test_ConfigDBConnector():
Expand All @@ -795,20 +805,20 @@ def test_ConfigDBConnector():
allconfig = config_db.get_config()
for i in range(1, 1001, 1):
# Make sure we have enough entries to trigger REDIS_SCAN_BATCH_SIZE
allconfig.setdefault("PORT_TABLE", {}).setdefault("Ethernet{}".format(i), {})
allconfig["PORT_TABLE"]["Ethernet{}".format(i)]["alias"] = "etp{}x".format(i)
allconfig.setdefault("PORT", {}).setdefault("Ethernet{}".format(i), {})
allconfig["PORT"]["Ethernet{}".format(i)]["alias"] = "etp{}x".format(i)

config_db.mod_config(allconfig)
allconfig = config_db.get_config()
assert len(allconfig["PORT_TABLE"]) == 1000
assert len(allconfig["PORT"]) == 1000

# Verify modify config with {} will no action
config_db.mod_config({'PORT_TABLE':{}})
config_db.mod_config({'PORT':{}})
allconfig = config_db.get_config()
assert len(allconfig["PORT_TABLE"]) == 1000
assert len(allconfig["PORT"]) == 1000

# Verify modify config with None will delete table
allconfig["PORT_TABLE"] = None
allconfig["PORT"] = None
config_db.mod_config(allconfig)
allconfig = config_db.get_config()
assert len(allconfig) == 0
Expand All @@ -824,9 +834,9 @@ def test_ConfigDBConnector_with_statement(self):
assert config_db.db_name == "CONFIG_DB"
assert config_db.TABLE_NAME_SEPARATOR == "|"
config_db.get_redis_client(config_db.CONFIG_DB).flushdb()
config_db.set_entry("TEST_PORT", "Ethernet111", {"alias": "etp1x"})
config_db.set_entry("PORT", "Ethernet111", {"alias": "etp1x"})
allconfig = config_db.get_config()
assert allconfig["TEST_PORT"]["Ethernet111"]["alias"] == "etp1x"
assert allconfig["PORT"]["Ethernet111"]["alias"] == "etp1x"

# check close() method called by with statement
ConfigDBConnector.close.assert_called_once_with()
Expand Down
Loading