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