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