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