blob: 38da1a139d12e9d249ba951c19e425d72d4c1fe7 [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
Scott Baker22b46c52018-11-15 15:15:29 -080015from requests import ConnectionError
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -080016import unittest
Matteo Scandolo2ed64b92018-06-18 10:32:56 -070017import functools
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -080018from mock import patch, call, Mock, PropertyMock
19import requests_mock
20
21import os, sys
22
23# Hack to load synchronizer framework
24test_path=os.path.abspath(os.path.dirname(os.path.realpath(__file__)))
25xos_dir=os.path.join(test_path, "../../..")
26if not os.path.exists(os.path.join(test_path, "new_base")):
27 xos_dir=os.path.join(test_path, "../../../../../../orchestration/xos/xos")
Matteo Scandoloce27e9c2018-04-06 10:06:53 -070028 services_dir = os.path.join(xos_dir, "../../xos_services")
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -080029sys.path.append(xos_dir)
30sys.path.append(os.path.join(xos_dir, 'synchronizers', 'new_base'))
Luca Preteca974c82018-05-01 18:06:16 -070031# END of hack to load synchronizer framework
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -080032
Luca Preteca974c82018-05-01 18:06:16 -070033# Generate model from xproto
Matteo Scandoloce27e9c2018-04-06 10:06:53 -070034def get_models_fn(service_name, xproto_name):
35 name = os.path.join(service_name, "xos", xproto_name)
36 if os.path.exists(os.path.join(services_dir, name)):
37 return name
38 else:
39 name = os.path.join(service_name, "xos", "synchronizer", "models", xproto_name)
40 if os.path.exists(os.path.join(services_dir, name)):
41 return name
42 raise Exception("Unable to find service=%s xproto=%s" % (service_name, xproto_name))
43# END generate model from xproto
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -080044
Scott Baker0bbbfd12018-12-11 07:01:06 +000045def match_onos_req(req):
46 request = req.json()['devices']
47 if not request['of:0000000ce2314000']:
48 return False
49 else:
50 if not request['of:0000000ce2314000']['basic']['driver'] == 'voltha':
51 return False
52 if not request['of:0000000ce2314000']['accessDevice']['vlan'] == 1 or not request['of:0000000ce2314000']['accessDevice']['uplink'] == "129":
53 return False
54 return True
55
Matteo Scandolo2ed64b92018-06-18 10:32:56 -070056def match_json(desired, req):
57 if desired!=req.json():
58 raise Exception("Got request %s, but body is not matching" % req.url)
59 return False
60 return True
61
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -080062class TestSyncOLTDevice(unittest.TestCase):
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -080063 def setUp(self):
Matteo Scandolo6be6ee92018-05-24 15:07:51 -070064 global DeferredException
Matteo Scandoloce27e9c2018-04-06 10:06:53 -070065 self.sys_path_save = sys.path
66 sys.path.append(xos_dir)
67 sys.path.append(os.path.join(xos_dir, 'synchronizers', 'new_base'))
68
69 # Setting up the config module
70 from xosconfig import Config
Matteo Scandolof7ebb112018-09-18 16:17:22 -070071 config = os.path.join(test_path, "../test_config.yaml")
Matteo Scandoloce27e9c2018-04-06 10:06:53 -070072 Config.clear()
73 Config.init(config, "synchronizer-config-schema.yaml")
Luca Preteca974c82018-05-01 18:06:16 -070074 # END setting up the config module
Matteo Scandoloce27e9c2018-04-06 10:06:53 -070075
76 from synchronizers.new_base.mock_modelaccessor_build import build_mock_modelaccessor
Matteo Scandolo19466a02018-05-16 17:43:39 -070077 # build_mock_modelaccessor(xos_dir, services_dir, [get_models_fn("olt-service", "volt.xproto")])
78
79 # FIXME this is to get jenkins to pass the tests, somehow it is running tests in a different order
80 # and apparently it is not overriding the generated model accessor
81 build_mock_modelaccessor(xos_dir, services_dir, [get_models_fn("olt-service", "volt.xproto"),
82 get_models_fn("vsg", "vsg.xproto"),
83 get_models_fn("../profiles/rcord", "rcord.xproto")])
84
Matteo Scandoloce27e9c2018-04-06 10:06:53 -070085 import synchronizers.new_base.modelaccessor
Matteo Scandolo6be6ee92018-05-24 15:07:51 -070086 from sync_olt_device import SyncOLTDevice, DeferredException
Matteo Scandoloce27e9c2018-04-06 10:06:53 -070087 self.sync_step = SyncOLTDevice
88
Matteo Scandolob8621cd2018-04-04 17:12:37 -070089 pon_port = Mock()
90 pon_port.port_id = "00ff00"
Matteo Scandolob8621cd2018-04-04 17:12:37 -070091
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"
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -080098
Matteo Scandoloa79395f2018-10-08 13:34:49 -070099 o.volt_service.onos_voltha_port = 4321
100 o.volt_service.onos_voltha_url = "onos"
101 o.volt_service.onos_voltha_user = "karaf"
102 o.volt_service.onos_voltha_pass = "karaf"
103
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800104 o.device_type = "ponsim_olt"
105 o.host = "172.17.0.1"
106 o.port = "50060"
Scott Baker0bbbfd12018-12-11 07:01:06 +0000107 o.uplink = "129"
Luca Prete244e6ec2018-07-02 14:30:24 +0200108 o.driver = "voltha"
Matteo Scandoloa79395f2018-10-08 13:34:49 -0700109 o.name = "Test Device"
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800110
Matteo Scandolob8621cd2018-04-04 17:12:37 -0700111 # feedback state
112 o.device_id = None
113 o.admin_state = None
114 o.oper_status = None
115 o.of_id = None
Matteo Scandolo096a3cf2018-06-20 13:56:13 -0700116 o.id = 1
Matteo Scandolob8621cd2018-04-04 17:12:37 -0700117
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800118 o.tologdict.return_value = {'name': "Mock VOLTServiceInstance"}
119
120 o.save.return_value = "Saved"
121
Matteo Scandolo6be6ee92018-05-24 15:07:51 -0700122 o.pon_ports.all.return_value = [pon_port]
Matteo Scandolob8621cd2018-04-04 17:12:37 -0700123
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800124 self.o = o
125
Matteo Scandolod6fce512018-10-16 10:35:29 -0700126 self.voltha_devices_response = {"id": "123", "serial_number": "foobar"}
127
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800128 def tearDown(self):
129 self.o = None
Matteo Scandoloce27e9c2018-04-06 10:06:53 -0700130 sys.path = self.sys_path_save
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800131
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800132 @requests_mock.Mocker()
133 def test_get_of_id_from_device(self, m):
134 logical_devices = {
135 "items": [
Matteo Scandolof6337eb2018-04-05 15:58:37 -0700136 {"root_device_id": "123", "id": "0001000ce2314000", "datapath_id": "55334486016"},
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800137 {"root_device_id": "0001cc4974a62b87", "id": "0001000000000001"}
138 ]
139 }
Luca Preteca974c82018-05-01 18:06:16 -0700140 m.get("http://voltha_url:1234/api/v1/logical_devices", status_code=200, json=logical_devices)
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800141 self.o.device_id = "123"
Matteo Scandolof6337eb2018-04-05 15:58:37 -0700142 self.o = self.sync_step.get_ids_from_logical_device(self.o)
143 self.assertEqual(self.o.of_id, "0001000ce2314000")
144 self.assertEqual(self.o.dp_id, "of:0000000ce2314000")
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800145
146 with self.assertRaises(Exception) as e:
147 self.o.device_id = "idonotexist"
Matteo Scandolof6337eb2018-04-05 15:58:37 -0700148 self.sync_step.get_ids_from_logical_device(self.o)
Matteo Scandolo2c144932018-05-04 14:06:24 -0700149 self.assertEqual(e.exception.message, "Can't find a logical_device for OLT device id: idonotexist")
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800150
151 @requests_mock.Mocker()
152 def test_sync_record_fail_add(self, m):
153 """
154 Should print an error if we can't add the device in VOLTHA
155 """
Luca Preteca974c82018-05-01 18:06:16 -0700156 m.post("http://voltha_url:1234/api/v1/devices", status_code=500, text="MockError")
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800157
158 with self.assertRaises(Exception) as e:
Matteo Scandoloce27e9c2018-04-06 10:06:53 -0700159 self.sync_step().sync_record(self.o)
Matteo Scandolo2c144932018-05-04 14:06:24 -0700160 self.assertEqual(e.exception.message, "Failed to add OLT device: MockError")
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800161
162 @requests_mock.Mocker()
163 def test_sync_record_fail_no_id(self, m):
164 """
165 Should print an error if VOLTHA does not return the device id
166 """
Luca Preteca974c82018-05-01 18:06:16 -0700167 m.post("http://voltha_url:1234/api/v1/devices", status_code=200, json={"id": ""})
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800168
169 with self.assertRaises(Exception) as e:
Matteo Scandoloce27e9c2018-04-06 10:06:53 -0700170 self.sync_step().sync_record(self.o)
Matteo Scandolo2c144932018-05-04 14:06:24 -0700171 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 -0800172
173 @requests_mock.Mocker()
174 def test_sync_record_fail_enable(self, m):
175 """
176 Should print an error if device.enable fails
177 """
Matteo Scandolod6fce512018-10-16 10:35:29 -0700178 m.post("http://voltha_url:1234/api/v1/devices", status_code=200, json=self.voltha_devices_response)
Luca Preteca974c82018-05-01 18:06:16 -0700179 m.post("http://voltha_url:1234/api/v1/devices/123/enable", status_code=500, text="EnableError")
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800180
181 with self.assertRaises(Exception) as e:
Matteo Scandoloce27e9c2018-04-06 10:06:53 -0700182 self.sync_step().sync_record(self.o)
Matteo Scandolo2c144932018-05-04 14:06:24 -0700183
184 self.assertEqual(e.exception.message, "Failed to enable OLT device: EnableError")
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800185
186 @requests_mock.Mocker()
187 def test_sync_record_success(self, m):
188 """
189 If device.enable succed should fetch the state, retrieve the of_id and push it to ONOS
190 """
Matteo Scandolo2ed64b92018-06-18 10:32:56 -0700191
192 expected_conf = {
193 "type": self.o.device_type,
194 "host_and_port": "%s:%s" % (self.o.host, self.o.port)
195 }
196
Matteo Scandolod6fce512018-10-16 10:35:29 -0700197 m.post("http://voltha_url:1234/api/v1/devices", status_code=200, json=self.voltha_devices_response, additional_matcher=functools.partial(match_json, expected_conf))
Luca Preteca974c82018-05-01 18:06:16 -0700198 m.post("http://voltha_url:1234/api/v1/devices/123/enable", status_code=200)
Matteo Scandolo45876652018-10-16 16:03:17 -0700199 m.get("http://voltha_url:1234/api/v1/devices/123", json={"oper_status": "ACTIVE", "admin_state": "ENABLED", "serial_number": "foobar"})
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800200 logical_devices = {
201 "items": [
Matteo Scandolof6337eb2018-04-05 15:58:37 -0700202 {"root_device_id": "123", "id": "0001000ce2314000", "datapath_id": "55334486016"},
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800203 {"root_device_id": "0001cc4974a62b87", "id": "0001000000000001"}
204 ]
205 }
Luca Preteca974c82018-05-01 18:06:16 -0700206 m.get("http://voltha_url:1234/api/v1/logical_devices", status_code=200, json=logical_devices)
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800207
Matteo Scandoloa79395f2018-10-08 13:34:49 -0700208 onos_expected_conf = {
209 "devices": {
210 "of:0000000ce2314000": {
211 "basic": {
212 "name": self.o.name
213 }
214 }
215 }
216 }
217 m.post("http://onos:4321/onos/v1/network/configuration/", status_code=200, json=onos_expected_conf,
218 additional_matcher=functools.partial(match_json, onos_expected_conf))
219
Matteo Scandoloce27e9c2018-04-06 10:06:53 -0700220 self.sync_step().sync_record(self.o)
Matteo Scandolo096a3cf2018-06-20 13:56:13 -0700221 self.assertEqual(self.o.admin_state, "ENABLED")
222 self.assertEqual(self.o.oper_status, "ACTIVE")
Matteo Scandolo45876652018-10-16 16:03:17 -0700223 self.assertEqual(self.o.serial_number, "foobar")
Matteo Scandolof6337eb2018-04-05 15:58:37 -0700224 self.assertEqual(self.o.of_id, "0001000ce2314000")
Matteo Scandolo096a3cf2018-06-20 13:56:13 -0700225 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 -0800226
227 @requests_mock.Mocker()
Matteo Scandolo2ed64b92018-06-18 10:32:56 -0700228 def test_sync_record_success_mac_address(self, m):
229 """
230 A device should be pre-provisioned via mac_address, the the process is the same
231 """
232
233 del self.o.host
234 del self.o.port
235 self.o.mac_address = "00:0c:e2:31:40:00"
236
237 expected_conf = {
238 "type": self.o.device_type,
239 "mac_address": self.o.mac_address
240 }
241
Matteo Scandoloa79395f2018-10-08 13:34:49 -0700242 onos_expected_conf = {
243 "devices": {
244 "of:0000000ce2314000": {
245 "basic": {
246 "name": self.o.name
247 }
248 }
249 }
250 }
251 m.post("http://onos:4321/onos/v1/network/configuration/", status_code=200, json=onos_expected_conf,
252 additional_matcher=functools.partial(match_json, onos_expected_conf))
253
Matteo Scandolod6fce512018-10-16 10:35:29 -0700254 m.post("http://voltha_url:1234/api/v1/devices", status_code=200, json=self.voltha_devices_response,
Matteo Scandolo2ed64b92018-06-18 10:32:56 -0700255 additional_matcher=functools.partial(match_json, expected_conf))
256 m.post("http://voltha_url:1234/api/v1/devices/123/enable", status_code=200)
Matteo Scandolo45876652018-10-16 16:03:17 -0700257 m.get("http://voltha_url:1234/api/v1/devices/123", json={"oper_status": "ACTIVE", "admin_state": "ENABLED", "serial_number": "foobar"})
Matteo Scandolo2ed64b92018-06-18 10:32:56 -0700258 logical_devices = {
259 "items": [
260 {"root_device_id": "123", "id": "0001000ce2314000", "datapath_id": "55334486016"},
261 {"root_device_id": "0001cc4974a62b87", "id": "0001000000000001"}
262 ]
263 }
264 m.get("http://voltha_url:1234/api/v1/logical_devices", status_code=200, json=logical_devices)
265
Matteo Scandolo2ed64b92018-06-18 10:32:56 -0700266 self.sync_step().sync_record(self.o)
Matteo Scandolo096a3cf2018-06-20 13:56:13 -0700267 self.assertEqual(self.o.admin_state, "ENABLED")
268 self.assertEqual(self.o.oper_status, "ACTIVE")
Matteo Scandolo2ed64b92018-06-18 10:32:56 -0700269 self.assertEqual(self.o.of_id, "0001000ce2314000")
Matteo Scandolo096a3cf2018-06-20 13:56:13 -0700270 self.assertEqual(self.o.save.call_count, 2)
271
272 @requests_mock.Mocker()
273 def test_sync_record_enable_timeout(self, m):
274 """
275 If device.enable fails we need to tell the suer
276 """
277
278 expected_conf = {
279 "type": self.o.device_type,
280 "host_and_port": "%s:%s" % (self.o.host, self.o.port)
281 }
282
Matteo Scandolod6fce512018-10-16 10:35:29 -0700283 m.post("http://voltha_url:1234/api/v1/devices", status_code=200, json=self.voltha_devices_response,
Matteo Scandolo096a3cf2018-06-20 13:56:13 -0700284 additional_matcher=functools.partial(match_json, expected_conf))
285 m.post("http://voltha_url:1234/api/v1/devices/123/enable", status_code=200)
286 m.get("http://voltha_url:1234/api/v1/devices/123", [
Matteo Scandolo45876652018-10-16 16:03:17 -0700287 {"json": {"oper_status": "ACTIVATING", "admin_state": "ENABLED", "serial_number": "foobar"}, "status_code": 200},
288 {"json": {"oper_status": "ERROR", "admin_state": "FAILED", "serial_number": "foobar"}, "status_code": 200}
Matteo Scandolo096a3cf2018-06-20 13:56:13 -0700289 ])
290
291 logical_devices = {
292 "items": [
293 {"root_device_id": "123", "id": "0001000ce2314000", "datapath_id": "55334486016"},
294 {"root_device_id": "0001cc4974a62b87", "id": "0001000000000001"}
295 ]
296 }
297 m.get("http://voltha_url:1234/api/v1/logical_devices", status_code=200, json=logical_devices)
298
Matteo Scandolo096a3cf2018-06-20 13:56:13 -0700299 with self.assertRaises(Exception) as e:
300 self.sync_step().sync_record(self.o)
301
302 self.assertEqual(e.exception.message, "It was not possible to activate OLTDevice with id 1")
303 self.assertEqual(self.o.oper_status, "ERROR")
304 self.assertEqual(self.o.admin_state, "FAILED")
305 self.assertEqual(self.o.save.call_count, 1)
Matteo Scandolo2ed64b92018-06-18 10:32:56 -0700306
307 @requests_mock.Mocker()
Matteo Scandolob8621cd2018-04-04 17:12:37 -0700308 def test_sync_record_already_existing_in_voltha(self, m):
Matteo Scandolob8621cd2018-04-04 17:12:37 -0700309 # mock device feedback state
310 self.o.device_id = "123"
Matteo Scandolo096a3cf2018-06-20 13:56:13 -0700311 self.o.admin_state = "ENABLED"
312 self.o.oper_status = "ACTIVE"
Matteo Scandolof6337eb2018-04-05 15:58:37 -0700313 self.o.dp_id = "of:0000000ce2314000"
Matteo Scandolo2c144932018-05-04 14:06:24 -0700314 self.o.of_id = "0001000ce2314000"
Matteo Scandolob8621cd2018-04-04 17:12:37 -0700315
Matteo Scandoloa79395f2018-10-08 13:34:49 -0700316 expected_conf = {
317 "devices": {
318 self.o.dp_id: {
319 "basic": {
320 "name": self.o.name
321 }
322 }
323 }
324 }
325 m.post("http://onos:4321/onos/v1/network/configuration/", status_code=200, json=expected_conf,
326 additional_matcher=functools.partial(match_json, expected_conf))
327
Matteo Scandolob8621cd2018-04-04 17:12:37 -0700328 self.sync_step().sync_record(self.o)
329 self.o.save.assert_not_called()
330
Matteo Scandolob8621cd2018-04-04 17:12:37 -0700331 @requests_mock.Mocker()
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800332 def test_delete_record(self, m):
Matteo Scandolof6337eb2018-04-05 15:58:37 -0700333 self.o.of_id = "0001000ce2314000"
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800334 self.o.device_id = "123"
335
Luca Preteca974c82018-05-01 18:06:16 -0700336 m.post("http://voltha_url:1234/api/v1/devices/123/disable", status_code=200)
337 m.delete("http://voltha_url:1234/api/v1/devices/123/delete", status_code=200)
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800338
Matteo Scandoloce27e9c2018-04-06 10:06:53 -0700339 self.sync_step().delete_record(self.o)
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800340
Matteo Scandolo563891c2018-08-21 11:56:32 -0700341 self.assertEqual(m.call_count, 2)
342
Scott Baker22b46c52018-11-15 15:15:29 -0800343 @patch('requests.post')
344 def test_delete_record_connectionerror(self, m):
345 self.o.of_id = "0001000ce2314000"
346 self.o.device_id = "123"
347
348 m.side_effect = ConnectionError()
349
350 self.sync_step().delete_record(self.o)
351
352 # No exception thrown, as ConnectionError will be caught
353
354
Matteo Scandolo563891c2018-08-21 11:56:32 -0700355 @requests_mock.Mocker()
356 def test_delete_unsynced_record(self, m):
357
358 self.sync_step().delete_record(self.o)
359
360 self.assertEqual(m.call_count, 0)
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800361
362if __name__ == "__main__":
Luca Preteca974c82018-05-01 18:06:16 -0700363 unittest.main()