SEBA-107 New modeling of whitelist
Change-Id: Ic1912685fb72b8d29e031735a963e9e4a21c97e5
diff --git a/xos/synchronizer/model_policies/model_policy_hippieossservice.py b/xos/synchronizer/model_policies/model_policy_hippieossservice.py
index 3559d88..48fad25 100644
--- a/xos/synchronizer/model_policies/model_policy_hippieossservice.py
+++ b/xos/synchronizer/model_policies/model_policy_hippieossservice.py
@@ -25,7 +25,10 @@
sis = HippieOSSServiceInstance.objects.all()
- whitelist = [x.strip() for x in service.whitelist.split(',')]
+ # TODO(smbaker): This is redudant with HippieOSSWhiteListEntry model policy, though etaining this does provide
+ # a handy way to trigger a full reexamination of the whitelist.
+
+ whitelist = [x.serial_number for x in service.whitelist_entries.all()]
for si in sis:
if si.serial_number in whitelist and not si.valid == "valid":
diff --git a/xos/synchronizer/model_policies/model_policy_hippieosswhitelistentry.py b/xos/synchronizer/model_policies/model_policy_hippieosswhitelistentry.py
new file mode 100644
index 0000000..5b2d29a
--- /dev/null
+++ b/xos/synchronizer/model_policies/model_policy_hippieosswhitelistentry.py
@@ -0,0 +1,59 @@
+
+# Copyright 2017-present Open Networking Foundation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+from synchronizers.new_base.modelaccessor import HippieOSSServiceInstance, HippieOSSWhiteListEntry, model_accessor
+from synchronizers.new_base.policy import Policy
+
+class OSSWhiteListEntryPolicy(Policy):
+ model_name = "HippieOSSWhiteListEntry"
+
+ def handle_create(self, whitelist):
+ self.handle_update(whitelist)
+
+ def handle_update(self, whitelist):
+ self.logger.debug("MODEL_POLICY: handle_update for HippieOSSWhiteListEntry", whitelist=whitelist)
+
+ sis = HippieOSSServiceInstance.objects.filter(serial_number = whitelist.serial_number,
+ owner_id = whitelist.owner.id)
+
+ for si in sis:
+ if si.valid != "valid":
+ self.logger.debug("MODEL_POLICY: activating HippieOSSServiceInstance because of change in the whitelist", si=si)
+ si.valid = "valid"
+ si.save(update_fields=["valid", "no_sync", "updated"], always_update_timestamp=True)
+
+ whitelist.backend_need_delete_policy=True
+ whitelist.save(update_fields=["backend_need_delete_policy"])
+
+ def handle_delete(self, whitelist):
+ self.logger.debug("MODEL_POLICY: handle_delete for HippieOSSWhiteListEntry", whitelist=whitelist)
+
+ # BUG: Sometimes the delete policy is not called, because the reaper deletes
+
+ assert(whitelist.owner)
+
+ sis = HippieOSSServiceInstance.objects.filter(serial_number = whitelist.serial_number,
+ owner_id = whitelist.owner.id)
+
+ for si in sis:
+ if si.valid != "invalid":
+ self.logger.debug(
+ "MODEL_POLICY: disabling HippieOSSServiceInstance because of change in the whitelist", si=si)
+ si.valid = "invalid"
+ si.save(update_fields=["valid", "no_sync", "updated"], always_update_timestamp=True)
+
+ whitelist.backend_need_reap=True
+ whitelist.save(update_fields=["backend_need_reap"])
diff --git a/xos/synchronizer/model_policies/test_model_policy_hippieossservice.py b/xos/synchronizer/model_policies/test_model_policy_hippieossservice.py
index 7c5a598..838cc6c 100644
--- a/xos/synchronizer/model_policies/test_model_policy_hippieossservice.py
+++ b/xos/synchronizer/model_policies/test_model_policy_hippieossservice.py
@@ -34,7 +34,6 @@
class TestModelPolicyHippieOssService(unittest.TestCase):
def setUp(self):
-
self.sys_path_save = sys.path
sys.path.append(xos_dir)
sys.path.append(os.path.join(xos_dir, 'synchronizers', 'new_base'))
@@ -55,6 +54,7 @@
from model_policy_hippieossservice import OSSServicePolicy, model_accessor
from mock_modelaccessor import MockObjectList
+ self.MockObjectList = MockObjectList
# import all class names to globals
for (k, v) in model_accessor.all_model_classes.items():
@@ -67,7 +67,8 @@
self.policy = OSSServicePolicy()
self.service = HippieOSSService(
- whitelist="BRCM111, BRCM222"
+ id = 5367,
+ whitelist_entries = [],
)
# needs to be enabled
@@ -109,6 +110,10 @@
patch.object(self.si4, "save") as si4_save:
oss_si.return_value = [self.si1, self.si2, self.si3, self.si4]
+ wle1 = HippieOSSWhiteListEntry(owner_id=self.service.id, serial_number="BRCM111")
+ wle2 = HippieOSSWhiteListEntry(owner_id=self.service.id, serial_number="BRCM222")
+ self.service.whitelist_entries = self.MockObjectList([wle1, wle2])
+
self.policy.handle_update(self.service)
self.si1.save.assert_called_with(always_update_timestamp=True, update_fields=['valid', 'no_sync', 'updated'])
diff --git a/xos/synchronizer/model_policies/test_model_policy_hippieosswhitelistentry.py b/xos/synchronizer/model_policies/test_model_policy_hippieosswhitelistentry.py
new file mode 100644
index 0000000..f96c759
--- /dev/null
+++ b/xos/synchronizer/model_policies/test_model_policy_hippieosswhitelistentry.py
@@ -0,0 +1,106 @@
+
+# Copyright 2017-present Open Networking Foundation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+import unittest
+from mock import patch, call, Mock, PropertyMock
+
+import os, sys
+
+test_path=os.path.abspath(os.path.dirname(os.path.realpath(__file__)))
+service_dir=os.path.join(test_path, "../../../..")
+xos_dir=os.path.join(test_path, "../../..")
+if not os.path.exists(os.path.join(test_path, "new_base")):
+ xos_dir=os.path.join(test_path, "../../../../../../orchestration/xos/xos")
+ services_dir=os.path.join(xos_dir, "../../xos_services")
+
+def get_models_fn(service_name, xproto_name):
+ name = os.path.join(service_name, "xos", "synchronizer", "models", xproto_name)
+ if os.path.exists(os.path.join(services_dir, name)):
+ return name
+ raise Exception("Unable to find service=%s xproto=%s" % (service_name, xproto_name))
+
+class TestModelPolicyHippieOssWhiteListEntry(unittest.TestCase):
+ def setUp(self):
+ self.sys_path_save = sys.path
+ sys.path.append(xos_dir)
+ sys.path.append(os.path.join(xos_dir, 'synchronizers', 'new_base'))
+
+ config = os.path.join(test_path, "../test_config.yaml")
+ from xosconfig import Config
+ Config.clear()
+ Config.init(config, 'synchronizer-config-schema.yaml')
+
+ from synchronizers.new_base.mock_modelaccessor_build import build_mock_modelaccessor
+ build_mock_modelaccessor(xos_dir, services_dir, [
+ get_models_fn("hippie-oss", "hippie-oss.xproto"),
+ get_models_fn("olt-service", "volt.xproto"),
+ get_models_fn("../profiles/rcord", "rcord.xproto")
+ ])
+
+ import synchronizers.new_base.modelaccessor
+ from model_policy_hippieosswhitelistentry import OSSWhiteListEntryPolicy, model_accessor
+
+ from mock_modelaccessor import MockObjectList
+ self.MockObjectList = MockObjectList
+
+ # import all class names to globals
+ for (k, v) in model_accessor.all_model_classes.items():
+ globals()[k] = v
+
+ # Some of the functions we call have side-effects. For example, creating a VSGServiceInstance may lead to creation of
+ # tags. Ideally, this wouldn't happen, but it does. So make sure we reset the world.
+ model_accessor.reset_all_object_stores()
+
+ self.policy = OSSWhiteListEntryPolicy()
+
+ self.service = HippieOSSService()
+
+
+ def tearDown(self):
+ sys.path = self.sys_path_save
+ self.service = None
+
+ def test_whitelist_update(self):
+ """
+ When a whitelist entry is added, see that the HippieOSSServiceInstance was set to valid
+ """
+ with patch.object(HippieOSSServiceInstance.objects, "get_items") as oss_si_items:
+ si = HippieOSSServiceInstance(serial_number="BRCM333", owner_id=self.service.id, valid="invalid")
+ oss_si_items.return_value = [si]
+
+ wle = HippieOSSWhiteListEntry(serial_number="BRCM333", owner_id=self.service.id, owner=self.service)
+
+ self.policy.handle_update(wle)
+
+ self.assertEqual(si.valid, "valid")
+
+ def test_whitelist_delete(self):
+ """
+ When a whitelist entry is deleted, see that the HippieOSSServiceInstance was set to invalid
+ """
+ with patch.object(HippieOSSServiceInstance.objects, "get_items") as oss_si_items:
+ si = HippieOSSServiceInstance(serial_number="BRCM333", owner_id=self.service.id, valid="valid")
+ oss_si_items.return_value = [si]
+
+ wle = HippieOSSWhiteListEntry(serial_number="BRCM333", owner_id=self.service.id, owner=self.service)
+
+ self.policy.handle_delete(wle)
+
+ self.assertEqual(si.valid, "invalid")
+
+if __name__ == '__main__':
+ unittest.main()
+