[CORD-2809] Synchronizer OLTDevice in VOLTHA

Change-Id: Ie4f2e10efd035e3fcb6066e5f7bd859179fa2fea
diff --git a/xos/synchronizer/steps/test_sync_olt_device.py b/xos/synchronizer/steps/test_sync_olt_device.py
new file mode 100644
index 0000000..4163e32
--- /dev/null
+++ b/xos/synchronizer/steps/test_sync_olt_device.py
@@ -0,0 +1,188 @@
+# 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 requests_mock
+
+import os, sys
+
+# Hack to load synchronizer framework
+test_path=os.path.abspath(os.path.dirname(os.path.realpath(__file__)))
+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")
+sys.path.append(xos_dir)
+sys.path.append(os.path.join(xos_dir, 'synchronizers', 'new_base'))
+# END Hack to load synchronizer framework
+
+# Setting up the config module
+from xosconfig import Config
+config = os.path.join(test_path, "../model_policies/test_config.yaml")
+Config.clear()
+Config.init(config, "synchronizer-config-schema.yaml")
+# END Setting up the config module
+
+from sync_olt_device import SyncOLTDevice
+
+class TestSyncOLTDevice(unittest.TestCase):
+
+    def setUp(self):
+        # create a mock service instance
+        o = Mock()
+        o.volt_service.voltha_url = "voltha_url"
+        o.volt_service.voltha_user = "voltha_user"
+        o.volt_service.voltha_pass = "voltha_pass"
+        o.volt_service.p_onos_url = "p_onos_url"
+        o.volt_service.p_onos_user = "p_onos_user"
+        o.volt_service.p_onos_pass = "p_onos_pass"
+
+        o.device_type = "ponsim_olt"
+        o.host = "172.17.0.1"
+        o.port = "50060"
+        o.uplink = "129"
+        o.vlan = "3"
+        o.driver = "pmc-olt"
+
+        o.tologdict.return_value = {'name': "Mock VOLTServiceInstance"}
+
+        o.save.return_value = "Saved"
+
+        self.o = o
+
+    def tearDown(self):
+        self.o = None
+
+    def test_format_url(self):
+        url = SyncOLTDevice.format_url("onf.com")
+        self.assertEqual(url, "http://onf.com")
+        url = SyncOLTDevice.format_url("http://onf.com")
+        self.assertEqual(url, "http://onf.com")
+
+    def test_get_voltha_info(self):
+        voltha_dict = SyncOLTDevice.get_voltha_info(self.o)
+
+        self.assertEqual(voltha_dict["url"], "http://voltha_url")
+        self.assertEqual(voltha_dict["user"], "voltha_user")
+        self.assertEqual(voltha_dict["pass"], "voltha_pass")
+
+    def test_get_onos_info(self):
+        p_onos_dict = SyncOLTDevice.get_p_onos_info(self.o)
+
+        self.assertEqual(p_onos_dict["url"], "http://p_onos_url")
+        self.assertEqual(p_onos_dict["user"], "p_onos_user")
+        self.assertEqual(p_onos_dict["pass"], "p_onos_pass")
+
+    @requests_mock.Mocker()
+    def test_get_of_id_from_device(self, m):
+        logical_devices = {
+            "items": [
+                {"root_device_id": "123", "id": "abc"},
+                {"root_device_id": "0001cc4974a62b87", "id": "0001000000000001"}
+            ]
+        }
+        m.get("http://voltha_url/api/v1/logical_devices", status_code=200, json=logical_devices)
+        self.o.device_id = "123"
+        of_id = SyncOLTDevice.get_of_id_from_device(self.o)
+        self.assertEqual(of_id, "abc")
+
+        with self.assertRaises(Exception) as e:
+            self.o.device_id = "idonotexist"
+            SyncOLTDevice.get_of_id_from_device(self.o)
+        self.assertEqual(e.exception.message, "Can't find a logical device for device id: idonotexist")
+
+    @requests_mock.Mocker()
+    def test_sync_record_fail_add(self, m):
+        """
+        Should print an error if we can't add the device in VOLTHA
+        """
+        m.post("http://voltha_url/api/v1/devices", status_code=500, text="MockError")
+
+        with self.assertRaises(Exception) as e:
+            SyncOLTDevice().sync_record(self.o)
+        self.assertEqual(e.exception.message, "Failed to add device: MockError")
+
+    @requests_mock.Mocker()
+    def test_sync_record_fail_no_id(self, m):
+        """
+        Should print an error if VOLTHA does not return the device id
+        """
+        m.post("http://voltha_url/api/v1/devices", status_code=200, json={"id": ""})
+
+        with self.assertRaises(Exception) as e:
+            SyncOLTDevice().sync_record(self.o)
+        self.assertEqual(e.exception.message, "VOLTHA Device Id is empty, this probably means that the device is already provisioned in VOLTHA")
+
+    @requests_mock.Mocker()
+    def test_sync_record_fail_enable(self, m):
+        """
+        Should print an error if device.enable fails
+        """
+        m.post("http://voltha_url/api/v1/devices", status_code=200, json={"id": "123"})
+        m.post("http://voltha_url/api/v1/devices/123/enable", status_code=500, text="EnableError")
+
+        with self.assertRaises(Exception) as e:
+            SyncOLTDevice().sync_record(self.o)
+        self.assertEqual(e.exception.message, "Failed to enable device: EnableError")
+
+    @requests_mock.Mocker()
+    def test_sync_record_success(self, m):
+        """
+        If device.enable succed should fetch the state, retrieve the of_id and push it to ONOS
+        """
+        m.post("http://voltha_url/api/v1/devices", status_code=200, json={"id": "123"})
+        m.post("http://voltha_url/api/v1/devices/123/enable", status_code=200)
+        m.get("http://voltha_url/api/v1/devices/123", json={"oper_status": "ENABLED", "admin_state": "ACTIVE"})
+        logical_devices = {
+            "items": [
+                {"root_device_id": "123", "id": "abc"},
+                {"root_device_id": "0001cc4974a62b87", "id": "0001000000000001"}
+            ]
+        }
+        m.get("http://voltha_url/api/v1/logical_devices", status_code=200, json=logical_devices)
+
+        def match_onos_req(req):
+            r = req.json()['devices']
+            if not r['abc']:
+                return False
+            else:
+                if not r['abc']['basic']['driver'] == 'pmc-olt':
+                    return False
+                if not r['abc']['accessDevice']['vlan'] == "3" or not r['abc']['accessDevice']['uplink'] == "129":
+                    return False
+            return True
+
+        m.post("http://p_onos_url/onos/v1/network/configuration/", status_code=200, additional_matcher=match_onos_req, json={})
+
+        SyncOLTDevice().sync_record(self.o)
+        self.assertEqual(self.o.admin_state, "ACTIVE")
+        self.assertEqual(self.o.oper_status, "ENABLED")
+        self.assertEqual(self.o.of_id, "abc")
+        self.o.save.assert_called_once()
+
+    @requests_mock.Mocker()
+    def test_delete_record(self, m):
+        self.o.of_id = "abc"
+        self.o.device_id = "123"
+
+        m.delete("http://p_onos_url/onos/v1/network/configuration/devices/abc", status_code=200)
+        m.post("http://voltha_url/api/v1/devices/123/disable", status_code=200)
+        m.delete("http://voltha_url/api/v1/devices/123/delete", status_code=200)
+
+        SyncOLTDevice().delete_record(self.o)
+
+        # we don't need to assert here, if there are no exceptions it succeded
+
+if __name__ == "__main__":
+    unittest.main()
\ No newline at end of file