Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Foundation |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package org.onosproject.faultmanagement.impl; |
| 17 | |
| 18 | import com.google.common.collect.ImmutableSet; |
| 19 | import com.google.common.collect.Lists; |
| 20 | import org.junit.Before; |
| 21 | import org.junit.Rule; |
| 22 | import org.junit.Test; |
| 23 | import org.junit.rules.ExpectedException; |
| 24 | import org.onlab.junit.TestTools; |
| 25 | import org.onlab.junit.TestUtils; |
| 26 | import org.onlab.util.ItemNotFoundException; |
| 27 | import org.onosproject.common.event.impl.TestEventDispatcher; |
| 28 | import org.onosproject.event.Event; |
| 29 | import org.onosproject.incubator.net.faultmanagement.alarm.Alarm; |
| 30 | import org.onosproject.incubator.net.faultmanagement.alarm.AlarmEntityId; |
| 31 | import org.onosproject.incubator.net.faultmanagement.alarm.AlarmEvent; |
| 32 | import org.onosproject.incubator.net.faultmanagement.alarm.AlarmId; |
| 33 | import org.onosproject.incubator.net.faultmanagement.alarm.AlarmListener; |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 34 | import org.onosproject.incubator.net.faultmanagement.alarm.AlarmProvider; |
| 35 | import org.onosproject.incubator.net.faultmanagement.alarm.AlarmProviderRegistry; |
| 36 | import org.onosproject.incubator.net.faultmanagement.alarm.AlarmProviderService; |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 37 | import org.onosproject.incubator.net.faultmanagement.alarm.DefaultAlarm; |
Andrea Campanella | 5a4df1e | 2017-10-24 13:46:56 +0200 | [diff] [blame] | 38 | import org.onosproject.mastership.MastershipService; |
| 39 | import org.onosproject.mastership.MastershipServiceAdapter; |
| 40 | import org.onosproject.net.DefaultAnnotations; |
| 41 | import org.onosproject.net.DefaultDevice; |
| 42 | import org.onosproject.net.Device; |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 43 | import org.onosproject.net.DeviceId; |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 44 | import org.onosproject.net.MastershipRole; |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 45 | import org.onosproject.net.NetTestTools; |
Andrea Campanella | 5a4df1e | 2017-10-24 13:46:56 +0200 | [diff] [blame] | 46 | import org.onosproject.net.device.DeviceEvent; |
| 47 | import org.onosproject.net.device.DeviceListener; |
| 48 | import org.onosproject.net.device.DeviceServiceAdapter; |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 49 | import org.onosproject.net.provider.AbstractProvider; |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 50 | import org.onosproject.store.service.TestStorageService; |
| 51 | |
| 52 | import java.util.Collections; |
| 53 | import java.util.HashMap; |
| 54 | import java.util.List; |
| 55 | import java.util.Map; |
| 56 | |
| 57 | import static junit.framework.TestCase.assertFalse; |
| 58 | import static org.junit.Assert.assertEquals; |
| 59 | import static org.junit.Assert.assertTrue; |
| 60 | import static org.onosproject.incubator.net.faultmanagement.alarm.Alarm.SeverityLevel.CLEARED; |
| 61 | import static org.onosproject.incubator.net.faultmanagement.alarm.Alarm.SeverityLevel.CRITICAL; |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 62 | import static org.onosproject.net.NetTestTools.PID; |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 63 | |
| 64 | /** |
| 65 | * Alarm manager test suite. |
| 66 | */ |
| 67 | public class AlarmManagerTest { |
| 68 | |
| 69 | private static final DeviceId DEVICE_ID = DeviceId.deviceId("foo:bar"); |
Andrea Campanella | 5a4df1e | 2017-10-24 13:46:56 +0200 | [diff] [blame] | 70 | |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 71 | private static final String UNIQUE_ID_1 = "unique_id_1"; |
| 72 | private static final String UNIQUE_ID_2 = "unique_id_2"; |
| 73 | private static final AlarmId A_ID = AlarmId.alarmId(DEVICE_ID, UNIQUE_ID_1); |
| 74 | private static final AlarmId B_ID = AlarmId.alarmId(DEVICE_ID, UNIQUE_ID_2); |
| 75 | private static final DefaultAlarm ALARM_A = new DefaultAlarm.Builder(A_ID, |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 76 | DEVICE_ID, "aaa", Alarm.SeverityLevel.CRITICAL, 0).build(); |
| 77 | |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 78 | private static final DefaultAlarm ALARM_A_CLEARED = new DefaultAlarm.Builder(ALARM_A) |
| 79 | .clear().build(); |
| 80 | |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 81 | private static final DefaultAlarm ALARM_A_WITHSRC = new DefaultAlarm.Builder( |
| 82 | ALARM_A).forSource(AlarmEntityId.alarmEntityId("port:foo")).build(); |
| 83 | |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 84 | private static final DefaultAlarm ALARM_B = new DefaultAlarm.Builder(B_ID, |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 85 | DEVICE_ID, "bbb", Alarm.SeverityLevel.CRITICAL, 0).build(); |
| 86 | |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 87 | |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 88 | private AlarmManager manager; |
| 89 | private DistributedAlarmStore alarmStore; |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 90 | private AlarmProviderService providerService; |
| 91 | private TestProvider provider; |
| 92 | protected AlarmProviderRegistry registry; |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 93 | protected TestListener listener = new TestListener(); |
Andrea Campanella | 5a4df1e | 2017-10-24 13:46:56 +0200 | [diff] [blame] | 94 | private final MastershipService mastershipService = new MockMastershipService(); |
| 95 | protected final MockDeviceService deviceService = new MockDeviceService(); |
| 96 | |
| 97 | private final Device device = new MockDevice(DEVICE_ID); |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 98 | |
| 99 | @Rule |
| 100 | public final ExpectedException exception = ExpectedException.none(); |
| 101 | |
| 102 | @Before |
| 103 | public void setUp() throws Exception { |
| 104 | alarmStore = new DistributedAlarmStore(); |
| 105 | TestUtils.setField(alarmStore, "storageService", new TestStorageService()); |
| 106 | alarmStore.activate(); |
| 107 | manager = new AlarmManager(); |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 108 | registry = manager; |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 109 | manager.addListener(listener); |
| 110 | NetTestTools.injectEventDispatcher(manager, new TestEventDispatcher()); |
Andrea Campanella | 5a4df1e | 2017-10-24 13:46:56 +0200 | [diff] [blame] | 111 | manager.deviceService = deviceService; |
| 112 | manager.mastershipService = mastershipService; |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 113 | manager.store = alarmStore; |
| 114 | manager.activate(); |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 115 | provider = new TestProvider(); |
| 116 | providerService = registry.register(provider); |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 117 | } |
| 118 | |
| 119 | @Test |
| 120 | public void deactivate() throws Exception { |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 121 | providerService.updateAlarmList(DEVICE_ID, ImmutableSet.of(ALARM_B, ALARM_A)); |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 122 | verifyGettingSetsOfAlarms(manager, 2, 2); |
| 123 | alarmStore.deactivate(); |
| 124 | manager.removeListener(listener); |
| 125 | manager.deactivate(); |
| 126 | NetTestTools.injectEventDispatcher(manager, null); |
| 127 | assertFalse("Store should not have delegate", alarmStore.hasDelegate()); |
| 128 | } |
| 129 | |
| 130 | @Test |
| 131 | public void testGettersWhenNoAlarms() { |
| 132 | |
| 133 | assertTrue("No alarms should be present", manager.getAlarms().isEmpty()); |
| 134 | assertTrue("No active alarms should be present", manager.getActiveAlarms().isEmpty()); |
| 135 | assertTrue("The map should be empty per unknown device", |
| 136 | manager.getAlarmCounts(DeviceId.NONE).keySet().isEmpty()); |
| 137 | assertTrue("The counts should be empty", manager.getAlarmCounts().keySet().isEmpty()); |
| 138 | |
| 139 | assertEquals("Incorrect number of alarms for unknown device", |
| 140 | 0, manager.getAlarms(DeviceId.NONE).size()); |
| 141 | assertEquals("Incorrect number of major alarms for unknown device", |
| 142 | 0, manager.getAlarms(Alarm.SeverityLevel.MAJOR).size()); |
| 143 | |
| 144 | exception.expect(NullPointerException.class); |
| 145 | manager.getAlarm(null); |
| 146 | |
| 147 | exception.expect(ItemNotFoundException.class); |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 148 | manager.getAlarm(AlarmId.alarmId(DEVICE_ID, "unique_3")); |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 149 | } |
| 150 | |
| 151 | @Test |
| 152 | public void testAlarmUpdates() throws InterruptedException { |
| 153 | |
| 154 | assertTrue("No alarms should be present", manager.getAlarms().isEmpty()); |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 155 | providerService.updateAlarmList(DEVICE_ID, ImmutableSet.of()); |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 156 | assertTrue("No alarms should be present", manager.getAlarms().isEmpty()); |
| 157 | Map<Alarm.SeverityLevel, Long> zeroAlarms = new CountsMapBuilder().create(); |
| 158 | assertEquals("No alarms count should be present", zeroAlarms, manager.getAlarmCounts()); |
| 159 | assertEquals("No alarms count should be present", zeroAlarms, manager.getAlarmCounts(DEVICE_ID)); |
| 160 | |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 161 | providerService.updateAlarmList(DEVICE_ID, ImmutableSet.of(ALARM_B, ALARM_A)); |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 162 | verifyGettingSetsOfAlarms(manager, 2, 2); |
| 163 | validateEvents(AlarmEvent.Type.CREATED, AlarmEvent.Type.CREATED); |
| 164 | Map<Alarm.SeverityLevel, Long> critical2 = new CountsMapBuilder().with(CRITICAL, 2L).create(); |
| 165 | assertEquals("A critical should be present", critical2, manager.getAlarmCounts()); |
| 166 | assertEquals("A critical should be present", critical2, manager.getAlarmCounts(DEVICE_ID)); |
| 167 | |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 168 | Alarm updated = manager.updateBookkeepingFields(ALARM_A.id(), true, false, null); |
| 169 | // providerService.updateAlarmList(DEVICE_ID, ImmutableSet.of(ALARM_A)); |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 170 | verifyGettingSetsOfAlarms(manager, 2, 1); |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 171 | validateEvents(AlarmEvent.Type.UPDATED); |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 172 | Map<Alarm.SeverityLevel, Long> critical1cleared1 = |
| 173 | new CountsMapBuilder().with(CRITICAL, 1L).with(CLEARED, 1L).create(); |
| 174 | assertEquals("A critical should be present and cleared", critical1cleared1, |
| 175 | manager.getAlarmCounts()); |
| 176 | assertEquals("A critical should be present and cleared", critical1cleared1, |
| 177 | manager.getAlarmCounts(DEVICE_ID)); |
| 178 | |
| 179 | // No change map when same alarms sent |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 180 | providerService.updateAlarmList(DEVICE_ID, ImmutableSet.of(updated)); |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 181 | verifyGettingSetsOfAlarms(manager, 2, 1); |
| 182 | validateEvents(); |
| 183 | assertEquals("Map should not be changed for same alarm", critical1cleared1, |
| 184 | manager.getAlarmCounts()); |
| 185 | assertEquals("Map should not be changed for same alarm", critical1cleared1, |
| 186 | manager.getAlarmCounts(DEVICE_ID)); |
| 187 | |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 188 | providerService.updateAlarmList(DEVICE_ID, ImmutableSet.of(updated, ALARM_A_WITHSRC)); |
| 189 | verifyGettingSetsOfAlarms(manager, 2, 2); |
| 190 | validateEvents(AlarmEvent.Type.UPDATED); |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 191 | Map<Alarm.SeverityLevel, Long> critical2cleared1 = |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 192 | new CountsMapBuilder().with(CRITICAL, 2L).create(); |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 193 | assertEquals("A critical should be present", critical2cleared1, manager.getAlarmCounts()); |
| 194 | assertEquals("A critical should be present", critical2cleared1, manager.getAlarmCounts(DEVICE_ID)); |
| 195 | |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 196 | providerService.updateAlarmList(DEVICE_ID, ImmutableSet.of()); |
| 197 | verifyGettingSetsOfAlarms(manager, 2, 2); |
| 198 | validateEvents(); |
| 199 | assertEquals(new CountsMapBuilder().with(CRITICAL, 2L).create(), |
| 200 | manager.getAlarmCounts(DEVICE_ID)); |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 201 | |
| 202 | assertEquals("The counts should be empty for unknown devices", zeroAlarms, |
| 203 | manager.getAlarmCounts(DeviceId.NONE)); |
| 204 | assertEquals("The counts should be empty for unknown devices", zeroAlarms, |
| 205 | manager.getAlarmCounts(DeviceId.deviceId("junk:junk"))); |
| 206 | |
| 207 | } |
| 208 | |
Andrea Campanella | 5a4df1e | 2017-10-24 13:46:56 +0200 | [diff] [blame] | 209 | @Test |
| 210 | public void testRemoveWhenDeviceRemoved() { |
| 211 | providerService.updateAlarmList(DEVICE_ID, ImmutableSet.of(ALARM_B, ALARM_A)); |
| 212 | verifyGettingSetsOfAlarms(manager, 2, 2); |
| 213 | validateEvents(AlarmEvent.Type.CREATED, AlarmEvent.Type.CREATED); |
| 214 | Map<Alarm.SeverityLevel, Long> critical2 = new CountsMapBuilder().with(CRITICAL, 2L).create(); |
| 215 | assertEquals("A critical should be present", critical2, manager.getAlarmCounts()); |
| 216 | assertEquals("A critical should be present", critical2, manager.getAlarmCounts(DEVICE_ID)); |
| 217 | deviceService.deviceListener.event(new DeviceEvent(DeviceEvent.Type.DEVICE_REMOVED, device)); |
| 218 | Map<Alarm.SeverityLevel, Long> zeroAlarms = new CountsMapBuilder().create(); |
| 219 | assertEquals("The counts should be empty for removed device", zeroAlarms, |
| 220 | manager.getAlarmCounts(DEVICE_ID)); |
| 221 | |
| 222 | } |
| 223 | |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 224 | private void verifyGettingSetsOfAlarms(AlarmManager am, int expectedTotal, int expectedActive) { |
| 225 | assertEquals("Incorrect total alarms", expectedTotal, am.getAlarms().size()); |
| 226 | assertEquals("Incorrect active alarms count", expectedActive, am.getActiveAlarms().size()); |
| 227 | } |
| 228 | |
| 229 | /** |
| 230 | * Method to validate that actual versus expected device key events were |
| 231 | * received correctly. |
| 232 | * |
| 233 | * @param types expected device key events. |
| 234 | */ |
| 235 | private void validateEvents(Enum... types) { |
| 236 | TestTools.assertAfter(100, () -> { |
| 237 | int i = 0; |
| 238 | assertEquals("wrong events received", types.length, listener.events.size()); |
| 239 | for (Event event : listener.events) { |
| 240 | assertEquals("incorrect event type", types[i], event.type()); |
| 241 | i++; |
| 242 | } |
| 243 | listener.events.clear(); |
| 244 | }); |
| 245 | } |
| 246 | |
| 247 | private static class CountsMapBuilder { |
| 248 | |
| 249 | private final Map<Alarm.SeverityLevel, Long> map = new HashMap<>(); |
| 250 | |
| 251 | public CountsMapBuilder with(Alarm.SeverityLevel sev, Long count) { |
| 252 | map.put(sev, count); |
| 253 | return this; |
| 254 | } |
| 255 | |
| 256 | public Map<Alarm.SeverityLevel, Long> create() { |
| 257 | return Collections.unmodifiableMap(map); |
| 258 | } |
| 259 | } |
| 260 | |
| 261 | |
Andrea Campanella | 5a4df1e | 2017-10-24 13:46:56 +0200 | [diff] [blame] | 262 | private class MockDeviceService extends DeviceServiceAdapter { |
| 263 | DeviceListener deviceListener = null; |
| 264 | |
| 265 | @Override |
| 266 | public void addListener(DeviceListener listener) { |
| 267 | this.deviceListener = listener; |
| 268 | } |
| 269 | |
| 270 | @Override |
| 271 | public void removeListener(DeviceListener listener) { |
| 272 | this.deviceListener = null; |
| 273 | } |
| 274 | } |
| 275 | |
| 276 | |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 277 | private class TestProvider extends AbstractProvider implements AlarmProvider { |
| 278 | private DeviceId deviceReceived; |
| 279 | private MastershipRole roleReceived; |
| 280 | |
| 281 | public TestProvider() { |
| 282 | super(PID); |
| 283 | } |
| 284 | |
| 285 | @Override |
| 286 | public void triggerProbe(DeviceId deviceId) { |
| 287 | } |
| 288 | } |
| 289 | |
Andrea Campanella | 5a4df1e | 2017-10-24 13:46:56 +0200 | [diff] [blame] | 290 | private class MockMastershipService extends MastershipServiceAdapter { |
| 291 | int test = 0; |
| 292 | @Override |
| 293 | public boolean isLocalMaster(DeviceId deviceId) { |
| 294 | return true; |
| 295 | } |
| 296 | } |
| 297 | |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 298 | /** |
| 299 | * Test listener class to receive alarm events. |
| 300 | */ |
| 301 | private static class TestListener implements AlarmListener { |
| 302 | |
| 303 | protected List<AlarmEvent> events = Lists.newArrayList(); |
| 304 | |
| 305 | @Override |
| 306 | public void event(AlarmEvent event) { |
| 307 | events.add(event); |
| 308 | } |
| 309 | |
| 310 | } |
Andrea Campanella | 5a4df1e | 2017-10-24 13:46:56 +0200 | [diff] [blame] | 311 | |
| 312 | private class MockDevice extends DefaultDevice { |
| 313 | |
| 314 | MockDevice(DeviceId id) { |
| 315 | super(null, id, null, null, null, null, null, |
| 316 | null, DefaultAnnotations.EMPTY); |
| 317 | } |
| 318 | |
| 319 | } |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 320 | } |