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