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

   1 /*
   2  * Copyright (c) 2016 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.assertFalse;
  12 import static org.junit.Assert.assertNull;
  13 import static org.junit.Assert.assertTrue;
  14 import static org.opendaylight.protocol.util.CheckUtil.checkEquals;
  15 import static org.opendaylight.protocol.util.CheckUtil.checkReceivedMessages;
  16 import static org.opendaylight.protocol.util.CheckUtil.waitFutureSuccess;
  17
  18 import com.google.common.collect.ImmutableMap;
  19 import io.netty.channel.Channel;
  20 import io.netty.channel.ChannelFuture;
  21 import java.net.InetSocketAddress;
  22 import java.util.Collections;
  23 import java.util.Map;
  24 import java.util.concurrent.ExecutionException;
  25 import org.junit.After;
  26 import org.junit.Before;
  27 import org.junit.Test;
  28 import org.opendaylight.protocol.bgp.mode.api.PathSelectionMode;
  29 import org.opendaylight.protocol.bgp.mode.impl.add.all.paths.AllPathSelection;
  30 import org.opendaylight.protocol.bgp.rib.spi.State;
  31 import org.opendaylight.protocol.bgp.rib.spi.state.BGPAfiSafiState;
  32 import org.opendaylight.protocol.bgp.rib.spi.state.BGPErrorHandlingState;
  33 import org.opendaylight.protocol.bgp.rib.spi.state.BGPGracelfulRestartState;
  34 import org.opendaylight.protocol.bgp.rib.spi.state.BGPPeerMessagesState;
  35 import org.opendaylight.protocol.bgp.rib.spi.state.BGPPeerState;
  36 import org.opendaylight.protocol.bgp.rib.spi.state.BGPRIBState;
  37 import org.opendaylight.protocol.bgp.rib.spi.state.BGPSessionState;
  38 import org.opendaylight.protocol.bgp.rib.spi.state.BGPTimersState;
  39 import org.opendaylight.protocol.bgp.rib.spi.state.BGPTransportState;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.Update;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.open.message.BgpParameters;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.PeerRole;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.RibId;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.rib.TablesKey;
  47
  48 public class AddPathAllPathsTest extends AbstractAddPathTest {
  49     private RIBImpl ribImpl;
  50     private Channel serverChannel;
  51
  52     @Before
  53     public void setUp() throws Exception {
  54         super.setUp();
  55         final Map<TablesKey, PathSelectionMode> pathTables = ImmutableMap.of(TABLES_KEY, new AllPathSelection());
  56
  57         this.ribImpl = new RIBImpl(new RibId("test-rib"), AS_NUMBER, BGP_ID, null,
  58                 this.ribExtension, this.serverDispatcher, this.mappingService.getCodecFactory(),
  59             getDomBroker(), TABLES_TYPE, pathTables, this.ribExtension.getClassLoadingStrategy());
  60
  61         this.ribImpl.instantiateServiceInstance();
  62         this.ribImpl.onGlobalContextUpdated(this.schemaContext);
  63         final ChannelFuture channelFuture = this.serverDispatcher.createServer(new InetSocketAddress(RIB_ID, PORT));
  64         waitFutureSuccess(channelFuture);
  65         this.serverChannel = channelFuture.channel();
  66     }
  67
  68     @After
  69     public void tearDown() throws ExecutionException, InterruptedException {
  70         waitFutureSuccess(this.serverChannel.close());
  71         super.tearDown();
  72     }
  73     /*
  74      * All-Paths
  75      *                                            ___________________
  76      *                                           | ODL BGP 127.0.0.1 |
  77      * [peer://127.0.0.2; p1, lp100] --(iBGP)--> |                   | --(RR-client, non add-path) --> [Peer://127.0.0.5; (p1, lp100), (p1, lp1200)]
  78      * [peer://127.0.0.3; p1, lp200] --(iBGP)--> |                   |
  79      * [peer://127.0.0.4; p1, lp50] --(iBGP)-->  |                   | --(RR-client, add-path) --> [Peer://127.0.0.6; (p1, path-id1, lp100), (p1, path-id2, pl50), (p1, path-id3, pl200), (p1, path-id4, pl20)]
  80      * [peer://127.0.0.2; p1, lp20] --(iBGP)-->  |___________________|
  81      * p1 = 1.1.1.1/32
  82      */
  83     @Test
  84     public void testUseCase1() throws Exception {
  85         final BgpParameters nonAddPathParams = createParameter(false);
  86         final BgpParameters addPathParams = createParameter(true);
  87
  88         final BGPPeer peer1 = configurePeer(PEER1, this.ribImpl, nonAddPathParams, PeerRole.Ibgp, this.serverRegistry);
  89         final BGPSessionImpl session1 = createPeerSession(PEER1, nonAddPathParams, new SimpleSessionListener());
  90
  91         configurePeer(PEER2, this.ribImpl, nonAddPathParams, PeerRole.Ibgp, this.serverRegistry);
  92         final BGPSessionImpl session2 = createPeerSession(PEER2, nonAddPathParams, new SimpleSessionListener());
  93
  94         configurePeer(PEER3, this.ribImpl, nonAddPathParams, PeerRole.Ibgp, this.serverRegistry);
  95         final BGPSessionImpl session3 = createPeerSession(PEER3, nonAddPathParams, new SimpleSessionListener());
  96
  97         final SimpleSessionListener listener4 = new SimpleSessionListener();
  98         final BGPPeer peer4 = configurePeer(PEER4, this.ribImpl, nonAddPathParams, PeerRole.RrClient, this.serverRegistry);
  99
 100         BGPPeerState peer4State = peer4.getPeerState();
 101         assertNull(peer4State.getGroupId());
 102         assertEquals(new IpAddress(PEER4), peer4State.getNeighborAddress());
 103         assertEquals(0L, peer4State.getTotalPathsCount());
 104         assertEquals(0L, peer4State.getTotalPrefixes());
 105
 106         assertNull(peer4State.getBGPTimersState());
 107         assertNull(peer4State.getBGPTransportState());
 108         assertNull(peer4State.getBGPSessionState());
 109         assertEquals(0L, peer4State.getBGPErrorHandlingState().getErroneousUpdateReceivedCount());
 110
 111         BGPGracelfulRestartState gracefulRestart = peer4State.getBGPGracelfulRestart();
 112         assertFalse(gracefulRestart.isGracefulRestartAdvertized(TABLES_KEY));
 113         assertFalse(gracefulRestart.isGracefulRestartReceived(TABLES_KEY));
 114         assertFalse(gracefulRestart.isLocalRestarting());
 115         assertFalse(gracefulRestart.isPeerRestarting());
 116         assertEquals(0L, gracefulRestart.getPeerRestartTime());
 117
 118         BGPAfiSafiState afiSafiState = peer4State.getBGPAfiSafiState();
 119         assertEquals(AFI_SAFIS_ADVERTIZED, afiSafiState.getAfiSafisAdvertized());
 120         assertEquals(Collections.emptySet(), afiSafiState.getAfiSafisReceived());
 121         assertEquals(0L, afiSafiState.getPrefixesSentCount(TABLES_KEY));
 122         assertEquals(0L, afiSafiState.getPrefixesReceivedCount(TABLES_KEY));
 123         assertEquals(0L, afiSafiState.getPrefixesInstalledCount(TABLES_KEY));
 124
 125         assertFalse(afiSafiState.isGracefulRestartAdvertized(TABLES_KEY));
 126         assertFalse(afiSafiState.isGracefulRestartAdvertized(TABLES_KEY));
 127         assertFalse(afiSafiState.isLocalRestarting());
 128         assertFalse(afiSafiState.isPeerRestarting());
 129         assertFalse(afiSafiState.isAfiSafiSupported(TABLES_KEY));
 130
 131         final BGPSessionImpl session4 = createPeerSession(PEER4, nonAddPathParams, listener4);
 132
 133         final SimpleSessionListener listener5 = new SimpleSessionListener();
 134         configurePeer(PEER5, this.ribImpl, addPathParams, PeerRole.RrClient, this.serverRegistry);
 135         final BGPSessionImpl session5 = createPeerSession(PEER5, addPathParams, listener5);
 136         checkPeersPresentOnDataStore(5);
 137
 138         //the best route
 139         sendRouteAndCheckIsOnLocRib(session1, PREFIX1, 100, 1);
 140         checkReceivedMessages(listener4, 1);
 141         checkReceivedMessages(listener5, 1);
 142         assertEquals(UPD_100, listener5.getListMsg().get(0));
 143
 144         final BGPPeerState peer1State = peer1.getPeerState();
 145         assertNull(peer1State.getGroupId());
 146         assertEquals(new IpAddress(PEER1), peer1State.getNeighborAddress());
 147         assertEquals(1L, peer1State.getTotalPathsCount());
 148         assertEquals(1L, peer1State.getTotalPrefixes());
 149
 150         final BGPTimersState timerStatePeer1 = peer1State.getBGPTimersState();
 151         assertEquals(HOLDTIMER, timerStatePeer1.getNegotiatedHoldTime());
 152         assertTrue(timerStatePeer1.getUpTime() > 0L);
 153
 154         final BGPTransportState transportStatePeer1 = peer1State.getBGPTransportState();
 155         assertEquals(new PortNumber(PORT), transportStatePeer1.getLocalPort());
 156         assertEquals(new IpAddress(PEER1), transportStatePeer1.getRemoteAddress());
 157
 158         assertEquals(State.UP, peer1State.getBGPSessionState().getSessionState());
 159         checkEquals(()-> assertEquals(1L, peer1State.getBGPPeerMessagesState().getUpdateMessagesReceivedCount()));
 160         checkEquals(()-> assertEquals(0L, peer1State.getBGPPeerMessagesState().getUpdateMessagesSentCount()));
 161
 162         final BGPSessionState sessionStatePeer1 = peer1State.getBGPSessionState();
 163         assertFalse(sessionStatePeer1.isAddPathCapabilitySupported());
 164         assertFalse(sessionStatePeer1.isAsn32CapabilitySupported());
 165         assertFalse(sessionStatePeer1.isGracefulRestartCapabilitySupported());
 166         assertTrue(sessionStatePeer1.isMultiProtocolCapabilitySupported());
 167         assertFalse(sessionStatePeer1.isRouterRefreshCapabilitySupported());
 168
 169         final BGPAfiSafiState afiSafiStatePeer1 = peer1State.getBGPAfiSafiState();
 170         assertEquals(AFI_SAFIS_ADVERTIZED, afiSafiStatePeer1.getAfiSafisAdvertized());
 171         assertEquals(AFI_SAFIS_ADVERTIZED, afiSafiStatePeer1.getAfiSafisReceived());
 172         assertEquals(0L, afiSafiStatePeer1.getPrefixesSentCount(TABLES_KEY));
 173         assertEquals(1L, afiSafiStatePeer1.getPrefixesReceivedCount(TABLES_KEY));
 174         assertEquals(1L, afiSafiStatePeer1.getPrefixesInstalledCount(TABLES_KEY));
 175
 176         assertFalse(afiSafiStatePeer1.isGracefulRestartAdvertized(TABLES_KEY));
 177         assertFalse(afiSafiStatePeer1.isGracefulRestartAdvertized(TABLES_KEY));
 178         assertFalse(afiSafiStatePeer1.isLocalRestarting());
 179         assertFalse(afiSafiStatePeer1.isPeerRestarting());
 180         assertTrue(afiSafiStatePeer1.isAfiSafiSupported(TABLES_KEY));
 181
 182         final BGPRIBState ribState = this.ribImpl.getRIBState();
 183         assertEquals(1, ribState.getPathsCount().size());
 184         assertEquals(1L,  ribState.getPrefixesCount().size());
 185         assertEquals(BGP_ID, ribState.getRouteId());
 186         assertEquals(AS_NUMBER, ribState.getAs());
 187         assertEquals(1L, ribState.getPathCount(TABLES_KEY));
 188         assertEquals(1L, ribState.getPrefixesCount(TABLES_KEY));
 189         assertEquals(1L, ribState.getTotalPathsCount());
 190         assertEquals(1L, ribState.getTotalPrefixesCount());
 191
 192         final SimpleSessionListener listener6 = new SimpleSessionListener();
 193         final BGPPeer peer6 = configurePeer(PEER6, this.ribImpl, nonAddPathParams, PeerRole.RrClient, this.serverRegistry);
 194         final BGPSessionImpl session6 = createPeerSession(PEER6, nonAddPathParams, listener6);
 195         checkPeersPresentOnDataStore(6);
 196         checkReceivedMessages(listener6, 1);
 197         assertEquals(UPD_NA_100, listener6.getListMsg().get(0));
 198         causeBGPError(session6);
 199         checkEquals(()-> assertEquals(1L, peer6.getPeerState().getBGPPeerMessagesState().getNotificationMessagesSentCount()));
 200
 201         checkPeersPresentOnDataStore(5);
 202
 203         //the second best route
 204         sendRouteAndCheckIsOnLocRib(session2, PREFIX1, 50, 2);
 205         checkReceivedMessages(listener4, 1);
 206         checkReceivedMessages(listener5, 2);
 207         assertEquals(UPD_50, listener5.getListMsg().get(1));
 208
 209         //new best route
 210         sendRouteAndCheckIsOnLocRib(session3, PREFIX1, 200, 3);
 211         checkReceivedMessages(listener4, 2);
 212         checkReceivedMessages(listener5, 3);
 213         assertEquals(UPD_200, listener5.getListMsg().get(2));
 214
 215         peer4State = peer4.getPeerState();
 216         assertNull(peer4State.getGroupId());
 217         assertEquals(new IpAddress(PEER4), peer4State.getNeighborAddress());
 218         assertEquals(0L, peer4State.getTotalPathsCount());
 219         assertEquals(0L, peer4State.getTotalPrefixes());
 220
 221         final BGPTimersState timerState = peer4State.getBGPTimersState();
 222         assertEquals(HOLDTIMER, timerState.getNegotiatedHoldTime());
 223         assertTrue(timerState.getUpTime() > 0L);
 224
 225         final BGPTransportState transportState = peer4State.getBGPTransportState();
 226         assertEquals(new PortNumber(PORT), transportState.getLocalPort());
 227         assertEquals(new IpAddress(PEER4), transportState.getRemoteAddress());
 228
 229         final BGPPeerMessagesState peerMessagesState = peer4State.getBGPPeerMessagesState();
 230         assertEquals(0L, peerMessagesState.getNotificationMessagesReceivedCount());
 231         assertEquals(0L, peerMessagesState.getNotificationMessagesSentCount());
 232         assertEquals(0L, peerMessagesState.getUpdateMessagesReceivedCount());
 233         assertEquals(2L, peerMessagesState.getUpdateMessagesSentCount());
 234
 235         final BGPSessionState bgpSessionState = peer4State.getBGPSessionState();
 236         assertEquals(State.UP, bgpSessionState.getSessionState());
 237         assertFalse(bgpSessionState.isAddPathCapabilitySupported());
 238         assertFalse(bgpSessionState.isAsn32CapabilitySupported());
 239         assertFalse(bgpSessionState.isGracefulRestartCapabilitySupported());
 240         assertTrue(bgpSessionState.isMultiProtocolCapabilitySupported());
 241         assertFalse(bgpSessionState.isRouterRefreshCapabilitySupported());
 242
 243         final BGPErrorHandlingState errorHandling = peer4State.getBGPErrorHandlingState();
 244         assertEquals(0L, errorHandling.getErroneousUpdateReceivedCount());
 245
 246         gracefulRestart = peer4State.getBGPGracelfulRestart();
 247         assertFalse(gracefulRestart.isGracefulRestartAdvertized(TABLES_KEY));
 248         assertFalse(gracefulRestart.isGracefulRestartReceived(TABLES_KEY));
 249         assertFalse(gracefulRestart.isLocalRestarting());
 250         assertFalse(gracefulRestart.isPeerRestarting());
 251         assertEquals(0L, gracefulRestart.getPeerRestartTime());
 252
 253         afiSafiState = peer4State.getBGPAfiSafiState();
 254         assertEquals(AFI_SAFIS_ADVERTIZED, afiSafiState.getAfiSafisAdvertized());
 255         assertEquals(AFI_SAFIS_ADVERTIZED, afiSafiState.getAfiSafisReceived());
 256         assertEquals(2L, afiSafiState.getPrefixesSentCount(TABLES_KEY));
 257         assertEquals(0L, afiSafiState.getPrefixesReceivedCount(TABLES_KEY));
 258         assertEquals(0L, afiSafiState.getPrefixesInstalledCount(TABLES_KEY));
 259
 260         assertFalse(afiSafiState.isGracefulRestartAdvertized(TABLES_KEY));
 261         assertFalse(afiSafiState.isGracefulRestartAdvertized(TABLES_KEY));
 262         assertFalse(afiSafiState.isLocalRestarting());
 263         assertFalse(afiSafiState.isPeerRestarting());
 264         assertTrue(afiSafiState.isAfiSafiSupported(TABLES_KEY));
 265
 266         //the worst route
 267         sendRouteAndCheckIsOnLocRib(session1, PREFIX1, 20, 3);
 268         checkReceivedMessages(listener4, 2);
 269         checkReceivedMessages(listener5, 4);
 270         assertEquals(UPD_200.getAttributes().getLocalPref(), ((Update) listener4.getListMsg().get(1)).getAttributes().getLocalPref());
 271         assertEquals(UPD_20, listener5.getListMsg().get(3));
 272
 273         //withdraw second best route, 1 advertisement(1 withdrawal) for add-path supported, none for non add path
 274         sendWithdrawalRouteAndCheckIsOnLocRib(session1, PREFIX1, 100, 2);
 275         checkReceivedMessages(listener4, 2);
 276         checkReceivedMessages(listener5, 5);
 277
 278         //we advertise again to try new test
 279         sendRouteAndCheckIsOnLocRib(session1, PREFIX1, 100, 3);
 280         checkReceivedMessages(listener4, 2);
 281         checkReceivedMessages(listener5, 6);
 282         assertEquals(UPD_200, listener5.getListMsg().get(2));
 283
 284         //withdraw second best route, 1 advertisement(1 withdrawal) for add-path supported, 1 for non add path (withdrawal)
 285         sendWithdrawalRouteAndCheckIsOnLocRib(session3, PREFIX1, 200, 2);
 286         checkReceivedMessages(listener4, 3);
 287         checkReceivedMessages(listener5, 7);
 288
 289         sendNotification(session1);
 290         checkEquals(()-> assertEquals(1L, peer1.getPeerState().getBGPPeerMessagesState().getNotificationMessagesReceivedCount()));
 291         session1.close();
 292         session2.close();
 293         session3.close();
 294         session4.close();
 295         session5.close();
 296     }
 297 }