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.ImmutableClassToInstanceMap;
27 import com.google.common.collect.ImmutableList;
28 import com.google.common.collect.ImmutableMap;
29 import com.google.common.collect.Lists;
30 import io.netty.channel.Channel;
31 import io.netty.channel.ChannelFuture;
32 import io.netty.channel.ChannelHandler;
33 import io.netty.channel.ChannelPipeline;
34 import io.netty.channel.EventLoop;
35 import io.netty.util.concurrent.GlobalEventExecutor;
36 import java.net.InetAddress;
37 import java.net.InetSocketAddress;
38 import java.util.ArrayList;
39 import java.util.Collections;
40 import java.util.List;
42 import java.util.concurrent.TimeUnit;
43 import org.junit.Before;
44 import org.junit.Test;
45 import org.mockito.ArgumentMatchers;
46 import org.mockito.Mock;
47 import org.opendaylight.mdsal.common.api.CommitInfo;
48 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
49 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
50 import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeService;
51 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
52 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
53 import org.opendaylight.protocol.bgp.mode.api.PathSelectionMode;
54 import org.opendaylight.protocol.bgp.mode.impl.base.BasePathSelectionModeFactory;
55 import org.opendaylight.protocol.bgp.parser.BgpExtendedMessageUtil;
56 import org.opendaylight.protocol.bgp.parser.BgpTableTypeImpl;
57 import org.opendaylight.protocol.bgp.rib.spi.RIBQNames;
58 import org.opendaylight.protocol.bgp.rib.spi.RibSupportUtils;
59 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
60 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone;
61 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone;
62 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.Notify;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.Open;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.OpenBuilder;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.ProtocolVersion;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.UpdateBuilder;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.BgpParametersBuilder;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.bgp.parameters.OptionalCapabilities;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.bgp.parameters.OptionalCapabilitiesBuilder;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.bgp.parameters.optional.capabilities.CParametersBuilder;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.bgp.parameters.optional.capabilities.c.parameters.As4BytesCapabilityBuilder;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.AttributesBuilder;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes.AsPath;
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes.AsPathBuilder;
76 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes.LocalPrefBuilder;
77 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes.Origin;
78 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes.OriginBuilder;
79 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.update.message.Nlri;
80 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.update.message.NlriBuilder;
81 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.BgpTableType;
82 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.CParameters1Builder;
83 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.GracefulRestartCapabilityBuilder;
84 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.MultiprotocolCapabilityBuilder;
85 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.PeerRole;
86 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.RibId;
87 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.Rib;
88 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.rib.Peer;
89 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
90 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.BgpId;
91 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.BgpOrigin;
92 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.Ipv4AddressFamily;
93 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.UnicastSubsequentAddressFamily;
94 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.next.hop.CNextHop;
95 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.next.hop.c.next.hop.Ipv4NextHopCaseBuilder;
96 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;
97 import org.opendaylight.yangtools.concepts.ListenerRegistration;
98 import org.opendaylight.yangtools.yang.common.QName;
99 import org.opendaylight.yangtools.yang.common.Uint16;
100 import org.opendaylight.yangtools.yang.common.Uint32;
101 import org.opendaylight.yangtools.yang.common.Uint8;
102 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
103 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
104 import org.opendaylight.yangtools.yang.data.impl.schema.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(RibSupportUtils.toYangTablesKey(new TablesKey(Ipv4AddressFamily.class,
119 UnicastSubsequentAddressFamily.class))).node(ATTRIBUTES_NID)
121 private final IpAddressNoZone neighbor = new IpAddressNoZone(new Ipv4AddressNoZone(LOCAL_IP));
122 private final BgpTableType ipv4tt = new BgpTableTypeImpl(Ipv4AddressFamily.class,
123 UnicastSubsequentAddressFamily.class);
124 private Open classicOpen;
126 private EventLoop eventLoop;
128 private ChannelPipeline pipeline;
130 private Channel speakerListener;
132 private DOMDataBroker domBroker;
134 private DOMTransactionChain domChain;
136 private DOMDataTreeWriteTransaction tx;
140 public void setUp() throws Exception {
143 final List<OptionalCapabilities> capa = new ArrayList<>();
144 capa.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder()
145 .addAugmentation(new CParameters1Builder()
146 .setMultiprotocolCapability(new MultiprotocolCapabilityBuilder()
147 .setAfi(this.ipv4tt.getAfi()).setSafi(this.ipv4tt.getSafi()).build())
148 .setGracefulRestartCapability(new GracefulRestartCapabilityBuilder().setRestartTime(Uint16.ZERO)
150 .setAs4BytesCapability(new As4BytesCapabilityBuilder().setAsNumber(AS_NUMBER).build()).build())
152 capa.add(new OptionalCapabilitiesBuilder()
153 .setCParameters(BgpExtendedMessageUtil.EXTENDED_MESSAGE_CAPABILITY).build());
155 this.classicOpen = new OpenBuilder()
156 .setMyAsNumber(Uint16.valueOf(AS_NUMBER.getValue()))
157 .setHoldTimer(Uint16.valueOf(HOLD_TIMER))
158 .setVersion(new ProtocolVersion(Uint8.valueOf(4)))
159 .setBgpParameters(List.of(new BgpParametersBuilder()
160 .setOptionalCapabilities(capa)
162 .setBgpIdentifier(BGP_ID)
165 doReturn(null).when(mock(ChannelFuture.class)).addListener(any());
166 doReturn(this.eventLoop).when(this.speakerListener).eventLoop();
167 doReturn(true).when(this.speakerListener).isActive();
168 doAnswer(invocation -> {
169 final Runnable command = invocation.getArgument(0);
170 final long delay = (long) invocation.getArgument(1);
171 final TimeUnit unit = invocation.getArgument(2);
172 GlobalEventExecutor.INSTANCE.schedule(command, delay, unit);
174 }).when(this.eventLoop).schedule(any(Runnable.class), any(long.class), any(TimeUnit.class));
175 doReturn("TestingChannel").when(this.speakerListener).toString();
176 doReturn(true).when(this.speakerListener).isWritable();
177 doReturn(new InetSocketAddress(InetAddress.getByName(BGP_ID.getValue()), 179))
178 .when(this.speakerListener).remoteAddress();
179 doReturn(new InetSocketAddress(InetAddress.getByName(LOCAL_IP), LOCAL_PORT))
180 .when(this.speakerListener).localAddress();
181 doReturn(this.pipeline).when(this.speakerListener).pipeline();
182 doReturn(this.pipeline).when(this.pipeline).replace(any(ChannelHandler.class),
184 any(ChannelHandler.class));
185 doReturn(null).when(this.pipeline).replace(ArgumentMatchers.<Class<ChannelHandler>>any(),
187 any(ChannelHandler.class));
188 doReturn(this.pipeline).when(this.pipeline).addLast(any(ChannelHandler.class));
189 final ChannelFuture futureChannel = mock(ChannelFuture.class);
190 doReturn(null).when(futureChannel).addListener(any());
191 doReturn(futureChannel).when(this.speakerListener).close();
192 doReturn(futureChannel).when(this.speakerListener).writeAndFlush(any(Notify.class));
193 doReturn(this.domChain).when(this.domBroker).createMergingTransactionChain(any());
194 doReturn(this.tx).when(this.domChain).newWriteOnlyTransaction();
195 final DOMDataTreeChangeService dOMDataTreeChangeService = mock(DOMDataTreeChangeService.class);
196 final ListenerRegistration<?> listener = mock(ListenerRegistration.class);
197 doReturn(listener).when(dOMDataTreeChangeService).registerDataTreeChangeListener(any(), any());
198 doNothing().when(listener).close();
199 doNothing().when(this.domChain).close();
201 doReturn(ImmutableClassToInstanceMap.of(DOMDataTreeChangeService.class, dOMDataTreeChangeService))
202 .when(this.domBroker).getExtensions();
203 doNothing().when(this.tx).merge(eq(LogicalDatastoreType.OPERATIONAL),
204 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
205 doNothing().when(this.tx).put(eq(LogicalDatastoreType.OPERATIONAL),
206 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
207 doNothing().when(this.tx).delete(any(LogicalDatastoreType.class), any(YangInstanceIdentifier.class));
208 doReturn(CommitInfo.emptyFluentFuture()).when(this.tx).commit();
212 public void testHandleMessageAfterException() {
213 final Map<TablesKey, PathSelectionMode> pathTables = ImmutableMap.of(TABLES_KEY,
214 BasePathSelectionModeFactory.createBestPathSelectionStrategy());
215 final RIBImpl ribImpl = new RIBImpl(this.tableRegistry, new RibId(RIB_ID), AS_NUMBER, new BgpId(RIB_ID),
217 this.serverDispatcher, this.codecsRegistry, this.domBroker, getDataBroker(), this.policies,
218 ImmutableList.of(this.ipv4tt), pathTables);
219 ribImpl.instantiateServiceInstance();
221 final BGPPeer bgpPeer = AbstractAddPathTest.configurePeer(this.tableRegistry, neighbor.getIpv4AddressNoZone(),
222 ribImpl, null, PeerRole.Ibgp, this.serverRegistry, AFI_SAFIS_ADVERTIZED, Collections.emptySet());
223 bgpPeer.instantiateServiceInstance();
224 final BGPSessionImpl bgpSession = new BGPSessionImpl(bgpPeer, this.speakerListener, this.classicOpen,
225 this.classicOpen.getHoldTimer().toJava(), null);
226 bgpSession.setChannelExtMsgCoder(this.classicOpen);
227 bgpPeer.onSessionUp(bgpSession);
229 final Nlri n1 = new NlriBuilder().setPrefix(new Ipv4Prefix("8.0.1.0/28")).build();
230 final Nlri n2 = new NlriBuilder().setPrefix(new Ipv4Prefix("127.0.0.1/32")).build();
231 final Nlri n3 = new NlriBuilder().setPrefix(new Ipv4Prefix("2.2.2.2/24")).build();
232 final List<Nlri> nlris = Lists.newArrayList(n1, n2, n3);
233 final UpdateBuilder wrongMessage = new UpdateBuilder();
234 wrongMessage.setNlri(nlris);
235 final Origin origin = new OriginBuilder().setValue(BgpOrigin.Igp).build();
236 final AsPath asPath = new AsPathBuilder().setSegments(Collections.emptyList()).build();
237 final CNextHop nextHop = new Ipv4NextHopCaseBuilder().setIpv4NextHop(new Ipv4NextHopBuilder()
238 .setGlobal(new Ipv4AddressNoZone("127.0.0.1")).build()).build();
239 final AttributesBuilder ab = new AttributesBuilder();
240 wrongMessage.setAttributes(ab.setOrigin(origin).setAsPath(asPath).setCNextHop(nextHop).build());
242 final UpdateBuilder correct = new UpdateBuilder(wrongMessage.build());
243 correct.setAttributes(ab.setLocalPref(new LocalPrefBuilder().setPref(Uint32.valueOf(100)).build()).build());
245 bgpSession.handleMessage(correct.build());
246 verify(this.tx, times(2)).merge(eq(LogicalDatastoreType.OPERATIONAL),
247 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
248 bgpSession.handleMessage(wrongMessage.build());
249 verify(this.tx, times(2)).merge(eq(LogicalDatastoreType.OPERATIONAL),
250 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
251 bgpSession.handleMessage(new UpdateBuilder().build());
252 verify(this.tx, times(2)).merge(eq(LogicalDatastoreType.OPERATIONAL),
253 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
254 verify(this.tx).delete(eq(LogicalDatastoreType.OPERATIONAL), eq(PEER_PATH));
255 verify(this.tx, times(0)).merge(eq(LogicalDatastoreType.OPERATIONAL), eq(TABLE_PATH),
256 eq(ImmutableNodes.leafNode(UPTODATE_NID, Boolean.TRUE)));
260 public void testUseCase1() {
261 final Map<TablesKey, PathSelectionMode> pathTables = ImmutableMap.of(TABLES_KEY,
262 BasePathSelectionModeFactory.createBestPathSelectionStrategy());
263 final RIBImpl ribImpl = new RIBImpl(this.tableRegistry, new RibId(RIB_ID), AS_NUMBER, new BgpId(RIB_ID),
265 this.serverDispatcher, this.codecsRegistry, this.domBroker, getDataBroker(), this.policies,
266 ImmutableList.of(this.ipv4tt), pathTables);
267 ribImpl.instantiateServiceInstance();
269 final BGPPeer bgpPeer = AbstractAddPathTest.configurePeer(this.tableRegistry, neighbor.getIpv4AddressNoZone(),
270 ribImpl, null, PeerRole.Ibgp, this.serverRegistry, AFI_SAFIS_ADVERTIZED, Collections.emptySet());
271 bgpPeer.instantiateServiceInstance();
272 final BGPSessionImpl bgpSession = new BGPSessionImpl(bgpPeer, this.speakerListener, this.classicOpen,
273 this.classicOpen.getHoldTimer().toJava(), null);
274 bgpSession.setChannelExtMsgCoder(this.classicOpen);
275 bgpPeer.onSessionUp(bgpSession);
277 final Nlri n1 = new NlriBuilder().setPrefix(new Ipv4Prefix("8.0.1.0/28")).build();
278 final Nlri n2 = new NlriBuilder().setPrefix(new Ipv4Prefix("127.0.0.1/32")).build();
279 final Nlri n3 = new NlriBuilder().setPrefix(new Ipv4Prefix("2.2.2.2/24")).build();
280 final List<Nlri> nlris = Lists.newArrayList(n1, n2, n3);
281 final UpdateBuilder wrongMessage = new UpdateBuilder();
282 wrongMessage.setNlri(nlris);
283 final Origin origin = new OriginBuilder().setValue(BgpOrigin.Igp).build();
284 final AsPath asPath = new AsPathBuilder().setSegments(Collections.emptyList()).build();
285 final CNextHop nextHop = new Ipv4NextHopCaseBuilder().setIpv4NextHop(new Ipv4NextHopBuilder()
286 .setGlobal(new Ipv4AddressNoZone("127.0.0.1")).build()).build();
287 final AttributesBuilder ab = new AttributesBuilder();
288 wrongMessage.setAttributes(ab.setOrigin(origin).setAsPath(asPath).setCNextHop(nextHop).build());
290 final UpdateBuilder correct = new UpdateBuilder(wrongMessage.build());
291 correct.setAttributes(ab.setLocalPref(new LocalPrefBuilder().setPref(Uint32.valueOf(100)).build()).build());
293 bgpSession.handleMessage(correct.build());
294 verify(this.tx, times(2)).merge(eq(LogicalDatastoreType.OPERATIONAL),
295 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
296 bgpSession.handleMessage(new UpdateBuilder().build());
297 verify(this.tx, times(3)).merge(eq(LogicalDatastoreType.OPERATIONAL),
298 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
300 verify(this.tx).merge(eq(LogicalDatastoreType.OPERATIONAL), eq(TABLE_PATH),
301 eq(ImmutableNodes.leafNode(UPTODATE_NID, Boolean.TRUE)));
302 verify(this.tx, times(0)).delete(eq(LogicalDatastoreType.OPERATIONAL), eq(PEER_PATH));