| /* |
| * Copyright 2014 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.onlab.onos.store.device.impl; |
| |
| import static org.easymock.EasyMock.*; |
| import static org.junit.Assert.*; |
| import static org.onlab.onos.net.Device.Type.SWITCH; |
| import static org.onlab.onos.net.DeviceId.deviceId; |
| import static org.onlab.onos.net.device.DeviceEvent.Type.*; |
| import static org.onlab.onos.cluster.ControllerNode.State.*; |
| import static org.onlab.onos.net.DefaultAnnotations.union; |
| import static java.util.Arrays.asList; |
| |
| import java.io.IOException; |
| import java.util.Arrays; |
| import java.util.Collections; |
| import java.util.HashMap; |
| import java.util.List; |
| import java.util.Map; |
| import java.util.Set; |
| import java.util.concurrent.CountDownLatch; |
| import java.util.concurrent.TimeUnit; |
| |
| import org.easymock.Capture; |
| import org.junit.After; |
| import org.junit.AfterClass; |
| import org.junit.Before; |
| import org.junit.BeforeClass; |
| import org.junit.Ignore; |
| import org.junit.Test; |
| import org.onlab.onos.cluster.ClusterEventListener; |
| import org.onlab.onos.cluster.ClusterService; |
| import org.onlab.onos.cluster.ControllerNode; |
| import org.onlab.onos.cluster.ControllerNode.State; |
| import org.onlab.onos.cluster.DefaultControllerNode; |
| import org.onlab.onos.cluster.NodeId; |
| import org.onlab.onos.mastership.MastershipServiceAdapter; |
| import org.onlab.onos.mastership.MastershipTerm; |
| import org.onlab.onos.net.Annotations; |
| import org.onlab.onos.net.DefaultAnnotations; |
| import org.onlab.onos.net.Device; |
| import org.onlab.onos.net.DeviceId; |
| import org.onlab.onos.net.Port; |
| import org.onlab.onos.net.PortNumber; |
| import org.onlab.onos.net.SparseAnnotations; |
| import org.onlab.onos.net.device.DefaultDeviceDescription; |
| import org.onlab.onos.net.device.DefaultPortDescription; |
| import org.onlab.onos.net.device.DeviceClockService; |
| import org.onlab.onos.net.device.DeviceDescription; |
| import org.onlab.onos.net.device.DeviceEvent; |
| import org.onlab.onos.net.device.DeviceStore; |
| import org.onlab.onos.net.device.DeviceStoreDelegate; |
| import org.onlab.onos.net.device.PortDescription; |
| import org.onlab.onos.net.provider.ProviderId; |
| import org.onlab.onos.store.cluster.messaging.ClusterCommunicationService; |
| import org.onlab.onos.store.cluster.messaging.ClusterMessage; |
| import org.onlab.onos.store.cluster.messaging.ClusterMessageHandler; |
| import org.onlab.onos.store.cluster.messaging.MessageSubject; |
| import org.onlab.packet.ChassisId; |
| import org.onlab.packet.IpAddress; |
| |
| import com.google.common.collect.Iterables; |
| import com.google.common.collect.Sets; |
| |
| |
| // TODO add tests for remote replication |
| /** |
| * Test of the gossip based distributed DeviceStore implementation. |
| */ |
| public class GossipDeviceStoreTest { |
| |
| private static final ProviderId PID = new ProviderId("of", "foo"); |
| private static final ProviderId PIDA = new ProviderId("of", "bar", true); |
| private static final DeviceId DID1 = deviceId("of:foo"); |
| private static final DeviceId DID2 = deviceId("of:bar"); |
| private static final String MFR = "whitebox"; |
| private static final String HW = "1.1.x"; |
| private static final String SW1 = "3.8.1"; |
| private static final String SW2 = "3.9.5"; |
| private static final String SN = "43311-12345"; |
| private static final ChassisId CID = new ChassisId(); |
| |
| private static final PortNumber P1 = PortNumber.portNumber(1); |
| private static final PortNumber P2 = PortNumber.portNumber(2); |
| private static final PortNumber P3 = PortNumber.portNumber(3); |
| |
| private static final SparseAnnotations A1 = DefaultAnnotations.builder() |
| .set("A1", "a1") |
| .set("B1", "b1") |
| .build(); |
| private static final SparseAnnotations A1_2 = DefaultAnnotations.builder() |
| .remove("A1") |
| .set("B3", "b3") |
| .build(); |
| private static final SparseAnnotations A2 = DefaultAnnotations.builder() |
| .set("A2", "a2") |
| .set("B2", "b2") |
| .build(); |
| private static final SparseAnnotations A2_2 = DefaultAnnotations.builder() |
| .remove("A2") |
| .set("B4", "b4") |
| .build(); |
| |
| // local node |
| private static final NodeId NID1 = new NodeId("local"); |
| private static final ControllerNode ONOS1 = |
| new DefaultControllerNode(NID1, IpAddress.valueOf("127.0.0.1")); |
| |
| // remote node |
| private static final NodeId NID2 = new NodeId("remote"); |
| private static final ControllerNode ONOS2 = |
| new DefaultControllerNode(NID2, IpAddress.valueOf("127.0.0.2")); |
| private static final List<SparseAnnotations> NO_ANNOTATION = Collections.<SparseAnnotations>emptyList(); |
| |
| |
| private TestGossipDeviceStore testGossipDeviceStore; |
| private GossipDeviceStore gossipDeviceStore; |
| private DeviceStore deviceStore; |
| |
| private DeviceClockManager deviceClockManager; |
| private DeviceClockService deviceClockService; |
| private ClusterCommunicationService clusterCommunicator; |
| @BeforeClass |
| public static void setUpBeforeClass() throws Exception { |
| } |
| |
| @AfterClass |
| public static void tearDownAfterClass() throws Exception { |
| } |
| |
| |
| @Before |
| public void setUp() throws Exception { |
| deviceClockManager = new DeviceClockManager(); |
| deviceClockManager.activate(); |
| deviceClockService = deviceClockManager; |
| |
| deviceClockManager.setMastershipTerm(DID1, MastershipTerm.of(NID1, 1)); |
| deviceClockManager.setMastershipTerm(DID2, MastershipTerm.of(NID1, 2)); |
| |
| clusterCommunicator = createNiceMock(ClusterCommunicationService.class); |
| clusterCommunicator.addSubscriber(anyObject(MessageSubject.class), |
| anyObject(ClusterMessageHandler.class)); |
| expectLastCall().anyTimes(); |
| replay(clusterCommunicator); |
| ClusterService clusterService = new TestClusterService(); |
| |
| testGossipDeviceStore = new TestGossipDeviceStore(deviceClockService, clusterService, clusterCommunicator); |
| testGossipDeviceStore.mastershipService = new TestMastershipService(); |
| |
| gossipDeviceStore = testGossipDeviceStore; |
| gossipDeviceStore.activate(); |
| deviceStore = gossipDeviceStore; |
| verify(clusterCommunicator); |
| reset(clusterCommunicator); |
| } |
| |
| @After |
| public void tearDown() throws Exception { |
| gossipDeviceStore.deactivate(); |
| deviceClockManager.deactivate(); |
| } |
| |
| private void putDevice(DeviceId deviceId, String swVersion, |
| SparseAnnotations... annotations) { |
| DeviceDescription description = |
| new DefaultDeviceDescription(deviceId.uri(), SWITCH, MFR, |
| HW, swVersion, SN, CID, annotations); |
| reset(clusterCommunicator); |
| try { |
| expect(clusterCommunicator.broadcast(anyObject(ClusterMessage.class))) |
| .andReturn(true).anyTimes(); |
| } catch (IOException e) { |
| fail("Should never reach here"); |
| } |
| replay(clusterCommunicator); |
| deviceStore.createOrUpdateDevice(PID, deviceId, description); |
| verify(clusterCommunicator); |
| } |
| |
| private void putDeviceAncillary(DeviceId deviceId, String swVersion, |
| SparseAnnotations... annotations) { |
| DeviceDescription description = |
| new DefaultDeviceDescription(deviceId.uri(), SWITCH, MFR, |
| HW, swVersion, SN, CID, annotations); |
| deviceStore.createOrUpdateDevice(PIDA, deviceId, description); |
| } |
| |
| private static void assertDevice(DeviceId id, String swVersion, Device device) { |
| assertNotNull(device); |
| assertEquals(id, device.id()); |
| assertEquals(MFR, device.manufacturer()); |
| assertEquals(HW, device.hwVersion()); |
| assertEquals(swVersion, device.swVersion()); |
| assertEquals(SN, device.serialNumber()); |
| } |
| |
| /** |
| * Verifies that Annotations created by merging {@code annotations} is |
| * equal to actual Annotations. |
| * |
| * @param actual Annotations to check |
| * @param annotations |
| */ |
| private static void assertAnnotationsEquals(Annotations actual, SparseAnnotations... annotations) { |
| SparseAnnotations expected = DefaultAnnotations.builder().build(); |
| for (SparseAnnotations a : annotations) { |
| expected = DefaultAnnotations.union(expected, a); |
| } |
| assertEquals(expected.keys(), actual.keys()); |
| for (String key : expected.keys()) { |
| assertEquals(expected.value(key), actual.value(key)); |
| } |
| } |
| |
| private static void assertDeviceDescriptionEquals(DeviceDescription expected, |
| DeviceDescription actual) { |
| if (expected == actual) { |
| return; |
| } |
| assertEquals(expected.deviceURI(), actual.deviceURI()); |
| assertEquals(expected.hwVersion(), actual.hwVersion()); |
| assertEquals(expected.manufacturer(), actual.manufacturer()); |
| assertEquals(expected.serialNumber(), actual.serialNumber()); |
| assertEquals(expected.swVersion(), actual.swVersion()); |
| |
| assertAnnotationsEquals(actual.annotations(), expected.annotations()); |
| } |
| |
| private static void assertDeviceDescriptionEquals(DeviceDescription expected, |
| List<SparseAnnotations> expectedAnnotations, |
| DeviceDescription actual) { |
| if (expected == actual) { |
| return; |
| } |
| assertEquals(expected.deviceURI(), actual.deviceURI()); |
| assertEquals(expected.hwVersion(), actual.hwVersion()); |
| assertEquals(expected.manufacturer(), actual.manufacturer()); |
| assertEquals(expected.serialNumber(), actual.serialNumber()); |
| assertEquals(expected.swVersion(), actual.swVersion()); |
| |
| assertAnnotationsEquals(actual.annotations(), |
| expectedAnnotations.toArray(new SparseAnnotations[0])); |
| } |
| |
| @Test |
| public final void testGetDeviceCount() { |
| assertEquals("initialy empty", 0, deviceStore.getDeviceCount()); |
| |
| putDevice(DID1, SW1); |
| putDevice(DID2, SW2); |
| putDevice(DID1, SW1); |
| |
| assertEquals("expect 2 uniq devices", 2, deviceStore.getDeviceCount()); |
| } |
| |
| @Test |
| public final void testGetDevices() { |
| assertEquals("initialy empty", 0, Iterables.size(deviceStore.getDevices())); |
| |
| putDevice(DID1, SW1); |
| putDevice(DID2, SW2); |
| putDevice(DID1, SW1); |
| |
| assertEquals("expect 2 uniq devices", |
| 2, Iterables.size(deviceStore.getDevices())); |
| |
| Map<DeviceId, Device> devices = new HashMap<>(); |
| for (Device device : deviceStore.getDevices()) { |
| devices.put(device.id(), device); |
| } |
| |
| assertDevice(DID1, SW1, devices.get(DID1)); |
| assertDevice(DID2, SW2, devices.get(DID2)); |
| |
| // add case for new node? |
| } |
| |
| @Test |
| public final void testGetDevice() { |
| |
| putDevice(DID1, SW1); |
| |
| assertDevice(DID1, SW1, deviceStore.getDevice(DID1)); |
| assertNull("DID2 shouldn't be there", deviceStore.getDevice(DID2)); |
| } |
| |
| private void assertInternalDeviceEvent(NodeId sender, |
| DeviceId deviceId, |
| ProviderId providerId, |
| DeviceDescription expectedDesc, |
| Capture<ClusterMessage> actualMsg) { |
| assertTrue(actualMsg.hasCaptured()); |
| assertEquals(sender, actualMsg.getValue().sender()); |
| assertEquals(GossipDeviceStoreMessageSubjects.DEVICE_UPDATE, |
| actualMsg.getValue().subject()); |
| InternalDeviceEvent addEvent |
| = testGossipDeviceStore.deserialize(actualMsg.getValue().payload()); |
| assertEquals(deviceId, addEvent.deviceId()); |
| assertEquals(providerId, addEvent.providerId()); |
| assertDeviceDescriptionEquals(expectedDesc, addEvent.deviceDescription().value()); |
| } |
| |
| private void assertInternalDeviceEvent(NodeId sender, |
| DeviceId deviceId, |
| ProviderId providerId, |
| DeviceDescription expectedDesc, |
| List<SparseAnnotations> expectedAnnotations, |
| Capture<ClusterMessage> actualMsg) { |
| assertTrue(actualMsg.hasCaptured()); |
| assertEquals(sender, actualMsg.getValue().sender()); |
| assertEquals(GossipDeviceStoreMessageSubjects.DEVICE_UPDATE, |
| actualMsg.getValue().subject()); |
| InternalDeviceEvent addEvent |
| = testGossipDeviceStore.deserialize(actualMsg.getValue().payload()); |
| assertEquals(deviceId, addEvent.deviceId()); |
| assertEquals(providerId, addEvent.providerId()); |
| assertDeviceDescriptionEquals(expectedDesc, expectedAnnotations, addEvent.deviceDescription().value()); |
| } |
| |
| @Test |
| public final void testCreateOrUpdateDevice() throws IOException { |
| DeviceDescription description = |
| new DefaultDeviceDescription(DID1.uri(), SWITCH, MFR, |
| HW, SW1, SN, CID); |
| Capture<ClusterMessage> bcast = new Capture<>(); |
| |
| resetCommunicatorExpectingSingleBroadcast(bcast); |
| DeviceEvent event = deviceStore.createOrUpdateDevice(PID, DID1, description); |
| assertEquals(DEVICE_ADDED, event.type()); |
| assertDevice(DID1, SW1, event.subject()); |
| verify(clusterCommunicator); |
| assertInternalDeviceEvent(NID1, DID1, PID, description, bcast); |
| |
| |
| DeviceDescription description2 = |
| new DefaultDeviceDescription(DID1.uri(), SWITCH, MFR, |
| HW, SW2, SN, CID); |
| resetCommunicatorExpectingSingleBroadcast(bcast); |
| DeviceEvent event2 = deviceStore.createOrUpdateDevice(PID, DID1, description2); |
| assertEquals(DEVICE_UPDATED, event2.type()); |
| assertDevice(DID1, SW2, event2.subject()); |
| |
| verify(clusterCommunicator); |
| assertInternalDeviceEvent(NID1, DID1, PID, description2, bcast); |
| reset(clusterCommunicator); |
| |
| assertNull("No change expected", deviceStore.createOrUpdateDevice(PID, DID1, description2)); |
| } |
| |
| @Test |
| public final void testCreateOrUpdateDeviceAncillary() throws IOException { |
| // add |
| DeviceDescription description = |
| new DefaultDeviceDescription(DID1.uri(), SWITCH, MFR, |
| HW, SW1, SN, CID, A2); |
| Capture<ClusterMessage> bcast = new Capture<>(); |
| |
| resetCommunicatorExpectingSingleBroadcast(bcast); |
| DeviceEvent event = deviceStore.createOrUpdateDevice(PIDA, DID1, description); |
| assertEquals(DEVICE_ADDED, event.type()); |
| assertDevice(DID1, SW1, event.subject()); |
| assertEquals(PIDA, event.subject().providerId()); |
| assertAnnotationsEquals(event.subject().annotations(), A2); |
| assertFalse("Ancillary will not bring device up", deviceStore.isAvailable(DID1)); |
| verify(clusterCommunicator); |
| assertInternalDeviceEvent(NID1, DID1, PIDA, description, bcast); |
| |
| // update from primary |
| DeviceDescription description2 = |
| new DefaultDeviceDescription(DID1.uri(), SWITCH, MFR, |
| HW, SW2, SN, CID, A1); |
| resetCommunicatorExpectingSingleBroadcast(bcast); |
| |
| DeviceEvent event2 = deviceStore.createOrUpdateDevice(PID, DID1, description2); |
| assertEquals(DEVICE_UPDATED, event2.type()); |
| assertDevice(DID1, SW2, event2.subject()); |
| assertEquals(PID, event2.subject().providerId()); |
| assertAnnotationsEquals(event2.subject().annotations(), A1, A2); |
| assertTrue(deviceStore.isAvailable(DID1)); |
| verify(clusterCommunicator); |
| assertInternalDeviceEvent(NID1, DID1, PID, description2, bcast); |
| |
| // no-op update from primary |
| resetCommunicatorExpectingNoBroadcast(bcast); |
| assertNull("No change expected", deviceStore.createOrUpdateDevice(PID, DID1, description2)); |
| |
| verify(clusterCommunicator); |
| assertFalse("no broadcast expected", bcast.hasCaptured()); |
| |
| // For now, Ancillary is ignored once primary appears |
| resetCommunicatorExpectingNoBroadcast(bcast); |
| |
| assertNull("No change expected", deviceStore.createOrUpdateDevice(PIDA, DID1, description)); |
| |
| verify(clusterCommunicator); |
| assertFalse("no broadcast expected", bcast.hasCaptured()); |
| |
| // But, Ancillary annotations will be in effect |
| DeviceDescription description3 = |
| new DefaultDeviceDescription(DID1.uri(), SWITCH, MFR, |
| HW, SW1, SN, CID, A2_2); |
| resetCommunicatorExpectingSingleBroadcast(bcast); |
| |
| DeviceEvent event3 = deviceStore.createOrUpdateDevice(PIDA, DID1, description3); |
| assertEquals(DEVICE_UPDATED, event3.type()); |
| // basic information will be the one from Primary |
| assertDevice(DID1, SW2, event3.subject()); |
| assertEquals(PID, event3.subject().providerId()); |
| // but annotation from Ancillary will be merged |
| assertAnnotationsEquals(event3.subject().annotations(), A1, A2, A2_2); |
| assertTrue(deviceStore.isAvailable(DID1)); |
| verify(clusterCommunicator); |
| // note: only annotation from PIDA is sent over the wire |
| assertInternalDeviceEvent(NID1, DID1, PIDA, description3, |
| asList(union(A2, A2_2)), bcast); |
| |
| } |
| |
| |
| @Test |
| public final void testMarkOffline() { |
| |
| putDevice(DID1, SW1); |
| assertTrue(deviceStore.isAvailable(DID1)); |
| |
| Capture<ClusterMessage> bcast = new Capture<>(); |
| |
| resetCommunicatorExpectingSingleBroadcast(bcast); |
| DeviceEvent event = deviceStore.markOffline(DID1); |
| assertEquals(DEVICE_AVAILABILITY_CHANGED, event.type()); |
| assertDevice(DID1, SW1, event.subject()); |
| assertFalse(deviceStore.isAvailable(DID1)); |
| verify(clusterCommunicator); |
| // TODO: verify broadcast message |
| assertTrue(bcast.hasCaptured()); |
| |
| |
| resetCommunicatorExpectingNoBroadcast(bcast); |
| DeviceEvent event2 = deviceStore.markOffline(DID1); |
| assertNull("No change, no event", event2); |
| verify(clusterCommunicator); |
| assertFalse(bcast.hasCaptured()); |
| } |
| |
| @Test |
| public final void testUpdatePorts() { |
| putDevice(DID1, SW1); |
| List<PortDescription> pds = Arrays.<PortDescription>asList( |
| new DefaultPortDescription(P1, true), |
| new DefaultPortDescription(P2, true) |
| ); |
| Capture<ClusterMessage> bcast = new Capture<>(); |
| |
| resetCommunicatorExpectingSingleBroadcast(bcast); |
| List<DeviceEvent> events = deviceStore.updatePorts(PID, DID1, pds); |
| verify(clusterCommunicator); |
| // TODO: verify broadcast message |
| assertTrue(bcast.hasCaptured()); |
| |
| Set<PortNumber> expectedPorts = Sets.newHashSet(P1, P2); |
| for (DeviceEvent event : events) { |
| assertEquals(PORT_ADDED, event.type()); |
| assertDevice(DID1, SW1, event.subject()); |
| assertTrue("PortNumber is one of expected", |
| expectedPorts.remove(event.port().number())); |
| assertTrue("Port is enabled", event.port().isEnabled()); |
| } |
| assertTrue("Event for all expectedport appeared", expectedPorts.isEmpty()); |
| |
| |
| List<PortDescription> pds2 = Arrays.<PortDescription>asList( |
| new DefaultPortDescription(P1, false), |
| new DefaultPortDescription(P2, true), |
| new DefaultPortDescription(P3, true) |
| ); |
| |
| resetCommunicatorExpectingSingleBroadcast(bcast); |
| events = deviceStore.updatePorts(PID, DID1, pds2); |
| verify(clusterCommunicator); |
| // TODO: verify broadcast message |
| assertTrue(bcast.hasCaptured()); |
| |
| assertFalse("event should be triggered", events.isEmpty()); |
| for (DeviceEvent event : events) { |
| PortNumber num = event.port().number(); |
| if (P1.equals(num)) { |
| assertEquals(PORT_UPDATED, event.type()); |
| assertDevice(DID1, SW1, event.subject()); |
| assertFalse("Port is disabled", event.port().isEnabled()); |
| } else if (P2.equals(num)) { |
| fail("P2 event not expected."); |
| } else if (P3.equals(num)) { |
| assertEquals(PORT_ADDED, event.type()); |
| assertDevice(DID1, SW1, event.subject()); |
| assertTrue("Port is enabled", event.port().isEnabled()); |
| } else { |
| fail("Unknown port number encountered: " + num); |
| } |
| } |
| |
| List<PortDescription> pds3 = Arrays.<PortDescription>asList( |
| new DefaultPortDescription(P1, false), |
| new DefaultPortDescription(P2, true) |
| ); |
| resetCommunicatorExpectingSingleBroadcast(bcast); |
| events = deviceStore.updatePorts(PID, DID1, pds3); |
| verify(clusterCommunicator); |
| // TODO: verify broadcast message |
| assertTrue(bcast.hasCaptured()); |
| |
| assertFalse("event should be triggered", events.isEmpty()); |
| for (DeviceEvent event : events) { |
| PortNumber num = event.port().number(); |
| if (P1.equals(num)) { |
| fail("P1 event not expected."); |
| } else if (P2.equals(num)) { |
| fail("P2 event not expected."); |
| } else if (P3.equals(num)) { |
| assertEquals(PORT_REMOVED, event.type()); |
| assertDevice(DID1, SW1, event.subject()); |
| assertTrue("Port was enabled", event.port().isEnabled()); |
| } else { |
| fail("Unknown port number encountered: " + num); |
| } |
| } |
| } |
| |
| @Test |
| public final void testUpdatePortStatus() { |
| putDevice(DID1, SW1); |
| List<PortDescription> pds = Arrays.<PortDescription>asList( |
| new DefaultPortDescription(P1, true) |
| ); |
| deviceStore.updatePorts(PID, DID1, pds); |
| |
| Capture<ClusterMessage> bcast = new Capture<>(); |
| |
| resetCommunicatorExpectingSingleBroadcast(bcast); |
| final DefaultPortDescription desc = new DefaultPortDescription(P1, false); |
| DeviceEvent event = deviceStore.updatePortStatus(PID, DID1, desc); |
| assertEquals(PORT_UPDATED, event.type()); |
| assertDevice(DID1, SW1, event.subject()); |
| assertEquals(P1, event.port().number()); |
| assertFalse("Port is disabled", event.port().isEnabled()); |
| verify(clusterCommunicator); |
| assertInternalPortStatusEvent(NID1, DID1, PID, desc, NO_ANNOTATION, bcast); |
| assertTrue(bcast.hasCaptured()); |
| } |
| |
| @Test |
| public final void testUpdatePortStatusAncillary() throws IOException { |
| putDeviceAncillary(DID1, SW1); |
| putDevice(DID1, SW1); |
| List<PortDescription> pds = Arrays.<PortDescription>asList( |
| new DefaultPortDescription(P1, true, A1) |
| ); |
| deviceStore.updatePorts(PID, DID1, pds); |
| |
| Capture<ClusterMessage> bcast = new Capture<>(); |
| |
| |
| // update port from primary |
| resetCommunicatorExpectingSingleBroadcast(bcast); |
| final DefaultPortDescription desc1 = new DefaultPortDescription(P1, false, A1_2); |
| DeviceEvent event = deviceStore.updatePortStatus(PID, DID1, desc1); |
| assertEquals(PORT_UPDATED, event.type()); |
| assertDevice(DID1, SW1, event.subject()); |
| assertEquals(P1, event.port().number()); |
| assertAnnotationsEquals(event.port().annotations(), A1, A1_2); |
| assertFalse("Port is disabled", event.port().isEnabled()); |
| verify(clusterCommunicator); |
| assertInternalPortStatusEvent(NID1, DID1, PID, desc1, asList(A1, A1_2), bcast); |
| assertTrue(bcast.hasCaptured()); |
| |
| // update port from ancillary with no attributes |
| resetCommunicatorExpectingNoBroadcast(bcast); |
| final DefaultPortDescription desc2 = new DefaultPortDescription(P1, true); |
| DeviceEvent event2 = deviceStore.updatePortStatus(PIDA, DID1, desc2); |
| assertNull("Ancillary is ignored if primary exists", event2); |
| verify(clusterCommunicator); |
| assertFalse(bcast.hasCaptured()); |
| |
| // but, Ancillary annotation update will be notified |
| resetCommunicatorExpectingSingleBroadcast(bcast); |
| final DefaultPortDescription desc3 = new DefaultPortDescription(P1, true, A2); |
| DeviceEvent event3 = deviceStore.updatePortStatus(PIDA, DID1, desc3); |
| assertEquals(PORT_UPDATED, event3.type()); |
| assertDevice(DID1, SW1, event3.subject()); |
| assertEquals(P1, event3.port().number()); |
| assertAnnotationsEquals(event3.port().annotations(), A1, A1_2, A2); |
| assertFalse("Port is disabled", event3.port().isEnabled()); |
| verify(clusterCommunicator); |
| assertInternalPortStatusEvent(NID1, DID1, PIDA, desc3, asList(A2), bcast); |
| assertTrue(bcast.hasCaptured()); |
| |
| // port only reported from Ancillary will be notified as down |
| resetCommunicatorExpectingSingleBroadcast(bcast); |
| final DefaultPortDescription desc4 = new DefaultPortDescription(P2, true); |
| DeviceEvent event4 = deviceStore.updatePortStatus(PIDA, DID1, desc4); |
| assertEquals(PORT_ADDED, event4.type()); |
| assertDevice(DID1, SW1, event4.subject()); |
| assertEquals(P2, event4.port().number()); |
| assertAnnotationsEquals(event4.port().annotations()); |
| assertFalse("Port is disabled if not given from primary provider", |
| event4.port().isEnabled()); |
| verify(clusterCommunicator); |
| // TODO: verify broadcast message content |
| assertInternalPortStatusEvent(NID1, DID1, PIDA, desc4, NO_ANNOTATION, bcast); |
| assertTrue(bcast.hasCaptured()); |
| } |
| |
| private void assertInternalPortStatusEvent(NodeId sender, DeviceId did, |
| ProviderId pid, DefaultPortDescription expectedDesc, |
| List<SparseAnnotations> expectedAnnotations, Capture<ClusterMessage> actualMsg) { |
| |
| assertTrue(actualMsg.hasCaptured()); |
| assertEquals(sender, actualMsg.getValue().sender()); |
| assertEquals(GossipDeviceStoreMessageSubjects.PORT_STATUS_UPDATE, |
| actualMsg.getValue().subject()); |
| InternalPortStatusEvent addEvent |
| = testGossipDeviceStore.deserialize(actualMsg.getValue().payload()); |
| assertEquals(did, addEvent.deviceId()); |
| assertEquals(pid, addEvent.providerId()); |
| assertPortDescriptionEquals(expectedDesc, expectedAnnotations, |
| addEvent.portDescription().value()); |
| |
| } |
| |
| private void assertPortDescriptionEquals( |
| PortDescription expectedDesc, |
| List<SparseAnnotations> expectedAnnotations, |
| PortDescription actual) { |
| |
| assertEquals(expectedDesc.portNumber(), actual.portNumber()); |
| assertEquals(expectedDesc.isEnabled(), actual.isEnabled()); |
| |
| assertAnnotationsEquals(actual.annotations(), |
| expectedAnnotations.toArray(new SparseAnnotations[0])); |
| } |
| |
| private void resetCommunicatorExpectingNoBroadcast( |
| Capture<ClusterMessage> bcast) { |
| bcast.reset(); |
| reset(clusterCommunicator); |
| replay(clusterCommunicator); |
| } |
| |
| private void resetCommunicatorExpectingSingleBroadcast( |
| Capture<ClusterMessage> bcast) { |
| |
| bcast.reset(); |
| reset(clusterCommunicator); |
| try { |
| expect(clusterCommunicator.broadcast(capture(bcast))).andReturn(true).once(); |
| } catch (IOException e) { |
| fail("Should never reach here"); |
| } |
| replay(clusterCommunicator); |
| } |
| |
| @Test |
| public final void testGetPorts() { |
| putDevice(DID1, SW1); |
| putDevice(DID2, SW1); |
| List<PortDescription> pds = Arrays.<PortDescription>asList( |
| new DefaultPortDescription(P1, true), |
| new DefaultPortDescription(P2, true) |
| ); |
| deviceStore.updatePorts(PID, DID1, pds); |
| |
| Set<PortNumber> expectedPorts = Sets.newHashSet(P1, P2); |
| List<Port> ports = deviceStore.getPorts(DID1); |
| for (Port port : ports) { |
| assertTrue("Port is enabled", port.isEnabled()); |
| assertTrue("PortNumber is one of expected", |
| expectedPorts.remove(port.number())); |
| } |
| assertTrue("Event for all expectedport appeared", expectedPorts.isEmpty()); |
| |
| |
| assertTrue("DID2 has no ports", deviceStore.getPorts(DID2).isEmpty()); |
| } |
| |
| @Test |
| public final void testGetPort() { |
| putDevice(DID1, SW1); |
| putDevice(DID2, SW1); |
| List<PortDescription> pds = Arrays.<PortDescription>asList( |
| new DefaultPortDescription(P1, true), |
| new DefaultPortDescription(P2, false) |
| ); |
| deviceStore.updatePorts(PID, DID1, pds); |
| |
| Port port1 = deviceStore.getPort(DID1, P1); |
| assertEquals(P1, port1.number()); |
| assertTrue("Port is enabled", port1.isEnabled()); |
| |
| Port port2 = deviceStore.getPort(DID1, P2); |
| assertEquals(P2, port2.number()); |
| assertFalse("Port is disabled", port2.isEnabled()); |
| |
| Port port3 = deviceStore.getPort(DID1, P3); |
| assertNull("P3 not expected", port3); |
| } |
| |
| @Test |
| public final void testRemoveDevice() { |
| putDevice(DID1, SW1, A1); |
| List<PortDescription> pds = Arrays.<PortDescription>asList( |
| new DefaultPortDescription(P1, true, A2) |
| ); |
| deviceStore.updatePorts(PID, DID1, pds); |
| putDevice(DID2, SW1); |
| |
| assertEquals(2, deviceStore.getDeviceCount()); |
| assertEquals(1, deviceStore.getPorts(DID1).size()); |
| assertAnnotationsEquals(deviceStore.getDevice(DID1).annotations(), A1); |
| assertAnnotationsEquals(deviceStore.getPort(DID1, P1).annotations(), A2); |
| |
| Capture<ClusterMessage> bcast = new Capture<>(); |
| |
| resetCommunicatorExpectingSingleBroadcast(bcast); |
| |
| DeviceEvent event = deviceStore.removeDevice(DID1); |
| assertEquals(DEVICE_REMOVED, event.type()); |
| assertDevice(DID1, SW1, event.subject()); |
| |
| assertEquals(1, deviceStore.getDeviceCount()); |
| assertEquals(0, deviceStore.getPorts(DID1).size()); |
| verify(clusterCommunicator); |
| // TODO: verify broadcast message |
| assertTrue(bcast.hasCaptured()); |
| |
| // putBack Device, Port w/o annotation |
| putDevice(DID1, SW1); |
| List<PortDescription> pds2 = Arrays.<PortDescription>asList( |
| new DefaultPortDescription(P1, true) |
| ); |
| deviceStore.updatePorts(PID, DID1, pds2); |
| |
| // annotations should not survive |
| assertEquals(2, deviceStore.getDeviceCount()); |
| assertEquals(1, deviceStore.getPorts(DID1).size()); |
| assertAnnotationsEquals(deviceStore.getDevice(DID1).annotations()); |
| assertAnnotationsEquals(deviceStore.getPort(DID1, P1).annotations()); |
| } |
| |
| // If Delegates should be called only on remote events, |
| // then Simple* should never call them, thus not test required. |
| // TODO add test for Port events when we have them |
| @Ignore("Ignore until Delegate spec. is clear.") |
| @Test |
| public final void testEvents() throws InterruptedException { |
| final CountDownLatch addLatch = new CountDownLatch(1); |
| DeviceStoreDelegate checkAdd = new DeviceStoreDelegate() { |
| @Override |
| public void notify(DeviceEvent event) { |
| assertEquals(DEVICE_ADDED, event.type()); |
| assertDevice(DID1, SW1, event.subject()); |
| addLatch.countDown(); |
| } |
| }; |
| final CountDownLatch updateLatch = new CountDownLatch(1); |
| DeviceStoreDelegate checkUpdate = new DeviceStoreDelegate() { |
| @Override |
| public void notify(DeviceEvent event) { |
| assertEquals(DEVICE_UPDATED, event.type()); |
| assertDevice(DID1, SW2, event.subject()); |
| updateLatch.countDown(); |
| } |
| }; |
| final CountDownLatch removeLatch = new CountDownLatch(1); |
| DeviceStoreDelegate checkRemove = new DeviceStoreDelegate() { |
| @Override |
| public void notify(DeviceEvent event) { |
| assertEquals(DEVICE_REMOVED, event.type()); |
| assertDevice(DID1, SW2, event.subject()); |
| removeLatch.countDown(); |
| } |
| }; |
| |
| DeviceDescription description = |
| new DefaultDeviceDescription(DID1.uri(), SWITCH, MFR, |
| HW, SW1, SN, CID); |
| deviceStore.setDelegate(checkAdd); |
| deviceStore.createOrUpdateDevice(PID, DID1, description); |
| assertTrue("Add event fired", addLatch.await(1, TimeUnit.SECONDS)); |
| |
| |
| DeviceDescription description2 = |
| new DefaultDeviceDescription(DID1.uri(), SWITCH, MFR, |
| HW, SW2, SN, CID); |
| deviceStore.unsetDelegate(checkAdd); |
| deviceStore.setDelegate(checkUpdate); |
| deviceStore.createOrUpdateDevice(PID, DID1, description2); |
| assertTrue("Update event fired", updateLatch.await(1, TimeUnit.SECONDS)); |
| |
| deviceStore.unsetDelegate(checkUpdate); |
| deviceStore.setDelegate(checkRemove); |
| deviceStore.removeDevice(DID1); |
| assertTrue("Remove event fired", removeLatch.await(1, TimeUnit.SECONDS)); |
| } |
| |
| private final class TestMastershipService extends MastershipServiceAdapter { |
| @Override |
| public NodeId getMasterFor(DeviceId deviceId) { |
| return NID1; |
| } |
| } |
| |
| private static final class TestGossipDeviceStore extends GossipDeviceStore { |
| |
| public TestGossipDeviceStore( |
| DeviceClockService deviceClockService, |
| ClusterService clusterService, |
| ClusterCommunicationService clusterCommunicator) { |
| this.deviceClockService = deviceClockService; |
| this.clusterService = clusterService; |
| this.clusterCommunicator = clusterCommunicator; |
| } |
| |
| public <T> T deserialize(byte[] bytes) { |
| return SERIALIZER.decode(bytes); |
| } |
| } |
| |
| private static final class TestClusterService implements ClusterService { |
| |
| private final Map<NodeId, ControllerNode> nodes = new HashMap<>(); |
| private final Map<NodeId, ControllerNode.State> nodeStates = new HashMap<>(); |
| |
| public TestClusterService() { |
| nodes.put(NID1, ONOS1); |
| nodeStates.put(NID1, ACTIVE); |
| |
| nodes.put(NID2, ONOS2); |
| nodeStates.put(NID2, ACTIVE); |
| } |
| |
| @Override |
| public ControllerNode getLocalNode() { |
| return GossipDeviceStoreTest.ONOS1; |
| } |
| |
| @Override |
| public Set<ControllerNode> getNodes() { |
| return Sets.newHashSet(nodes.values()); |
| } |
| |
| @Override |
| public ControllerNode getNode(NodeId nodeId) { |
| return nodes.get(nodeId); |
| } |
| |
| @Override |
| public State getState(NodeId nodeId) { |
| return nodeStates.get(nodeId); |
| } |
| |
| @Override |
| public void addListener(ClusterEventListener listener) { |
| } |
| |
| @Override |
| public void removeListener(ClusterEventListener listener) { |
| } |
| } |
| } |