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