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.base.Optional;
27 import com.google.common.collect.ImmutableClassToInstanceMap;
28 import com.google.common.collect.ImmutableList;
29 import com.google.common.collect.ImmutableMap;
30 import com.google.common.collect.Lists;
31 import com.google.common.util.concurrent.FluentFuture;
32 import io.netty.channel.Channel;
33 import io.netty.channel.ChannelFuture;
34 import io.netty.channel.ChannelHandler;
35 import io.netty.channel.ChannelPipeline;
36 import io.netty.channel.EventLoop;
37 import io.netty.channel.embedded.EmbeddedChannel;
38 import io.netty.util.concurrent.GlobalEventExecutor;
39 import java.net.InetAddress;
40 import java.net.InetSocketAddress;
41 import java.util.Collections;
42 import java.util.List;
44 import java.util.concurrent.Executor;
45 import java.util.concurrent.TimeUnit;
46 import org.junit.Before;
47 import org.junit.Test;
48 import org.mockito.ArgumentMatchers;
49 import org.mockito.Mock;
50 import org.opendaylight.mdsal.common.api.CommitInfo;
51 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
52 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
53 import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeService;
54 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
55 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
56 import org.opendaylight.protocol.bgp.mode.api.PathSelectionMode;
57 import org.opendaylight.protocol.bgp.mode.impl.base.BasePathSelectionModeFactory;
58 import org.opendaylight.protocol.bgp.parser.BgpExtendedMessageUtil;
59 import org.opendaylight.protocol.bgp.parser.BgpTableTypeImpl;
60 import org.opendaylight.protocol.bgp.rib.spi.RIBQNames;
61 import org.opendaylight.protocol.bgp.rib.spi.RibSupportUtils;
62 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
63 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
64 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
65 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.Notify;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.Open;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.OpenBuilder;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.ProtocolVersion;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.UpdateBuilder;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.BgpParameters;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.BgpParametersBuilder;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.bgp.parameters.OptionalCapabilities;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.bgp.parameters.OptionalCapabilitiesBuilder;
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.bgp.parameters.optional.capabilities.CParametersBuilder;
76 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.bgp.parameters.optional.capabilities.c.parameters.As4BytesCapabilityBuilder;
77 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.AttributesBuilder;
78 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.attributes.AsPath;
79 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.attributes.AsPathBuilder;
80 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.attributes.LocalPrefBuilder;
81 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.attributes.Origin;
82 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.attributes.OriginBuilder;
83 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.update.message.Nlri;
84 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.update.message.NlriBuilder;
85 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.BgpTableType;
86 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.CParameters1;
87 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.CParameters1Builder;
88 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.GracefulRestartCapabilityBuilder;
89 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.MultiprotocolCapabilityBuilder;
90 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.PeerRole;
91 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.RibId;
92 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.Rib;
93 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.rib.Peer;
94 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
95 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.BgpId;
96 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.BgpOrigin;
97 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.Ipv4AddressFamily;
98 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.UnicastSubsequentAddressFamily;
99 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.next.hop.CNextHop;
100 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.next.hop.c.next.hop.Ipv4NextHopCaseBuilder;
101 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.next.hop.c.next.hop.ipv4.next.hop._case.Ipv4NextHopBuilder;
102 import org.opendaylight.yangtools.concepts.ListenerRegistration;
103 import org.opendaylight.yangtools.yang.common.QName;
104 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
105 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
106 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
108 public class SynchronizationAndExceptionTest extends AbstractAddPathTest {
109 private static final int HOLD_TIMER = 3;
110 private static final AsNumber AS_NUMBER = new AsNumber(30L);
111 private static final Ipv4Address BGP_ID = new Ipv4Address("1.1.1.2");
112 private static final String LOCAL_IP = "1.1.1.4";
113 private static final int LOCAL_PORT = 12345;
114 private static final String RIB_ID = "1.1.1.2";
115 private static final YangInstanceIdentifier PEER_PATH = YangInstanceIdentifier.builder()
116 .node(BGPRIB_NID).node(RIB_NID)
117 .nodeWithKey(Rib.QNAME, QName.create(Rib.QNAME, "id").intern(), RIB_ID)
118 .node(PEER_NID).nodeWithKey(Peer.QNAME, RIBQNames.PEER_ID_QNAME, "bgp://1.1.1.2").build();
119 private static final YangInstanceIdentifier TABLE_PATH = PEER_PATH.node(ADJRIBIN_NID).node(TABLES_NID)
120 .node(RibSupportUtils.toYangTablesKey(new TablesKey(Ipv4AddressFamily.class,
121 UnicastSubsequentAddressFamily.class))).node(ATTRIBUTES_NID)
123 private final IpAddress neighbor = new IpAddress(new Ipv4Address(LOCAL_IP));
124 private final BgpTableType ipv4tt = new BgpTableTypeImpl(Ipv4AddressFamily.class,
125 UnicastSubsequentAddressFamily.class);
126 private Open classicOpen;
128 private EventLoop eventLoop;
130 private ChannelPipeline pipeline;
132 private Channel speakerListener;
134 private DOMDataBroker domBroker;
136 private DOMTransactionChain domChain;
138 private DOMDataTreeWriteTransaction tx;
142 public void setUp() throws Exception {
144 new EmbeddedChannel();
145 final List<BgpParameters> tlvs = Lists.newArrayList();
146 this.classicOpen = new OpenBuilder().setMyAsNumber(AS_NUMBER.getValue().intValue()).setHoldTimer(HOLD_TIMER)
147 .setVersion(new ProtocolVersion((short) 4)).setBgpParameters(tlvs).setBgpIdentifier(BGP_ID).build();
149 final List<OptionalCapabilities> capa = Lists.newArrayList();
150 capa.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder()
151 .addAugmentation(CParameters1.class, new CParameters1Builder()
152 .setMultiprotocolCapability(new MultiprotocolCapabilityBuilder()
153 .setAfi(this.ipv4tt.getAfi()).setSafi(this.ipv4tt.getSafi()).build())
154 .setGracefulRestartCapability(new GracefulRestartCapabilityBuilder().setRestartTime(0)
156 .setAs4BytesCapability(new As4BytesCapabilityBuilder().setAsNumber(AS_NUMBER).build()).build())
158 capa.add(new OptionalCapabilitiesBuilder()
159 .setCParameters(BgpExtendedMessageUtil.EXTENDED_MESSAGE_CAPABILITY).build());
160 tlvs.add(new BgpParametersBuilder().setOptionalCapabilities(capa).build());
162 doReturn(null).when(mock(ChannelFuture.class)).addListener(any());
163 doReturn(this.eventLoop).when(this.speakerListener).eventLoop();
164 doReturn(true).when(this.speakerListener).isActive();
165 doAnswer(invocation -> {
166 final Runnable command = invocation.getArgument(0);
167 final long delay = (long) invocation.getArgument(1);
168 final TimeUnit unit = invocation.getArgument(2);
169 GlobalEventExecutor.INSTANCE.schedule(command, delay, unit);
171 }).when(this.eventLoop).schedule(any(Runnable.class), any(long.class), any(TimeUnit.class));
172 doReturn("TestingChannel").when(this.speakerListener).toString();
173 doReturn(true).when(this.speakerListener).isWritable();
174 doReturn(new InetSocketAddress(InetAddress.getByName(BGP_ID.getValue()), 179))
175 .when(this.speakerListener).remoteAddress();
176 doReturn(new InetSocketAddress(InetAddress.getByName(LOCAL_IP), LOCAL_PORT))
177 .when(this.speakerListener).localAddress();
178 doReturn(this.pipeline).when(this.speakerListener).pipeline();
179 doReturn(this.pipeline).when(this.pipeline).replace(any(ChannelHandler.class),
181 any(ChannelHandler.class));
182 doReturn(null).when(this.pipeline).replace(ArgumentMatchers.<Class<ChannelHandler>>any(),
184 any(ChannelHandler.class));
185 doReturn(this.pipeline).when(this.pipeline).addLast(any(ChannelHandler.class));
186 final ChannelFuture futureChannel = mock(ChannelFuture.class);
187 doReturn(null).when(futureChannel).addListener(any());
188 doReturn(futureChannel).when(this.speakerListener).close();
189 doReturn(futureChannel).when(this.speakerListener).writeAndFlush(any(Notify.class));
190 doReturn(this.domChain).when(this.domBroker).createMergingTransactionChain(any());
191 doReturn(this.tx).when(this.domChain).newWriteOnlyTransaction();
192 final DOMDataTreeChangeService dOMDataTreeChangeService = mock(DOMDataTreeChangeService.class);
193 final ListenerRegistration<?> listener = mock(ListenerRegistration.class);
194 doReturn(listener).when(dOMDataTreeChangeService).registerDataTreeChangeListener(any(), any());
195 doNothing().when(listener).close();
196 doNothing().when(this.domChain).close();
198 doReturn(ImmutableClassToInstanceMap.of(DOMDataTreeChangeService.class, dOMDataTreeChangeService))
199 .when(this.domBroker).getExtensions();
200 doNothing().when(this.tx).merge(eq(LogicalDatastoreType.OPERATIONAL),
201 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
202 doNothing().when(this.tx).put(eq(LogicalDatastoreType.OPERATIONAL),
203 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
204 doNothing().when(this.tx).delete(any(LogicalDatastoreType.class), any(YangInstanceIdentifier.class));
205 final FluentFuture<? extends CommitInfo> fluentFuture = mock(FluentFuture.class);
206 doAnswer(invocation -> {
207 final Runnable callback = (Runnable) invocation.getArguments()[0];
210 }).when(fluentFuture).addListener(any(Runnable.class), any(Executor.class));
211 doReturn(fluentFuture).when(this.tx).commit();
212 doReturn(mock(Optional.class)).when(fluentFuture).get();
216 public void testHandleMessageAfterException() {
217 final Map<TablesKey, PathSelectionMode> pathTables = ImmutableMap.of(TABLES_KEY,
218 BasePathSelectionModeFactory.createBestPathSelectionStrategy());
219 final RIBImpl ribImpl = new RIBImpl(this.tableRegistry, new RibId(RIB_ID), AS_NUMBER, new BgpId(RIB_ID),
221 this.serverDispatcher, this.codecsRegistry, this.domBroker, getDataBroker(), this.policies,
222 ImmutableList.of(this.ipv4tt), pathTables);
223 ribImpl.instantiateServiceInstance();
224 ribImpl.onGlobalContextUpdated(this.schemaService.getGlobalContext());
226 final BGPPeer bgpPeer = AbstractAddPathTest.configurePeer(this.tableRegistry, neighbor.getIpv4Address(),
227 ribImpl, null, PeerRole.Ibgp, this.serverRegistry, AFI_SAFIS_ADVERTIZED, Collections.emptySet());
228 bgpPeer.instantiateServiceInstance();
229 final BGPSessionImpl bgpSession = new BGPSessionImpl(bgpPeer, this.speakerListener, this.classicOpen,
230 this.classicOpen.getHoldTimer(), null);
231 bgpSession.setChannelExtMsgCoder(this.classicOpen);
232 bgpPeer.onSessionUp(bgpSession);
234 final Nlri n1 = new NlriBuilder().setPrefix(new Ipv4Prefix("8.0.1.0/28")).build();
235 final Nlri n2 = new NlriBuilder().setPrefix(new Ipv4Prefix("127.0.0.1/32")).build();
236 final Nlri n3 = new NlriBuilder().setPrefix(new Ipv4Prefix("2.2.2.2/24")).build();
237 final List<Nlri> nlris = Lists.newArrayList(n1, n2, n3);
238 final UpdateBuilder wrongMessage = new UpdateBuilder();
239 wrongMessage.setNlri(nlris);
240 final Origin origin = new OriginBuilder().setValue(BgpOrigin.Igp).build();
241 final AsPath asPath = new AsPathBuilder().setSegments(Collections.emptyList()).build();
242 final CNextHop nextHop = new Ipv4NextHopCaseBuilder().setIpv4NextHop(new Ipv4NextHopBuilder()
243 .setGlobal(new Ipv4Address("127.0.0.1")).build()).build();
244 final AttributesBuilder ab = new AttributesBuilder();
245 wrongMessage.setAttributes(ab.setOrigin(origin).setAsPath(asPath).setCNextHop(nextHop).build());
247 final UpdateBuilder correct = new UpdateBuilder(wrongMessage.build());
248 correct.setAttributes(ab.setLocalPref(new LocalPrefBuilder().setPref((long) 100).build()).build());
250 bgpSession.handleMessage(correct.build());
251 verify(this.tx, times(2)).merge(eq(LogicalDatastoreType.OPERATIONAL),
252 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
253 bgpSession.handleMessage(wrongMessage.build());
254 verify(this.tx, times(2)).merge(eq(LogicalDatastoreType.OPERATIONAL),
255 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
256 bgpSession.handleMessage(new UpdateBuilder().build());
257 verify(this.tx, times(2)).merge(eq(LogicalDatastoreType.OPERATIONAL),
258 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
259 verify(this.tx).delete(eq(LogicalDatastoreType.OPERATIONAL), eq(PEER_PATH));
260 verify(this.tx, times(0)).merge(eq(LogicalDatastoreType.OPERATIONAL), eq(TABLE_PATH),
261 eq(ImmutableNodes.leafNode(UPTODATE_NID, Boolean.TRUE)));
265 public void testUseCase1() {
266 final Map<TablesKey, PathSelectionMode> pathTables = ImmutableMap.of(TABLES_KEY,
267 BasePathSelectionModeFactory.createBestPathSelectionStrategy());
268 final RIBImpl ribImpl = new RIBImpl(this.tableRegistry, new RibId(RIB_ID), AS_NUMBER, new BgpId(RIB_ID),
270 this.serverDispatcher, this.codecsRegistry, this.domBroker, getDataBroker(), this.policies,
271 ImmutableList.of(this.ipv4tt), pathTables);
272 ribImpl.instantiateServiceInstance();
273 ribImpl.onGlobalContextUpdated(this.schemaService.getGlobalContext());
275 final BGPPeer bgpPeer = AbstractAddPathTest.configurePeer(this.tableRegistry, neighbor.getIpv4Address(),
276 ribImpl, null, PeerRole.Ibgp, this.serverRegistry, AFI_SAFIS_ADVERTIZED, Collections.emptySet());
277 bgpPeer.instantiateServiceInstance();
278 final BGPSessionImpl bgpSession = new BGPSessionImpl(bgpPeer, this.speakerListener, this.classicOpen,
279 this.classicOpen.getHoldTimer(), null);
280 bgpSession.setChannelExtMsgCoder(this.classicOpen);
281 bgpPeer.onSessionUp(bgpSession);
283 final Nlri n1 = new NlriBuilder().setPrefix(new Ipv4Prefix("8.0.1.0/28")).build();
284 final Nlri n2 = new NlriBuilder().setPrefix(new Ipv4Prefix("127.0.0.1/32")).build();
285 final Nlri n3 = new NlriBuilder().setPrefix(new Ipv4Prefix("2.2.2.2/24")).build();
286 final List<Nlri> nlris = Lists.newArrayList(n1, n2, n3);
287 final UpdateBuilder wrongMessage = new UpdateBuilder();
288 wrongMessage.setNlri(nlris);
289 final Origin origin = new OriginBuilder().setValue(BgpOrigin.Igp).build();
290 final AsPath asPath = new AsPathBuilder().setSegments(Collections.emptyList()).build();
291 final CNextHop nextHop = new Ipv4NextHopCaseBuilder().setIpv4NextHop(new Ipv4NextHopBuilder()
292 .setGlobal(new Ipv4Address("127.0.0.1")).build()).build();
293 final AttributesBuilder ab = new AttributesBuilder();
294 wrongMessage.setAttributes(ab.setOrigin(origin).setAsPath(asPath).setCNextHop(nextHop).build());
296 final UpdateBuilder correct = new UpdateBuilder(wrongMessage.build());
297 correct.setAttributes(ab.setLocalPref(new LocalPrefBuilder().setPref((long) 100).build()).build());
299 bgpSession.handleMessage(correct.build());
300 verify(this.tx, times(2)).merge(eq(LogicalDatastoreType.OPERATIONAL),
301 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
302 bgpSession.handleMessage(new UpdateBuilder().build());
303 verify(this.tx, times(3)).merge(eq(LogicalDatastoreType.OPERATIONAL),
304 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
306 verify(this.tx).merge(eq(LogicalDatastoreType.OPERATIONAL), eq(TABLE_PATH),
307 eq(ImmutableNodes.leafNode(UPTODATE_NID, Boolean.TRUE)));
308 verify(this.tx, times(0)).delete(eq(LogicalDatastoreType.OPERATIONAL), eq(PEER_PATH));