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