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 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.rev180329.Update;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.BgpParameters;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.PeerRole;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.RibId;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
48 public class AddPathAllPathsTest extends AbstractAddPathTest {
49 private RIBImpl ribImpl;
50 private Channel serverChannel;
53 public void setUp() throws Exception {
55 final Map<TablesKey, PathSelectionMode> pathTables
56 = ImmutableMap.of(TABLES_KEY, new AllPathSelection(this.peerTracker));
58 this.ribImpl = new RIBImpl(new RibId("test-rib"), AS_NUMBER, BGP_ID,
59 this.ribExtension, this.serverDispatcher, this.codecsRegistry,
60 getDomBroker(), getDataBroker(), this.policies, this.peerTracker, TABLES_TYPE, pathTables);
62 this.ribImpl.instantiateServiceInstance();
63 this.ribImpl.onGlobalContextUpdated(this.schemaContext);
64 final ChannelFuture channelFuture = this.serverDispatcher.createServer(new InetSocketAddress(RIB_ID, PORT));
65 waitFutureSuccess(channelFuture);
66 this.serverChannel = channelFuture.channel();
70 public void tearDown() throws ExecutionException, InterruptedException {
71 waitFutureSuccess(this.serverChannel.close());
77 * | ODL BGP 127.0.0.1 |
78 * [peer://127.0.0.2; p1, lp100] --(iBGP)--> | | --(RR-client, non add-path) --> [Peer://127.0.0.5; (p1, lp100), (p1, lp1200)]
79 * [peer://127.0.0.3; p1, lp200] --(iBGP)--> | |
80 * [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)]
81 * [peer://127.0.0.2; p1, lp20] --(iBGP)--> |___________________|
85 public void testUseCase1() throws Exception {
86 final BgpParameters nonAddPathParams = createParameter(false);
87 final BgpParameters addPathParams = createParameter(true);
89 final BGPPeer peer1 = configurePeer(PEER1, this.ribImpl, nonAddPathParams, PeerRole.Ibgp, this.serverRegistry);
90 final BGPSessionImpl session1 = createPeerSession(PEER1, nonAddPathParams, new SimpleSessionListener());
92 configurePeer(PEER2, this.ribImpl, nonAddPathParams, PeerRole.Ibgp, this.serverRegistry);
93 final BGPSessionImpl session2 = createPeerSession(PEER2, nonAddPathParams, new SimpleSessionListener());
95 configurePeer(PEER3, this.ribImpl, nonAddPathParams, PeerRole.Ibgp, this.serverRegistry);
96 final BGPSessionImpl session3 = createPeerSession(PEER3, nonAddPathParams, new SimpleSessionListener());
98 final SimpleSessionListener listener4 = new SimpleSessionListener();
99 final BGPPeer peer4 = configurePeer(PEER4, this.ribImpl, nonAddPathParams, PeerRole.RrClient, this.serverRegistry);
101 BGPPeerState peer4State = peer4.getPeerState();
102 assertNull(peer4State.getGroupId());
103 assertEquals(new IpAddress(PEER4), peer4State.getNeighborAddress());
104 assertEquals(0L, peer4State.getTotalPathsCount());
105 assertEquals(0L, peer4State.getTotalPrefixes());
107 assertNull(peer4State.getBGPTimersState());
108 assertNull(peer4State.getBGPTransportState());
109 assertNull(peer4State.getBGPSessionState());
110 assertEquals(0L, peer4State.getBGPErrorHandlingState().getErroneousUpdateReceivedCount());
112 BGPGracelfulRestartState gracefulRestart = peer4State.getBGPGracelfulRestart();
113 assertFalse(gracefulRestart.isGracefulRestartAdvertized(TABLES_KEY));
114 assertFalse(gracefulRestart.isGracefulRestartReceived(TABLES_KEY));
115 assertFalse(gracefulRestart.isLocalRestarting());
116 assertFalse(gracefulRestart.isPeerRestarting());
117 assertEquals(0L, gracefulRestart.getPeerRestartTime());
119 BGPAfiSafiState afiSafiState = peer4State.getBGPAfiSafiState();
120 assertEquals(AFI_SAFIS_ADVERTIZED, afiSafiState.getAfiSafisAdvertized());
121 assertEquals(Collections.emptySet(), afiSafiState.getAfiSafisReceived());
122 assertEquals(0L, afiSafiState.getPrefixesSentCount(TABLES_KEY));
123 assertEquals(0L, afiSafiState.getPrefixesReceivedCount(TABLES_KEY));
124 assertEquals(0L, afiSafiState.getPrefixesInstalledCount(TABLES_KEY));
126 assertFalse(afiSafiState.isGracefulRestartAdvertized(TABLES_KEY));
127 assertFalse(afiSafiState.isGracefulRestartAdvertized(TABLES_KEY));
128 assertFalse(afiSafiState.isLocalRestarting());
129 assertFalse(afiSafiState.isPeerRestarting());
130 assertFalse(afiSafiState.isAfiSafiSupported(TABLES_KEY));
132 final BGPSessionImpl session4 = createPeerSession(PEER4, nonAddPathParams, listener4);
134 final SimpleSessionListener listener5 = new SimpleSessionListener();
135 configurePeer(PEER5, this.ribImpl, addPathParams, PeerRole.RrClient, this.serverRegistry);
136 final BGPSessionImpl session5 = createPeerSession(PEER5, addPathParams, listener5);
137 checkPeersPresentOnDataStore(5);
140 sendRouteAndCheckIsOnLocRib(session1, PREFIX1, 100, 1);
141 checkReceivedMessages(listener4, 1);
142 checkReceivedMessages(listener5, 1);
143 assertEquals(UPD_100, listener5.getListMsg().get(0));
145 final BGPPeerState peer1State = peer1.getPeerState();
146 assertNull(peer1State.getGroupId());
147 assertEquals(new IpAddress(PEER1), peer1State.getNeighborAddress());
148 assertEquals(1L, peer1State.getTotalPathsCount());
149 assertEquals(1L, peer1State.getTotalPrefixes());
151 final BGPTimersState timerStatePeer1 = peer1State.getBGPTimersState();
152 assertEquals(HOLDTIMER, timerStatePeer1.getNegotiatedHoldTime());
153 assertTrue(timerStatePeer1.getUpTime() > 0L);
155 final BGPTransportState transportStatePeer1 = peer1State.getBGPTransportState();
156 assertEquals(new PortNumber(PORT), transportStatePeer1.getLocalPort());
157 assertEquals(PEER1.getValue(), transportStatePeer1.getRemoteAddress().getIpv4Address().getValue());
159 assertEquals(State.UP, peer1State.getBGPSessionState().getSessionState());
160 checkEquals(()-> assertEquals(1L, peer1State.getBGPPeerMessagesState().getUpdateMessagesReceivedCount()));
161 checkEquals(()-> assertEquals(0L, peer1State.getBGPPeerMessagesState().getUpdateMessagesSentCount()));
163 final BGPSessionState sessionStatePeer1 = peer1State.getBGPSessionState();
164 assertFalse(sessionStatePeer1.isAddPathCapabilitySupported());
165 assertFalse(sessionStatePeer1.isAsn32CapabilitySupported());
166 assertFalse(sessionStatePeer1.isGracefulRestartCapabilitySupported());
167 assertTrue(sessionStatePeer1.isMultiProtocolCapabilitySupported());
168 assertFalse(sessionStatePeer1.isRouterRefreshCapabilitySupported());
170 final BGPAfiSafiState afiSafiStatePeer1 = peer1State.getBGPAfiSafiState();
171 assertEquals(AFI_SAFIS_ADVERTIZED, afiSafiStatePeer1.getAfiSafisAdvertized());
172 assertEquals(AFI_SAFIS_ADVERTIZED, afiSafiStatePeer1.getAfiSafisReceived());
173 assertEquals(0L, afiSafiStatePeer1.getPrefixesSentCount(TABLES_KEY));
174 assertEquals(1L, afiSafiStatePeer1.getPrefixesReceivedCount(TABLES_KEY));
175 assertEquals(1L, afiSafiStatePeer1.getPrefixesInstalledCount(TABLES_KEY));
177 assertFalse(afiSafiStatePeer1.isGracefulRestartAdvertized(TABLES_KEY));
178 assertFalse(afiSafiStatePeer1.isGracefulRestartAdvertized(TABLES_KEY));
179 assertFalse(afiSafiStatePeer1.isLocalRestarting());
180 assertFalse(afiSafiStatePeer1.isPeerRestarting());
181 assertTrue(afiSafiStatePeer1.isAfiSafiSupported(TABLES_KEY));
183 final BGPRibState ribState = this.ribImpl.getRIBState();
184 assertEquals(1, ribState.getPathsCount().size());
185 assertEquals(1L, ribState.getTablesPrefixesCount().size());
186 assertEquals(BGP_ID, ribState.getRouteId());
187 assertEquals(AS_NUMBER, ribState.getAs());
188 assertEquals(1L, ribState.getPathCount(TABLES_KEY));
189 assertEquals(1L, ribState.getPrefixesCount(TABLES_KEY));
190 assertEquals(1L, ribState.getTotalPathsCount());
191 assertEquals(1L, ribState.getTotalPrefixesCount());
193 final SimpleSessionListener listener6 = new SimpleSessionListener();
194 final BGPPeer peer6 = configurePeer(PEER6, this.ribImpl, nonAddPathParams, PeerRole.RrClient, this.serverRegistry);
195 final BGPSessionImpl session6 = createPeerSession(PEER6, nonAddPathParams, listener6);
196 checkPeersPresentOnDataStore(6);
197 checkReceivedMessages(listener6, 1);
198 assertEquals(UPD_NA_100, listener6.getListMsg().get(0));
199 causeBGPError(session6);
200 checkEquals(()-> assertEquals(1L, peer6.getPeerState().getBGPPeerMessagesState().getNotificationMessagesSentCount()));
202 checkPeersPresentOnDataStore(5);
204 //the second best route
205 sendRouteAndCheckIsOnLocRib(session2, PREFIX1, 50, 2);
206 checkReceivedMessages(listener4, 1);
207 checkReceivedMessages(listener5, 2);
208 assertEquals(UPD_50, listener5.getListMsg().get(1));
211 sendRouteAndCheckIsOnLocRib(session3, PREFIX1, 200, 3);
212 checkReceivedMessages(listener4, 2);
213 checkReceivedMessages(listener5, 3);
214 assertEquals(UPD_200, listener5.getListMsg().get(2));
216 peer4State = peer4.getPeerState();
217 assertNull(peer4State.getGroupId());
218 assertEquals(new IpAddress(PEER4), peer4State.getNeighborAddress());
219 assertEquals(0L, peer4State.getTotalPathsCount());
220 assertEquals(0L, peer4State.getTotalPrefixes());
222 final BGPTimersState timerState = peer4State.getBGPTimersState();
223 assertEquals(HOLDTIMER, timerState.getNegotiatedHoldTime());
224 assertTrue(timerState.getUpTime() > 0L);
226 final BGPTransportState transportState = peer4State.getBGPTransportState();
227 assertEquals(new PortNumber(PORT), transportState.getLocalPort());
228 assertEquals(PEER4.getValue(), transportState.getRemoteAddress().getIpv4Address().getValue());
230 final BGPPeerMessagesState peerMessagesState = peer4State.getBGPPeerMessagesState();
231 assertEquals(0L, peerMessagesState.getNotificationMessagesReceivedCount());
232 assertEquals(0L, peerMessagesState.getNotificationMessagesSentCount());
233 assertEquals(0L, peerMessagesState.getUpdateMessagesReceivedCount());
234 assertEquals(2L, peerMessagesState.getUpdateMessagesSentCount());
236 final BGPSessionState bgpSessionState = peer4State.getBGPSessionState();
237 assertEquals(State.UP, bgpSessionState.getSessionState());
238 assertFalse(bgpSessionState.isAddPathCapabilitySupported());
239 assertFalse(bgpSessionState.isAsn32CapabilitySupported());
240 assertFalse(bgpSessionState.isGracefulRestartCapabilitySupported());
241 assertTrue(bgpSessionState.isMultiProtocolCapabilitySupported());
242 assertFalse(bgpSessionState.isRouterRefreshCapabilitySupported());
244 final BGPErrorHandlingState errorHandling = peer4State.getBGPErrorHandlingState();
245 assertEquals(0L, errorHandling.getErroneousUpdateReceivedCount());
247 gracefulRestart = peer4State.getBGPGracelfulRestart();
248 assertFalse(gracefulRestart.isGracefulRestartAdvertized(TABLES_KEY));
249 assertFalse(gracefulRestart.isGracefulRestartReceived(TABLES_KEY));
250 assertFalse(gracefulRestart.isLocalRestarting());
251 assertFalse(gracefulRestart.isPeerRestarting());
252 assertEquals(0L, gracefulRestart.getPeerRestartTime());
254 afiSafiState = peer4State.getBGPAfiSafiState();
255 assertEquals(AFI_SAFIS_ADVERTIZED, afiSafiState.getAfiSafisAdvertized());
256 assertEquals(AFI_SAFIS_ADVERTIZED, afiSafiState.getAfiSafisReceived());
257 assertEquals(2L, afiSafiState.getPrefixesSentCount(TABLES_KEY));
258 assertEquals(0L, afiSafiState.getPrefixesReceivedCount(TABLES_KEY));
259 assertEquals(0L, afiSafiState.getPrefixesInstalledCount(TABLES_KEY));
261 assertFalse(afiSafiState.isGracefulRestartAdvertized(TABLES_KEY));
262 assertFalse(afiSafiState.isGracefulRestartAdvertized(TABLES_KEY));
263 assertFalse(afiSafiState.isLocalRestarting());
264 assertFalse(afiSafiState.isPeerRestarting());
265 assertTrue(afiSafiState.isAfiSafiSupported(TABLES_KEY));
268 sendRouteAndCheckIsOnLocRib(session1, PREFIX1, 20, 3);
269 checkReceivedMessages(listener4, 2);
270 checkReceivedMessages(listener5, 4);
271 assertEquals(UPD_200.getAttributes().getLocalPref(), ((Update) listener4.getListMsg().get(1)).getAttributes().getLocalPref());
272 assertEquals(UPD_20, listener5.getListMsg().get(3));
274 //withdraw second best route, 1 advertisement(1 withdrawal) for add-path supported, none for non add path
275 sendWithdrawalRouteAndCheckIsOnLocRib(session1, PREFIX1, 100, 2);
276 checkReceivedMessages(listener4, 2);
277 checkReceivedMessages(listener5, 5);
279 //we advertise again to try new test
280 sendRouteAndCheckIsOnLocRib(session1, PREFIX1, 100, 3);
281 checkReceivedMessages(listener4, 2);
282 checkReceivedMessages(listener5, 6);
283 assertEquals(UPD_200, listener5.getListMsg().get(2));
285 //withdraw second best route, 1 advertisement(1 withdrawal) for add-path supported, 1 for non add path (withdrawal)
286 sendWithdrawalRouteAndCheckIsOnLocRib(session3, PREFIX1, 200, 2);
287 checkReceivedMessages(listener4, 3);
288 checkReceivedMessages(listener5, 7);
290 sendNotification(session1);
291 checkEquals(()-> assertEquals(1L, peer1.getPeerState().getBGPPeerMessagesState().getNotificationMessagesReceivedCount()));