bgp/rib-impl/src/test/java/org/opendaylight/protocol/bgp/rib/impl/BGPSessionImplTest.java

   1 /*
   2  * Copyright (c) 2014 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.assertNotEquals;
  12 import static org.junit.Assert.assertSame;
  13 import static org.junit.Assert.assertTrue;
  14 import static org.junit.Assert.fail;
  15 import static org.mockito.ArgumentMatchers.any;
  16 import static org.mockito.Mockito.doAnswer;
  17 import static org.mockito.Mockito.doNothing;
  18 import static org.mockito.Mockito.doReturn;
  19 import static org.mockito.Mockito.doThrow;
  20 import static org.mockito.Mockito.mock;
  21 import static org.mockito.Mockito.never;
  22 import static org.mockito.Mockito.spy;
  23 import static org.mockito.Mockito.verify;
  24 import static org.opendaylight.protocol.bgp.rib.impl.CheckUtil.checkIdleState;
  25
  26 import io.netty.channel.Channel;
  27 import io.netty.channel.ChannelFuture;
  28 import io.netty.channel.ChannelHandler;
  29 import io.netty.channel.ChannelPipeline;
  30 import io.netty.channel.EventLoop;
  31 import io.netty.util.concurrent.GlobalEventExecutor;
  32 import java.net.InetAddress;
  33 import java.net.InetSocketAddress;
  34 import java.net.UnknownHostException;
  35 import java.util.ArrayList;
  36 import java.util.List;
  37 import java.util.concurrent.TimeUnit;
  38 import org.junit.Before;
  39 import org.junit.Test;
  40 import org.mockito.ArgumentMatchers;
  41 import org.mockito.Mock;
  42 import org.mockito.MockitoAnnotations;
  43 import org.opendaylight.protocol.bgp.parser.BGPDocumentedException;
  44 import org.opendaylight.protocol.bgp.parser.BGPError;
  45 import org.opendaylight.protocol.bgp.parser.BgpExtendedMessageUtil;
  46 import org.opendaylight.protocol.bgp.parser.BgpTableTypeImpl;
  47 import org.opendaylight.protocol.bgp.rib.spi.BGPSessionListener;
  48 import org.opendaylight.protocol.bgp.rib.spi.BGPTerminationReason;
  49 import org.opendaylight.protocol.bgp.rib.spi.State;
  50 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
  51 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.Notify;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.NotifyBuilder;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.Open;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.OpenBuilder;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.ProtocolVersion;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.Update;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.UpdateBuilder;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.BgpParametersBuilder;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.bgp.parameters.OptionalCapabilities;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.bgp.parameters.OptionalCapabilitiesBuilder;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.bgp.parameters.optional.capabilities.CParametersBuilder;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.bgp.parameters.optional.capabilities.c.parameters.As4BytesCapabilityBuilder;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.BgpTableType;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.CParameters1Builder;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.GracefulRestartCapabilityBuilder;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.MultiprotocolCapabilityBuilder;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.Ipv4AddressFamily;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.UnicastSubsequentAddressFamily;
  70 import org.opendaylight.yangtools.yang.binding.Notification;
  71 import org.opendaylight.yangtools.yang.common.Uint16;
  72 import org.opendaylight.yangtools.yang.common.Uint32;
  73 import org.opendaylight.yangtools.yang.common.Uint8;
  74
  75 public class BGPSessionImplTest {
  76     private static final Uint16 HOLD_TIMER = Uint16.valueOf(3);
  77     private static final AsNumber AS_NUMBER = new AsNumber(Uint32.valueOf(30));
  78     private static final Ipv4AddressNoZone BGP_ID = new Ipv4AddressNoZone("1.1.1.2");
  79     private static final String LOCAL_IP = "1.1.1.4";
  80     private static final int LOCAL_PORT = 12345;
  81
  82     @Mock
  83     private EventLoop eventLoop;
  84
  85     @Mock
  86     private Channel speakerListener;
  87
  88     @Mock
  89     private ChannelPipeline pipeline;
  90
  91     private final BgpTableType ipv4tt = new BgpTableTypeImpl(Ipv4AddressFamily.class,
  92         UnicastSubsequentAddressFamily.class);
  93
  94     private final List<Notification> receivedMsgs = new ArrayList<>();
  95
  96     private Open classicOpen;
  97
  98     private BGPSessionImpl bgpSession;
  99
 100     private SimpleSessionListener listener;
 101
 102     @Before
 103     public void setUp() throws UnknownHostException {
 104         MockitoAnnotations.initMocks(this);
 105
 106         final List<OptionalCapabilities> capa = new ArrayList<>();
 107         capa.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder()
 108             .addAugmentation(new CParameters1Builder()
 109                 .setMultiprotocolCapability(new MultiprotocolCapabilityBuilder()
 110                     .setAfi(this.ipv4tt.getAfi()).setSafi(this.ipv4tt.getSafi()).build())
 111                 .setGracefulRestartCapability(new GracefulRestartCapabilityBuilder().build()).build())
 112             .setAs4BytesCapability(new As4BytesCapabilityBuilder().setAsNumber(AS_NUMBER).build()).build()).build());
 113         capa.add(new OptionalCapabilitiesBuilder().setCParameters(BgpExtendedMessageUtil.EXTENDED_MESSAGE_CAPABILITY)
 114             .build());
 115
 116         this.classicOpen = new OpenBuilder()
 117                 .setMyAsNumber(Uint16.valueOf(AS_NUMBER.getValue()))
 118                 .setHoldTimer(HOLD_TIMER)
 119                 .setVersion(new ProtocolVersion(Uint8.valueOf(4)))
 120                 .setBgpParameters(List.of(new BgpParametersBuilder().setOptionalCapabilities(capa).build()))
 121                 .setBgpIdentifier(BGP_ID)
 122                 .build();
 123
 124         final ChannelFuture f = mock(ChannelFuture.class);
 125         doReturn(null).when(f).addListener(any());
 126
 127         doAnswer(invocation -> {
 128             final Object[] args = invocation.getArguments();
 129             BGPSessionImplTest.this.receivedMsgs.add((Notification) args[0]);
 130             return f;
 131         }).when(this.speakerListener).writeAndFlush(any(Notification.class));
 132         doReturn(this.eventLoop).when(this.speakerListener).eventLoop();
 133         doReturn(true).when(this.speakerListener).isActive();
 134         doAnswer(invocation -> {
 135             final Runnable command = (Runnable) invocation.getArguments()[0];
 136             final long delay = (long) invocation.getArguments()[1];
 137             final TimeUnit unit = (TimeUnit) invocation.getArguments()[2];
 138             GlobalEventExecutor.INSTANCE.schedule(command, delay, unit);
 139             return null;
 140         }).when(this.eventLoop).schedule(any(Runnable.class), any(long.class), any(TimeUnit.class));
 141         doReturn("TestingChannel").when(this.speakerListener).toString();
 142         doReturn(true).when(this.speakerListener).isWritable();
 143         doReturn(new InetSocketAddress(InetAddress.getByName(BGP_ID.getValue()), 179)).when(this.speakerListener)
 144         .remoteAddress();
 145         doReturn(new InetSocketAddress(InetAddress.getByName(LOCAL_IP), LOCAL_PORT)).when(this.speakerListener)
 146         .localAddress();
 147         doReturn(this.pipeline).when(this.speakerListener).pipeline();
 148         doReturn(this.pipeline).when(this.pipeline).replace(any(ChannelHandler.class), any(String.class),
 149             any(ChannelHandler.class));
 150         doReturn(null).when(this.pipeline).replace(ArgumentMatchers.<Class<ChannelHandler>>any(), any(String.class),
 151             any(ChannelHandler.class));
 152         doReturn(this.pipeline).when(this.pipeline).addLast(any(ChannelHandler.class));
 153         final ChannelFuture futureChannel = mock(ChannelFuture.class);
 154         doReturn(null).when(futureChannel).addListener(any());
 155         doReturn(futureChannel).when(this.speakerListener).close();
 156         this.listener = new SimpleSessionListener();
 157         this.bgpSession = new BGPSessionImpl(this.listener, this.speakerListener, this.classicOpen,
 158             this.classicOpen.getHoldTimer().toJava(), null);
 159         this.bgpSession.setChannelExtMsgCoder(this.classicOpen);
 160     }
 161
 162     @Test
 163     public void testBGPSession() throws BGPDocumentedException {
 164         this.bgpSession.sessionUp();
 165         assertEquals(State.UP, this.bgpSession.getState());
 166         assertEquals(AS_NUMBER, this.bgpSession.getAsNumber());
 167         assertEquals(BGP_ID, this.bgpSession.getBgpId());
 168         assertEquals(1, this.bgpSession.getAdvertisedTableTypes().size());
 169         assertEquals(State.UP, this.listener.getState());
 170
 171         this.bgpSession.handleMessage(new UpdateBuilder().build());
 172         assertEquals(1, this.listener.getListMsg().size());
 173         assertTrue(this.listener.getListMsg().get(0) instanceof Update);
 174         this.bgpSession.close();
 175         assertEquals(State.IDLE, this.bgpSession.getState());
 176         assertEquals(1, this.receivedMsgs.size());
 177         assertTrue(this.receivedMsgs.get(0) instanceof Notify);
 178         final Notify error = (Notify) this.receivedMsgs.get(0);
 179         assertEquals(BGPError.CEASE.getCode(), error.getErrorCode());
 180         assertEquals(BGPError.CEASE.getSubcode(), error.getErrorSubcode());
 181         verify(this.speakerListener).close();
 182     }
 183
 184     @Test
 185     public void testHandleOpenMsg() throws BGPDocumentedException {
 186         this.bgpSession.handleMessage(this.classicOpen);
 187         assertEquals(State.IDLE, this.bgpSession.getState());
 188         assertEquals(1, this.receivedMsgs.size());
 189         assertTrue(this.receivedMsgs.get(0) instanceof Notify);
 190         final Notify error = (Notify) this.receivedMsgs.get(0);
 191         assertEquals(BGPError.FSM_ERROR.getCode(), error.getErrorCode());
 192         assertEquals(BGPError.FSM_ERROR.getSubcode(), error.getErrorSubcode());
 193         verify(this.speakerListener).close();
 194     }
 195
 196     @Test
 197     public void testHandleNotifyMsg() throws BGPDocumentedException {
 198         this.bgpSession.handleMessage(new NotifyBuilder().setErrorCode(BGPError.BAD_BGP_ID.getCode())
 199                 .setErrorSubcode(BGPError.BAD_BGP_ID.getSubcode()).build());
 200         assertEquals(State.IDLE, this.bgpSession.getState());
 201         verify(this.speakerListener).close();
 202     }
 203
 204     @Test
 205     public void testEndOfInput() throws InterruptedException {
 206         this.bgpSession.sessionUp();
 207         assertEquals(State.UP, this.listener.getState());
 208         this.bgpSession.endOfInput();
 209         checkIdleState(this.listener);
 210     }
 211
 212     @Test
 213     public void testHoldTimerExpire() throws InterruptedException {
 214         this.bgpSession.sessionUp();
 215         checkIdleState(this.listener);
 216         assertEquals(3, this.receivedMsgs.size());
 217         assertTrue(this.receivedMsgs.get(2) instanceof Notify);
 218         final Notify error = (Notify) this.receivedMsgs.get(2);
 219         assertEquals(BGPError.HOLD_TIMER_EXPIRED.getCode(), error.getErrorCode());
 220         assertEquals(BGPError.HOLD_TIMER_EXPIRED.getSubcode(), error.getErrorSubcode());
 221         verify(this.speakerListener).close();
 222     }
 223
 224     @Test
 225     public void testSessionRecoveryOnException() throws Exception {
 226         final BGPSessionListener mockListener = mock(BGPSessionListener.class);
 227         final IllegalStateException mockedEx = new IllegalStateException("Mocked runtime exception.");
 228
 229         doThrow(mockedEx).when(mockListener).onSessionUp(any());
 230         doNothing().when(mockListener).onSessionTerminated(any(), any());
 231         this.bgpSession = spy(new BGPSessionImpl(mockListener, this.speakerListener, this.classicOpen,
 232                 this.classicOpen.getHoldTimer().toJava(), null));
 233         this.bgpSession.setChannelExtMsgCoder(this.classicOpen);
 234
 235         verify(this.bgpSession, never()).handleException(any());
 236         verify(this.bgpSession, never()).writeAndFlush(any(Notification.class));
 237         verify(this.bgpSession, never()).terminate(any(BGPDocumentedException.class));
 238         try {
 239             this.bgpSession.sessionUp();
 240             // expect the exception to be populated
 241             fail();
 242         } catch (final IllegalStateException e) {
 243             assertSame(mockedEx, e);
 244         }
 245         assertNotEquals(State.UP, this.bgpSession.getState());
 246         verify(this.bgpSession).handleException(any());
 247         verify(this.bgpSession).writeAndFlush(any(Notification.class));
 248         verify(this.bgpSession).terminate(any(BGPDocumentedException.class));
 249         verify(mockListener).onSessionTerminated(this.bgpSession, new BGPTerminationReason(BGPError.CEASE));
 250     }
 251 }