Scott Baker | 1268773 | 2019-03-19 15:40:57 -0700 | [diff] [blame] | 1 | # 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 | |
| 15 | import unittest |
| 16 | import json |
| 17 | from mock import patch, Mock, MagicMock, ANY |
| 18 | |
| 19 | import datetime |
| 20 | import os |
| 21 | import sys |
| 22 | import time |
| 23 | |
| 24 | test_path = os.path.abspath(os.path.dirname(os.path.realpath(__file__))) |
| 25 | |
| 26 | |
| 27 | class TestOnosPortEvent(unittest.TestCase): |
| 28 | |
| 29 | def setUp(self): |
| 30 | global DeferredException |
| 31 | |
| 32 | self.sys_path_save = sys.path |
| 33 | |
| 34 | # Setting up the config module |
| 35 | from xosconfig import Config |
| 36 | config = os.path.join(test_path, "../test_config.yaml") |
| 37 | Config.clear() |
| 38 | Config.init(config, "synchronizer-config-schema.yaml") |
| 39 | |
| 40 | # Mock the kafka producer |
| 41 | self.mockxoskafka = MagicMock() |
| 42 | modules = { |
| 43 | 'xoskafka': self.mockxoskafka, |
| 44 | 'xoskafka.XOSKafkaProducer': self.mockxoskafka.XOSKafkaProducer, |
| 45 | } |
| 46 | self.module_patcher = patch.dict('sys.modules', modules) |
| 47 | self.module_patcher.start() |
| 48 | |
| 49 | from xossynchronizer.mock_modelaccessor_build import mock_modelaccessor_config |
| 50 | mock_modelaccessor_config(test_path, [("olt-service", "volt.xproto"), |
| 51 | ("rcord", "rcord.xproto")]) |
| 52 | |
| 53 | import xossynchronizer.modelaccessor |
| 54 | import mock_modelaccessor |
| 55 | reload(mock_modelaccessor) # in case nose2 loaded it in a previous test |
| 56 | reload(xossynchronizer.modelaccessor) # in case nose2 loaded it in a previous test |
| 57 | |
| 58 | from mock_modelaccessor import MockObjectList |
| 59 | from xossynchronizer.modelaccessor import model_accessor |
| 60 | self.model_accessor = model_accessor |
| 61 | |
| 62 | # necessary to reset XOSKafkaProducer's call_count |
| 63 | import onos_event |
| 64 | reload(onos_event) |
| 65 | |
| 66 | from onos_event import OnosPortEventStep, XOSKafkaProducer |
| 67 | from onos_event import XOSKafkaProducer |
| 68 | self.XOSKafkaProducer = XOSKafkaProducer |
| 69 | |
| 70 | # import all class names to globals |
| 71 | for (k, v) in model_accessor.all_model_classes.items(): |
| 72 | globals()[k] = v |
| 73 | |
| 74 | self.event_step = OnosPortEventStep |
| 75 | |
| 76 | self.volt_service = VOLTService(name="volt", |
| 77 | id=1112, |
| 78 | backend_code=1, |
| 79 | backend_status="succeeded") |
| 80 | |
| 81 | self.oltdevice = OLTDevice(name="myolt", |
| 82 | device_id="of:0000000000000001", |
Scott Baker | 2a4dacb | 2019-04-03 13:00:35 -0700 | [diff] [blame] | 83 | switch_datapath_id="of:0000000000000001", |
Scott Baker | 1268773 | 2019-03-19 15:40:57 -0700 | [diff] [blame] | 84 | switch_port="1") |
| 85 | |
| 86 | self.ponport = PONPort(olt_device = self.oltdevice) |
| 87 | |
| 88 | self.onudevice = ONUDevice(pon_port = self.ponport) |
| 89 | |
| 90 | self.subscriber = RCORDSubscriber(name="somesubscriber") |
| 91 | self.voltsi = VOLTServiceInstance() |
| 92 | |
| 93 | # chain it all together |
| 94 | self.oltdevice.pon_ports = MockObjectList([self.ponport]) |
| 95 | self.ponport.onu_devices = MockObjectList([self.onudevice]) |
| 96 | self.onudevice.volt_service_instances = MockObjectList([self.voltsi]) |
| 97 | self.voltsi.westbound_service_instances = [self.subscriber] |
| 98 | |
| 99 | self.log = Mock() |
| 100 | |
| 101 | def tearDown(self): |
| 102 | sys.path = self.sys_path_save |
| 103 | |
| 104 | def test_process_event_enable(self): |
| 105 | with patch.object(OLTDevice.objects, "get_items") as olt_objects: |
| 106 | olt_objects.return_value = [self.oltdevice] |
| 107 | |
| 108 | event_dict = {"timestamp":"2019-03-21T18:00:26.613Z", |
| 109 | "deviceId": self.oltdevice.switch_datapath_id, |
| 110 | "portId": self.oltdevice.switch_port, |
| 111 | "enabled": True} |
| 112 | event = Mock() |
| 113 | event.value = json.dumps(event_dict) |
| 114 | |
| 115 | step = self.event_step(model_accessor=self.model_accessor, log=self.log) |
| 116 | step.process_event(event) |
| 117 | |
| 118 | self.assertEqual(self.oltdevice.link_status, "up") |
| 119 | |
| 120 | def test_process_event_disable(self): |
| 121 | with patch.object(OLTDevice.objects, "get_items") as olt_objects: |
| 122 | olt_objects.return_value = [self.oltdevice] |
| 123 | |
| 124 | event_dict = {"timestamp":"2019-03-21T18:00:26.613Z", |
| 125 | "deviceId": self.oltdevice.switch_datapath_id, |
| 126 | "portId": self.oltdevice.switch_port, |
| 127 | "enabled": False} |
| 128 | event = Mock() |
| 129 | event.value = json.dumps(event_dict) |
| 130 | |
| 131 | step = self.event_step(model_accessor=self.model_accessor, log=self.log) |
| 132 | step.process_event(event) |
| 133 | |
| 134 | self.assertEqual(self.oltdevice.link_status, "down") |
| 135 | |
| 136 | def test_process_event_no_olt(self): |
| 137 | with patch.object(OLTDevice.objects, "get_items") as olt_objects: |
| 138 | olt_objects.return_value = [self.oltdevice] |
| 139 | |
| 140 | event_dict = {"timestamp":"2019-03-21T18:00:26.613Z", |
| 141 | "deviceId": "doesnotexist", |
| 142 | "portId": self.oltdevice.switch_port, |
| 143 | "enabled": True} |
| 144 | event = Mock() |
| 145 | event.value = json.dumps(event_dict) |
| 146 | |
| 147 | step = self.event_step(model_accessor=self.model_accessor, log=self.log) |
| 148 | step.process_event(event) |
| 149 | |
| 150 | # should not have changed |
| 151 | self.assertEqual(self.oltdevice.link_status, None) |
| 152 | |
| 153 | def test_send_alarm(self): |
| 154 | self.oltdevice.link_status = "down" |
| 155 | value = {"timestamp":"2019-03-21T18:00:26.613Z", |
| 156 | "deviceId":"of:0000000000000001", |
| 157 | "portId":"2", |
| 158 | "enabled":False, |
| 159 | "speed":10000, |
| 160 | "type":"COPPER"} |
| 161 | |
| 162 | step = self.event_step(model_accessor=self.model_accessor, log=self.log) |
| 163 | step.send_alarm(self.oltdevice, value) |
| 164 | |
| 165 | self.assertEqual(self.XOSKafkaProducer.produce.call_count, 1) |
| 166 | topic = self.XOSKafkaProducer.produce.call_args[0][0] |
| 167 | key = self.XOSKafkaProducer.produce.call_args[0][1] |
| 168 | event = json.loads(self.XOSKafkaProducer.produce.call_args[0][2]) |
| 169 | |
| 170 | self.assertEqual(topic, "xos.alarms.olt-service") |
| 171 | self.assertEqual(key, "of:0000000000000001") |
| 172 | |
| 173 | raised_ts = time.mktime(datetime.datetime.strptime(value["timestamp"], "%Y-%m-%dT%H:%M:%S.%fZ").timetuple()) |
| 174 | |
| 175 | self.maxDiff = None |
| 176 | |
| 177 | expected_alarm = { |
| 178 | u"category": u"OLT", |
| 179 | u"reported_ts": ANY, |
| 180 | u"raised_ts": raised_ts, |
| 181 | u"state": u"RAISED", |
Scott Baker | 2a4dacb | 2019-04-03 13:00:35 -0700 | [diff] [blame] | 182 | u"alarm_type_name": u"OLT.PORT_LOS", |
Scott Baker | 1268773 | 2019-03-19 15:40:57 -0700 | [diff] [blame] | 183 | u"severity": u"MAJOR", |
| 184 | u"resource_id": unicode(self.oltdevice.device_id), |
| 185 | u"logical_device_id": self.oltdevice.dp_id, |
Scott Baker | 2a4dacb | 2019-04-03 13:00:35 -0700 | [diff] [blame] | 186 | u"context": {u'affected_subscribers': [u'somesubscriber'], |
| 187 | u"switch_datapath_id": "of:0000000000000001", |
| 188 | u"switch_port": "1", |
| 189 | u"oltdevice.name": "myolt"}, |
Scott Baker | 1268773 | 2019-03-19 15:40:57 -0700 | [diff] [blame] | 190 | u"type": u"COMMUNICATION", |
Scott Baker | 2a4dacb | 2019-04-03 13:00:35 -0700 | [diff] [blame] | 191 | u"id": u"xos.voltservice.%s.OLT_PORT_LOS" % self.oltdevice.device_id, |
| 192 | u"description": u"xos.voltservice.%s - OLT PORT LOS Alarm - OLT_PORT_LOS - RAISED" % self.oltdevice.device_id} |
Scott Baker | 1268773 | 2019-03-19 15:40:57 -0700 | [diff] [blame] | 193 | |
| 194 | self.assertDictEqual(expected_alarm, event) |
| 195 | |
| 196 | def test_clear_alarm(self): |
| 197 | self.oltdevice.link_status = "up" |
| 198 | value = {"timestamp":"2019-03-21T18:00:26.613Z", |
| 199 | "deviceId":"of:0000000000000001", |
| 200 | "portId":"2", |
| 201 | "enabled":True, |
| 202 | "speed":10000, |
| 203 | "type":"COPPER"} |
| 204 | |
| 205 | step = self.event_step(model_accessor=self.model_accessor, log=self.log) |
| 206 | step.send_alarm(self.oltdevice, value) |
| 207 | |
| 208 | self.assertEqual(self.XOSKafkaProducer.produce.call_count, 1) |
| 209 | topic = self.XOSKafkaProducer.produce.call_args[0][0] |
| 210 | key = self.XOSKafkaProducer.produce.call_args[0][1] |
| 211 | event = json.loads(self.XOSKafkaProducer.produce.call_args[0][2]) |
| 212 | |
| 213 | self.assertEqual(topic, "xos.alarms.olt-service") |
| 214 | self.assertEqual(key, "of:0000000000000001") |
| 215 | |
| 216 | raised_ts = time.mktime(datetime.datetime.strptime(value["timestamp"], "%Y-%m-%dT%H:%M:%S.%fZ").timetuple()) |
| 217 | |
| 218 | self.maxDiff = None |
| 219 | |
| 220 | expected_alarm = { |
| 221 | u"category": u"OLT", |
| 222 | u"reported_ts": ANY, |
| 223 | u"raised_ts": raised_ts, |
| 224 | u"state": u"CLEARED", |
Scott Baker | 2a4dacb | 2019-04-03 13:00:35 -0700 | [diff] [blame] | 225 | u"alarm_type_name": u"OLT.PORT_LOS", |
Scott Baker | 1268773 | 2019-03-19 15:40:57 -0700 | [diff] [blame] | 226 | u"severity": u"MAJOR", |
| 227 | u"resource_id": unicode(self.oltdevice.device_id), |
| 228 | u"logical_device_id": self.oltdevice.dp_id, |
Scott Baker | 2a4dacb | 2019-04-03 13:00:35 -0700 | [diff] [blame] | 229 | u"context": {u'affected_subscribers': [u'somesubscriber'], |
| 230 | u"switch_datapath_id": "of:0000000000000001", |
| 231 | u"switch_port": "1", |
| 232 | u"oltdevice.name": "myolt"}, |
Scott Baker | 1268773 | 2019-03-19 15:40:57 -0700 | [diff] [blame] | 233 | u"type": u"COMMUNICATION", |
Scott Baker | 2a4dacb | 2019-04-03 13:00:35 -0700 | [diff] [blame] | 234 | u"id": u"xos.voltservice.%s.OLT_PORT_LOS" % self.oltdevice.device_id, |
| 235 | u"description": u"xos.voltservice.%s - OLT PORT LOS Alarm - OLT_PORT_LOS - CLEARED" % self.oltdevice.device_id} |
Scott Baker | 1268773 | 2019-03-19 15:40:57 -0700 | [diff] [blame] | 236 | |
| 237 | self.assertDictEqual(expected_alarm, event) |
| 238 | |
| 239 | |
| 240 | if __name__ == '__main__': |
| 241 | unittest.main() |