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