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.doReturn;
  13 import static org.mockito.Mockito.mock;
  14 import static org.mockito.Mockito.never;
  15 import static org.mockito.Mockito.verify;
  16 import static org.mockito.Mockito.when;
  17
  18 import com.google.common.base.Optional;
  19 import com.google.common.util.concurrent.CheckedFuture;
  20 import java.util.Collection;
  21 import java.util.Collections;
  22 import java.util.UUID;
  23 import org.junit.Before;
  24 import org.junit.Test;
  25 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  26 import org.opendaylight.controller.md.sal.binding.api.DataObjectModification;
  27 import org.opendaylight.controller.md.sal.binding.api.DataTreeChangeListener;
  28 import org.opendaylight.controller.md.sal.binding.api.DataTreeIdentifier;
  29 import org.opendaylight.controller.md.sal.binding.api.DataTreeModification;
  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.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.rev130715.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.InstanceIdentifier;
  58
  59 public class TerminationPointDataChangeListenerTest {
  60
  61     private TerminationPointDataChangeListener listener;
  62
  63     private DataBroker dataBroker;
  64     private EndpointService epService;
  65     private ListenerRegistration<?> registration;
  66
  67     private DataObjectModification<OvsdbTerminationPointAugmentation> mockModification;
  68     private Collection<DataTreeModification<OvsdbTerminationPointAugmentation>> changeEvent;
  69     private Node node;
  70
  71     private CheckedFuture<Optional<OvsdbBridgeAugmentation>, ReadFailedException> ovsdbBridgeFuture;
  72     private CheckedFuture<Optional<Node>, ReadFailedException> nodeFuture;
  73     private CheckedFuture<Optional<EndpointByPort>, ReadFailedException> endpointByPortFuture;
  74     private CheckedFuture<Optional<Endpoint>, ReadFailedException> endpointFuture;
  75     private CheckedFuture<Optional<OfOverlayNodeConfig>, ReadFailedException> ofOverlayNodeConfigFuture;
  76     private ReadOnlyTransaction readTransaction;
  77     private ReadWriteTransaction readWriteTransaction;
  78
  79     private OvsdbTerminationPointAugmentation ovsdbTp;
  80
  81     @SuppressWarnings({"unchecked", "rawtypes"})
  82     @Before
  83     public void init() throws Exception {
  84         dataBroker = mock(DataBroker.class);
  85         epService = mock(EndpointService.class);
  86         registration = mock(ListenerRegistration.class);
  87         when(dataBroker.registerDataTreeChangeListener(any(DataTreeIdentifier.class),
  88                         any(DataTreeChangeListener.class))).thenReturn(registration);
  89
  90         ovsdbTp = mock(OvsdbTerminationPointAugmentation.class);
  91         when(ovsdbTp.getInterfaceType()).thenReturn((Class) Object.class);
  92         InterfaceExternalIds externalId = mock(InterfaceExternalIds.class);
  93         when(ovsdbTp.getInterfaceExternalIds()).thenReturn(Collections.singletonList(externalId));
  94         when(externalId.getExternalIdKey()).thenReturn("iface-id");
  95         when(externalId.getExternalIdValue()).thenReturn(UUID.randomUUID().toString());
  96
  97         readTransaction = mock(ReadOnlyTransaction.class);
  98         when(dataBroker.newReadOnlyTransaction()).thenReturn(readTransaction);
  99         readWriteTransaction = mock(ReadWriteTransaction.class);
 100         when(dataBroker.newReadWriteTransaction()).thenReturn(readWriteTransaction);
 101         CheckedFuture<Void, TransactionCommitFailedException> submitFuture = mock(CheckedFuture.class);
 102         when(readWriteTransaction.submit()).thenReturn(submitFuture);
 103
 104         // OvsdbBridgeAugmentation
 105         ovsdbBridgeFuture = mock(CheckedFuture.class);
 106         Optional<OvsdbBridgeAugmentation> ovsdbOptional = mock(Optional.class);
 107         when(ovsdbBridgeFuture.checkedGet()).thenReturn(ovsdbOptional);
 108         when(ovsdbOptional.isPresent()).thenReturn(true);
 109         OvsdbBridgeAugmentation ovsdbBridge = mock(OvsdbBridgeAugmentation.class);
 110         when(ovsdbOptional.get()).thenReturn(ovsdbBridge);
 111
 112         DatapathId dpid = mock(DatapathId.class);
 113         when(ovsdbBridge.getDatapathId()).thenReturn(dpid);
 114         when(dpid.getValue()).thenReturn("FF:FF:FF:FF:FF:FF:FF:FF");
 115
 116         OvsdbBridgeName bridgeName = mock(OvsdbBridgeName.class);
 117         when(ovsdbBridge.getBridgeName()).thenReturn(bridgeName);
 118         when(bridgeName.getValue()).thenReturn("bridgeName");
 119
 120         // Node
 121         nodeFuture = mock(CheckedFuture.class);
 122         Optional<Node> nodeOptional = mock(Optional.class);
 123         when(nodeFuture.checkedGet()).thenReturn(nodeOptional);
 124         when(nodeOptional.isPresent()).thenReturn(true);
 125         node = mock(Node.class);
 126         when(nodeOptional.get()).thenReturn(node);
 127         OvsdbNodeAugmentation ovsdbNode = mock(OvsdbNodeAugmentation.class);
 128         when(node.getAugmentation(OvsdbNodeAugmentation.class)).thenReturn(ovsdbNode);
 129
 130         // EndpointByPort
 131         endpointByPortFuture = mock(CheckedFuture.class);
 132         Optional<EndpointByPort> endpointByPortOptional = mock(Optional.class);
 133         when(endpointByPortFuture.checkedGet()).thenReturn(endpointByPortOptional);
 134         when(endpointByPortOptional.isPresent()).thenReturn(true);
 135         EndpointByPort endpointByPort = mock(EndpointByPort.class);
 136         when(endpointByPortOptional.get()).thenReturn(endpointByPort);
 137         L2BridgeDomainId l2BridgeDomainId = mock(L2BridgeDomainId.class);
 138         MacAddress macAddress = mock(MacAddress.class);
 139         when(endpointByPort.getL2Context()).thenReturn(l2BridgeDomainId);
 140         when(endpointByPort.getMacAddress()).thenReturn(macAddress);
 141
 142         // Endpoint
 143         endpointFuture = mock(CheckedFuture.class);
 144         Optional<Endpoint> endpointOptional = mock(Optional.class);
 145         when(endpointFuture.checkedGet()).thenReturn(endpointOptional);
 146         when(endpointOptional.isPresent()).thenReturn(true);
 147         OfOverlayContext ofc = mock(OfOverlayContext.class);
 148         Endpoint endpoint = new EndpointBuilder().setL2Context(new L2BridgeDomainId("foo"))
 149             .setMacAddress(new MacAddress("01:23:45:67:89:AB"))
 150             .setTenant(new TenantId("fooTenant"))
 151             .addAugmentation(OfOverlayContext.class, ofc)
 152             .build();
 153         when(endpointOptional.get()).thenReturn(endpoint);
 154
 155         // OfOverlayNodeConfig
 156         ofOverlayNodeConfigFuture = mock(CheckedFuture.class);
 157         Optional<OfOverlayNodeConfig> ofOverlayNodeConfigOptional = mock(Optional.class);
 158         when(ofOverlayNodeConfigFuture.checkedGet()).thenReturn(ofOverlayNodeConfigOptional);
 159         when(ofOverlayNodeConfigOptional.isPresent()).thenReturn(true);
 160         OfOverlayNodeConfig ofOverlayNodeConfig = mock(OfOverlayNodeConfig.class);
 161         when(ofOverlayNodeConfigOptional.get()).thenReturn(ofOverlayNodeConfig);
 162
 163         listener = new TerminationPointDataChangeListener(dataBroker, epService);
 164
 165         DataTreeModification<OvsdbTerminationPointAugmentation> mockDataTreeModification =
 166                 mock(DataTreeModification.class);
 167         mockModification = mock(DataObjectModification.class);
 168         doReturn(mockModification).when(mockDataTreeModification).getRootNode();
 169
 170         InstanceIdentifier<OvsdbTerminationPointAugmentation> ovsdbTpIid = InstanceIdentifier.create(
 171             NetworkTopology.class)
 172             .child(Topology.class, new TopologyKey(SouthboundConstants.OVSDB_TOPOLOGY_ID))
 173             .child(Node.class)
 174             .child(TerminationPoint.class)
 175             .augmentation(OvsdbTerminationPointAugmentation.class);
 176         doReturn(new DataTreeIdentifier<>(LogicalDatastoreType.OPERATIONAL, ovsdbTpIid))
 177                 .when(mockDataTreeModification).getRootPath();
 178         changeEvent = Collections.singletonList(mockDataTreeModification);
 179     }
 180
 181     @Test
 182     public void testConstructor() throws Exception {
 183         listener.close();
 184         verify(registration).close();
 185     }
 186
 187     @SuppressWarnings("unchecked")
 188     @Test
 189     public void testOnDataChanged_Creation() {
 190         doReturn(DataObjectModification.ModificationType.WRITE).when(mockModification).getModificationType();
 191         doReturn(ovsdbTp).when(mockModification).getDataAfter();
 192
 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.onDataTreeChanged(changeEvent);
 202         verify(readWriteTransaction).submit();
 203     }
 204
 205     @SuppressWarnings("unchecked")
 206     @Test
 207     public void testOnDataChanged_CreationExternalIdNull() {
 208         doReturn(DataObjectModification.ModificationType.WRITE).when(mockModification).getModificationType();
 209         doReturn(ovsdbTp).when(mockModification).getDataAfter();
 210
 211         when(readTransaction.read(any(LogicalDatastoreType.class), any(InstanceIdentifier.class))).thenReturn(
 212                 ovsdbBridgeFuture).thenReturn(nodeFuture);
 213         when(ovsdbTp.getInterfaceExternalIds()).thenReturn(null);
 214
 215         listener.onDataTreeChanged(changeEvent);
 216         verify(readWriteTransaction, never()).submit();
 217     }
 218
 219     @SuppressWarnings("unchecked")
 220     @Test
 221     public void testOnDataChanged_Update() {
 222         doReturn(DataObjectModification.ModificationType.WRITE).when(mockModification).getModificationType();
 223         doReturn(ovsdbTp).when(mockModification).getDataBefore();
 224         doReturn(ovsdbTp).when(mockModification).getDataAfter();
 225
 226         when(readTransaction.read(any(LogicalDatastoreType.class), any(InstanceIdentifier.class))).thenReturn(
 227                 ovsdbBridgeFuture)
 228             .thenReturn(endpointFuture)
 229             .thenReturn(nodeFuture);
 230         when(readWriteTransaction.read(any(LogicalDatastoreType.class), any(InstanceIdentifier.class))).thenReturn(
 231                 endpointByPortFuture).thenReturn(ofOverlayNodeConfigFuture);
 232
 233         listener.onDataTreeChanged(changeEvent);
 234         verify(readWriteTransaction).submit();
 235     }
 236
 237     @SuppressWarnings("unchecked")
 238     @Test
 239     public void testOnDataChanged_Removal() {
 240         doReturn(DataObjectModification.ModificationType.DELETE).when(mockModification).getModificationType();
 241         doReturn(ovsdbTp).when(mockModification).getDataBefore();
 242
 243         when(readWriteTransaction.read(any(LogicalDatastoreType.class), any(InstanceIdentifier.class))).thenReturn(
 244                 endpointByPortFuture);
 245         when(readTransaction.read(any(LogicalDatastoreType.class), any(InstanceIdentifier.class))).thenReturn(
 246                 endpointFuture);
 247
 248         listener.onDataTreeChanged(changeEvent);
 249         verify(readWriteTransaction).submit();
 250     }
 251 }