bgp/rib-impl/src/test/java/org/opendaylight/protocol/bgp/rib/impl/FSMTest.java

   1 /*
   2  * Copyright (c) 2013 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.assertEquals;
  11 import static org.junit.Assert.assertNotNull;
  12 import static org.junit.Assert.assertTrue;
  13 import static org.mockito.Matchers.any;
  14 import static org.mockito.Mockito.doAnswer;
  15 import static org.mockito.Mockito.doReturn;
  16 import static org.mockito.Mockito.mock;
  17
  18 import com.google.common.collect.Lists;
  19 import io.netty.channel.Channel;
  20 import io.netty.channel.ChannelFuture;
  21 import io.netty.channel.ChannelHandler;
  22 import io.netty.channel.ChannelPipeline;
  23 import io.netty.channel.EventLoop;
  24 import io.netty.util.concurrent.DefaultPromise;
  25 import io.netty.util.concurrent.GenericFutureListener;
  26 import io.netty.util.concurrent.GlobalEventExecutor;
  27 import java.net.InetAddress;
  28 import java.net.InetSocketAddress;
  29 import java.net.UnknownHostException;
  30 import java.util.List;
  31 import java.util.Optional;
  32 import java.util.concurrent.TimeUnit;
  33 import org.junit.Before;
  34 import org.junit.Test;
  35 import org.mockito.Matchers;
  36 import org.mockito.Mock;
  37 import org.mockito.MockitoAnnotations;
  38 import org.opendaylight.protocol.bgp.parser.BGPError;
  39 import org.opendaylight.protocol.bgp.parser.BgpExtendedMessageUtil;
  40 import org.opendaylight.protocol.bgp.parser.BgpTableTypeImpl;
  41 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPPeerRegistry;
  42 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPSessionPreferences;
  43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
  44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.LinkstateAddressFamily;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.LinkstateSubsequentAddressFamily;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.Keepalive;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.KeepaliveBuilder;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.Notify;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.Open;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.OpenBuilder;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.ProtocolVersion;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.open.message.BgpParameters;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.open.message.BgpParametersBuilder;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.open.message.bgp.parameters.OptionalCapabilities;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.open.message.bgp.parameters.OptionalCapabilitiesBuilder;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.open.message.bgp.parameters.optional.capabilities.CParametersBuilder;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.open.message.bgp.parameters.optional.capabilities.c.parameters.As4BytesCapabilityBuilder;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.BgpTableType;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.CParameters1;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.CParameters1Builder;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.mp.capabilities.GracefulRestartCapabilityBuilder;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.mp.capabilities.MultiprotocolCapabilityBuilder;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.BgpId;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Ipv4AddressFamily;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.UnicastSubsequentAddressFamily;
  68 import org.opendaylight.yangtools.yang.binding.Notification;
  69
  70 public class FSMTest {
  71
  72
  73     @Mock
  74     private EventLoop eventLoop;
  75
  76     private BGPClientSessionNegotiator clientSession;
  77
  78     @Mock
  79     private Channel speakerListener;
  80
  81     @Mock
  82     private ChannelPipeline pipeline;
  83
  84     private final BgpTableType ipv4tt = new BgpTableTypeImpl(Ipv4AddressFamily.class, UnicastSubsequentAddressFamily.class);
  85
  86     private final BgpTableType linkstatett = new BgpTableTypeImpl(LinkstateAddressFamily.class, LinkstateSubsequentAddressFamily.class);
  87
  88     private final List<Notification> receivedMsgs = Lists.newArrayList();
  89
  90     private Open classicOpen;
  91
  92     @Before
  93     public void setUp() throws UnknownHostException {
  94         MockitoAnnotations.initMocks(this);
  95         final List<BgpParameters> tlvs = Lists.newArrayList();
  96         final List<OptionalCapabilities> capas = Lists.newArrayList();
  97
  98         capas.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().addAugmentation(CParameters1.class,
  99             new CParameters1Builder().setMultiprotocolCapability(new MultiprotocolCapabilityBuilder()
 100                 .setAfi(this.ipv4tt.getAfi()).setSafi(this.ipv4tt.getSafi()).build()).build()).build()).build());
 101         capas.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().addAugmentation(CParameters1.class,
 102             new CParameters1Builder().setMultiprotocolCapability(new MultiprotocolCapabilityBuilder()
 103                 .setAfi(this.linkstatett.getAfi()).setSafi(this.linkstatett.getSafi()).build()).build()).build()).build());
 104         capas.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().setAs4BytesCapability(
 105                 new As4BytesCapabilityBuilder().setAsNumber(new AsNumber(30L)).build()).build()).build());
 106         capas.add(new OptionalCapabilitiesBuilder().setCParameters(BgpExtendedMessageUtil.EXTENDED_MESSAGE_CAPABILITY).build());
 107         capas.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().addAugmentation(CParameters1.class,
 108             new CParameters1Builder().setGracefulRestartCapability(new GracefulRestartCapabilityBuilder().build()).build()).build()).build());
 109
 110
 111         tlvs.add(new BgpParametersBuilder().setOptionalCapabilities(capas).build());
 112         final BGPSessionPreferences prefs = new BGPSessionPreferences(new AsNumber(30L), (short) 3,
 113                 new BgpId("1.1.1.1"), new AsNumber(30L), tlvs);
 114
 115         final ChannelFuture f = mock(ChannelFuture.class);
 116         doReturn(null).when(f).addListener(any(GenericFutureListener.class));
 117
 118         final InetAddress peerAddress = InetAddress.getByName("1.1.1.2");
 119         doAnswer(invocation -> {
 120             final Object[] args = invocation.getArguments();
 121             FSMTest.this.receivedMsgs.add((Notification) args[0]);
 122             return f;
 123         }).when(this.speakerListener).writeAndFlush(any(Notification.class));
 124         doReturn(this.eventLoop).when(this.speakerListener).eventLoop();
 125         doReturn(null).when(this.eventLoop).schedule(any(Runnable.class), any(long.class), any(TimeUnit.class));
 126         doReturn("TestingChannel").when(this.speakerListener).toString();
 127         doReturn(new InetSocketAddress(peerAddress, 179)).when(this.speakerListener).remoteAddress();
 128         doReturn(new InetSocketAddress(peerAddress, 179)).when(this.speakerListener).localAddress();
 129         doReturn(this.pipeline).when(this.speakerListener).pipeline();
 130         doReturn(this.pipeline).when(this.pipeline).replace(any(ChannelHandler.class), any(String.class), any(ChannelHandler.class));
 131         doReturn(null).when(this.pipeline).replace(Matchers.<Class<ChannelHandler>>any(), any(String.class), any(ChannelHandler.class));
 132         doReturn(this.pipeline).when(this.pipeline).addLast(any(ChannelHandler.class));
 133         doReturn(mock(ChannelFuture.class)).when(this.speakerListener).close();
 134
 135         final BGPPeerRegistry peerRegistry = new StrictBGPPeerRegistry();
 136         peerRegistry.addPeer(new IpAddress(new Ipv4Address(peerAddress.getHostAddress())), new SimpleSessionListener(), prefs);
 137
 138         this.clientSession = new BGPClientSessionNegotiator(new DefaultPromise<>(GlobalEventExecutor.INSTANCE), this.speakerListener, peerRegistry);
 139
 140         this.classicOpen = new OpenBuilder().setMyAsNumber(30).setHoldTimer(3).setVersion(new ProtocolVersion((short) 4)).setBgpParameters(
 141             tlvs).setBgpIdentifier(new Ipv4Address("1.1.1.2")).build();
 142     }
 143
 144     @Test
 145     public void testDenyPeer() {
 146         this.clientSession = new BGPClientSessionNegotiator(new DefaultPromise<>(GlobalEventExecutor.INSTANCE), this.speakerListener, new StrictBGPPeerRegistry());
 147         this.clientSession.channelActive(null);
 148         assertEquals(1, this.receivedMsgs.size());
 149         assertTrue(this.receivedMsgs.get(0) instanceof Notify);
 150     }
 151
 152     @Test
 153     public void testAccSessionChar() {
 154         this.clientSession.channelActive(null);
 155         assertEquals(1, this.receivedMsgs.size());
 156         assertTrue(this.receivedMsgs.get(0) instanceof Open);
 157         this.clientSession.handleMessage(this.classicOpen);
 158         assertEquals(2, this.receivedMsgs.size());
 159         assertTrue(this.receivedMsgs.get(1) instanceof Keepalive);
 160         this.clientSession.handleMessage(new KeepaliveBuilder().build());
 161         assertEquals(this.clientSession.getState(), BGPClientSessionNegotiator.State.FINISHED);
 162     }
 163
 164     @Test
 165     public void testNotAccChars() {
 166         this.clientSession.channelActive(null);
 167         assertEquals(1, this.receivedMsgs.size());
 168         assertTrue(this.receivedMsgs.get(0) instanceof Open);
 169         this.clientSession.handleMessage(new OpenBuilder().setMyAsNumber(30).setHoldTimer(1).setBgpIdentifier(new Ipv4Address("127.0.0.1")).setVersion(new ProtocolVersion((short) 4)).build());
 170         assertEquals(2, this.receivedMsgs.size());
 171         assertTrue(this.receivedMsgs.get(1) instanceof Notify);
 172         final Notification m = this.receivedMsgs.get(this.receivedMsgs.size() - 1);
 173         assertEquals(BGPError.UNSPECIFIC_OPEN_ERROR, BGPError.forValue(((Notify) m).getErrorCode(), ((Notify) m).getErrorSubcode()));
 174     }
 175
 176     @Test
 177     public void testNoAs4BytesCapability() {
 178         this.clientSession.channelActive(null);
 179         assertEquals(1, this.receivedMsgs.size());
 180         assertTrue(this.receivedMsgs.get(0) instanceof Open);
 181
 182         final List<BgpParameters> tlvs = Lists.newArrayList();
 183         final List<OptionalCapabilities> capas = Lists.newArrayList();
 184         capas.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().addAugmentation(CParameters1.class,
 185             new CParameters1Builder().setMultiprotocolCapability(new MultiprotocolCapabilityBuilder()
 186                 .setAfi(this.ipv4tt.getAfi()).setSafi(this.ipv4tt.getSafi()).build()).build()).build()).build());
 187         capas.add(new OptionalCapabilitiesBuilder().setCParameters(BgpExtendedMessageUtil.EXTENDED_MESSAGE_CAPABILITY).build());
 188         tlvs.add(new BgpParametersBuilder().setOptionalCapabilities(capas).build());
 189         // Open Message without advertised four-octet AS Number capability
 190         this.clientSession.handleMessage(new OpenBuilder().setMyAsNumber(30).setHoldTimer(1).setVersion(
 191             new ProtocolVersion((short) 4)).setBgpParameters(tlvs).setBgpIdentifier(new Ipv4Address("1.1.1.2")).build());
 192         assertEquals(2, this.receivedMsgs.size());
 193         assertTrue(this.receivedMsgs.get(1) instanceof Notify);
 194         final Notification m = this.receivedMsgs.get(this.receivedMsgs.size() - 1);
 195         assertEquals(BGPError.UNSUPPORTED_CAPABILITY, BGPError.forValue(((Notify) m).getErrorCode(), ((Notify) m).getErrorSubcode()));
 196         assertNotNull(((Notify) m).getData());
 197     }
 198
 199     @Test
 200     public void testBgpExtendedMessageCapability() {
 201         this.clientSession.channelActive(null);
 202         assertEquals(1, this.receivedMsgs.size());
 203         assertTrue(this.receivedMsgs.get(0) instanceof Open);
 204
 205         final List<BgpParameters> tlvs = Lists.newArrayList();
 206         final List<OptionalCapabilities> capas = Lists.newArrayList();
 207         capas.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().addAugmentation(CParameters1.class,
 208                 new CParameters1Builder().setMultiprotocolCapability(new MultiprotocolCapabilityBuilder()
 209                         .setAfi(this.ipv4tt.getAfi()).setSafi(this.ipv4tt.getSafi()).build()).build()).build()).build());
 210         capas.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().setAs4BytesCapability(
 211                 new As4BytesCapabilityBuilder().setAsNumber(new AsNumber(30L)).build()).build()).build());
 212         tlvs.add(new BgpParametersBuilder().setOptionalCapabilities(capas).build());
 213         this.clientSession.handleMessage(new OpenBuilder().setMyAsNumber(30).setHoldTimer(1).setVersion(
 214                 new ProtocolVersion((short) 4)).setBgpParameters(tlvs).setBgpIdentifier(new Ipv4Address("1.1.1.2")).build());
 215         assertEquals(2, this.receivedMsgs.size());
 216         assertTrue(this.receivedMsgs.get(1) instanceof Keepalive);
 217
 218     }
 219
 220     @Test
 221     public void sendNotification() {
 222         this.clientSession.channelActive(null);
 223         this.clientSession.handleMessage(this.classicOpen);
 224         this.clientSession.handleMessage(new KeepaliveBuilder().build());
 225         assertEquals(this.clientSession.getState(), BGPClientSessionNegotiator.State.FINISHED);
 226         this.clientSession.handleMessage(new OpenBuilder().setMyAsNumber(30).setHoldTimer(3).setVersion(new ProtocolVersion((short) 4)).build());
 227         assertEquals(3, this.receivedMsgs.size());
 228         assertTrue(this.receivedMsgs.get(2) instanceof Notify);
 229         final Notification m = this.receivedMsgs.get(2);
 230         assertEquals(BGPError.FSM_ERROR.getCode(), ((Notify) m).getErrorCode().shortValue());
 231         assertEquals(BGPError.FSM_ERROR.getSubcode(), ((Notify) m).getErrorSubcode().shortValue());
 232     }
 233
 234     @Test
 235     public void sameBGPIDs() {
 236         this.clientSession.channelActive(null);
 237         assertEquals(1, this.receivedMsgs.size());
 238         assertTrue(this.receivedMsgs.get(0) instanceof Open);
 239
 240         this.clientSession.handleMessage(new OpenBuilder(this.classicOpen).setBgpIdentifier(new Ipv4Address("1.1.1.1")).build());
 241         assertEquals(2, this.receivedMsgs.size());
 242         assertTrue(this.receivedMsgs.get(1) instanceof Notify);
 243         final Notification m = this.receivedMsgs.get(this.receivedMsgs.size() - 1);
 244         assertEquals(BGPError.BAD_BGP_ID, BGPError.forValue(((Notify) m).getErrorCode(), ((Notify) m).getErrorSubcode()));
 245     }
 246 }