blob: 4700b05e2ca74fee59597081b2e31b7469623165 [file] [log] [blame]
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -08001# Copyright 2017-present Open Networking Foundation
2#
3# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
6#
7# http://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14
15import unittest
Matteo Scandolo2ed64b92018-06-18 10:32:56 -070016import functools
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -080017from mock import patch, call, Mock, PropertyMock
18import requests_mock
19
20import os, sys
21
22# Hack to load synchronizer framework
23test_path=os.path.abspath(os.path.dirname(os.path.realpath(__file__)))
24xos_dir=os.path.join(test_path, "../../..")
25if not os.path.exists(os.path.join(test_path, "new_base")):
26 xos_dir=os.path.join(test_path, "../../../../../../orchestration/xos/xos")
Matteo Scandoloce27e9c2018-04-06 10:06:53 -070027 services_dir = os.path.join(xos_dir, "../../xos_services")
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -080028sys.path.append(xos_dir)
29sys.path.append(os.path.join(xos_dir, 'synchronizers', 'new_base'))
Luca Preteca974c82018-05-01 18:06:16 -070030# END of hack to load synchronizer framework
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -080031
Luca Preteca974c82018-05-01 18:06:16 -070032# Generate model from xproto
Matteo Scandoloce27e9c2018-04-06 10:06:53 -070033def get_models_fn(service_name, xproto_name):
34 name = os.path.join(service_name, "xos", xproto_name)
35 if os.path.exists(os.path.join(services_dir, name)):
36 return name
37 else:
38 name = os.path.join(service_name, "xos", "synchronizer", "models", xproto_name)
39 if os.path.exists(os.path.join(services_dir, name)):
40 return name
41 raise Exception("Unable to find service=%s xproto=%s" % (service_name, xproto_name))
42# END generate model from xproto
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -080043
Matteo Scandolob8621cd2018-04-04 17:12:37 -070044def match_onos_req(req):
Luca Preteca974c82018-05-01 18:06:16 -070045 request = req.json()['devices']
46 if not request['of:0000000ce2314000']:
Matteo Scandolob8621cd2018-04-04 17:12:37 -070047 return False
48 else:
Luca Preteca974c82018-05-01 18:06:16 -070049 if not request['of:0000000ce2314000']['basic']['driver'] == 'pmc-olt':
Matteo Scandolob8621cd2018-04-04 17:12:37 -070050 return False
Luca Preteca974c82018-05-01 18:06:16 -070051 if not request['of:0000000ce2314000']['accessDevice']['vlan'] == "s_tag" or not request['of:0000000ce2314000']['accessDevice']['uplink'] == "129":
Matteo Scandolob8621cd2018-04-04 17:12:37 -070052 return False
53 return True
54
Matteo Scandolo2ed64b92018-06-18 10:32:56 -070055def match_json(desired, req):
56 if desired!=req.json():
57 raise Exception("Got request %s, but body is not matching" % req.url)
58 return False
59 return True
60
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -080061class TestSyncOLTDevice(unittest.TestCase):
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -080062 def setUp(self):
Matteo Scandolo6be6ee92018-05-24 15:07:51 -070063 global DeferredException
Matteo Scandoloce27e9c2018-04-06 10:06:53 -070064 self.sys_path_save = sys.path
65 sys.path.append(xos_dir)
66 sys.path.append(os.path.join(xos_dir, 'synchronizers', 'new_base'))
67
68 # Setting up the config module
69 from xosconfig import Config
70 config = os.path.join(test_path, "../model_policies/test_config.yaml")
71 Config.clear()
72 Config.init(config, "synchronizer-config-schema.yaml")
Luca Preteca974c82018-05-01 18:06:16 -070073 # END setting up the config module
Matteo Scandoloce27e9c2018-04-06 10:06:53 -070074
75 from synchronizers.new_base.mock_modelaccessor_build import build_mock_modelaccessor
Matteo Scandolo19466a02018-05-16 17:43:39 -070076 # build_mock_modelaccessor(xos_dir, services_dir, [get_models_fn("olt-service", "volt.xproto")])
77
78 # FIXME this is to get jenkins to pass the tests, somehow it is running tests in a different order
79 # and apparently it is not overriding the generated model accessor
80 build_mock_modelaccessor(xos_dir, services_dir, [get_models_fn("olt-service", "volt.xproto"),
81 get_models_fn("vsg", "vsg.xproto"),
82 get_models_fn("../profiles/rcord", "rcord.xproto")])
83
Matteo Scandoloce27e9c2018-04-06 10:06:53 -070084 import synchronizers.new_base.modelaccessor
Matteo Scandolo6be6ee92018-05-24 15:07:51 -070085 from sync_olt_device import SyncOLTDevice, DeferredException
Matteo Scandoloce27e9c2018-04-06 10:06:53 -070086 self.sync_step = SyncOLTDevice
87
Matteo Scandolob8621cd2018-04-04 17:12:37 -070088 pon_port = Mock()
89 pon_port.port_id = "00ff00"
90 pon_port.s_tag = "s_tag"
91
Matteo Scandolo2ed64b92018-06-18 10:32:56 -070092 # Create a mock OLTDevice
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -080093 o = Mock()
94 o.volt_service.voltha_url = "voltha_url"
Luca Preteca974c82018-05-01 18:06:16 -070095 o.volt_service.voltha_port = 1234
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -080096 o.volt_service.voltha_user = "voltha_user"
97 o.volt_service.voltha_pass = "voltha_pass"
Luca Preteca974c82018-05-01 18:06:16 -070098 o.volt_service.onos_voltha_url = "onos_voltha_url"
99 o.volt_service.onos_voltha_port = 4321
100 o.volt_service.onos_voltha_user = "onos_voltha_user"
101 o.volt_service.onos_voltha_pass = "onos_voltha_pass"
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800102
103 o.device_type = "ponsim_olt"
104 o.host = "172.17.0.1"
105 o.port = "50060"
106 o.uplink = "129"
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800107 o.driver = "pmc-olt"
108
Matteo Scandolob8621cd2018-04-04 17:12:37 -0700109 # feedback state
110 o.device_id = None
111 o.admin_state = None
112 o.oper_status = None
113 o.of_id = None
Matteo Scandolo096a3cf2018-06-20 13:56:13 -0700114 o.id = 1
Matteo Scandolob8621cd2018-04-04 17:12:37 -0700115
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800116 o.tologdict.return_value = {'name': "Mock VOLTServiceInstance"}
117
118 o.save.return_value = "Saved"
119
Matteo Scandolo6be6ee92018-05-24 15:07:51 -0700120 o.pon_ports.all.return_value = [pon_port]
Matteo Scandolob8621cd2018-04-04 17:12:37 -0700121
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800122 self.o = o
123
124 def tearDown(self):
125 self.o = None
Matteo Scandoloce27e9c2018-04-06 10:06:53 -0700126 sys.path = self.sys_path_save
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800127
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800128 @requests_mock.Mocker()
129 def test_get_of_id_from_device(self, m):
130 logical_devices = {
131 "items": [
Matteo Scandolof6337eb2018-04-05 15:58:37 -0700132 {"root_device_id": "123", "id": "0001000ce2314000", "datapath_id": "55334486016"},
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800133 {"root_device_id": "0001cc4974a62b87", "id": "0001000000000001"}
134 ]
135 }
Luca Preteca974c82018-05-01 18:06:16 -0700136 m.get("http://voltha_url:1234/api/v1/logical_devices", status_code=200, json=logical_devices)
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800137 self.o.device_id = "123"
Matteo Scandolof6337eb2018-04-05 15:58:37 -0700138 self.o = self.sync_step.get_ids_from_logical_device(self.o)
139 self.assertEqual(self.o.of_id, "0001000ce2314000")
140 self.assertEqual(self.o.dp_id, "of:0000000ce2314000")
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800141
142 with self.assertRaises(Exception) as e:
143 self.o.device_id = "idonotexist"
Matteo Scandolof6337eb2018-04-05 15:58:37 -0700144 self.sync_step.get_ids_from_logical_device(self.o)
Matteo Scandolo2c144932018-05-04 14:06:24 -0700145 self.assertEqual(e.exception.message, "Can't find a logical_device for OLT device id: idonotexist")
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800146
147 @requests_mock.Mocker()
148 def test_sync_record_fail_add(self, m):
149 """
150 Should print an error if we can't add the device in VOLTHA
151 """
Luca Preteca974c82018-05-01 18:06:16 -0700152 m.post("http://voltha_url:1234/api/v1/devices", status_code=500, text="MockError")
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800153
154 with self.assertRaises(Exception) as e:
Matteo Scandoloce27e9c2018-04-06 10:06:53 -0700155 self.sync_step().sync_record(self.o)
Matteo Scandolo2c144932018-05-04 14:06:24 -0700156 self.assertEqual(e.exception.message, "Failed to add OLT device: MockError")
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800157
158 @requests_mock.Mocker()
159 def test_sync_record_fail_no_id(self, m):
160 """
161 Should print an error if VOLTHA does not return the device id
162 """
Luca Preteca974c82018-05-01 18:06:16 -0700163 m.post("http://voltha_url:1234/api/v1/devices", status_code=200, json={"id": ""})
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800164
165 with self.assertRaises(Exception) as e:
Matteo Scandoloce27e9c2018-04-06 10:06:53 -0700166 self.sync_step().sync_record(self.o)
Matteo Scandolo2c144932018-05-04 14:06:24 -0700167 self.assertEqual(e.exception.message, "VOLTHA Device Id is empty. This probably means that the OLT device is already provisioned in VOLTHA")
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800168
169 @requests_mock.Mocker()
170 def test_sync_record_fail_enable(self, m):
171 """
172 Should print an error if device.enable fails
173 """
Luca Preteca974c82018-05-01 18:06:16 -0700174 m.post("http://voltha_url:1234/api/v1/devices", status_code=200, json={"id": "123"})
175 m.post("http://voltha_url:1234/api/v1/devices/123/enable", status_code=500, text="EnableError")
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800176
177 with self.assertRaises(Exception) as e:
Matteo Scandoloce27e9c2018-04-06 10:06:53 -0700178 self.sync_step().sync_record(self.o)
Matteo Scandolo2c144932018-05-04 14:06:24 -0700179
180 self.assertEqual(e.exception.message, "Failed to enable OLT device: EnableError")
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800181
182 @requests_mock.Mocker()
183 def test_sync_record_success(self, m):
184 """
185 If device.enable succed should fetch the state, retrieve the of_id and push it to ONOS
186 """
Matteo Scandolo2ed64b92018-06-18 10:32:56 -0700187
188 expected_conf = {
189 "type": self.o.device_type,
190 "host_and_port": "%s:%s" % (self.o.host, self.o.port)
191 }
192
193 m.post("http://voltha_url:1234/api/v1/devices", status_code=200, json={"id": "123"}, additional_matcher=functools.partial(match_json, expected_conf))
Luca Preteca974c82018-05-01 18:06:16 -0700194 m.post("http://voltha_url:1234/api/v1/devices/123/enable", status_code=200)
Matteo Scandolo096a3cf2018-06-20 13:56:13 -0700195 m.get("http://voltha_url:1234/api/v1/devices/123", json={"oper_status": "ACTIVE", "admin_state": "ENABLED"})
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800196 logical_devices = {
197 "items": [
Matteo Scandolof6337eb2018-04-05 15:58:37 -0700198 {"root_device_id": "123", "id": "0001000ce2314000", "datapath_id": "55334486016"},
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800199 {"root_device_id": "0001cc4974a62b87", "id": "0001000000000001"}
200 ]
201 }
Luca Preteca974c82018-05-01 18:06:16 -0700202 m.get("http://voltha_url:1234/api/v1/logical_devices", status_code=200, json=logical_devices)
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800203
Luca Preteca974c82018-05-01 18:06:16 -0700204 m.post("http://onos_voltha_url:4321/onos/v1/network/configuration/", status_code = 200, additional_matcher=match_onos_req, json={})
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800205
Matteo Scandoloce27e9c2018-04-06 10:06:53 -0700206 self.sync_step().sync_record(self.o)
Matteo Scandolo096a3cf2018-06-20 13:56:13 -0700207 self.assertEqual(self.o.admin_state, "ENABLED")
208 self.assertEqual(self.o.oper_status, "ACTIVE")
Matteo Scandolof6337eb2018-04-05 15:58:37 -0700209 self.assertEqual(self.o.of_id, "0001000ce2314000")
Matteo Scandolo096a3cf2018-06-20 13:56:13 -0700210 self.assertEqual(self.o.save.call_count, 2) # we're updating the backend_status when activating and then adding logical device ids
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800211
212 @requests_mock.Mocker()
Matteo Scandolo2ed64b92018-06-18 10:32:56 -0700213 def test_sync_record_success_mac_address(self, m):
214 """
215 A device should be pre-provisioned via mac_address, the the process is the same
216 """
217
218 del self.o.host
219 del self.o.port
220 self.o.mac_address = "00:0c:e2:31:40:00"
221
222 expected_conf = {
223 "type": self.o.device_type,
224 "mac_address": self.o.mac_address
225 }
226
227 m.post("http://voltha_url:1234/api/v1/devices", status_code=200, json={"id": "123"},
228 additional_matcher=functools.partial(match_json, expected_conf))
229 m.post("http://voltha_url:1234/api/v1/devices/123/enable", status_code=200)
Matteo Scandolo096a3cf2018-06-20 13:56:13 -0700230 m.get("http://voltha_url:1234/api/v1/devices/123", json={"oper_status": "ACTIVE", "admin_state": "ENABLED"})
Matteo Scandolo2ed64b92018-06-18 10:32:56 -0700231 logical_devices = {
232 "items": [
233 {"root_device_id": "123", "id": "0001000ce2314000", "datapath_id": "55334486016"},
234 {"root_device_id": "0001cc4974a62b87", "id": "0001000000000001"}
235 ]
236 }
237 m.get("http://voltha_url:1234/api/v1/logical_devices", status_code=200, json=logical_devices)
238
239 m.post("http://onos_voltha_url:4321/onos/v1/network/configuration/", status_code=200,
240 additional_matcher=match_onos_req, json={})
241
242 self.sync_step().sync_record(self.o)
Matteo Scandolo096a3cf2018-06-20 13:56:13 -0700243 self.assertEqual(self.o.admin_state, "ENABLED")
244 self.assertEqual(self.o.oper_status, "ACTIVE")
Matteo Scandolo2ed64b92018-06-18 10:32:56 -0700245 self.assertEqual(self.o.of_id, "0001000ce2314000")
Matteo Scandolo096a3cf2018-06-20 13:56:13 -0700246 self.assertEqual(self.o.save.call_count, 2)
247
248 @requests_mock.Mocker()
249 def test_sync_record_enable_timeout(self, m):
250 """
251 If device.enable fails we need to tell the suer
252 """
253
254 expected_conf = {
255 "type": self.o.device_type,
256 "host_and_port": "%s:%s" % (self.o.host, self.o.port)
257 }
258
259 m.post("http://voltha_url:1234/api/v1/devices", status_code=200, json={"id": "123"},
260 additional_matcher=functools.partial(match_json, expected_conf))
261 m.post("http://voltha_url:1234/api/v1/devices/123/enable", status_code=200)
262 m.get("http://voltha_url:1234/api/v1/devices/123", [
263 {"json": {"oper_status": "ACTIVATING", "admin_state": "ENABLED"}, "status_code": 200},
264 {"json": {"oper_status": "ERROR", "admin_state": "FAILED"}, "status_code": 200}
265 ])
266
267 logical_devices = {
268 "items": [
269 {"root_device_id": "123", "id": "0001000ce2314000", "datapath_id": "55334486016"},
270 {"root_device_id": "0001cc4974a62b87", "id": "0001000000000001"}
271 ]
272 }
273 m.get("http://voltha_url:1234/api/v1/logical_devices", status_code=200, json=logical_devices)
274
275 m.post("http://onos_voltha_url:4321/onos/v1/network/configuration/", status_code=200,
276 additional_matcher=match_onos_req, json={})
277
278 with self.assertRaises(Exception) as e:
279 self.sync_step().sync_record(self.o)
280
281 self.assertEqual(e.exception.message, "It was not possible to activate OLTDevice with id 1")
282 self.assertEqual(self.o.oper_status, "ERROR")
283 self.assertEqual(self.o.admin_state, "FAILED")
284 self.assertEqual(self.o.save.call_count, 1)
Matteo Scandolo2ed64b92018-06-18 10:32:56 -0700285
286 @requests_mock.Mocker()
Matteo Scandolob8621cd2018-04-04 17:12:37 -0700287 def test_sync_record_already_existing_in_voltha(self, m):
Matteo Scandolob8621cd2018-04-04 17:12:37 -0700288 # mock device feedback state
289 self.o.device_id = "123"
Matteo Scandolo096a3cf2018-06-20 13:56:13 -0700290 self.o.admin_state = "ENABLED"
291 self.o.oper_status = "ACTIVE"
Matteo Scandolof6337eb2018-04-05 15:58:37 -0700292 self.o.dp_id = "of:0000000ce2314000"
Matteo Scandolo2c144932018-05-04 14:06:24 -0700293 self.o.of_id = "0001000ce2314000"
Matteo Scandolob8621cd2018-04-04 17:12:37 -0700294
Luca Preteca974c82018-05-01 18:06:16 -0700295 m.post("http://onos_voltha_url:4321/onos/v1/network/configuration/", status_code = 200, additional_matcher=match_onos_req, json={})
Matteo Scandolob8621cd2018-04-04 17:12:37 -0700296
297 self.sync_step().sync_record(self.o)
298 self.o.save.assert_not_called()
299
Matteo Scandolob8621cd2018-04-04 17:12:37 -0700300 @requests_mock.Mocker()
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800301 def test_delete_record(self, m):
Matteo Scandolof6337eb2018-04-05 15:58:37 -0700302 self.o.of_id = "0001000ce2314000"
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800303 self.o.device_id = "123"
304
Matteo Scandolo19466a02018-05-16 17:43:39 -0700305 m.delete("http://onos_voltha_url:4321/onos/v1/network/configuration/devices/0001000ce2314000", status_code=204)
Luca Preteca974c82018-05-01 18:06:16 -0700306 m.post("http://voltha_url:1234/api/v1/devices/123/disable", status_code=200)
307 m.delete("http://voltha_url:1234/api/v1/devices/123/delete", status_code=200)
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800308
Matteo Scandoloce27e9c2018-04-06 10:06:53 -0700309 self.sync_step().delete_record(self.o)
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800310
Luca Preteca974c82018-05-01 18:06:16 -0700311 # We don't need to assert here if there are no exceptions happening
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800312
Matteo Scandolo6be6ee92018-05-24 15:07:51 -0700313 def test_deferred_for_port(self):
314 self.o.pon_ports.all.side_effect = Exception
315 with self.assertRaises(DeferredException) as e:
316 self.sync_step().configure_onos(self.o)
317 self.assertEqual(e.exception.message, "Waiting for pon_ports to come up")
318
319 self.o.pon_ports.all.return_value = []
320 with self.assertRaises(DeferredException) as e:
321 self.sync_step().configure_onos(self.o)
322 self.assertEqual(e.exception.message, "Waiting for pon_ports to come up")
323
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800324if __name__ == "__main__":
Luca Preteca974c82018-05-01 18:06:16 -0700325 unittest.main()