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.assertTrue;
  12 import static org.mockito.Matchers.any;
  13 import static org.mockito.Mockito.doAnswer;
  14 import static org.mockito.Mockito.doReturn;
  15 import static org.mockito.Mockito.mock;
  16
  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.util.HashedWheelTimer;
  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 org.junit.After;
  31 import org.junit.Before;
  32 import org.junit.Ignore;
  33 import org.junit.Test;
  34 import org.mockito.Mock;
  35 import org.mockito.MockitoAnnotations;
  36 import org.mockito.invocation.InvocationOnMock;
  37 import org.mockito.stubbing.Answer;
  38 import org.opendaylight.protocol.bgp.parser.BGPError;
  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.rev100924.AsNumber;
  43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress;
  44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Address;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev131125.LinkstateAddressFamily;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev131125.LinkstateSubsequentAddressFamily;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Keepalive;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.KeepaliveBuilder;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Notify;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Open;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.OpenBuilder;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.ProtocolVersion;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.BgpParameters;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.BgpParametersBuilder;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.bgp.parameters.c.parameters.As4BytesCaseBuilder;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.bgp.parameters.c.parameters.as4.bytes._case.As4BytesCapabilityBuilder;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.BgpTableType;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.open.bgp.parameters.c.parameters.MultiprotocolCaseBuilder;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.open.bgp.parameters.c.parameters.multiprotocol._case.MultiprotocolCapabilityBuilder;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Ipv4AddressFamily;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.UnicastSubsequentAddressFamily;
  62 import org.opendaylight.yangtools.yang.binding.Notification;
  63
  64 public class FSMTest {
  65
  66     private BGPClientSessionNegotiator clientSession;
  67
  68     @Mock
  69     private Channel speakerListener;
  70
  71     @Mock
  72     private ChannelPipeline pipeline;
  73
  74     private final BgpTableType ipv4tt = new BgpTableTypeImpl(Ipv4AddressFamily.class, UnicastSubsequentAddressFamily.class);
  75
  76     private final BgpTableType linkstatett = new BgpTableTypeImpl(LinkstateAddressFamily.class, LinkstateSubsequentAddressFamily.class);
  77
  78     private final List<Notification> receivedMsgs = Lists.newArrayList();
  79
  80     private Open classicOpen;
  81
  82     @Before
  83     public void setUp() throws UnknownHostException {
  84         MockitoAnnotations.initMocks(this);
  85         final List<BgpParameters> tlvs = Lists.newArrayList();
  86
  87         tlvs.add(new BgpParametersBuilder().setCParameters(
  88                 new MultiprotocolCaseBuilder().setMultiprotocolCapability(
  89                         new MultiprotocolCapabilityBuilder().setAfi(this.ipv4tt.getAfi()).setSafi(this.ipv4tt.getSafi()).build()).build()).build());
  90         tlvs.add(new BgpParametersBuilder().setCParameters(
  91                 new MultiprotocolCaseBuilder().setMultiprotocolCapability(
  92                         new MultiprotocolCapabilityBuilder().setAfi(this.linkstatett.getAfi()).setSafi(this.linkstatett.getSafi()).build()).build()).build());
  93         tlvs.add(new BgpParametersBuilder().setCParameters(new As4BytesCaseBuilder().setAs4BytesCapability(new As4BytesCapabilityBuilder().setAsNumber(
  94                 new AsNumber(30L)).build()).build()).build());
  95         final BGPSessionPreferences prefs = new BGPSessionPreferences(new AsNumber(30L), (short) 3, new Ipv4Address("1.1.1.1"), tlvs);
  96
  97         final ChannelFuture f = mock(ChannelFuture.class);
  98         doReturn(null).when(f).addListener(any(GenericFutureListener.class));
  99
 100         final InetAddress peerAddress = InetAddress.getByName("1.1.1.2");
 101         final BGPPeerRegistry peerRegistry = new StrictBGPPeerRegistry();
 102         peerRegistry.addPeer(new IpAddress(new Ipv4Address(peerAddress.getHostAddress())), new SimpleSessionListener(), prefs);
 103
 104         this.clientSession = new BGPClientSessionNegotiator(new HashedWheelTimer(), new DefaultPromise<BGPSessionImpl>(GlobalEventExecutor.INSTANCE), this.speakerListener, peerRegistry, new BGPClientSessionValidator(new AsNumber(30L)));
 105         doAnswer(new Answer<Object>() {
 106             @Override
 107             public Object answer(final InvocationOnMock invocation) {
 108                 final Object[] args = invocation.getArguments();
 109                 FSMTest.this.receivedMsgs.add((Notification) args[0]);
 110                 return f;
 111             }
 112         }).when(this.speakerListener).writeAndFlush(any(Notification.class));
 113
 114         doReturn("TestingChannel").when(this.speakerListener).toString();
 115         doReturn(new InetSocketAddress(peerAddress, 179)).when(this.speakerListener).remoteAddress();
 116         doReturn(this.pipeline).when(this.speakerListener).pipeline();
 117         doReturn(this.pipeline).when(this.pipeline).replace(any(ChannelHandler.class), any(String.class), any(ChannelHandler.class));
 118         doReturn(mock(ChannelFuture.class)).when(this.speakerListener).close();
 119         this.classicOpen = new OpenBuilder().setMyAsNumber(30).setHoldTimer(3).setVersion(new ProtocolVersion((short) 4)).setBgpParameters(
 120                 tlvs).setBgpIdentifier(new Ipv4Address("1.1.1.2")).build();
 121     }
 122
 123     @Test
 124     public void testAccSessionChar() throws InterruptedException {
 125         this.clientSession.channelActive(null);
 126         assertEquals(1, this.receivedMsgs.size());
 127         assertTrue(this.receivedMsgs.get(0) instanceof Open);
 128         this.clientSession.handleMessage(this.classicOpen);
 129         assertEquals(2, this.receivedMsgs.size());
 130         assertTrue(this.receivedMsgs.get(1) instanceof Keepalive);
 131         this.clientSession.handleMessage(new KeepaliveBuilder().build());
 132         assertEquals(this.clientSession.getState(), BGPClientSessionNegotiator.State.Finished);
 133         Thread.sleep(1000);
 134         Thread.sleep(100);
 135         assertEquals(3, this.receivedMsgs.size());
 136         assertTrue(this.receivedMsgs.get(2) instanceof Keepalive); // test of keepalive timer
 137     }
 138
 139     @Test
 140     public void testNotAccChars() throws InterruptedException {
 141         this.clientSession.channelActive(null);
 142         assertEquals(1, this.receivedMsgs.size());
 143         assertTrue(this.receivedMsgs.get(0) instanceof Open);
 144         this.clientSession.handleMessage(new OpenBuilder().setMyAsNumber(30).setHoldTimer(1).setVersion(new ProtocolVersion((short) 4)).build());
 145         assertEquals(2, this.receivedMsgs.size());
 146         assertTrue(this.receivedMsgs.get(1) instanceof Notify);
 147         final Notification m = this.receivedMsgs.get(this.receivedMsgs.size() - 1);
 148         assertEquals(BGPError.UNSPECIFIC_OPEN_ERROR, BGPError.forValue(((Notify) m).getErrorCode(), ((Notify) m).getErrorSubcode()));
 149     }
 150
 151     @Test
 152     public void testNoAs4BytesCapability() {
 153         this.clientSession.channelActive(null);
 154         assertEquals(1, this.receivedMsgs.size());
 155         assertTrue(this.receivedMsgs.get(0) instanceof Open);
 156
 157         final List<BgpParameters> tlvs = Lists.newArrayList();
 158         tlvs.add(new BgpParametersBuilder().setCParameters(
 159                 new MultiprotocolCaseBuilder().setMultiprotocolCapability(
 160                         new MultiprotocolCapabilityBuilder().setAfi(this.ipv4tt.getAfi()).setSafi(this.ipv4tt.getSafi()).build()).build()).build());
 161         // Open Message without advertised four-octet AS Number capability
 162         this.clientSession.handleMessage(new OpenBuilder().setMyAsNumber(30).setHoldTimer(1).setVersion(new ProtocolVersion((short) 4)).setBgpParameters(tlvs).build());
 163         assertEquals(2, this.receivedMsgs.size());
 164         assertTrue(this.receivedMsgs.get(1) instanceof Notify);
 165         final Notification m = this.receivedMsgs.get(this.receivedMsgs.size() - 1);
 166         assertEquals(BGPError.UNSPECIFIC_OPEN_ERROR, BGPError.forValue(((Notify) m).getErrorCode(), ((Notify) m).getErrorSubcode()));
 167     }
 168
 169     @Test
 170     @Ignore
 171     // long duration
 172     public void testNoOpen() throws InterruptedException {
 173         this.clientSession.channelActive(null);
 174         assertEquals(1, this.receivedMsgs.size());
 175         assertTrue(this.receivedMsgs.get(0) instanceof Open);
 176         Thread.sleep(BGPClientSessionNegotiator.INITIAL_HOLDTIMER * 1000 * 60);
 177         Thread.sleep(100);
 178         final Notification m = this.receivedMsgs.get(this.receivedMsgs.size() - 1);
 179         assertEquals(BGPError.HOLD_TIMER_EXPIRED, BGPError.forValue(((Notify) m).getErrorCode(), ((Notify) m).getErrorSubcode()));
 180     }
 181
 182     @Test
 183     public void sendNotification() {
 184         this.clientSession.channelActive(null);
 185         this.clientSession.handleMessage(this.classicOpen);
 186         this.clientSession.handleMessage(new KeepaliveBuilder().build());
 187         assertEquals(this.clientSession.getState(), BGPClientSessionNegotiator.State.Finished);
 188         this.clientSession.handleMessage(new OpenBuilder().setMyAsNumber(30).setHoldTimer(3).setVersion(new ProtocolVersion((short) 4)).build());
 189         assertEquals(3, this.receivedMsgs.size());
 190         assertTrue(this.receivedMsgs.get(2) instanceof Notify);
 191         final Notification m = this.receivedMsgs.get(2);
 192         assertEquals(BGPError.FSM_ERROR.getCode(), ((Notify) m).getErrorCode().shortValue());
 193         assertEquals(BGPError.FSM_ERROR.getSubcode(), ((Notify) m).getErrorSubcode().shortValue());
 194     }
 195
 196     @After
 197     public void tearDown() {
 198
 199     }
 200 }