pcep/topology/topology-provider/src/test/java/org/opendaylight/bgpcep/pcep/topology/provider/AbstractPCEPSessionTest.java

   1 /*
   2  * Copyright (c) 2014 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.bgpcep.pcep.topology.provider;
   9
  10 import static org.junit.Assert.assertFalse;
  11 import static org.junit.Assert.assertTrue;
  12 import static org.mockito.ArgumentMatchers.any;
  13 import static org.mockito.Mockito.doAnswer;
  14 import static org.mockito.Mockito.doNothing;
  15 import static org.mockito.Mockito.doReturn;
  16 import static org.mockito.Mockito.mock;
  17
  18 import io.netty.channel.Channel;
  19 import io.netty.channel.ChannelFuture;
  20 import io.netty.channel.ChannelHandler;
  21 import io.netty.channel.ChannelPipeline;
  22 import io.netty.channel.EventLoop;
  23 import io.netty.util.concurrent.Promise;
  24 import java.net.InetSocketAddress;
  25 import java.util.ArrayList;
  26 import java.util.List;
  27 import java.util.concurrent.TimeUnit;
  28 import org.junit.After;
  29 import org.junit.Before;
  30 import org.mockito.Mock;
  31 import org.mockito.MockitoAnnotations;
  32 import org.opendaylight.mdsal.binding.dom.adapter.test.AbstractConcurrentDataBrokerTest;
  33 import org.opendaylight.protocol.pcep.impl.DefaultPCEPSessionNegotiator;
  34 import org.opendaylight.protocol.pcep.impl.PCEPSessionImpl;
  35 import org.opendaylight.protocol.util.InetSocketAddressUtil;
  36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix;
  37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.graph.rev220720.graph.topology.GraphKey;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.explicit.route.object.Ero;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.explicit.route.object.EroBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.explicit.route.object.ero.Subobject;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.explicit.route.object.ero.SubobjectBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.open.object.Open;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.open.object.OpenBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.basic.explicit.route.subobjects.subobject.type.IpPrefixCase;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.basic.explicit.route.subobjects.subobject.type.IpPrefixCaseBuilder;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.basic.explicit.route.subobjects.subobject.type.ip.prefix._case.IpPrefixBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev220730.NetworkTopologyPcepService;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev220730.Node1;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev220730.pcep.client.attributes.PathComputationClient;
  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.NodeId;
  53 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
  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.NodeKey;
  58 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  59 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  60 import org.opendaylight.yangtools.yang.binding.Notification;
  61 import org.opendaylight.yangtools.yang.common.Uint8;
  62
  63 public abstract class AbstractPCEPSessionTest extends AbstractConcurrentDataBrokerTest {
  64
  65     static final short RPC_TIMEOUT = 4;
  66     private static final TopologyKey TEST_TOPOLOGY_ID = new TopologyKey(new TopologyId("testtopo"));
  67     static final KeyedInstanceIdentifier<Topology, TopologyKey> TOPO_IID =
  68         InstanceIdentifier.create(NetworkTopology.class).child(Topology.class, TEST_TOPOLOGY_ID);
  69     private static final String IPV4_MASK = "/32";
  70     final String testAddress = InetSocketAddressUtil.getRandomLoopbackIpAddress();
  71     final NodeId nodeId = new NodeId("pcc://" + testAddress);
  72     protected final InstanceIdentifier<PathComputationClient> pathComputationClientIId = TOPO_IID.builder()
  73             .child(Node.class, new NodeKey(nodeId)).augmentation(Node1.class).child(PathComputationClient.class
  74             ).build();
  75     final String eroIpPrefix = testAddress + IPV4_MASK;
  76     final String newDestinationAddress = InetSocketAddressUtil.getRandomLoopbackIpAddress();
  77     final String dstIpPrefix = newDestinationAddress + IPV4_MASK;
  78     private final Open localPrefs = new OpenBuilder()
  79         .setDeadTimer(Uint8.valueOf(30))
  80         .setKeepalive(Uint8.TEN)
  81         .setSessionId(Uint8.ZERO)
  82         .build();
  83     private final Open remotePrefs = localPrefs;
  84
  85     List<Notification<?>> receivedMsgs;
  86     ServerSessionManager manager;
  87     NetworkTopologyPcepService topologyRpcs;
  88     @Mock
  89     private EventLoop eventLoop;
  90     @Mock
  91     private Channel clientListener;
  92     @Mock
  93     private ChannelPipeline pipeline;
  94     @Mock
  95     private ChannelFuture channelFuture;
  96     @Mock
  97     private TopologySessionStatsRegistry statsRegistry;
  98     @Mock
  99     private PCEPTopologyProviderDependencies topologyDependencies;
 100     @Mock
 101     private Promise<PCEPSessionImpl> promise;
 102     private DefaultPCEPSessionNegotiator neg;
 103
 104     @Before
 105     public void setUp() throws Exception {
 106         MockitoAnnotations.initMocks(this);
 107         receivedMsgs = new ArrayList<>();
 108         doAnswer(invocation -> {
 109             receivedMsgs.add(invocation.getArgument(0, Notification.class));
 110             return channelFuture;
 111         }).when(clientListener).writeAndFlush(any(Notification.class));
 112         doReturn(null).when(channelFuture).addListener(any());
 113         doReturn("TestingChannel").when(clientListener).toString();
 114         doReturn(pipeline).when(clientListener).pipeline();
 115         doReturn(pipeline).when(pipeline).replace(any(ChannelHandler.class), any(String.class),
 116             any(ChannelHandler.class));
 117         doReturn(eventLoop).when(clientListener).eventLoop();
 118         doNothing().when(statsRegistry).bind(any(), any());
 119         doNothing().when(statsRegistry).unbind(any());
 120         doReturn(null).when(eventLoop).schedule(any(Runnable.class), any(long.class), any(TimeUnit.class));
 121         doReturn(true).when(clientListener).isActive();
 122         final InetSocketAddress ra = new InetSocketAddress(testAddress, 4189);
 123         doReturn(ra).when(clientListener).remoteAddress();
 124         final InetSocketAddress la = new InetSocketAddress(testAddress, InetSocketAddressUtil.getRandomPort());
 125         doReturn(la).when(clientListener).localAddress();
 126
 127         doReturn(mock(ChannelFuture.class)).when(clientListener).close();
 128
 129         doReturn(getDataBroker()).when(topologyDependencies).getDataBroker();
 130         doReturn(statsRegistry).when(topologyDependencies).getStateRegistry();
 131         doReturn(null).when(topologyDependencies).getPceServerProvider();
 132
 133         manager = customizeSessionManager(new ServerSessionManager(TOPO_IID, topologyDependencies, RPC_TIMEOUT,
 134                 new GraphKey("graph-test")));
 135         startSessionManager();
 136         neg = new DefaultPCEPSessionNegotiator(promise, clientListener, manager.getSessionListener(), (short) 1, 5,
 137             localPrefs);
 138         topologyRpcs = new TopologyRPCs(manager);
 139     }
 140
 141     // Visible for TopologyProgrammingTest
 142     ServerSessionManager customizeSessionManager(final ServerSessionManager original) {
 143         return original;
 144     }
 145
 146     void startSessionManager() throws Exception {
 147         assertTrue(manager.start().get());
 148         assertFalse(manager.isClosed.get());
 149     }
 150
 151     void stopSessionManager() {
 152         manager.stop();
 153     }
 154
 155     @After
 156     public void tearDown() {
 157         stopSessionManager();
 158     }
 159
 160     Ero createEroWithIpPrefixes(final List<String> ipPrefixes) {
 161         final List<Subobject> subobjs = new ArrayList<>(ipPrefixes.size());
 162         final SubobjectBuilder subobjBuilder = new SubobjectBuilder();
 163         for (final String ipPrefix : ipPrefixes) {
 164             subobjBuilder.setSubobjectType(new IpPrefixCaseBuilder().setIpPrefix(new IpPrefixBuilder()
 165                     .setIpPrefix(new IpPrefix(new Ipv4Prefix(ipPrefix))).build()).build());
 166             subobjs.add(subobjBuilder.build());
 167         }
 168         return new EroBuilder().setSubobject(subobjs).build();
 169     }
 170
 171     String getLastEroIpPrefix(final Ero ero) {
 172         return ((IpPrefixCase) ero.getSubobject().get(ero.getSubobject().size() - 1).getSubobjectType()).getIpPrefix()
 173                 .getIpPrefix().getIpv4Prefix().getValue();
 174     }
 175
 176     protected Open getLocalPref() {
 177         return localPrefs;
 178     }
 179
 180     protected Open getRemotePref() {
 181         return remotePrefs;
 182     }
 183
 184     protected PCEPTopologySessionListener getSessionListener() {
 185         return manager.getSessionListener();
 186     }
 187
 188     protected final PCEPSessionImpl getPCEPSession(final Open localOpen, final Open remoteOpen) {
 189         return neg.createSession(clientListener, localOpen, remoteOpen);
 190     }
 191 }