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.yangtools.yang.binding.InstanceIdentifier;
  46 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  47
  48 public final class TestUtils {
  49     private TestUtils() {
  50     }
  51
  52     static void verifyMockTx(ReadWriteTransaction mockTx) {
  53         InOrder inOrder = inOrder(mockTx);
  54         inOrder.verify(mockTx, atLeast(0)).commit();
  55         inOrder.verify(mockTx, never()).delete(eq(LogicalDatastoreType.OPERATIONAL), any(InstanceIdentifier.class));
  56     }
  57
  58     @SuppressWarnings("rawtypes")
  59     static void assertDeletedIDs(InstanceIdentifier[] expDeletedIIDs,
  60                                  ArgumentCaptor<InstanceIdentifier> deletedLinkIDs) {
  61         Set<InstanceIdentifier> actualIIDs = new HashSet<>(deletedLinkIDs.getAllValues());
  62         for (InstanceIdentifier id : expDeletedIIDs) {
  63             assertTrue("Missing expected deleted IID " + id, actualIIDs.contains(id));
  64         }
  65     }
  66
  67     static void setReadFutureAsync(final Topology topology, final SettableFuture<Optional<Topology>> readFuture) {
  68         new Thread(() -> {
  69             Uninterruptibles.sleepUninterruptibly(5, TimeUnit.SECONDS);
  70             readFuture.set(Optional.of(topology));
  71         }).start();
  72     }
  73
  74     static void waitForSubmit(CountDownLatch latch) {
  75         assertEquals("Transaction submitted", true, Uninterruptibles.awaitUninterruptibly(latch, 5, TimeUnit.SECONDS));
  76     }
  77
  78     static void waitForDeletes(int expDeleteCalls, final CountDownLatch latch) {
  79         boolean done = Uninterruptibles.awaitUninterruptibly(latch, 5, TimeUnit.SECONDS);
  80         if (!done) {
  81             fail("Expected " + expDeleteCalls + " delete calls. Actual: " + (expDeleteCalls - latch.getCount()));
  82         }
  83     }
  84
  85     static CountDownLatch setupStubbedSubmit(ReadWriteTransaction mockTx) {
  86         final CountDownLatch latch = new CountDownLatch(1);
  87         doAnswer(invocation -> {
  88             latch.countDown();
  89             return CommitInfo.emptyFluentFuture();
  90         }).when(mockTx).commit();
  91
  92         return latch;
  93     }
  94
  95     @SuppressWarnings("rawtypes")
  96     static void setupStubbedDeletes(ReadWriteTransaction mockTx, ArgumentCaptor<InstanceIdentifier> deletedLinkIDs,
  97                                     final CountDownLatch latch) {
  98         doAnswer(invocation -> {
  99             latch.countDown();
 100             return null;
 101         }).when(mockTx).delete(eq(LogicalDatastoreType.OPERATIONAL), deletedLinkIDs.capture());
 102     }
 103
 104     static org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey newInvNodeKey(String id) {
 105         org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey nodeKey
 106                 = new org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey(
 107                 new org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId(id));
 108         return nodeKey;
 109     }
 110
 111     static NodeConnectorKey newInvNodeConnKey(String id) {
 112         return new org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey(
 113                 new org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId(id));
 114     }
 115
 116     static KeyedInstanceIdentifier<NodeConnector, NodeConnectorKey> newNodeConnID(
 117             org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey nodeKey,
 118             org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey ncKey) {
 119         return InstanceIdentifier.create(Nodes.class)
 120                 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node.class, nodeKey)
 121                 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector.class,
 122                        ncKey);
 123     }
 124
 125     static Link newLink(String id, Source source, Destination dest) {
 126         return new LinkBuilder().setLinkId(new LinkId(id)).setSource(source).setDestination(dest).build();
 127     }
 128
 129     static Destination newDestTp(String id) {
 130         return new DestinationBuilder().setDestTp(new TpId(id)).build();
 131     }
 132
 133     static Source newSourceTp(String id) {
 134         return new SourceBuilder().setSourceTp(new TpId(id)).build();
 135     }
 136
 137     static Destination newDestNode(String id) {
 138         return new DestinationBuilder().setDestNode(new NodeId(id)).build();
 139     }
 140
 141     static Source newSourceNode(String id) {
 142         return new SourceBuilder().setSourceNode(new NodeId(id)).build();
 143     }
 144
 145 }