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