CORD-2340 volt service unit tests

Change-Id: I78b35b0e577ac2200e68eab9d550563239e7e648
(cherry picked from commit 48aeaed51c1b26ebdae1d9e3584001891e75a7d7)
diff --git a/xos/synchronizer/model_policies/test_model_policy_volttenant.py b/xos/synchronizer/model_policies/test_model_policy_volttenant.py
new file mode 100644
index 0000000..d3a2b42
--- /dev/null
+++ b/xos/synchronizer/model_policies/test_model_policy_volttenant.py
@@ -0,0 +1,212 @@
+
+# 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 mock
+
+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")
+
+class TestModelPolicyVOLTTenant(unittest.TestCase):
+    def setUp(self):
+        global VOLTTenantPolicy, MockObjectList
+
+        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, ["olt-service/xos/volt.xproto", "vsg/xos/vsg.xproto", "../profiles/rcord/xos/rcord.xproto"])
+
+        import synchronizers.new_base.modelaccessor
+        import model_policy_volttenant
+        from model_policy_volttenant import VOLTTenantPolicy, model_accessor
+
+        from mock_modelaccessor import 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 = VOLTTenantPolicy()
+        self.tenant = VOLTTenant(s_tag=111, c_tag=222, service_specific_id=1234)
+
+        self.vsg_service = VSGService(name="the vsg service")
+
+    def tearDown(self):
+        sys.path = self.sys_path_save
+
+    def test_handle_create(self):
+        with patch.object(VOLTTenantPolicy, "manage_vsg") as manage_vsg, \
+                patch.object(VOLTTenantPolicy, "manage_subscriber") as manage_subscriber, \
+                patch.object(VOLTTenantPolicy, "cleanup_orphans") as cleanup_orphans:
+            self.policy.handle_create(self.tenant)
+            manage_subscriber.assert_called_with(self.tenant)
+            manage_vsg.assert_called_with(self.tenant)
+            cleanup_orphans.assert_called_with(self.tenant)
+
+    def test_manage_vsg(self):
+        with patch.object(VOLTTenantPolicy, "get_current_vsg") as get_current_vsg, \
+                patch.object(VOLTTenantPolicy, "create_vsg") as create_vsg, \
+                patch.object(VSGService.objects, "get_items") as vsg_items:
+
+            vsg_items.return_value = [self.vsg_service]
+            get_current_vsg.return_value = None
+            self.policy.manage_vsg(self.tenant)
+
+            create_vsg.assert_called()
+
+    def test_get_current_vsg(self):
+        with patch.object(ServiceInstanceLink.objects, "get_items") as link_items:
+            vsg = VSGServiceInstance()
+            link = ServiceInstanceLink(provider_service_instance=vsg, subscriber_service_instance_id=self.tenant.id)
+
+            link_items.return_value = [link]
+
+            vsg = self.policy.get_current_vsg(self.tenant)
+
+            self.assertNotEqual(vsg, None)
+
+    def test_get_current_vsg_noexist(self):
+        vsg = self.policy.get_current_vsg(self.tenant)
+
+        self.assertEqual(vsg, None)
+
+    def test_create_vsg(self):
+        with patch.object(VSGService.objects, "get_items") as vsg_items, \
+                patch.object(ServiceInstanceLink, "save", autospec=True) as save_link, \
+                patch.object(VSGServiceInstance, "save", autospec=True) as save_vsg:
+
+            vsg_items.return_value = [self.vsg_service]
+            self.policy.create_vsg(self.tenant)
+
+            # Should have created a vsg
+
+            self.assertEqual(save_vsg.call_count, 1)
+            vsg = save_vsg.call_args[0][0]
+            self.assertEqual(vsg.creator, self.tenant.creator)
+
+            # Should have created a link from OLT to vsg
+
+            self.assertEqual(save_link.call_count, 1)
+            link = save_link.call_args[0][0]
+            self.assertEqual(link.provider_service_instance, vsg)
+            self.assertEqual(link.subscriber_service_instance, self.tenant)
+
+    def test_manage_subscriber(self):
+        with patch.object(ServiceInstanceLink, "save", autospec=True) as save_link, \
+                patch.object(CordSubscriberRoot, "save", autospec=True) as save_csr:
+
+            self.tenant.provided_links = MockObjectList()
+
+            self.policy.manage_subscriber(self.tenant)
+
+            self.assertEqual(save_csr.call_count, 1)
+            csr = save_csr.call_args[0][0]
+
+            self.assertEqual(save_link.call_count, 1)
+            link = save_link.call_args[0][0]
+            self.assertEqual(link.provider_service_instance, self.tenant)
+            self.assertEqual(link.subscriber_service_instance, csr)
+
+    def test_manage_subscriber_exists(self):
+        with patch.object(ServiceInstanceLink, "save", autospec=True) as save_link, \
+                patch.object(CordSubscriberRoot, "save", autospec=True) as save_csr, \
+                patch.object(CordSubscriberRoot.objects, "get_items") as csr_items, \
+                patch.object(ServiceInstanceLink.objects, "get_items") as link_items:
+            self.tenant.provided_links = MockObjectList()
+
+            subscriber = CordSubscriberRoot(service_specific_id=1234)
+            csr_items.return_value = [subscriber]
+
+            link = ServiceInstanceLink(provider_service_instance= self.tenant, subscriber_service_instance = subscriber)
+            link_items.return_value = [link]
+
+            self.tenant.provided_links = MockObjectList(initial=[link])
+
+            self.policy.manage_subscriber(self.tenant)
+
+            self.assertEqual(save_csr.call_count, 0)
+            self.assertEqual(save_link.call_count, 0)
+
+    def test_manage_subscriber_exists_nolink(self):
+        with patch.object(ServiceInstanceLink, "save", autospec=True) as save_link, \
+                patch.object(CordSubscriberRoot, "save", autospec=True) as save_csr, \
+                patch.object(CordSubscriberRoot.objects, "get_items") as csr_items, \
+                patch.object(ServiceInstanceLink.objects, "get_items") as link_items:
+            self.tenant.provided_links = MockObjectList()
+
+            subscriber = CordSubscriberRoot(service_specific_id=1234)
+            csr_items.return_value = [subscriber]
+
+            self.tenant.provided_links = MockObjectList()
+
+            self.policy.manage_subscriber(self.tenant)
+
+            self.assertEqual(save_csr.call_count, 0)
+
+            self.assertEqual(save_link.call_count, 1)
+            link = save_link.call_args[0][0]
+            self.assertEqual(link.provider_service_instance, self.tenant)
+            self.assertEqual(link.subscriber_service_instance, subscriber)
+
+    def test_handle_delete(self):
+        self.policy.handle_delete(self.tenant)
+        # handle delete does nothing, and should trivially succeed
+
+    def test_cleanup_orphans(self):
+        with patch.object(ServiceInstanceLink, "delete", autospec=True) as delete_link, \
+                patch.object(VSGServiceInstance.objects, "get_items") as vsg_si_items, \
+                patch.object(ServiceInstanceLink.objects, "get_items") as link_items:
+
+            vsg1 = VSGServiceInstance(id=123)
+            vsg2 = VSGServiceInstance(id=456)
+            link1 = ServiceInstanceLink(provider_service_instance=vsg1, provider_service_instance_id=vsg1.id,
+                                        subscriber_service_instance=self.tenant, subscriber_service_instance_id=self.tenant.id)
+            link2 = ServiceInstanceLink(provider_service_instance=vsg2, provider_service_instance_id=vsg2.id,
+                                        subscriber_service_instance=self.tenant, subscriber_service_instance_id=self.tenant.id)
+
+            self.tenant.subscribed_links=MockObjectList(initial=[link1,link2])
+
+            vsg_si_items.return_value = [vsg1, vsg2]
+            link_items.return_value = [link1, link2]
+
+            self.policy.cleanup_orphans(self.tenant)
+
+            # Since there are two VSGs linked to this VOLT, cleanup_orphans() will have caused one of them to be
+            # deleted.
+
+            self.assertEqual(delete_link.call_count, 1)
+
+if __name__ == '__main__':
+    unittest.main()
+