bgp/rib-impl/src/test/java/org/opendaylight/protocol/bgp/rib/impl/PeerTest.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.protocol.bgp.rib.impl;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.junit.Assert.assertNotNull;
  12 import static org.mockito.Matchers.any;
  13 import com.google.common.base.Optional;
  14 import com.google.common.base.Throwables;
  15 import com.google.common.collect.Lists;
  16 import com.google.common.util.concurrent.CheckedFuture;
  17 import io.netty.channel.Channel;
  18 import io.netty.channel.ChannelHandler;
  19 import io.netty.channel.ChannelPipeline;
  20 import io.netty.channel.DefaultChannelPromise;
  21 import io.netty.channel.EventLoop;
  22 import java.net.InetSocketAddress;
  23 import java.util.ArrayList;
  24 import java.util.Collection;
  25 import java.util.HashMap;
  26 import java.util.List;
  27 import java.util.Map;
  28 import java.util.concurrent.Executor;
  29 import java.util.concurrent.TimeUnit;
  30 import javassist.ClassPool;
  31 import org.junit.After;
  32 import org.junit.Assert;
  33 import org.junit.Before;
  34 import org.junit.Test;
  35 import org.mockito.Mock;
  36 import org.mockito.Mockito;
  37 import org.mockito.MockitoAnnotations;
  38 import org.mockito.invocation.InvocationOnMock;
  39 import org.mockito.stubbing.Answer;
  40 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
  41 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  42 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  43 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  44 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  45 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  46 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
  47 import org.opendaylight.controller.md.sal.dom.api.DOMDataBrokerExtension;
  48 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeListener;
  49 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeService;
  50 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeIdentifier;
  51 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  52 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
  53 import org.opendaylight.protocol.bgp.parser.BgpTableTypeImpl;
  54 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPDispatcher;
  55 import org.opendaylight.protocol.bgp.rib.spi.RIBExtensionProviderContext;
  56 import org.opendaylight.protocol.bgp.rib.spi.RIBSupport;
  57 import org.opendaylight.protocol.bgp.rib.spi.RibSupportUtils;
  58 import org.opendaylight.protocol.bgp.rib.spi.SimpleRIBExtensionProviderContext;
  59 import org.opendaylight.protocol.framework.ReconnectStrategyFactory;
  60 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.AsNumber;
  61 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Address;
  62 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Prefix;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.routes.ipv4.routes.Ipv4Route;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.KeepaliveBuilder;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.OpenBuilder;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.UpdateBuilder;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.BgpParameters;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.BgpParametersBuilder;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.bgp.parameters.OptionalCapabilitiesBuilder;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.bgp.parameters.optional.capabilities.CParametersBuilder;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.AttributesBuilder;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.update.NlriBuilder;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.update.WithdrawnRoutesBuilder;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.Attributes2;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.Attributes2Builder;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.BgpTableType;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.CParameters1;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.CParameters1Builder;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.open.bgp.parameters.optional.capabilities.c.parameters.MultiprotocolCapabilityBuilder;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpUnreachNlriBuilder;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.ApplicationRibId;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.RibId;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.Rib;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.LocRib;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.Tables;
  86 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
  87 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.tables.Routes;
  88 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Ipv4AddressFamily;
  89 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.UnicastSubsequentAddressFamily;
  90 import org.opendaylight.yangtools.binding.data.codec.api.BindingCodecTreeFactory;
  91 import org.opendaylight.yangtools.binding.data.codec.gen.impl.DataObjectSerializerGenerator;
  92 import org.opendaylight.yangtools.binding.data.codec.gen.impl.StreamWriterGenerator;
  93 import org.opendaylight.yangtools.binding.data.codec.impl.BindingNormalizedNodeCodecRegistry;
  94 import org.opendaylight.yangtools.sal.binding.generator.api.ClassLoadingStrategy;
  95 import org.opendaylight.yangtools.sal.binding.generator.impl.GeneratedClassLoadingStrategy;
  96 import org.opendaylight.yangtools.sal.binding.generator.impl.ModuleInfoBackedContext;
  97 import org.opendaylight.yangtools.sal.binding.generator.util.BindingRuntimeContext;
  98 import org.opendaylight.yangtools.sal.binding.generator.util.JavassistUtils;
  99 import org.opendaylight.yangtools.yang.binding.DataObject;
 100 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 101 import org.opendaylight.yangtools.yang.binding.Notification;
 102 import org.opendaylight.yangtools.yang.binding.util.BindingReflections;
 103 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
 104 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
 105 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
 106 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
 107 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
 108 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
 109 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNodes;
 110 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.DefaultDataTreeCandidate;
 111 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
 112 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
 113 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
 114 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
 115
 116 public class PeerTest {
 117
 118     private final TablesKey tk = new TablesKey(Ipv4AddressFamily.class, UnicastSubsequentAddressFamily.class);
 119
 120     private RIBImpl r;
 121
 122     @Mock
 123     BGPDispatcher dispatcher;
 124
 125     @Mock
 126     ReconnectStrategyFactory tcpStrategyFactory;
 127
 128     @Mock
 129     DataBroker dps;
 130
 131     @Mock
 132     DOMDataBroker dom;
 133
 134     @Mock
 135     WriteTransaction transWrite;
 136
 137     @Mock
 138     DOMDataWriteTransaction domTransWrite;
 139
 140     @Mock
 141     BindingTransactionChain chain;
 142
 143     @Mock
 144     DOMTransactionChain domChain;
 145
 146     BindingCodecTreeFactory codecFactory;
 147
 148     ApplicationPeer peer;
 149
 150     @Mock
 151     CheckedFuture<?,?> future;
 152
 153     @Mock
 154     Optional<Rib> o;
 155
 156     @Mock
 157     DOMDataTreeChangeService service;
 158
 159     BGPSessionImpl session;
 160
 161     List<YangInstanceIdentifier> routes;
 162
 163     private BGPPeer classic;
 164
 165     @Mock
 166     Channel channel;
 167
 168     @Mock
 169     ChannelPipeline pipeline;
 170
 171     @Mock
 172     private EventLoop eventLoop;
 173
 174     private RIBActivator a1;
 175
 176     @SuppressWarnings("unchecked")
 177     @Before
 178     public void setUp() throws Exception {
 179         MockitoAnnotations.initMocks(this);
 180         final ModuleInfoBackedContext strategy = createClassLoadingStrategy();
 181         final SchemaContext schemaContext = strategy.tryToCreateSchemaContext().get();
 182         this.codecFactory = createCodecFactory(strategy,schemaContext);
 183         final List<BgpTableType> localTables = new ArrayList<>();
 184         this.routes = new ArrayList<>();
 185         localTables.add(new BgpTableTypeImpl(Ipv4AddressFamily.class, UnicastSubsequentAddressFamily.class));
 186         final RIBExtensionProviderContext context = new SimpleRIBExtensionProviderContext();
 187         this.a1 = new RIBActivator();
 188         this.a1.startRIBExtensionProvider(context);
 189         Mockito.doReturn(this.chain).when(this.dps).createTransactionChain(Mockito.any(RIBImpl.class));
 190         Mockito.doReturn(this.domChain).when(this.dom).createTransactionChain(Mockito.any(BGPPeer.class));
 191         final Map<Class<? extends DOMDataBrokerExtension>, DOMDataBrokerExtension> map = new HashMap<>();
 192         map.put(DOMDataTreeChangeService.class, this.service);
 193         Mockito.doReturn(null).when(this.service).registerDataTreeChangeListener(Mockito.any(DOMDataTreeIdentifier.class), Mockito.any(DOMDataTreeChangeListener.class));
 194         Mockito.doReturn(map).when(this.dom).getSupportedExtensions();
 195         Mockito.doReturn(this.o).when(this.future).checkedGet();
 196         Mockito.doNothing().when(this.domChain).close();
 197         Mockito.doAnswer(new Answer<Object>() {
 198             @Override
 199             public Object answer(final InvocationOnMock invocation) throws Throwable {
 200                 final Object[] args = invocation.getArguments();
 201                 final NormalizedNode<?,?> node = (NormalizedNode<?,?>)args[2];
 202                 if (node.getNodeType().equals(Ipv4Route.QNAME) || node.getNodeType().equals(IPv4RIBSupport.PREFIX_QNAME)) {
 203                     PeerTest.this.routes.add((YangInstanceIdentifier) args[1]);
 204                 }
 205                 return args[1];
 206             }
 207         }).when(this.domTransWrite).put(Mockito.eq(LogicalDatastoreType.OPERATIONAL), Mockito.any(YangInstanceIdentifier.class), Mockito.any(NormalizedNode.class));
 208         Mockito.doNothing().when(this.domTransWrite).merge(Mockito.eq(LogicalDatastoreType.OPERATIONAL), Mockito.any(YangInstanceIdentifier.class), Mockito.any(NormalizedNode.class));
 209         Mockito.doAnswer(new Answer<Object>() {
 210
 211             @Override
 212             public Object answer(final InvocationOnMock invocation) throws Throwable {
 213                 final Object[] args = invocation.getArguments();
 214                 PeerTest.this.routes.remove(args[1]);
 215                 return args[1];
 216             }
 217         }).when(this.domTransWrite).delete(Mockito.eq(LogicalDatastoreType.OPERATIONAL), Mockito.any(YangInstanceIdentifier.class));
 218         Mockito.doReturn(false).when(this.o).isPresent();
 219         Mockito.doReturn(this.future).when(this.domTransWrite).submit();
 220         Mockito.doNothing().when(this.future).addListener(Mockito.any(Runnable.class), Mockito.any(Executor.class));
 221         Mockito.doReturn(this.transWrite).when(this.chain).newWriteOnlyTransaction();
 222         Mockito.doNothing().when(this.transWrite).put(Mockito.eq(LogicalDatastoreType.OPERATIONAL), Mockito.any(InstanceIdentifier.class), Mockito.any(DataObject.class), Mockito.eq(true));
 223         Mockito.doNothing().when(this.transWrite).put(Mockito.eq(LogicalDatastoreType.OPERATIONAL), Mockito.any(InstanceIdentifier.class), Mockito.any(DataObject.class));
 224         Mockito.doReturn(this.future).when(this.transWrite).submit();
 225         Mockito.doReturn(this.domTransWrite).when(this.domChain).newWriteOnlyTransaction();
 226         Mockito.doReturn(this.eventLoop).when(this.channel).eventLoop();
 227         Mockito.doReturn("channel").when(this.channel).toString();
 228         Mockito.doReturn(this.pipeline).when(this.channel).pipeline();
 229         Mockito.doReturn(this.pipeline).when(this.pipeline).addLast(Mockito.any(ChannelHandler.class));
 230         this.r = new RIBImpl(new RibId("test"), new AsNumber(5L), new Ipv4Address("127.0.0.1"),
 231             new Ipv4Address("128.0.0.1"), context , this.dispatcher, this.tcpStrategyFactory, this.codecFactory, this.tcpStrategyFactory, this.dps, this.dom, localTables,GeneratedClassLoadingStrategy.getTCCLClassLoadingStrategy());
 232         this.peer = new ApplicationPeer(new ApplicationRibId("t"), new Ipv4Address("127.0.0.1"), this.r);
 233         this.r.onGlobalContextUpdated(schemaContext);
 234         final ReadOnlyTransaction readTx = Mockito.mock(ReadOnlyTransaction.class);
 235         Mockito.doNothing().when(readTx).close();
 236         Mockito.doReturn(readTx).when(this.dps).newReadOnlyTransaction();
 237         final CheckedFuture<Optional<DataObject>, ReadFailedException> readFuture = Mockito.mock(CheckedFuture.class);
 238         Mockito.doReturn(Optional.<DataObject>absent()).when(readFuture).checkedGet();
 239         Mockito.doReturn(readFuture).when(readTx).read(Mockito.eq(LogicalDatastoreType.OPERATIONAL), Mockito.any(InstanceIdentifier.class));
 240     }
 241
 242     private BindingCodecTreeFactory createCodecFactory(final ClassLoadingStrategy str, final SchemaContext ctx) {
 243         final DataObjectSerializerGenerator generator = StreamWriterGenerator.create(JavassistUtils.forClassPool(ClassPool.getDefault()));
 244         final BindingNormalizedNodeCodecRegistry codec = new BindingNormalizedNodeCodecRegistry(generator);
 245         codec.onBindingRuntimeContextUpdated(BindingRuntimeContext.create(str, ctx));
 246         return codec;
 247     }
 248
 249     private ModuleInfoBackedContext createClassLoadingStrategy() {
 250         final ModuleInfoBackedContext ctx = ModuleInfoBackedContext.create();
 251         try {
 252             ctx.registerModuleInfo(BindingReflections.getModuleInfo(Ipv4Route.class));
 253         } catch (final Exception e) {
 254             throw Throwables.propagate(e);
 255         }
 256         return ctx;
 257     }
 258
 259     @After
 260     public void tearDown() {
 261         this.a1.close();
 262     }
 263
 264     @Test
 265     public void testAppPeer() {
 266         final Collection<DataTreeCandidate> changes = new ArrayList<>();
 267         final RIBSupport support = this.r.getRibSupportContext().getRIBSupportContext(this.tk).getRibSupport();
 268
 269         final YangInstanceIdentifier base = this.r.getYangRibId().node(LocRib.QNAME).node(Tables.QNAME).node(RibSupportUtils.toYangTablesKey(this.tk));
 270
 271         final NodeIdentifierWithPredicates routekey = new NodeIdentifierWithPredicates(Ipv4Route.QNAME, IPv4RIBSupport.PREFIX_QNAME, new Ipv4Prefix("127.0.0.1/32"));
 272         final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> b = ImmutableNodes.mapEntryBuilder();
 273         b.withNodeIdentifier(routekey);
 274         b.addChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(IPv4RIBSupport.PREFIX_QNAME)).withValue("127.0.0.1/32").build());
 275
 276         changes.add(new DefaultDataTreeCandidate(support.routePath(base.node(Routes.QNAME), routekey), DataTreeCandidateNodes.fromNormalizedNode(b.build())));
 277
 278         this.peer.onDataTreeChanged(changes);
 279         assertEquals(1, this.routes.size());
 280     }
 281
 282     @Test
 283     public void testClassicPeer() {
 284         this.classic = new BGPPeer("testPeer", this.r);
 285         Mockito.doReturn(null).when(this.eventLoop).schedule(any(Runnable.class), any(long.class), any(TimeUnit.class));
 286         Mockito.doReturn(Boolean.TRUE).when(this.channel).isWritable();
 287         Mockito.doReturn(null).when(this.channel).close();
 288         Mockito.doReturn(new DefaultChannelPromise(this.channel)).when(this.channel).writeAndFlush(any(Notification.class));
 289
 290         Mockito.doReturn(new InetSocketAddress("localhost", 12345)).when(this.channel).remoteAddress();
 291         Mockito.doReturn(new InetSocketAddress("localhost", 12345)).when(this.channel).localAddress();
 292         final List<BgpParameters> params = Lists.newArrayList(new BgpParametersBuilder().setOptionalCapabilities(
 293             Lists.newArrayList(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().addAugmentation(
 294                 CParameters1.class, new CParameters1Builder().setMultiprotocolCapability(new MultiprotocolCapabilityBuilder()
 295                     .setAfi(Ipv4AddressFamily.class).setSafi(UnicastSubsequentAddressFamily.class).build()).build()).build()).build())).build());
 296         this.session = new BGPSessionImpl(this.classic, this.channel, new OpenBuilder().setBgpIdentifier(new Ipv4Address("1.1.1.1"))
 297                 .setHoldTimer(50).setMyAsNumber(72).setBgpParameters(params).build(), 30, null);
 298         assertEquals("testPeer", this.classic.getName());
 299         this.classic.onSessionUp(this.session);
 300         Assert.assertArrayEquals(new byte[] {1, 1, 1, 1}, this.classic.getRawIdentifier());
 301         assertEquals("BGPPeer{name=testPeer, tables=[TablesKey [_afi=class org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Ipv4AddressFamily, _safi=class org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.UnicastSubsequentAddressFamily]]}", this.classic.toString());
 302         final List<Ipv4Prefix> prefs = Lists.newArrayList(new Ipv4Prefix("127.0.0.1/32"), new Ipv4Prefix("2.2.2.2/24"));
 303         final UpdateBuilder ub = new UpdateBuilder();
 304         ub.setNlri(new NlriBuilder().setNlri(prefs).build());
 305         ub.setAttributes(new AttributesBuilder().build());
 306         this.classic.onMessage(this.session, ub.build());
 307         assertEquals(2, this.routes.size());
 308
 309         //create new peer so that it gets advertized routes from RIB
 310         try (final BGPPeer testingPeer = new BGPPeer("testingPeer", this.r)) {
 311             testingPeer.onSessionUp(this.session);
 312             assertEquals(2, this.routes.size());
 313             assertEquals(1, testingPeer.getBgpPeerState().getSessionEstablishedCount().intValue());
 314             assertEquals(1, testingPeer.getBgpPeerState().getRouteTable().size());
 315             assertNotNull(testingPeer.getBgpSessionState());
 316         }
 317
 318         ub.setNlri(null);
 319         ub.setWithdrawnRoutes(new WithdrawnRoutesBuilder().setWithdrawnRoutes(prefs).build());
 320         this.classic.onMessage(this.session, ub.build());
 321         assertEquals(0, this.routes.size());
 322         this.classic.onMessage(this.session, new KeepaliveBuilder().build());
 323         this.classic.onMessage(this.session, new UpdateBuilder().setAttributes(
 324             new AttributesBuilder().addAugmentation(
 325                     Attributes2.class,
 326                     new Attributes2Builder().setMpUnreachNlri(
 327                             new MpUnreachNlriBuilder().setAfi(Ipv4AddressFamily.class).setSafi(UnicastSubsequentAddressFamily.class).build()).build()).build()).build());
 328         this.classic.releaseConnection();
 329     }
 330
 331     @After
 332     public void cleanUp() {
 333         this.peer.close();
 334     }
 335 }