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