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.assertArrayEquals;
  11 import static org.junit.Assert.assertEquals;
  12 import static org.junit.Assert.fail;
  13 import static org.mockito.ArgumentMatchers.any;
  14 import static org.mockito.ArgumentMatchers.eq;
  15 import static org.mockito.Mockito.doAnswer;
  16 import static org.mockito.Mockito.doCallRealMethod;
  17 import static org.mockito.Mockito.doReturn;
  18 import static org.mockito.Mockito.mock;
  19
  20 import com.google.common.collect.Lists;
  21 import io.netty.channel.Channel;
  22 import io.netty.channel.ChannelHandler;
  23 import io.netty.channel.ChannelPipeline;
  24 import io.netty.channel.DefaultChannelPromise;
  25 import io.netty.channel.EventLoop;
  26 import java.net.InetSocketAddress;
  27 import java.util.Collections;
  28 import java.util.HashMap;
  29 import java.util.List;
  30 import java.util.Map;
  31 import java.util.concurrent.TimeUnit;
  32 import org.junit.Assert;
  33 import org.junit.Before;
  34 import org.junit.Test;
  35 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  36 import org.opendaylight.protocol.bgp.parser.BGPDocumentedException;
  37 import org.opendaylight.protocol.bgp.parser.BGPError;
  38 import org.opendaylight.protocol.bgp.parser.impl.message.update.LocalPreferenceAttributeParser;
  39 import org.opendaylight.protocol.bgp.rib.spi.RibSupportUtils;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
  42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv4.routes.ipv4.routes.Ipv4Route;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.KeepaliveBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.Open;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.OpenBuilder;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.UpdateBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.BgpParameters;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.BgpParametersBuilder;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.bgp.parameters.OptionalCapabilitiesBuilder;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.bgp.parameters.optional.capabilities.CParametersBuilder;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.AttributesBuilder;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.attributes.AsPath;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.attributes.AsPathBuilder;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.attributes.LocalPref;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.attributes.LocalPrefBuilder;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.attributes.Origin;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.attributes.OriginBuilder;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.update.message.Nlri;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.update.message.NlriBuilder;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.update.message.WithdrawnRoutes;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.update.message.WithdrawnRoutesBuilder;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.Attributes2;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.Attributes2Builder;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.CParameters1;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.CParameters1Builder;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.RouteRefreshBuilder;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.MultiprotocolCapabilityBuilder;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpUnreachNlriBuilder;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.ApplicationRibId;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.PeerRole;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.rib.LocRib;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.Tables;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.BgpOrigin;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.Ipv4AddressFamily;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.Ipv6AddressFamily;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.UnicastSubsequentAddressFamily;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.next.hop.CNextHop;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.next.hop.c.next.hop.Ipv4NextHopCaseBuilder;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.next.hop.c.next.hop.ipv4.next.hop._case.Ipv4NextHopBuilder;
  81 import org.opendaylight.yangtools.yang.binding.Notification;
  82 import org.opendaylight.yangtools.yang.common.Uint16;
  83 import org.opendaylight.yangtools.yang.common.Uint32;
  84 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  85 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  86 import org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType;
  87
  88 public class PeerTest extends AbstractRIBTestSetup {
  89
  90     private final IpAddress neighborAddress = new IpAddress(new Ipv4Address("127.0.0.1"));
  91     private ApplicationPeer peer;
  92     private BGPSessionImpl session;
  93     private Map<YangInstanceIdentifier, NormalizedNode<?, ?>> routes;
  94     private BGPPeer classic;
  95
  96     @Override
  97     @Before
  98     public void setUp() throws Exception {
  99         super.setUp();
 100         this.routes = new HashMap<>();
 101         overrideMockedBehaviour();
 102     }
 103
 104     private void overrideMockedBehaviour() {
 105         doAnswer(invocation -> {
 106             final Object[] args = invocation.getArguments();
 107             final NormalizedNode<?, ?> node = (NormalizedNode<?, ?>) args[2];
 108             if (node.getIdentifier().getNodeType().equals(Ipv4Route.QNAME) || node.getNodeType().equals(PREFIX_QNAME)) {
 109                 this.routes.put((YangInstanceIdentifier) args[1], node);
 110             }
 111             return args[1];
 112         }).when(getTransaction()).put(eq(LogicalDatastoreType.OPERATIONAL),
 113                 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
 114
 115         doAnswer(invocation -> {
 116             final Object[] args = invocation.getArguments();
 117             this.routes.remove(args[1]);
 118             return args[1];
 119         }).when(getTransaction()).delete(eq(LogicalDatastoreType.OPERATIONAL), any(YangInstanceIdentifier.class));
 120     }
 121
 122     @Test
 123     public void testAppPeer() {
 124         final Ipv4Prefix first = new Ipv4Prefix("127.0.0.2/32");
 125         final Ipv4Prefix second = new Ipv4Prefix("127.0.0.1/32");
 126         final Ipv4Prefix third = new Ipv4Prefix("127.0.0.3/32");
 127         this.peer = new ApplicationPeer(this.tableRegistry,
 128                 new ApplicationRibId(this.neighborAddress.getIpv4Address().getValue()),
 129                 this.neighborAddress.getIpv4Address(), getRib());
 130         this.peer.instantiateServiceInstance(null, null);
 131         final YangInstanceIdentifier base = getRib().getYangRibId().node(LocRib.QNAME)
 132                 .node(Tables.QNAME).node(RibSupportUtils.toYangTablesKey(KEY));
 133         this.peer.onDataTreeChanged(ipv4Input(base, ModificationType.WRITE, first, second, third));
 134         assertEquals(3, this.routes.size());
 135
 136         this.peer.onDataTreeChanged(ipv4Input(base, ModificationType.DELETE, third));
 137         assertEquals(2, this.routes.size());
 138     }
 139
 140     @Test
 141     public void testClassicPeer() throws Exception {
 142         this.classic = AbstractAddPathTest.configurePeer(this.tableRegistry, this.neighborAddress.getIpv4Address(),
 143                 getRib(), null, PeerRole.Ibgp, new StrictBGPPeerRegistry());
 144         this.classic.instantiateServiceInstance();
 145         this.mockSession();
 146         assertEquals(this.neighborAddress.getIpv4Address().getValue(), this.classic.getName());
 147         this.classic.onSessionUp(this.session);
 148         Assert.assertArrayEquals(new byte[]{1, 1, 1, 1}, this.classic.getRawIdentifier());
 149         assertEquals("BGPPeer{name=127.0.0.1, tables=[TablesKey{_afi=interface org.opendaylight.yang.gen.v1"
 150                         + ".urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.Ipv4AddressFamily,"
 151                         + " _safi=interface org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types"
 152                         + ".rev180329.UnicastSubsequentAddressFamily}]}",
 153                 this.classic.toString());
 154
 155         final Nlri n1 = new NlriBuilder().setPrefix(new Ipv4Prefix("8.0.1.0/28")).build();
 156         final Nlri n2 = new NlriBuilder().setPrefix(new Ipv4Prefix("127.0.0.1/32")).build();
 157         final Nlri n3 = new NlriBuilder().setPrefix(new Ipv4Prefix("2.2.2.2/24")).build();
 158         final List<Nlri> nlris = Lists.newArrayList(n1, n2, n3);
 159         final UpdateBuilder ub = new UpdateBuilder();
 160         ub.setNlri(nlris);
 161         final Origin origin = new OriginBuilder().setValue(BgpOrigin.Igp).build();
 162         final AsPath asPath = new AsPathBuilder().setSegments(Collections.emptyList()).build();
 163         final CNextHop nextHop = new Ipv4NextHopCaseBuilder().setIpv4NextHop(new Ipv4NextHopBuilder()
 164                 .setGlobal(new Ipv4Address("127.0.0.1")).build()).build();
 165         final AttributesBuilder ab = new AttributesBuilder();
 166         ub.setAttributes(ab.setOrigin(origin).setAsPath(asPath).setCNextHop(nextHop).build());
 167         try {
 168             this.classic.onMessage(this.session, ub.build());
 169             fail();
 170         } catch (final BGPDocumentedException e) {
 171             assertEquals(BGPError.MANDATORY_ATTR_MISSING_MSG + "LOCAL_PREF", e.getMessage());
 172             assertEquals(BGPError.WELL_KNOWN_ATTR_MISSING.getCode(), e.getError().getCode());
 173             assertEquals(BGPError.WELL_KNOWN_ATTR_MISSING.getSubcode(), e.getError().getSubcode());
 174             assertArrayEquals(new byte[]{LocalPreferenceAttributeParser.TYPE}, e.getData());
 175         }
 176         assertEquals(0, this.routes.size());
 177
 178         final LocalPref localPref = new LocalPrefBuilder().setPref(Uint32.valueOf(100)).build();
 179         ub.setAttributes(ab.setLocalPref(localPref).build());
 180         this.classic.onMessage(this.session, ub.build());
 181         assertEquals(3, this.routes.size());
 182
 183         //create new peer so that it gets advertized routes from RIB
 184         final BGPPeer testingPeer = AbstractAddPathTest.configurePeer(this.tableRegistry,
 185             this.neighborAddress.getIpv4Address(), getRib(), null, PeerRole.Ibgp, new StrictBGPPeerRegistry());
 186         testingPeer.instantiateServiceInstance();
 187         testingPeer.onSessionUp(this.session);
 188         assertEquals(3, this.routes.size());
 189
 190         final Nlri n11 = new NlriBuilder().setPrefix(new Ipv4Prefix("8.0.1.0/28")).build();
 191         final Nlri n22 = new NlriBuilder().setPrefix(new Ipv4Prefix("8.0.1.16/28")).build();
 192         final List<Nlri> nlris2 = Lists.newArrayList(n11, n22);
 193         ub.setNlri(nlris2);
 194         final WithdrawnRoutes w1 = new WithdrawnRoutesBuilder().setPrefix(new Ipv4Prefix("8.0.1.0/28")).build();
 195         final WithdrawnRoutes w2 = new WithdrawnRoutesBuilder().setPrefix(new Ipv4Prefix("127.0.0.1/32")).build();
 196         final WithdrawnRoutes w3 = new WithdrawnRoutesBuilder().setPrefix(new Ipv4Prefix("2.2.2.2/24")).build();
 197         final List<WithdrawnRoutes> wrs = Lists.newArrayList(w1, w2, w3);
 198         ub.setWithdrawnRoutes(wrs);
 199         this.classic.onMessage(this.session, ub.build());
 200         assertEquals(2, this.routes.size());
 201         this.classic.onMessage(this.session, new KeepaliveBuilder().build());
 202         this.classic.onMessage(this.session, new UpdateBuilder().setAttributes(
 203                 new AttributesBuilder().addAugmentation(
 204                         Attributes2.class,
 205                         new Attributes2Builder().setMpUnreachNlri(
 206                                 new MpUnreachNlriBuilder()
 207                                         .setAfi(IPV4_AFI)
 208                                         .setSafi(SAFI)
 209                                         .build()).build()).build()).build());
 210         this.classic.onMessage(this.session, new RouteRefreshBuilder().setAfi(IPV4_AFI).setSafi(SAFI).build());
 211         this.classic.onMessage(this.session, new RouteRefreshBuilder()
 212                 .setAfi(Ipv6AddressFamily.class)
 213                 .setSafi(SAFI).build());
 214         assertEquals(2, this.routes.size());
 215         this.classic.releaseConnection();
 216     }
 217
 218     private void mockSession() {
 219         final EventLoop eventLoop = mock(EventLoop.class);
 220         final Channel channel = mock(Channel.class);
 221         final ChannelPipeline pipeline = mock(ChannelPipeline.class);
 222         doReturn(null).when(eventLoop).schedule(any(Runnable.class), any(long.class), any(TimeUnit.class));
 223         doReturn(eventLoop).when(channel).eventLoop();
 224         doReturn(Boolean.TRUE).when(channel).isWritable();
 225         doReturn(null).when(channel).close();
 226         doReturn(pipeline).when(channel).pipeline();
 227         doCallRealMethod().when(channel).toString();
 228         doReturn(pipeline).when(pipeline).addLast(any(ChannelHandler.class));
 229         doReturn(new DefaultChannelPromise(channel)).when(channel).writeAndFlush(any(Notification.class));
 230         doReturn(new InetSocketAddress("localhost", 12345)).when(channel).remoteAddress();
 231         doReturn(new InetSocketAddress("localhost", 12345)).when(channel).localAddress();
 232         final List<BgpParameters> params = Lists.newArrayList(new BgpParametersBuilder().setOptionalCapabilities(
 233                 Lists.newArrayList(new OptionalCapabilitiesBuilder().setCParameters(
 234                         new CParametersBuilder().addAugmentation(
 235                                 CParameters1.class, new CParameters1Builder().setMultiprotocolCapability(
 236                                         new MultiprotocolCapabilityBuilder()
 237                                                 .setAfi(Ipv4AddressFamily.class)
 238                                                 .setSafi(UnicastSubsequentAddressFamily.class)
 239                                                 .build()).build()).build()).build())).build());
 240         final Open openObj = new OpenBuilder()
 241                 .setBgpIdentifier(new Ipv4Address("1.1.1.1"))
 242                 .setHoldTimer(Uint16.valueOf(50))
 243                 .setMyAsNumber(Uint16.valueOf(72))
 244                 .setBgpParameters(params).build();
 245         this.session = new BGPSessionImpl(this.classic, channel, openObj, 30, null);
 246         this.session.setChannelExtMsgCoder(openObj);
 247     }
 248 }