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