[ONOS-4287] Persistent and distributed alarm store
Change-Id: I2fb0f5d84e563a53f036be012a8190d7df5869dc
diff --git a/apps/faultmanagement/fmmgr/src/test/java/org/onosproject/faultmanagement/impl/AlarmManagerTest.java b/apps/faultmanagement/fmmgr/src/test/java/org/onosproject/faultmanagement/impl/AlarmManagerTest.java
new file mode 100644
index 0000000..f81142f
--- /dev/null
+++ b/apps/faultmanagement/fmmgr/src/test/java/org/onosproject/faultmanagement/impl/AlarmManagerTest.java
@@ -0,0 +1,223 @@
+/*
+ * Copyright 2015-present Open Networking Laboratory
+ *
+ * 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.
+ */
+package org.onosproject.faultmanagement.impl;
+
+import com.google.common.collect.ImmutableSet;
+import com.google.common.collect.Lists;
+import org.junit.Before;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.rules.ExpectedException;
+import org.onlab.junit.TestTools;
+import org.onlab.junit.TestUtils;
+import org.onlab.util.ItemNotFoundException;
+import org.onosproject.common.event.impl.TestEventDispatcher;
+import org.onosproject.event.Event;
+import org.onosproject.incubator.net.faultmanagement.alarm.Alarm;
+import org.onosproject.incubator.net.faultmanagement.alarm.AlarmEntityId;
+import org.onosproject.incubator.net.faultmanagement.alarm.AlarmEvent;
+import org.onosproject.incubator.net.faultmanagement.alarm.AlarmId;
+import org.onosproject.incubator.net.faultmanagement.alarm.AlarmListener;
+import org.onosproject.incubator.net.faultmanagement.alarm.DefaultAlarm;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.NetTestTools;
+import org.onosproject.store.service.TestStorageService;
+
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import static junit.framework.TestCase.assertFalse;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+import static org.onosproject.incubator.net.faultmanagement.alarm.Alarm.SeverityLevel.CLEARED;
+import static org.onosproject.incubator.net.faultmanagement.alarm.Alarm.SeverityLevel.CRITICAL;
+
+/**
+ * Alarm manager test suite.
+ */
+public class AlarmManagerTest {
+
+ private static final DeviceId DEVICE_ID = DeviceId.deviceId("foo:bar");
+ private static final DefaultAlarm ALARM_A = new DefaultAlarm.Builder(
+ DEVICE_ID, "aaa", Alarm.SeverityLevel.CRITICAL, 0).build();
+
+ private static final DefaultAlarm ALARM_A_WITHSRC = new DefaultAlarm.Builder(
+ ALARM_A).forSource(AlarmEntityId.alarmEntityId("port:foo")).build();
+
+ private static final DefaultAlarm ALARM_B = new DefaultAlarm.Builder(
+ DEVICE_ID, "bbb", Alarm.SeverityLevel.CRITICAL, 0).build();
+
+ private AlarmManager manager;
+ private DistributedAlarmStore alarmStore;
+ protected TestListener listener = new TestListener();
+
+ @Rule
+ public final ExpectedException exception = ExpectedException.none();
+
+ @Before
+ public void setUp() throws Exception {
+ alarmStore = new DistributedAlarmStore();
+ TestUtils.setField(alarmStore, "storageService", new TestStorageService());
+ alarmStore.activate();
+ manager = new AlarmManager();
+ manager.addListener(listener);
+ NetTestTools.injectEventDispatcher(manager, new TestEventDispatcher());
+ manager.store = alarmStore;
+ manager.activate();
+ }
+
+ @Test
+ public void deactivate() throws Exception {
+ manager.updateAlarms(DEVICE_ID, ImmutableSet.of(ALARM_B, ALARM_A));
+ verifyGettingSetsOfAlarms(manager, 2, 2);
+ alarmStore.deactivate();
+ manager.removeListener(listener);
+ manager.deactivate();
+ NetTestTools.injectEventDispatcher(manager, null);
+ assertFalse("Store should not have delegate", alarmStore.hasDelegate());
+ }
+
+ @Test
+ public void testGettersWhenNoAlarms() {
+
+ assertTrue("No alarms should be present", manager.getAlarms().isEmpty());
+ assertTrue("No active alarms should be present", manager.getActiveAlarms().isEmpty());
+ assertTrue("The map should be empty per unknown device",
+ manager.getAlarmCounts(DeviceId.NONE).keySet().isEmpty());
+ assertTrue("The counts should be empty", manager.getAlarmCounts().keySet().isEmpty());
+
+ assertEquals("Incorrect number of alarms for unknown device",
+ 0, manager.getAlarms(DeviceId.NONE).size());
+ assertEquals("Incorrect number of major alarms for unknown device",
+ 0, manager.getAlarms(Alarm.SeverityLevel.MAJOR).size());
+
+ exception.expect(NullPointerException.class);
+ manager.getAlarm(null);
+
+ exception.expect(ItemNotFoundException.class);
+ manager.getAlarm(AlarmId.alarmId(1));
+ }
+
+ @Test
+ public void testAlarmUpdates() throws InterruptedException {
+
+ assertTrue("No alarms should be present", manager.getAlarms().isEmpty());
+ manager.updateAlarms(DEVICE_ID, ImmutableSet.of());
+ assertTrue("No alarms should be present", manager.getAlarms().isEmpty());
+ Map<Alarm.SeverityLevel, Long> zeroAlarms = new CountsMapBuilder().create();
+ assertEquals("No alarms count should be present", zeroAlarms, manager.getAlarmCounts());
+ assertEquals("No alarms count should be present", zeroAlarms, manager.getAlarmCounts(DEVICE_ID));
+
+ manager.updateAlarms(DEVICE_ID, ImmutableSet.of(ALARM_B, ALARM_A));
+ verifyGettingSetsOfAlarms(manager, 2, 2);
+ validateEvents(AlarmEvent.Type.CREATED, AlarmEvent.Type.CREATED);
+ Map<Alarm.SeverityLevel, Long> critical2 = new CountsMapBuilder().with(CRITICAL, 2L).create();
+ assertEquals("A critical should be present", critical2, manager.getAlarmCounts());
+ assertEquals("A critical should be present", critical2, manager.getAlarmCounts(DEVICE_ID));
+
+ manager.updateAlarms(DEVICE_ID, ImmutableSet.of(ALARM_A));
+ verifyGettingSetsOfAlarms(manager, 2, 1);
+ validateEvents(AlarmEvent.Type.CREATED);
+ Map<Alarm.SeverityLevel, Long> critical1cleared1 =
+ new CountsMapBuilder().with(CRITICAL, 1L).with(CLEARED, 1L).create();
+ assertEquals("A critical should be present and cleared", critical1cleared1,
+ manager.getAlarmCounts());
+ assertEquals("A critical should be present and cleared", critical1cleared1,
+ manager.getAlarmCounts(DEVICE_ID));
+
+ // No change map when same alarms sent
+ manager.updateAlarms(DEVICE_ID, ImmutableSet.of(ALARM_A));
+ verifyGettingSetsOfAlarms(manager, 2, 1);
+ validateEvents();
+ assertEquals("Map should not be changed for same alarm", critical1cleared1,
+ manager.getAlarmCounts());
+ assertEquals("Map should not be changed for same alarm", critical1cleared1,
+ manager.getAlarmCounts(DEVICE_ID));
+
+ manager.updateAlarms(DEVICE_ID, ImmutableSet.of(ALARM_A, ALARM_A_WITHSRC));
+ verifyGettingSetsOfAlarms(manager, 3, 2);
+ validateEvents(AlarmEvent.Type.CREATED);
+ Map<Alarm.SeverityLevel, Long> critical2cleared1 =
+ new CountsMapBuilder().with(CRITICAL, 2L).with(CLEARED, 1L).create();
+ assertEquals("A critical should be present", critical2cleared1, manager.getAlarmCounts());
+ assertEquals("A critical should be present", critical2cleared1, manager.getAlarmCounts(DEVICE_ID));
+
+ manager.updateAlarms(DEVICE_ID, ImmutableSet.of());
+ verifyGettingSetsOfAlarms(manager, 3, 0);
+ validateEvents(AlarmEvent.Type.CREATED, AlarmEvent.Type.CREATED);
+ assertEquals(new CountsMapBuilder().with(CLEARED, 3L).create(), manager.getAlarmCounts(DEVICE_ID));
+
+ assertEquals("The counts should be empty for unknown devices", zeroAlarms,
+ manager.getAlarmCounts(DeviceId.NONE));
+ assertEquals("The counts should be empty for unknown devices", zeroAlarms,
+ manager.getAlarmCounts(DeviceId.deviceId("junk:junk")));
+
+ }
+
+ private void verifyGettingSetsOfAlarms(AlarmManager am, int expectedTotal, int expectedActive) {
+ assertEquals("Incorrect total alarms", expectedTotal, am.getAlarms().size());
+ assertEquals("Incorrect active alarms count", expectedActive, am.getActiveAlarms().size());
+ }
+
+ /**
+ * Method to validate that actual versus expected device key events were
+ * received correctly.
+ *
+ * @param types expected device key events.
+ */
+ private void validateEvents(Enum... types) {
+ TestTools.assertAfter(100, () -> {
+ int i = 0;
+ assertEquals("wrong events received", types.length, listener.events.size());
+ for (Event event : listener.events) {
+ assertEquals("incorrect event type", types[i], event.type());
+ i++;
+ }
+ listener.events.clear();
+ });
+ }
+
+ private static class CountsMapBuilder {
+
+ private final Map<Alarm.SeverityLevel, Long> map = new HashMap<>();
+
+ public CountsMapBuilder with(Alarm.SeverityLevel sev, Long count) {
+ map.put(sev, count);
+ return this;
+ }
+
+ public Map<Alarm.SeverityLevel, Long> create() {
+ return Collections.unmodifiableMap(map);
+ }
+ }
+
+
+ /**
+ * Test listener class to receive alarm events.
+ */
+ private static class TestListener implements AlarmListener {
+
+ protected List<AlarmEvent> events = Lists.newArrayList();
+
+ @Override
+ public void event(AlarmEvent event) {
+ events.add(event);
+ }
+
+ }
+}
diff --git a/apps/faultmanagement/fmmgr/src/test/java/org/onosproject/faultmanagement/impl/AlarmsManagerTest.java b/apps/faultmanagement/fmmgr/src/test/java/org/onosproject/faultmanagement/impl/AlarmsManagerTest.java
deleted file mode 100644
index 7bc1b77..0000000
--- a/apps/faultmanagement/fmmgr/src/test/java/org/onosproject/faultmanagement/impl/AlarmsManagerTest.java
+++ /dev/null
@@ -1,163 +0,0 @@
-/*
- * Copyright 2015-present Open Networking Laboratory
- *
- * 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.
- */
-package org.onosproject.faultmanagement.impl;
-
-import com.google.common.collect.ImmutableSet;
-import org.junit.Before;
-import org.junit.Rule;
-import org.junit.Test;
-import org.junit.rules.ExpectedException;
-import org.onlab.util.ItemNotFoundException;
-import org.onosproject.incubator.net.faultmanagement.alarm.Alarm;
-import org.onosproject.incubator.net.faultmanagement.alarm.AlarmEntityId;
-import org.onosproject.incubator.net.faultmanagement.alarm.AlarmId;
-import org.onosproject.incubator.net.faultmanagement.alarm.DefaultAlarm;
-import org.onosproject.net.DeviceId;
-
-import java.util.Collections;
-import java.util.HashMap;
-import java.util.Map;
-
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertTrue;
-import static org.onosproject.incubator.net.faultmanagement.alarm.Alarm.SeverityLevel.CLEARED;
-import static org.onosproject.incubator.net.faultmanagement.alarm.Alarm.SeverityLevel.CRITICAL;
-
-/**
- * Alarm manager test suite.
- */
-public class AlarmsManagerTest {
-
- private static final DeviceId DEVICE_ID = DeviceId.deviceId("foo:bar");
- private static final DefaultAlarm ALARM_A = new DefaultAlarm.Builder(
- DEVICE_ID, "aaa", Alarm.SeverityLevel.CRITICAL, 0).build();
-
- private static final DefaultAlarm ALARM_A_WITHSRC = new DefaultAlarm.Builder(
- ALARM_A).forSource(AlarmEntityId.alarmEntityId("port:foo")).build();
-
- private static final DefaultAlarm ALARM_B = new DefaultAlarm.Builder(
- DEVICE_ID, "bbb", Alarm.SeverityLevel.CRITICAL, 0).build();
-
- private AlarmsManager am;
-
- @Rule
- public final ExpectedException exception = ExpectedException.none();
-
- @Before
- public void setUp() throws Exception {
- am = new AlarmsManager();
- }
-
- @Test
- public void deactivate() throws Exception {
- am.updateAlarms(DEVICE_ID, ImmutableSet.of(ALARM_B, ALARM_A));
- verifyGettingSetsOfAlarms(am, 2, 2);
- am.deactivate(null);
- assertEquals("Alarms should be purged", 0, am.alarms.size());
- }
-
- @Test
- public void testGettersWhenNoAlarms() {
-
- assertTrue("No alarms should be present", am.getAlarms().isEmpty());
- assertTrue("No active alarms should be present", am.getActiveAlarms().isEmpty());
- assertTrue("The map should be empty per unknown device",
- am.getAlarmCounts(DeviceId.NONE).keySet().isEmpty());
- assertTrue("The counts should be empty", am.getAlarmCounts().keySet().isEmpty());
-
- assertEquals("Incorrect number of alarms for unknown device",
- 0, am.getAlarms(DeviceId.NONE).size());
- assertEquals("Incorrect number of major alarms for unknown device",
- 0, am.getAlarms(Alarm.SeverityLevel.MAJOR).size());
-
- exception.expect(NullPointerException.class);
- am.getAlarm(null);
-
- exception.expect(ItemNotFoundException.class);
- am.getAlarm(AlarmId.alarmId(1));
- }
-
- @Test
- public void testAlarmUpdates() {
-
- assertTrue("No alarms should be present", am.getAlarms().isEmpty());
- am.updateAlarms(DEVICE_ID, ImmutableSet.of());
- assertTrue("No alarms should be present", am.getAlarms().isEmpty());
- Map<Alarm.SeverityLevel, Long> zeroAlarms = new CountsMapBuilder().create();
- assertEquals("No alarms count should be present", zeroAlarms, am.getAlarmCounts());
- assertEquals("No alarms count should be present", zeroAlarms, am.getAlarmCounts(DEVICE_ID));
-
- am.updateAlarms(DEVICE_ID, ImmutableSet.of(ALARM_B, ALARM_A));
- verifyGettingSetsOfAlarms(am, 2, 2);
- Map<Alarm.SeverityLevel, Long> critical2 = new CountsMapBuilder().with(CRITICAL, 2L).create();
- assertEquals("A critical should be present", critical2, am.getAlarmCounts());
- assertEquals("A critical should be present", critical2, am.getAlarmCounts(DEVICE_ID));
-
- am.updateAlarms(DEVICE_ID, ImmutableSet.of(ALARM_A));
- verifyGettingSetsOfAlarms(am, 2, 1);
- Map<Alarm.SeverityLevel, Long> critical1cleared1 =
- new CountsMapBuilder().with(CRITICAL, 1L).with(CLEARED, 1L).create();
- assertEquals("A critical should be present and cleared", critical1cleared1,
- am.getAlarmCounts());
- assertEquals("A critical should be present and cleared", critical1cleared1,
- am.getAlarmCounts(DEVICE_ID));
-
- // No change map when same alarms sent
- am.updateAlarms(DEVICE_ID, ImmutableSet.of(ALARM_A));
- verifyGettingSetsOfAlarms(am, 2, 1);
- assertEquals("Map should not be changed for same alarm", critical1cleared1,
- am.getAlarmCounts());
- assertEquals("Map should not be changed for same alarm", critical1cleared1,
- am.getAlarmCounts(DEVICE_ID));
-
- am.updateAlarms(DEVICE_ID, ImmutableSet.of(ALARM_A, ALARM_A_WITHSRC));
- verifyGettingSetsOfAlarms(am, 3, 2);
- Map<Alarm.SeverityLevel, Long> critical2cleared1 =
- new CountsMapBuilder().with(CRITICAL, 2L).with(CLEARED, 1L).create();
- assertEquals("A critical should be present", critical2cleared1, am.getAlarmCounts());
- assertEquals("A critical should be present", critical2cleared1, am.getAlarmCounts(DEVICE_ID));
-
- am.updateAlarms(DEVICE_ID, ImmutableSet.of());
- verifyGettingSetsOfAlarms(am, 3, 0);
- assertEquals(new CountsMapBuilder().with(CLEARED, 3L).create(), am.getAlarmCounts(DEVICE_ID));
-
- assertEquals("The counts should be empty for unknown devices", zeroAlarms,
- am.getAlarmCounts(DeviceId.NONE));
- assertEquals("The counts should be empty for unknown devices", zeroAlarms,
- am.getAlarmCounts(DeviceId.deviceId("junk:junk")));
-
- }
-
- private void verifyGettingSetsOfAlarms(AlarmsManager am, int expectedTotal, int expectedActive) {
- assertEquals("Incorrect total alarms", expectedTotal, am.getAlarms().size());
- assertEquals("Incorrect active alarms count", expectedActive, am.getActiveAlarms().size());
- }
-
- private static class CountsMapBuilder {
-
- private final Map<Alarm.SeverityLevel, Long> map = new HashMap<>();
-
- public CountsMapBuilder with(Alarm.SeverityLevel sev, Long count) {
- map.put(sev, count);
- return this;
- }
-
- public Map<Alarm.SeverityLevel, Long> create() {
- return Collections.unmodifiableMap(map);
- }
- }
-
-}
diff --git a/apps/faultmanagement/fmmgr/src/test/java/org/onosproject/faultmanagement/impl/DistributedAlarmStoreTest.java b/apps/faultmanagement/fmmgr/src/test/java/org/onosproject/faultmanagement/impl/DistributedAlarmStoreTest.java
new file mode 100644
index 0000000..34fb320
--- /dev/null
+++ b/apps/faultmanagement/fmmgr/src/test/java/org/onosproject/faultmanagement/impl/DistributedAlarmStoreTest.java
@@ -0,0 +1,76 @@
+/*
+ * Copyright 2016-present Open Networking Laboratory
+ *
+ * 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.
+ */
+
+package org.onosproject.faultmanagement.impl;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.onosproject.incubator.net.faultmanagement.alarm.Alarm;
+import org.onosproject.incubator.net.faultmanagement.alarm.DefaultAlarm;
+import org.onosproject.net.DeviceId;
+import org.onosproject.store.service.TestStorageService;
+
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+
+/**
+ * Distributed Alarm store test suite.
+ */
+public class DistributedAlarmStoreTest {
+ private DistributedAlarmStore alarmStore;
+ private static final DeviceId DEVICE_ID = DeviceId.deviceId("foo:bar");
+ private static final DefaultAlarm ALARM_A = new DefaultAlarm.Builder(
+ DEVICE_ID, "aaa", Alarm.SeverityLevel.CRITICAL, 0).build();
+
+ /**
+ * Sets up the device key store and the storage service test harness.
+ */
+ @Before
+ public void setUp() {
+ alarmStore = new DistributedAlarmStore();
+ alarmStore.storageService = new TestStorageService();
+ alarmStore.setDelegate(event -> {
+ });
+ alarmStore.activate();
+ }
+
+ /**
+ * Tears down the device key store.
+ */
+ @After
+ public void tearDown() {
+ alarmStore.deactivate();
+ }
+
+ /**
+ * Tests adding, removing and getting.
+ */
+ @Test
+ public void basics() {
+ alarmStore.setAlarm(ALARM_A);
+ assertTrue("There should be one alarm in the set.",
+ alarmStore.getAlarms().contains(ALARM_A));
+ assertTrue("The same alarm should be returned.",
+ alarmStore.getAlarms(DEVICE_ID).contains(ALARM_A));
+ assertTrue("The alarm should be the same",
+ alarmStore.getAlarm(ALARM_A.id()).equals(ALARM_A));
+ alarmStore.removeAlarm(ALARM_A.id());
+ assertFalse("There should be no alarm in the set.",
+ alarmStore.getAlarms().contains(ALARM_A));
+ }
+
+}