neutron-ovsdb/src/test/java/org/opendaylight/groupbasedpolicy/neutron/ovsdb/TerminationPointDataChangeListenerTest.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.groupbasedpolicy.neutron.ovsdb;
  10
  11 import static org.mockito.Matchers.any;
  12 import static org.mockito.Mockito.mock;
  13 import static org.mockito.Mockito.never;
  14 import static org.mockito.Mockito.verify;
  15 import static org.mockito.Mockito.when;
  16
  17 import java.util.Collections;
  18 import java.util.HashMap;
  19 import java.util.HashSet;
  20 import java.util.Map;
  21 import java.util.Set;
  22 import java.util.UUID;
  23
  24 import com.google.common.base.Optional;
  25 import com.google.common.util.concurrent.CheckedFuture;
  26 import org.junit.Before;
  27 import org.junit.Test;
  28 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  29 import org.opendaylight.controller.md.sal.binding.api.DataChangeListener;
  30 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  31 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
  32 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
  33 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent;
  34 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  35 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  36 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  37 import org.opendaylight.ovsdb.southbound.SouthboundConstants;
  38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.L2BridgeDomainId;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.TenantId;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.EndpointService;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.endpoints.Endpoint;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.endpoints.EndpointBuilder;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.neutron.gbp.mapper.rev150513.mappings.gbp.by.neutron.mappings.endpoints.by.ports.EndpointByPort;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.ofoverlay.rev140528.OfOverlayContext;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.ofoverlay.rev140528.OfOverlayNodeConfig;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.DatapathId;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentation;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeName;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbNodeAugmentation;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbTerminationPointAugmentation;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceExternalIds;
  53 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  54 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  55 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  56 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  57 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
  58 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  59 import org.opendaylight.yangtools.yang.binding.DataObject;
  60 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  61
  62 public class TerminationPointDataChangeListenerTest {
  63
  64     private TerminationPointDataChangeListener listener;
  65
  66     private DataBroker dataBroker;
  67     private EndpointService epService;
  68     private ListenerRegistration<DataChangeListener> registration;
  69     private AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> change;
  70
  71     private Map<InstanceIdentifier<?>, DataObject> dataMap;
  72     private Set<InstanceIdentifier<?>> dataSet;
  73     private Node node;
  74
  75     private CheckedFuture<Optional<OvsdbBridgeAugmentation>, ReadFailedException> ovsdbBridgeFuture;
  76     private CheckedFuture<Optional<Node>, ReadFailedException> nodeFuture;
  77     private CheckedFuture<Optional<EndpointByPort>, ReadFailedException> endpointByPortFuture;
  78     private CheckedFuture<Optional<Endpoint>, ReadFailedException> endpointFuture;
  79     private CheckedFuture<Optional<OfOverlayNodeConfig>, ReadFailedException> ofOverlayNodeConfigFuture;
  80     private ReadOnlyTransaction readTransaction;
  81     private ReadWriteTransaction readWriteTransaction;
  82
  83     private OvsdbTerminationPointAugmentation ovsdbTp;
  84
  85     @SuppressWarnings({"unchecked", "rawtypes"})
  86     @Before
  87     public void init() throws Exception {
  88         dataBroker = mock(DataBroker.class);
  89         epService = mock(EndpointService.class);
  90         registration = mock(ListenerRegistration.class);
  91         when(
  92                 dataBroker.registerDataChangeListener(any(LogicalDatastoreType.class), any(InstanceIdentifier.class),
  93                         any(DataChangeListener.class), any(DataChangeScope.class))).thenReturn(registration);
  94         change = mock(AsyncDataChangeEvent.class);
  95
  96         InstanceIdentifier<OvsdbTerminationPointAugmentation> ovsdbTpIid = InstanceIdentifier.create(
  97                 NetworkTopology.class)
  98             .child(Topology.class, new TopologyKey(SouthboundConstants.OVSDB_TOPOLOGY_ID))
  99             .child(Node.class)
 100             .child(TerminationPoint.class)
 101             .augmentation(OvsdbTerminationPointAugmentation.class);
 102         ovsdbTp = mock(OvsdbTerminationPointAugmentation.class);
 103         when(ovsdbTp.getInterfaceType()).thenReturn((Class) Object.class);
 104         InterfaceExternalIds externalId = mock(InterfaceExternalIds.class);
 105         when(ovsdbTp.getInterfaceExternalIds()).thenReturn(Collections.singletonList(externalId));
 106         when(externalId.getExternalIdKey()).thenReturn("iface-id");
 107         when(externalId.getExternalIdValue()).thenReturn(UUID.randomUUID().toString());
 108
 109         dataMap = new HashMap<>();
 110         dataMap.put(ovsdbTpIid, ovsdbTp);
 111         dataSet = new HashSet<InstanceIdentifier<?>>(Collections.singletonList(ovsdbTpIid));
 112
 113         readTransaction = mock(ReadOnlyTransaction.class);
 114         when(dataBroker.newReadOnlyTransaction()).thenReturn(readTransaction);
 115         readWriteTransaction = mock(ReadWriteTransaction.class);
 116         when(dataBroker.newReadWriteTransaction()).thenReturn(readWriteTransaction);
 117         CheckedFuture<Void, TransactionCommitFailedException> submitFuture = mock(CheckedFuture.class);
 118         when(readWriteTransaction.submit()).thenReturn(submitFuture);
 119
 120         // OvsdbBridgeAugmentation
 121         ovsdbBridgeFuture = mock(CheckedFuture.class);
 122         Optional<OvsdbBridgeAugmentation> ovsdbOptional = mock(Optional.class);
 123         when(ovsdbBridgeFuture.checkedGet()).thenReturn(ovsdbOptional);
 124         when(ovsdbOptional.isPresent()).thenReturn(true);
 125         OvsdbBridgeAugmentation ovsdbBridge = mock(OvsdbBridgeAugmentation.class);
 126         when(ovsdbOptional.get()).thenReturn(ovsdbBridge);
 127
 128         DatapathId dpid = mock(DatapathId.class);
 129         when(ovsdbBridge.getDatapathId()).thenReturn(dpid);
 130         when(dpid.getValue()).thenReturn("FF:FF:FF:FF:FF:FF:FF:FF");
 131
 132         OvsdbBridgeName bridgeName = mock(OvsdbBridgeName.class);
 133         when(ovsdbBridge.getBridgeName()).thenReturn(bridgeName);
 134         when(bridgeName.getValue()).thenReturn("bridgeName");
 135
 136         // Node
 137         nodeFuture = mock(CheckedFuture.class);
 138         Optional<Node> nodeOptional = mock(Optional.class);
 139         when(nodeFuture.checkedGet()).thenReturn(nodeOptional);
 140         when(nodeOptional.isPresent()).thenReturn(true);
 141         node = mock(Node.class);
 142         when(nodeOptional.get()).thenReturn(node);
 143         OvsdbNodeAugmentation ovsdbNode = mock(OvsdbNodeAugmentation.class);
 144         when(node.getAugmentation(OvsdbNodeAugmentation.class)).thenReturn(ovsdbNode);
 145
 146         // EndpointByPort
 147         endpointByPortFuture = mock(CheckedFuture.class);
 148         Optional<EndpointByPort> endpointByPortOptional = mock(Optional.class);
 149         when(endpointByPortFuture.checkedGet()).thenReturn(endpointByPortOptional);
 150         when(endpointByPortOptional.isPresent()).thenReturn(true);
 151         EndpointByPort endpointByPort = mock(EndpointByPort.class);
 152         when(endpointByPortOptional.get()).thenReturn(endpointByPort);
 153         L2BridgeDomainId l2BridgeDomainId = mock(L2BridgeDomainId.class);
 154         MacAddress macAddress = mock(MacAddress.class);
 155         when(endpointByPort.getL2Context()).thenReturn(l2BridgeDomainId);
 156         when(endpointByPort.getMacAddress()).thenReturn(macAddress);
 157
 158         // Endpoint
 159         endpointFuture = mock(CheckedFuture.class);
 160         Optional<Endpoint> endpointOptional = mock(Optional.class);
 161         when(endpointFuture.checkedGet()).thenReturn(endpointOptional);
 162         when(endpointOptional.isPresent()).thenReturn(true);
 163         OfOverlayContext ofc = mock(OfOverlayContext.class);
 164         Endpoint endpoint = new EndpointBuilder().setL2Context(new L2BridgeDomainId("foo"))
 165             .setMacAddress(new MacAddress("01:23:45:67:89:AB"))
 166             .setTenant(new TenantId("fooTenant"))
 167             .addAugmentation(OfOverlayContext.class, ofc)
 168             .build();
 169         when(endpointOptional.get()).thenReturn(endpoint);
 170
 171         // OfOverlayNodeConfig
 172         ofOverlayNodeConfigFuture = mock(CheckedFuture.class);
 173         Optional<OfOverlayNodeConfig> ofOverlayNodeConfigOptional = mock(Optional.class);
 174         when(ofOverlayNodeConfigFuture.checkedGet()).thenReturn(ofOverlayNodeConfigOptional);
 175         when(ofOverlayNodeConfigOptional.isPresent()).thenReturn(true);
 176         OfOverlayNodeConfig ofOverlayNodeConfig = mock(OfOverlayNodeConfig.class);
 177         when(ofOverlayNodeConfigOptional.get()).thenReturn(ofOverlayNodeConfig);
 178
 179         listener = new TerminationPointDataChangeListener(dataBroker, epService);
 180     }
 181
 182     @Test
 183     public void testConstructor() throws Exception {
 184         listener.close();
 185         verify(registration).close();
 186     }
 187
 188     @SuppressWarnings("unchecked")
 189     @Test
 190     public void testOnDataChanged_Creation() {
 191         when(change.getCreatedData()).thenReturn(dataMap);
 192         when(readTransaction.read(any(LogicalDatastoreType.class), any(InstanceIdentifier.class))).thenReturn(
 193                 ovsdbBridgeFuture)
 194             .thenReturn(endpointFuture)
 195             .thenReturn(nodeFuture);
 196
 197         when(readWriteTransaction.read(any(LogicalDatastoreType.class), any(InstanceIdentifier.class))).thenReturn(
 198                 endpointByPortFuture).thenReturn(ofOverlayNodeConfigFuture);
 199
 200         listener.onDataChanged(change);
 201         verify(readWriteTransaction).submit();
 202     }
 203
 204     @SuppressWarnings("unchecked")
 205     @Test
 206     public void testOnDataChanged_CreationExternalIdNull() {
 207         when(change.getCreatedData()).thenReturn(dataMap);
 208         when(readTransaction.read(any(LogicalDatastoreType.class), any(InstanceIdentifier.class))).thenReturn(
 209                 ovsdbBridgeFuture).thenReturn(nodeFuture);
 210         when(ovsdbTp.getInterfaceExternalIds()).thenReturn(null);
 211
 212         listener.onDataChanged(change);
 213         verify(readWriteTransaction, never()).submit();
 214     }
 215
 216     @SuppressWarnings("unchecked")
 217     @Test
 218     public void testOnDataChanged_Update() {
 219         when(change.getUpdatedData()).thenReturn(dataMap);
 220         when(readTransaction.read(any(LogicalDatastoreType.class), any(InstanceIdentifier.class))).thenReturn(
 221                 ovsdbBridgeFuture)
 222             .thenReturn(endpointFuture)
 223             .thenReturn(nodeFuture);
 224         when(readWriteTransaction.read(any(LogicalDatastoreType.class), any(InstanceIdentifier.class))).thenReturn(
 225                 endpointByPortFuture).thenReturn(ofOverlayNodeConfigFuture);
 226
 227         listener.onDataChanged(change);
 228         verify(readWriteTransaction).submit();
 229     }
 230
 231     @SuppressWarnings("unchecked")
 232     @Test
 233     public void testOnDataChanged_Removal() {
 234         when(change.getRemovedPaths()).thenReturn(dataSet);
 235         when(change.getOriginalData()).thenReturn(dataMap);
 236         when(readWriteTransaction.read(any(LogicalDatastoreType.class), any(InstanceIdentifier.class))).thenReturn(
 237                 endpointByPortFuture);
 238         when(readTransaction.read(any(LogicalDatastoreType.class), any(InstanceIdentifier.class))).thenReturn(
 239                 endpointFuture);
 240
 241         listener.onDataChanged(change);
 242         verify(readWriteTransaction).submit();
 243     }
 244 }