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