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