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.mockito.invocation.InvocationOnMock;
  40 import org.mockito.stubbing.Answer;
  41 import org.opendaylight.protocol.bgp.parser.BGPError;
  42 import org.opendaylight.protocol.bgp.parser.BgpExtendedMessageUtil;
  43 import org.opendaylight.protocol.bgp.parser.BgpTableTypeImpl;
  44 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPPeerRegistry;
  45 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPSessionPreferences;
  46 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
  47 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  48 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.LinkstateAddressFamily;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.LinkstateSubsequentAddressFamily;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Keepalive;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.KeepaliveBuilder;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Notify;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Open;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.OpenBuilder;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.ProtocolVersion;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.BgpParameters;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.BgpParametersBuilder;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.bgp.parameters.OptionalCapabilities;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.bgp.parameters.OptionalCapabilitiesBuilder;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.bgp.parameters.optional.capabilities.CParametersBuilder;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.bgp.parameters.optional.capabilities.c.parameters.As4BytesCapabilityBuilder;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.BgpTableType;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.CParameters1;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.CParameters1Builder;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.mp.capabilities.GracefulRestartCapabilityBuilder;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.mp.capabilities.MultiprotocolCapabilityBuilder;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.BgpId;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Ipv4AddressFamily;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.UnicastSubsequentAddressFamily;
  71 import org.opendaylight.yangtools.yang.binding.Notification;
  72
  73 public class FSMTest {
  74
  75
  76     @Mock
  77     private EventLoop eventLoop;
  78
  79     private BGPClientSessionNegotiator clientSession;
  80
  81     @Mock
  82     private Channel speakerListener;
  83
  84     @Mock
  85     private ChannelPipeline pipeline;
  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(BgpExtendedMessageUtil.EXTENDED_MESSAGE_CAPABILITY).build());
 110         capas.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().addAugmentation(CParameters1.class,
 111             new CParameters1Builder().setGracefulRestartCapability(new GracefulRestartCapabilityBuilder().build()).build()).build()).build());
 112
 113
 114         tlvs.add(new BgpParametersBuilder().setOptionalCapabilities(capas).build());
 115         final BGPSessionPreferences prefs = new BGPSessionPreferences(new AsNumber(30L), (short) 3, new BgpId("1.1.1.1"), new AsNumber(30L), tlvs,
 116                 Optional.<byte[]>absent());
 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(null).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     }
 169
 170     @Test
 171     public void testNotAccChars() throws InterruptedException {
 172         this.clientSession.channelActive(null);
 173         assertEquals(1, this.receivedMsgs.size());
 174         assertTrue(this.receivedMsgs.get(0) instanceof Open);
 175         this.clientSession.handleMessage(new OpenBuilder().setMyAsNumber(30).setHoldTimer(1).setBgpIdentifier(new Ipv4Address("127.0.0.1")).setVersion(new ProtocolVersion((short) 4)).build());
 176         assertEquals(2, this.receivedMsgs.size());
 177         assertTrue(this.receivedMsgs.get(1) instanceof Notify);
 178         final Notification m = this.receivedMsgs.get(this.receivedMsgs.size() - 1);
 179         assertEquals(BGPError.UNSPECIFIC_OPEN_ERROR, BGPError.forValue(((Notify) m).getErrorCode(), ((Notify) m).getErrorSubcode()));
 180     }
 181
 182     @Test
 183     public void testNoAs4BytesCapability() {
 184         this.clientSession.channelActive(null);
 185         assertEquals(1, this.receivedMsgs.size());
 186         assertTrue(this.receivedMsgs.get(0) instanceof Open);
 187
 188         final List<BgpParameters> tlvs = Lists.newArrayList();
 189         final List<OptionalCapabilities> capas = Lists.newArrayList();
 190         capas.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().addAugmentation(CParameters1.class,
 191             new CParameters1Builder().setMultiprotocolCapability(new MultiprotocolCapabilityBuilder()
 192                 .setAfi(this.ipv4tt.getAfi()).setSafi(this.ipv4tt.getSafi()).build()).build()).build()).build());
 193         capas.add(new OptionalCapabilitiesBuilder().setCParameters(BgpExtendedMessageUtil.EXTENDED_MESSAGE_CAPABILITY).build());
 194         tlvs.add(new BgpParametersBuilder().setOptionalCapabilities(capas).build());
 195         // Open Message without advertised four-octet AS Number capability
 196         this.clientSession.handleMessage(new OpenBuilder().setMyAsNumber(30).setHoldTimer(1).setVersion(
 197             new ProtocolVersion((short) 4)).setBgpParameters(tlvs).setBgpIdentifier(new Ipv4Address("1.1.1.2")).build());
 198         assertEquals(2, this.receivedMsgs.size());
 199         assertTrue(this.receivedMsgs.get(1) instanceof Notify);
 200         final Notification m = this.receivedMsgs.get(this.receivedMsgs.size() - 1);
 201         assertEquals(BGPError.UNSUPPORTED_CAPABILITY, BGPError.forValue(((Notify) m).getErrorCode(), ((Notify) m).getErrorSubcode()));
 202         assertNotNull(((Notify) m).getData());
 203     }
 204
 205     @Test
 206     public void testBgpExtendedMessageCapability() {
 207         this.clientSession.channelActive(null);
 208         assertEquals(1, this.receivedMsgs.size());
 209         assertTrue(this.receivedMsgs.get(0) instanceof Open);
 210
 211         final List<BgpParameters> tlvs = Lists.newArrayList();
 212         final List<OptionalCapabilities> capas = Lists.newArrayList();
 213         capas.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().addAugmentation(CParameters1.class,
 214                 new CParameters1Builder().setMultiprotocolCapability(new MultiprotocolCapabilityBuilder()
 215                         .setAfi(this.ipv4tt.getAfi()).setSafi(this.ipv4tt.getSafi()).build()).build()).build()).build());
 216         capas.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().setAs4BytesCapability(
 217                 new As4BytesCapabilityBuilder().setAsNumber(new AsNumber(30L)).build()).build()).build());
 218         tlvs.add(new BgpParametersBuilder().setOptionalCapabilities(capas).build());
 219         this.clientSession.handleMessage(new OpenBuilder().setMyAsNumber(30).setHoldTimer(1).setVersion(
 220                 new ProtocolVersion((short) 4)).setBgpParameters(tlvs).setBgpIdentifier(new Ipv4Address("1.1.1.2")).build());
 221         assertEquals(2, this.receivedMsgs.size());
 222         assertTrue(this.receivedMsgs.get(1) instanceof Keepalive);
 223
 224     }
 225
 226     @Test
 227     public void sendNotification() {
 228         this.clientSession.channelActive(null);
 229         this.clientSession.handleMessage(this.classicOpen);
 230         this.clientSession.handleMessage(new KeepaliveBuilder().build());
 231         assertEquals(this.clientSession.getState(), BGPClientSessionNegotiator.State.FINISHED);
 232         this.clientSession.handleMessage(new OpenBuilder().setMyAsNumber(30).setHoldTimer(3).setVersion(new ProtocolVersion((short) 4)).build());
 233         assertEquals(3, this.receivedMsgs.size());
 234         assertTrue(this.receivedMsgs.get(2) instanceof Notify);
 235         final Notification m = this.receivedMsgs.get(2);
 236         assertEquals(BGPError.FSM_ERROR.getCode(), ((Notify) m).getErrorCode().shortValue());
 237         assertEquals(BGPError.FSM_ERROR.getSubcode(), ((Notify) m).getErrorSubcode().shortValue());
 238     }
 239
 240     @Test
 241     public void sameBGPIDs() {
 242         this.clientSession.channelActive(null);
 243         assertEquals(1, this.receivedMsgs.size());
 244         assertTrue(this.receivedMsgs.get(0) instanceof Open);
 245
 246         this.clientSession.handleMessage(new OpenBuilder(this.classicOpen).setBgpIdentifier(new Ipv4Address("1.1.1.1")).build());
 247         assertEquals(2, this.receivedMsgs.size());
 248         assertTrue(this.receivedMsgs.get(1) instanceof Notify);
 249         final Notification m = this.receivedMsgs.get(this.receivedMsgs.size() - 1);
 250         assertEquals(BGPError.BAD_BGP_ID, BGPError.forValue(((Notify) m).getErrorCode(), ((Notify) m).getErrorSubcode()));
 251     }
 252
 253     @After
 254     public void tearDown() {
 255
 256     }
 257 }