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