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 final ChannelFuture channelFuture = this.serverDispatcher.createServer(
64 new InetSocketAddress(RIB_ID, PORT.toJava()));
65 waitFutureSuccess(channelFuture);
66 this.serverChannel = channelFuture.channel();
71 public void tearDown() throws Exception {
72 waitFutureSuccess(this.serverChannel.close());
79 * | ODL BGP 127.0.0.1 |
80 * [peer://127.0.0.2; p1, lp100] --(iBGP)--> | | --(RR-client, non add-path) -->
81 * [peer://127.0.0.3; p1, lp200] --(iBGP)--> | | [Peer://127.0.0.5; (p1, lp100), (p1, lp1200)]
82 * [peer://127.0.0.4; p1, lp50] --(iBGP)--> | | --(RR-client, add-path) -->
83 * [peer://127.0.0.2; p1, lp20] --(iBGP)--> |___________________| [Peer://127.0.0.6; (p1, path-id1, lp100),
84 * p1 = 1.1.1.1/32 (p1, path-id2, pl50), (p1, path-id3, pl200),
85 * (p1, path-id4, pl20)]
88 public void testUseCase1() throws Exception {
89 final BgpParameters nonAddPathParams = createParameter(false);
90 final BgpParameters addPathParams = createParameter(true);
92 final BGPPeer peer1 = configurePeer(this.tableRegistry, PEER1, this.ribImpl, nonAddPathParams, PeerRole.Ibgp,
94 final BGPSessionImpl session1 = createPeerSession(PEER1, nonAddPathParams, new SimpleSessionListener());
96 configurePeer(this.tableRegistry, PEER2, this.ribImpl, nonAddPathParams, PeerRole.Ibgp, this.serverRegistry);
97 final BGPSessionImpl session2 = createPeerSession(PEER2, nonAddPathParams, new SimpleSessionListener());
99 configurePeer(this.tableRegistry, PEER3, this.ribImpl, nonAddPathParams, PeerRole.Ibgp, this.serverRegistry);
100 final BGPSessionImpl session3 = createPeerSession(PEER3, nonAddPathParams, new SimpleSessionListener());
102 final SimpleSessionListener listener4 = new SimpleSessionListener();
103 final BGPPeer peer4 = configurePeer(this.tableRegistry, PEER4, this.ribImpl, nonAddPathParams,
104 PeerRole.RrClient, this.serverRegistry);
106 BGPPeerState peer4State = peer4.getPeerState();
107 assertNull(peer4State.getGroupId());
108 assertEquals(new IpAddressNoZone(PEER4), peer4State.getNeighborAddress());
109 assertEquals(0L, peer4State.getTotalPathsCount());
110 assertEquals(0L, peer4State.getTotalPrefixes());
112 assertNull(peer4State.getBGPTimersState());
113 assertNull(peer4State.getBGPTransportState());
114 assertNull(peer4State.getBGPSessionState());
115 assertEquals(0L, peer4State.getBGPErrorHandlingState().getErroneousUpdateReceivedCount());
117 BGPGracelfulRestartState gracefulRestart = peer4State.getBGPGracelfulRestart();
118 assertFalse(gracefulRestart.isGracefulRestartAdvertized(TABLES_KEY));
119 assertFalse(gracefulRestart.isGracefulRestartReceived(TABLES_KEY));
120 assertFalse(gracefulRestart.isLocalRestarting());
121 assertFalse(gracefulRestart.isPeerRestarting());
122 assertEquals(0L, gracefulRestart.getPeerRestartTime());
124 BGPAfiSafiState afiSafiState = peer4State.getBGPAfiSafiState();
125 assertEquals(AFI_SAFIS_ADVERTIZED, afiSafiState.getAfiSafisAdvertized());
126 assertEquals(Collections.emptySet(), afiSafiState.getAfiSafisReceived());
127 assertEquals(0L, afiSafiState.getPrefixesSentCount(TABLES_KEY));
128 assertEquals(0L, afiSafiState.getPrefixesReceivedCount(TABLES_KEY));
129 assertEquals(0L, afiSafiState.getPrefixesInstalledCount(TABLES_KEY));
131 assertFalse(afiSafiState.isGracefulRestartAdvertized(TABLES_KEY));
132 assertFalse(afiSafiState.isGracefulRestartAdvertized(TABLES_KEY));
133 assertFalse(afiSafiState.isLocalRestarting());
134 assertFalse(afiSafiState.isPeerRestarting());
135 assertFalse(afiSafiState.isAfiSafiSupported(TABLES_KEY));
137 final BGPSessionImpl session4 = createPeerSession(PEER4, nonAddPathParams, listener4);
139 final SimpleSessionListener listener5 = new SimpleSessionListener();
140 configurePeer(this.tableRegistry, PEER5, this.ribImpl, addPathParams, PeerRole.RrClient, this.serverRegistry);
141 final BGPSessionImpl session5 = createPeerSession(PEER5, addPathParams, listener5);
142 checkPeersPresentOnDataStore(5);
145 sendRouteAndCheckIsOnLocRib(session1, PREFIX1, 100, 1);
146 checkReceivedMessages(listener4, 2);
147 checkReceivedMessages(listener5, 2);
148 assertEquals(UPD_100, listener5.getListMsg().get(1));
150 final BGPPeerState peer1State = peer1.getPeerState();
151 assertNull(peer1State.getGroupId());
152 assertEquals(new IpAddressNoZone(PEER1), peer1State.getNeighborAddress());
153 assertEquals(1L, peer1State.getTotalPathsCount());
154 assertEquals(1L, peer1State.getTotalPrefixes());
156 final BGPTimersState timerStatePeer1 = peer1State.getBGPTimersState();
157 assertEquals(HOLDTIMER, timerStatePeer1.getNegotiatedHoldTime());
158 assertTrue(timerStatePeer1.getUpTime() > 0L);
160 final BGPTransportState transportStatePeer1 = peer1State.getBGPTransportState();
161 assertEquals(new PortNumber(PORT), transportStatePeer1.getLocalPort());
162 assertEquals(new IpAddressNoZone(PEER1), transportStatePeer1.getRemoteAddress());
164 assertEquals(State.UP, peer1State.getBGPSessionState().getSessionState());
165 checkEquals(() -> assertEquals(1L, peer1State.getBGPPeerMessagesState().getUpdateMessagesReceivedCount()));
166 checkEquals(() -> assertEquals(1L, peer1State.getBGPPeerMessagesState().getUpdateMessagesSentCount()));
168 final BGPSessionState sessionStatePeer1 = peer1State.getBGPSessionState();
169 assertFalse(sessionStatePeer1.isAddPathCapabilitySupported());
170 assertFalse(sessionStatePeer1.isAsn32CapabilitySupported());
171 assertFalse(sessionStatePeer1.isGracefulRestartCapabilitySupported());
172 assertTrue(sessionStatePeer1.isMultiProtocolCapabilitySupported());
173 assertFalse(sessionStatePeer1.isRouterRefreshCapabilitySupported());
175 final BGPAfiSafiState afiSafiStatePeer1 = peer1State.getBGPAfiSafiState();
176 assertEquals(AFI_SAFIS_ADVERTIZED, afiSafiStatePeer1.getAfiSafisAdvertized());
177 assertEquals(AFI_SAFIS_ADVERTIZED, afiSafiStatePeer1.getAfiSafisReceived());
178 assertEquals(0L, afiSafiStatePeer1.getPrefixesSentCount(TABLES_KEY));
179 assertEquals(1L, afiSafiStatePeer1.getPrefixesReceivedCount(TABLES_KEY));
180 assertEquals(1L, afiSafiStatePeer1.getPrefixesInstalledCount(TABLES_KEY));
182 assertFalse(afiSafiStatePeer1.isGracefulRestartAdvertized(TABLES_KEY));
183 assertFalse(afiSafiStatePeer1.isGracefulRestartAdvertized(TABLES_KEY));
184 assertFalse(afiSafiStatePeer1.isLocalRestarting());
185 assertFalse(afiSafiStatePeer1.isPeerRestarting());
186 assertTrue(afiSafiStatePeer1.isAfiSafiSupported(TABLES_KEY));
188 final BGPRibState ribState = this.ribImpl.getRIBState();
189 assertEquals(1, ribState.getPathsCount().size());
190 assertEquals(1L, ribState.getTablesPrefixesCount().size());
191 assertEquals(BGP_ID, ribState.getRouteId());
192 assertEquals(AS_NUMBER, ribState.getAs());
193 assertEquals(1L, ribState.getPathCount(TABLES_KEY));
194 assertEquals(1L, ribState.getPrefixesCount(TABLES_KEY));
195 assertEquals(1L, ribState.getTotalPathsCount());
196 assertEquals(1L, ribState.getTotalPrefixesCount());
198 final SimpleSessionListener listener6 = new SimpleSessionListener();
199 final BGPPeer peer6 = configurePeer(this.tableRegistry, PEER6, this.ribImpl, nonAddPathParams,
200 PeerRole.RrClient, this.serverRegistry);
201 final BGPSessionImpl session6 = createPeerSession(PEER6, nonAddPathParams, listener6);
202 checkPeersPresentOnDataStore(6);
203 checkReceivedMessages(listener6, 2);
204 assertEquals(UPD_NA_100, listener6.getListMsg().get(1));
205 causeBGPError(session6);
206 checkEquals(() -> assertEquals(1L,
207 peer6.getPeerState().getBGPPeerMessagesState().getNotificationMessagesSentCount()));
209 checkPeersPresentOnDataStore(5);
211 //the second best route
212 sendRouteAndCheckIsOnLocRib(session2, PREFIX1, 50, 2);
213 checkReceivedMessages(listener4, 2);
214 checkReceivedMessages(listener5, 3);
215 assertEquals(UPD_50, listener5.getListMsg().get(2));
218 sendRouteAndCheckIsOnLocRib(session3, PREFIX1, 200, 3);
219 checkReceivedMessages(listener4, 3);
220 checkReceivedMessages(listener5, 4);
221 assertEquals(UPD_200, listener5.getListMsg().get(3));
223 peer4State = peer4.getPeerState();
224 assertNull(peer4State.getGroupId());
225 assertEquals(new IpAddressNoZone(PEER4), peer4State.getNeighborAddress());
226 assertEquals(0L, peer4State.getTotalPathsCount());
227 assertEquals(0L, peer4State.getTotalPrefixes());
229 final BGPTimersState timerState = peer4State.getBGPTimersState();
230 assertEquals(HOLDTIMER, timerState.getNegotiatedHoldTime());
231 assertTrue(timerState.getUpTime() > 0L);
233 final BGPTransportState transportState = peer4State.getBGPTransportState();
234 assertEquals(new PortNumber(PORT), transportState.getLocalPort());
235 assertEquals(new IpAddressNoZone(PEER4), transportState.getRemoteAddress());
237 final BGPPeerMessagesState peerMessagesState = peer4State.getBGPPeerMessagesState();
238 assertEquals(0L, peerMessagesState.getNotificationMessagesReceivedCount());
239 assertEquals(0L, peerMessagesState.getNotificationMessagesSentCount());
240 assertEquals(0L, peerMessagesState.getUpdateMessagesReceivedCount());
241 assertEquals(3L, peerMessagesState.getUpdateMessagesSentCount());
243 final BGPSessionState bgpSessionState = peer4State.getBGPSessionState();
244 assertEquals(State.UP, bgpSessionState.getSessionState());
245 assertFalse(bgpSessionState.isAddPathCapabilitySupported());
246 assertFalse(bgpSessionState.isAsn32CapabilitySupported());
247 assertFalse(bgpSessionState.isGracefulRestartCapabilitySupported());
248 assertTrue(bgpSessionState.isMultiProtocolCapabilitySupported());
249 assertFalse(bgpSessionState.isRouterRefreshCapabilitySupported());
251 final BGPErrorHandlingState errorHandling = peer4State.getBGPErrorHandlingState();
252 assertEquals(0L, errorHandling.getErroneousUpdateReceivedCount());
254 gracefulRestart = peer4State.getBGPGracelfulRestart();
255 assertFalse(gracefulRestart.isGracefulRestartAdvertized(TABLES_KEY));
256 assertFalse(gracefulRestart.isGracefulRestartReceived(TABLES_KEY));
257 assertFalse(gracefulRestart.isLocalRestarting());
258 assertFalse(gracefulRestart.isPeerRestarting());
259 assertEquals(0L, gracefulRestart.getPeerRestartTime());
261 afiSafiState = peer4State.getBGPAfiSafiState();
262 assertEquals(AFI_SAFIS_ADVERTIZED, afiSafiState.getAfiSafisAdvertized());
263 assertEquals(AFI_SAFIS_ADVERTIZED, afiSafiState.getAfiSafisReceived());
264 assertEquals(2L, afiSafiState.getPrefixesSentCount(TABLES_KEY));
265 assertEquals(0L, afiSafiState.getPrefixesReceivedCount(TABLES_KEY));
266 assertEquals(0L, afiSafiState.getPrefixesInstalledCount(TABLES_KEY));
268 assertFalse(afiSafiState.isGracefulRestartAdvertized(TABLES_KEY));
269 assertFalse(afiSafiState.isGracefulRestartAdvertized(TABLES_KEY));
270 assertFalse(afiSafiState.isLocalRestarting());
271 assertFalse(afiSafiState.isPeerRestarting());
272 assertTrue(afiSafiState.isAfiSafiSupported(TABLES_KEY));
275 sendRouteAndCheckIsOnLocRib(session1, PREFIX1, 20, 3);
276 checkReceivedMessages(listener4, 3);
277 checkReceivedMessages(listener5, 5);
278 assertEquals(UPD_200.getAttributes().getLocalPref(),
279 ((Update) listener4.getListMsg().get(2)).getAttributes().getLocalPref());
280 assertEquals(UPD_20, listener5.getListMsg().get(4));
282 //withdraw second best route, 1 advertisement(1 withdrawal) for add-path supported, none for non add path
283 sendWithdrawalRouteAndCheckIsOnLocRib(session1, PREFIX1, 100, 2);
284 checkReceivedMessages(listener4, 3);
285 checkReceivedMessages(listener5, 6);
287 //we advertise again to try new test
288 sendRouteAndCheckIsOnLocRib(session1, PREFIX1, 100, 3);
289 checkReceivedMessages(listener4, 3);
290 checkReceivedMessages(listener5, 7);
291 assertEquals(UPD_200, listener5.getListMsg().get(3));
293 // withdraw second best route, 1 advertisement(1 withdrawal) for add-path supported, 1 for non add path
295 sendWithdrawalRouteAndCheckIsOnLocRib(session3, PREFIX1, 200, 2);
296 checkReceivedMessages(listener4, 4);
297 checkReceivedMessages(listener5, 8);
299 sendNotification(session1);
300 checkEquals(() -> assertEquals(1L,
301 peer1.getPeerState().getBGPPeerMessagesState().getNotificationMessagesReceivedCount()));