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.mockito.ArgumentMatchers.any;
11 import static org.mockito.ArgumentMatchers.eq;
12 import static org.mockito.Mockito.doAnswer;
13 import static org.mockito.Mockito.doNothing;
14 import static org.mockito.Mockito.doReturn;
15 import static org.mockito.Mockito.mock;
16 import static org.mockito.Mockito.verify;
17 import static org.mockito.internal.verification.VerificationModeFactory.times;
18 import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.ADJRIBIN_NID;
19 import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.ATTRIBUTES_NID;
20 import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.BGPRIB_NID;
21 import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.PEER_NID;
22 import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.RIB_NID;
23 import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.TABLES_NID;
24 import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.UPTODATE_NID;
26 import com.google.common.collect.ImmutableList;
27 import com.google.common.collect.ImmutableMap;
28 import com.google.common.collect.Lists;
29 import io.netty.channel.Channel;
30 import io.netty.channel.ChannelFuture;
31 import io.netty.channel.ChannelHandler;
32 import io.netty.channel.ChannelPipeline;
33 import io.netty.channel.EventLoop;
34 import io.netty.util.concurrent.GlobalEventExecutor;
35 import java.net.InetAddress;
36 import java.net.InetSocketAddress;
37 import java.util.ArrayList;
38 import java.util.Collections;
39 import java.util.List;
41 import java.util.concurrent.TimeUnit;
42 import org.junit.Before;
43 import org.junit.Test;
44 import org.mockito.ArgumentMatchers;
45 import org.mockito.Mock;
46 import org.opendaylight.mdsal.common.api.CommitInfo;
47 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
48 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
49 import org.opendaylight.mdsal.dom.api.DOMDataBroker.DataTreeChangeExtension;
50 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
51 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
52 import org.opendaylight.protocol.bgp.mode.api.PathSelectionMode;
53 import org.opendaylight.protocol.bgp.mode.impl.base.BasePathSelectionModeFactory;
54 import org.opendaylight.protocol.bgp.parser.BgpExtendedMessageUtil;
55 import org.opendaylight.protocol.bgp.parser.BgpTableTypeImpl;
56 import org.opendaylight.protocol.bgp.rib.spi.RIBQNames;
57 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
58 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone;
59 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone;
60 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.Notify;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.Open;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.OpenBuilder;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.ProtocolVersion;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.UpdateBuilder;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.BgpParametersBuilder;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.bgp.parameters.OptionalCapabilities;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.bgp.parameters.OptionalCapabilitiesBuilder;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.bgp.parameters.optional.capabilities.CParametersBuilder;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.bgp.parameters.optional.capabilities.c.parameters.As4BytesCapabilityBuilder;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.AttributesBuilder;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes.AsPath;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes.AsPathBuilder;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes.LocalPrefBuilder;
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes.Origin;
76 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes.OriginBuilder;
77 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.update.message.Nlri;
78 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.update.message.NlriBuilder;
79 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.BgpTableType;
80 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.CParameters1Builder;
81 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.GracefulRestartCapabilityBuilder;
82 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.MultiprotocolCapabilityBuilder;
83 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.PeerRole;
84 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.RibId;
85 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.Rib;
86 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.rib.Peer;
87 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.Tables;
88 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
89 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.BgpId;
90 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.BgpOrigin;
91 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.Ipv4AddressFamily;
92 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.UnicastSubsequentAddressFamily;
93 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.next.hop.CNextHop;
94 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.next.hop.c.next.hop.Ipv4NextHopCaseBuilder;
95 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.next.hop.c.next.hop.ipv4.next.hop._case.Ipv4NextHopBuilder;
96 import org.opendaylight.yangtools.concepts.Registration;
97 import org.opendaylight.yangtools.yang.common.QName;
98 import org.opendaylight.yangtools.yang.common.Uint16;
99 import org.opendaylight.yangtools.yang.common.Uint32;
100 import org.opendaylight.yangtools.yang.common.Uint8;
101 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
102 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
103 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
104 import org.opendaylight.yangtools.yang.data.spi.node.ImmutableNodes;
106 public class SynchronizationAndExceptionTest extends AbstractAddPathTest {
107 private static final int HOLD_TIMER = 3;
108 private static final AsNumber AS_NUMBER = new AsNumber(Uint32.valueOf(30));
109 private static final Ipv4AddressNoZone BGP_ID = new Ipv4AddressNoZone("1.1.1.2");
110 private static final String LOCAL_IP = "1.1.1.4";
111 private static final int LOCAL_PORT = 12345;
112 private static final String RIB_ID = "1.1.1.2";
113 private static final YangInstanceIdentifier PEER_PATH = YangInstanceIdentifier.builder()
114 .node(BGPRIB_NID).node(RIB_NID)
115 .nodeWithKey(Rib.QNAME, QName.create(Rib.QNAME, "id").intern(), RIB_ID)
116 .node(PEER_NID).nodeWithKey(Peer.QNAME, RIBQNames.PEER_ID_QNAME, "bgp://1.1.1.2").build();
117 private static final YangInstanceIdentifier TABLE_PATH = PEER_PATH.node(ADJRIBIN_NID).node(TABLES_NID)
118 .node(NodeIdentifierWithPredicates.of(Tables.QNAME, Map.of(RIBQNames.AFI_QNAME, Ipv4AddressFamily.QNAME,
119 RIBQNames.SAFI_QNAME, UnicastSubsequentAddressFamily.QNAME))).node(ATTRIBUTES_NID).node(UPTODATE_NID);
120 private final IpAddressNoZone neighbor = new IpAddressNoZone(new Ipv4AddressNoZone(LOCAL_IP));
121 private final BgpTableType ipv4tt = new BgpTableTypeImpl(Ipv4AddressFamily.VALUE,
122 UnicastSubsequentAddressFamily.VALUE);
123 private Open classicOpen;
125 private EventLoop eventLoop;
127 private ChannelPipeline pipeline;
129 private Channel speakerListener;
131 private DOMDataBroker domBroker;
133 private DOMTransactionChain domChain;
135 private DOMDataTreeWriteTransaction tx;
139 public void setUp() throws Exception {
142 final List<OptionalCapabilities> capa = new ArrayList<>();
143 capa.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder()
144 .addAugmentation(new CParameters1Builder()
145 .setMultiprotocolCapability(new MultiprotocolCapabilityBuilder()
146 .setAfi(ipv4tt.getAfi()).setSafi(ipv4tt.getSafi()).build())
147 .setGracefulRestartCapability(new GracefulRestartCapabilityBuilder().setRestartTime(Uint16.ZERO)
149 .setAs4BytesCapability(new As4BytesCapabilityBuilder().setAsNumber(AS_NUMBER).build()).build())
151 capa.add(new OptionalCapabilitiesBuilder()
152 .setCParameters(BgpExtendedMessageUtil.EXTENDED_MESSAGE_CAPABILITY).build());
154 classicOpen = new OpenBuilder()
155 .setMyAsNumber(Uint16.valueOf(AS_NUMBER.getValue()))
156 .setHoldTimer(Uint16.valueOf(HOLD_TIMER))
157 .setVersion(new ProtocolVersion(Uint8.valueOf(4)))
158 .setBgpParameters(List.of(new BgpParametersBuilder()
159 .setOptionalCapabilities(capa)
161 .setBgpIdentifier(BGP_ID)
164 doReturn(null).when(mock(ChannelFuture.class)).addListener(any());
165 doReturn(eventLoop).when(speakerListener).eventLoop();
166 doReturn(true).when(speakerListener).isActive();
167 doAnswer(invocation -> {
168 final Runnable command = invocation.getArgument(0);
169 final long delay = (long) invocation.getArgument(1);
170 final TimeUnit unit = invocation.getArgument(2);
171 GlobalEventExecutor.INSTANCE.schedule(command, delay, unit);
173 }).when(eventLoop).schedule(any(Runnable.class), any(long.class), any(TimeUnit.class));
174 doReturn("TestingChannel").when(speakerListener).toString();
175 doReturn(true).when(speakerListener).isWritable();
176 doReturn(new InetSocketAddress(InetAddress.getByName(BGP_ID.getValue()), 179))
177 .when(speakerListener).remoteAddress();
178 doReturn(new InetSocketAddress(InetAddress.getByName(LOCAL_IP), LOCAL_PORT))
179 .when(speakerListener).localAddress();
180 doReturn(pipeline).when(speakerListener).pipeline();
181 doReturn(pipeline).when(pipeline).replace(any(ChannelHandler.class),
183 any(ChannelHandler.class));
184 doReturn(null).when(pipeline).replace(ArgumentMatchers.<Class<ChannelHandler>>any(),
186 any(ChannelHandler.class));
187 doReturn(pipeline).when(pipeline).addLast(any(ChannelHandler.class));
188 final ChannelFuture futureChannel = mock(ChannelFuture.class);
189 doReturn(null).when(futureChannel).addListener(any());
190 doReturn(futureChannel).when(speakerListener).close();
191 doReturn(futureChannel).when(speakerListener).writeAndFlush(any(Notify.class));
192 doReturn(domChain).when(domBroker).createMergingTransactionChain();
193 doNothing().when(domChain).addCallback(any());
194 doReturn(tx).when(domChain).newWriteOnlyTransaction();
195 final DataTreeChangeExtension domDataTreeChangeService = mock(DataTreeChangeExtension.class);
196 final Registration listener = mock(Registration.class);
197 doReturn(listener).when(domDataTreeChangeService).registerTreeChangeListener(any(), any());
198 doNothing().when(listener).close();
199 doNothing().when(domChain).close();
201 doReturn(domDataTreeChangeService).when(domBroker).extension(DataTreeChangeExtension.class);
202 doNothing().when(tx).merge(eq(LogicalDatastoreType.OPERATIONAL),
203 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
204 doNothing().when(tx).put(eq(LogicalDatastoreType.OPERATIONAL),
205 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
206 doNothing().when(tx).delete(any(LogicalDatastoreType.class), any(YangInstanceIdentifier.class));
207 doReturn(CommitInfo.emptyFluentFuture()).when(tx).commit();
211 public void testHandleMessageAfterException() {
212 final Map<TablesKey, PathSelectionMode> pathTables = ImmutableMap.of(TABLES_KEY,
213 BasePathSelectionModeFactory.createBestPathSelectionStrategy());
214 final RIBImpl ribImpl = new RIBImpl(tableRegistry, new RibId(RIB_ID), AS_NUMBER, new BgpId(RIB_ID),
216 serverDispatcher, codecsRegistry, domBroker, policies,
217 ImmutableList.of(ipv4tt), pathTables);
218 ribImpl.instantiateServiceInstance();
220 final BGPPeer bgpPeer = AbstractAddPathTest.configurePeer(tableRegistry, neighbor.getIpv4AddressNoZone(),
221 ribImpl, null, PeerRole.Ibgp, serverRegistry, AFI_SAFIS_ADVERTIZED, Collections.emptySet());
222 bgpPeer.instantiateServiceInstance();
223 final BGPSessionImpl bgpSession = new BGPSessionImpl(bgpPeer, speakerListener, classicOpen,
224 classicOpen.getHoldTimer().toJava(), null);
225 bgpSession.setChannelExtMsgCoder(classicOpen);
226 bgpPeer.onSessionUp(bgpSession);
228 final Nlri n1 = new NlriBuilder().setPrefix(new Ipv4Prefix("8.0.1.0/28")).build();
229 final Nlri n2 = new NlriBuilder().setPrefix(new Ipv4Prefix("127.0.0.1/32")).build();
230 final Nlri n3 = new NlriBuilder().setPrefix(new Ipv4Prefix("2.2.2.2/24")).build();
231 final List<Nlri> nlris = Lists.newArrayList(n1, n2, n3);
232 final UpdateBuilder wrongMessage = new UpdateBuilder();
233 wrongMessage.setNlri(nlris);
234 final Origin origin = new OriginBuilder().setValue(BgpOrigin.Igp).build();
235 final AsPath asPath = new AsPathBuilder().setSegments(Collections.emptyList()).build();
236 final CNextHop nextHop = new Ipv4NextHopCaseBuilder().setIpv4NextHop(new Ipv4NextHopBuilder()
237 .setGlobal(new Ipv4AddressNoZone("127.0.0.1")).build()).build();
238 final AttributesBuilder ab = new AttributesBuilder();
239 wrongMessage.setAttributes(ab.setOrigin(origin).setAsPath(asPath).setCNextHop(nextHop).build());
241 final UpdateBuilder correct = new UpdateBuilder(wrongMessage.build());
242 correct.setAttributes(ab.setLocalPref(new LocalPrefBuilder().setPref(Uint32.valueOf(100)).build()).build());
244 bgpSession.handleMessage(correct.build());
245 verify(tx, times(2)).merge(eq(LogicalDatastoreType.OPERATIONAL),
246 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
247 bgpSession.handleMessage(wrongMessage.build());
248 verify(tx, times(2)).merge(eq(LogicalDatastoreType.OPERATIONAL),
249 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
250 bgpSession.handleMessage(new UpdateBuilder().build());
251 verify(tx, times(2)).merge(eq(LogicalDatastoreType.OPERATIONAL),
252 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
253 verify(tx).delete(eq(LogicalDatastoreType.OPERATIONAL), eq(PEER_PATH));
254 verify(tx, times(0)).merge(eq(LogicalDatastoreType.OPERATIONAL), eq(TABLE_PATH),
255 eq(ImmutableNodes.leafNode(UPTODATE_NID, Boolean.TRUE)));
259 public void testUseCase1() {
260 final Map<TablesKey, PathSelectionMode> pathTables = ImmutableMap.of(TABLES_KEY,
261 BasePathSelectionModeFactory.createBestPathSelectionStrategy());
262 final RIBImpl ribImpl = new RIBImpl(tableRegistry, new RibId(RIB_ID), AS_NUMBER, new BgpId(RIB_ID),
264 serverDispatcher, codecsRegistry, domBroker, policies,
265 ImmutableList.of(ipv4tt), pathTables);
266 ribImpl.instantiateServiceInstance();
268 final BGPPeer bgpPeer = AbstractAddPathTest.configurePeer(tableRegistry, neighbor.getIpv4AddressNoZone(),
269 ribImpl, null, PeerRole.Ibgp, serverRegistry, AFI_SAFIS_ADVERTIZED, Collections.emptySet());
270 bgpPeer.instantiateServiceInstance();
271 final BGPSessionImpl bgpSession = new BGPSessionImpl(bgpPeer, speakerListener, classicOpen,
272 classicOpen.getHoldTimer().toJava(), null);
273 bgpSession.setChannelExtMsgCoder(classicOpen);
274 bgpPeer.onSessionUp(bgpSession);
276 final Nlri n1 = new NlriBuilder().setPrefix(new Ipv4Prefix("8.0.1.0/28")).build();
277 final Nlri n2 = new NlriBuilder().setPrefix(new Ipv4Prefix("127.0.0.1/32")).build();
278 final Nlri n3 = new NlriBuilder().setPrefix(new Ipv4Prefix("2.2.2.2/24")).build();
279 final List<Nlri> nlris = Lists.newArrayList(n1, n2, n3);
280 final UpdateBuilder wrongMessage = new UpdateBuilder();
281 wrongMessage.setNlri(nlris);
282 final Origin origin = new OriginBuilder().setValue(BgpOrigin.Igp).build();
283 final AsPath asPath = new AsPathBuilder().setSegments(Collections.emptyList()).build();
284 final CNextHop nextHop = new Ipv4NextHopCaseBuilder().setIpv4NextHop(new Ipv4NextHopBuilder()
285 .setGlobal(new Ipv4AddressNoZone("127.0.0.1")).build()).build();
286 final AttributesBuilder ab = new AttributesBuilder();
287 wrongMessage.setAttributes(ab.setOrigin(origin).setAsPath(asPath).setCNextHop(nextHop).build());
289 final UpdateBuilder correct = new UpdateBuilder(wrongMessage.build());
290 correct.setAttributes(ab.setLocalPref(new LocalPrefBuilder().setPref(Uint32.valueOf(100)).build()).build());
292 bgpSession.handleMessage(correct.build());
293 verify(tx, times(2)).merge(eq(LogicalDatastoreType.OPERATIONAL),
294 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
295 bgpSession.handleMessage(new UpdateBuilder().build());
296 verify(tx, times(3)).merge(eq(LogicalDatastoreType.OPERATIONAL),
297 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
299 verify(tx).merge(eq(LogicalDatastoreType.OPERATIONAL), eq(TABLE_PATH),
300 eq(ImmutableNodes.leafNode(UPTODATE_NID, Boolean.TRUE)));
301 verify(tx, times(0)).delete(eq(LogicalDatastoreType.OPERATIONAL), eq(PEER_PATH));