applications/topology-manager/src/test/java/org/opendaylight/openflowplugin/applications/topology/manager/TestUtils.java

   1 /*
   2  * Copyright (c) 2015, 2017 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 package org.opendaylight.openflowplugin.applications.topology.manager;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.junit.Assert.assertTrue;
  12 import static org.junit.Assert.fail;
  13 import static org.mockito.ArgumentMatchers.any;
  14 import static org.mockito.ArgumentMatchers.eq;
  15 import static org.mockito.Mockito.atLeast;
  16 import static org.mockito.Mockito.doAnswer;
  17 import static org.mockito.Mockito.inOrder;
  18 import static org.mockito.Mockito.never;
  19
  20 import com.google.common.util.concurrent.SettableFuture;
  21 import com.google.common.util.concurrent.Uninterruptibles;
  22 import java.util.HashSet;
  23 import java.util.Optional;
  24 import java.util.Set;
  25 import java.util.concurrent.CountDownLatch;
  26 import java.util.concurrent.TimeUnit;
  27 import org.mockito.ArgumentCaptor;
  28 import org.mockito.InOrder;
  29 import org.opendaylight.mdsal.binding.api.ReadWriteTransaction;
  30 import org.opendaylight.mdsal.common.api.CommitInfo;
  31 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
  35 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId;
  36 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  37 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TpId;
  38 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.link.attributes.Destination;
  39 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.link.attributes.DestinationBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.link.attributes.Source;
  41 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.link.attributes.SourceBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  43 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Link;
  44 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.LinkBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.LinkKey;
  46 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  47 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  48
  49 public final class TestUtils {
  50     private TestUtils() {
  51     }
  52
  53     static void verifyMockTx(ReadWriteTransaction mockTx) {
  54         InOrder inOrder = inOrder(mockTx);
  55         inOrder.verify(mockTx, atLeast(0)).commit();
  56         inOrder.verify(mockTx, never()).delete(eq(LogicalDatastoreType.OPERATIONAL), any(InstanceIdentifier.class));
  57     }
  58
  59     @SuppressWarnings("rawtypes")
  60     static void assertDeletedIDs(InstanceIdentifier[] expDeletedIIDs,
  61                                  ArgumentCaptor<InstanceIdentifier> deletedLinkIDs) {
  62         Set<InstanceIdentifier> actualIIDs = new HashSet<>(deletedLinkIDs.getAllValues());
  63         for (InstanceIdentifier id : expDeletedIIDs) {
  64             assertTrue("Missing expected deleted IID " + id, actualIIDs.contains(id));
  65         }
  66     }
  67
  68     static void setReadFutureAsync(final Topology topology, final SettableFuture<Optional<Topology>> readFuture) {
  69         new Thread(() -> {
  70             Uninterruptibles.sleepUninterruptibly(5, TimeUnit.SECONDS);
  71             readFuture.set(Optional.of(topology));
  72         }).start();
  73     }
  74
  75     static void waitForSubmit(CountDownLatch latch) {
  76         assertEquals("Transaction submitted", true, Uninterruptibles.awaitUninterruptibly(latch, 5, TimeUnit.SECONDS));
  77     }
  78
  79     static void waitForDeletes(int expDeleteCalls, final CountDownLatch latch) {
  80         boolean done = Uninterruptibles.awaitUninterruptibly(latch, 5, TimeUnit.SECONDS);
  81         if (!done) {
  82             fail("Expected " + expDeleteCalls + " delete calls. Actual: " + (expDeleteCalls - latch.getCount()));
  83         }
  84     }
  85
  86     static CountDownLatch setupStubbedSubmit(ReadWriteTransaction mockTx) {
  87         final CountDownLatch latch = new CountDownLatch(1);
  88         doAnswer(invocation -> {
  89             latch.countDown();
  90             return CommitInfo.emptyFluentFuture();
  91         }).when(mockTx).commit();
  92
  93         return latch;
  94     }
  95
  96     @SuppressWarnings("rawtypes")
  97     static void setupStubbedDeletes(ReadWriteTransaction mockTx, ArgumentCaptor<InstanceIdentifier> deletedLinkIDs,
  98                                     final CountDownLatch latch) {
  99         doAnswer(invocation -> {
 100             latch.countDown();
 101             return null;
 102         }).when(mockTx).delete(eq(LogicalDatastoreType.OPERATIONAL), deletedLinkIDs.capture());
 103     }
 104
 105     static org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey newInvNodeKey(String id) {
 106         org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey nodeKey
 107                 = new org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey(
 108                 new org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId(id));
 109         return nodeKey;
 110     }
 111
 112     static NodeConnectorKey newInvNodeConnKey(String id) {
 113         return new org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey(
 114                 new org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId(id));
 115     }
 116
 117     static KeyedInstanceIdentifier<NodeConnector, NodeConnectorKey> newNodeConnID(
 118             org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey nodeKey,
 119             org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey ncKey) {
 120         return InstanceIdentifier.create(Nodes.class)
 121                 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node.class, nodeKey)
 122                 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector.class,
 123                        ncKey);
 124     }
 125
 126     static Link newLink(String id, Source source, Destination dest) {
 127         return new LinkBuilder().setLinkId(new LinkId(id)).setSource(source).setDestination(dest)
 128                 .withKey(new LinkKey(new LinkId(id))).build();
 129     }
 130
 131     static Destination newDestTp(String id) {
 132         return new DestinationBuilder().setDestTp(new TpId(id)).build();
 133     }
 134
 135     static Source newSourceTp(String id) {
 136         return new SourceBuilder().setSourceTp(new TpId(id)).build();
 137     }
 138
 139     static Destination newDestNode(String id) {
 140         return new DestinationBuilder().setDestNode(new NodeId(id)).build();
 141     }
 142
 143     static Source newSourceNode(String id) {
 144         return new SourceBuilder().setSourceNode(new NodeId(id)).build();
 145     }
 146
 147 }