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