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.Matchers.any;
12 import static org.mockito.Matchers.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.CheckedFuture;
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.protocol.bgp.mode.api.PathSelectionMode;
50 import org.opendaylight.protocol.bgp.mode.impl.base.BasePathSelectionModeFactory;
51 import org.opendaylight.protocol.bgp.parser.BgpExtendedMessageUtil;
52 import org.opendaylight.protocol.bgp.parser.BgpTableTypeImpl;
53 import org.opendaylight.protocol.bgp.rib.spi.RibSupportUtils;
54 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
55 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
56 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
57 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.Notify;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.Open;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.OpenBuilder;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.ProtocolVersion;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.UpdateBuilder;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.open.message.BgpParameters;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.open.message.BgpParametersBuilder;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.open.message.bgp.parameters.OptionalCapabilities;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.open.message.bgp.parameters.OptionalCapabilitiesBuilder;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.open.message.bgp.parameters.optional.capabilities.CParametersBuilder;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.open.message.bgp.parameters.optional.capabilities.c.parameters.As4BytesCapabilityBuilder;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.path.attributes.AttributesBuilder;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.path.attributes.attributes.AsPath;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.path.attributes.attributes.AsPathBuilder;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.path.attributes.attributes.LocalPrefBuilder;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.path.attributes.attributes.Origin;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.path.attributes.attributes.OriginBuilder;
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.update.message.Nlri;
76 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.update.message.NlriBuilder;
77 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.BgpTableType;
78 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.CParameters1;
79 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.CParameters1Builder;
80 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.mp.capabilities.GracefulRestartCapabilityBuilder;
81 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.mp.capabilities.MultiprotocolCapabilityBuilder;
82 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.BgpRib;
83 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.PeerRole;
84 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.RibId;
85 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.bgp.rib.Rib;
86 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.bgp.rib.rib.Peer;
87 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.bgp.rib.rib.peer.AdjRibIn;
88 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.rib.Tables;
89 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.rib.TablesKey;
90 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.rib.tables.Attributes;
91 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.BgpId;
92 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.BgpOrigin;
93 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Ipv4AddressFamily;
94 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.UnicastSubsequentAddressFamily;
95 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.next.hop.CNextHop;
96 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.next.hop.c.next.hop.Ipv4NextHopCaseBuilder;
97 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.next.hop.c.next.hop.ipv4.next.hop._case.Ipv4NextHopBuilder;
98 import org.opendaylight.yangtools.concepts.ListenerRegistration;
99 import org.opendaylight.yangtools.yang.common.QName;
100 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
101 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
102 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
104 public class SynchronizationAndExceptionTest extends AbstractAddPathTest {
105 private static final int HOLD_TIMER = 3;
106 private static final AsNumber AS_NUMBER = new AsNumber(30L);
107 private static final Ipv4Address BGP_ID = new Ipv4Address("1.1.1.2");
108 private static final String LOCAL_IP = "1.1.1.4";
109 private static final int LOCAL_PORT = 12345;
110 private static final String RIB_ID = "1.1.1.2";
111 private static final YangInstanceIdentifier PEER_PATH = YangInstanceIdentifier.builder()
112 .node(BgpRib.QNAME).node(Rib.QNAME)
113 .nodeWithKey(Rib.QNAME, QName.create(Rib.QNAME, "id").intern(), RIB_ID)
114 .node(Peer.QNAME).nodeWithKey(Peer.QNAME, AdjRibInWriter.PEER_ID_QNAME, "bgp://1.1.1.2").build();
115 private static final YangInstanceIdentifier TABLE_PATH = PEER_PATH.node(AdjRibIn.QNAME).node(Tables.QNAME)
116 .node(RibSupportUtils.toYangTablesKey(new TablesKey(Ipv4AddressFamily.class,
117 UnicastSubsequentAddressFamily.class))).node(Attributes.QNAME)
118 .node(QName.create(Attributes.QNAME, "uptodate"));
119 private final IpAddress neighbor = new IpAddress(new Ipv4Address(LOCAL_IP));
120 private final BgpTableType ipv4tt = new BgpTableTypeImpl(Ipv4AddressFamily.class,
121 UnicastSubsequentAddressFamily.class);
122 private Open classicOpen;
124 private EventLoop eventLoop;
126 private ChannelPipeline pipeline;
128 private Channel speakerListener;
130 private DOMDataBroker domBroker;
132 private DOMTransactionChain domChain;
134 private DOMDataWriteTransaction tx;
138 public void setUp() throws Exception {
140 new EmbeddedChannel();
141 final List<BgpParameters> tlvs = Lists.newArrayList();
142 this.classicOpen = new OpenBuilder().setMyAsNumber(AS_NUMBER.getValue().intValue()).setHoldTimer(HOLD_TIMER)
143 .setVersion(new ProtocolVersion((short) 4)).setBgpParameters(tlvs).setBgpIdentifier(BGP_ID).build();
145 final List<OptionalCapabilities> capa = Lists.newArrayList();
146 capa.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().addAugmentation(CParameters1.class,
147 new CParameters1Builder().setMultiprotocolCapability(new MultiprotocolCapabilityBuilder()
148 .setAfi(this.ipv4tt.getAfi()).setSafi(this.ipv4tt.getSafi()).build())
149 .setGracefulRestartCapability(new GracefulRestartCapabilityBuilder().build()).build())
150 .setAs4BytesCapability(new As4BytesCapabilityBuilder().setAsNumber(AS_NUMBER).build()).build()).build());
151 capa.add(new OptionalCapabilitiesBuilder().setCParameters(BgpExtendedMessageUtil.EXTENDED_MESSAGE_CAPABILITY).build());
152 tlvs.add(new BgpParametersBuilder().setOptionalCapabilities(capa).build());
154 doReturn(null).when(mock(ChannelFuture.class)).addListener(any());
155 doReturn(this.eventLoop).when(this.speakerListener).eventLoop();
156 doReturn(true).when(this.speakerListener).isActive();
157 doAnswer(invocation -> {
158 final Runnable command = (Runnable) invocation.getArguments()[0];
159 final long delay = (long) invocation.getArguments()[1];
160 final TimeUnit unit = (TimeUnit) invocation.getArguments()[2];
161 GlobalEventExecutor.INSTANCE.schedule(command, delay, unit);
163 }).when(this.eventLoop).schedule(any(Runnable.class), any(long.class), any(TimeUnit.class));
164 doReturn("TestingChannel").when(this.speakerListener).toString();
165 doReturn(true).when(this.speakerListener).isWritable();
166 doReturn(new InetSocketAddress(InetAddress.getByName(BGP_ID.getValue()), 179))
167 .when(this.speakerListener).remoteAddress();
168 doReturn(new InetSocketAddress(InetAddress.getByName(LOCAL_IP), LOCAL_PORT))
169 .when(this.speakerListener).localAddress();
170 doReturn(this.pipeline).when(this.speakerListener).pipeline();
171 doReturn(this.pipeline).when(this.pipeline).replace(any(ChannelHandler.class),
173 any(ChannelHandler.class));
174 doReturn(null).when(this.pipeline).replace(Matchers.<Class<ChannelHandler>>any(),
176 any(ChannelHandler.class));
177 doReturn(this.pipeline).when(this.pipeline).addLast(any(ChannelHandler.class));
178 final ChannelFuture futureChannel = mock(ChannelFuture.class);
179 doReturn(null).when(futureChannel).addListener(any());
180 doReturn(futureChannel).when(this.speakerListener).close();
181 doReturn(futureChannel).when(this.speakerListener).writeAndFlush(any(Notify.class));
182 doReturn(this.domChain).when(this.domBroker).createTransactionChain(any());
183 doReturn(this.tx).when(this.domChain).newWriteOnlyTransaction();
184 final DOMDataTreeChangeService dOMDataTreeChangeService = mock(DOMDataTreeChangeService.class);
185 final ListenerRegistration<?> listener = mock(ListenerRegistration.class);
186 doReturn(listener).when(dOMDataTreeChangeService).registerDataTreeChangeListener(any(), any());
187 doNothing().when(listener).close();
189 doReturn(Collections.singletonMap(DOMDataTreeChangeService.class, dOMDataTreeChangeService))
190 .when(this.domBroker).getSupportedExtensions();
191 doNothing().when(this.tx).merge(eq(LogicalDatastoreType.OPERATIONAL),
192 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
193 doNothing().when(this.tx).put(eq(LogicalDatastoreType.OPERATIONAL),
194 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
195 doNothing().when(this.tx).delete(any(LogicalDatastoreType.class), any(YangInstanceIdentifier.class));
196 final CheckedFuture<?, ?> future = mock(CheckedFuture.class);
197 doAnswer(invocation -> {
198 final Runnable callback = (Runnable) invocation.getArguments()[0];
201 }).when(future).addListener(any(Runnable.class), any(Executor.class));
202 doReturn(future).when(this.tx).submit();
203 doReturn(mock(Optional.class)).when(future).checkedGet();
207 public void testHandleMessageAfterException() {
208 final Map<TablesKey, PathSelectionMode> pathTables = ImmutableMap.of(TABLES_KEY,
209 BasePathSelectionModeFactory.createBestPathSelectionStrategy(this.peerTracker));
210 final RIBImpl ribImpl = new RIBImpl( new RibId(RIB_ID), AS_NUMBER, new BgpId(RIB_ID), this.ribExtension,
211 this.serverDispatcher, this.codecsRegistry, this.domBroker, getDataBroker(), this.policies,
212 this.peerTracker, ImmutableList.of(this.ipv4tt), pathTables);
213 ribImpl.instantiateServiceInstance();
214 ribImpl.onGlobalContextUpdated(this.schemaContext);
216 final BGPPeer bgpPeer = new BGPPeer(neighbor, ribImpl, PeerRole.Ibgp, null, AFI_SAFIS_ADVERTIZED,
217 Collections.emptySet());
218 bgpPeer.instantiateServiceInstance();
219 final BGPSessionImpl bgpSession = new BGPSessionImpl(bgpPeer, this.speakerListener, this.classicOpen,
220 this.classicOpen.getHoldTimer(), null);
221 bgpSession.setChannelExtMsgCoder(this.classicOpen);
222 bgpPeer.onSessionUp(bgpSession);
224 final Nlri n1 = new NlriBuilder().setPrefix(new Ipv4Prefix("8.0.1.0/28")).build();
225 final Nlri n2 = new NlriBuilder().setPrefix( new Ipv4Prefix("127.0.0.1/32")).build();
226 final Nlri n3 = new NlriBuilder().setPrefix( new Ipv4Prefix("2.2.2.2/24")).build();
227 final List<Nlri> nlris = Lists.newArrayList(n1, n2, n3);
228 final UpdateBuilder wrongMessage = new UpdateBuilder();
229 wrongMessage.setNlri(nlris);
230 final Origin origin = new OriginBuilder().setValue(BgpOrigin.Igp).build();
231 final AsPath asPath = new AsPathBuilder().setSegments(Collections.emptyList()).build();
232 final CNextHop nextHop = new Ipv4NextHopCaseBuilder().setIpv4NextHop(new Ipv4NextHopBuilder()
233 .setGlobal(new Ipv4Address("127.0.0.1")).build()).build();
234 final AttributesBuilder ab = new AttributesBuilder();
235 wrongMessage.setAttributes(ab.setOrigin(origin).setAsPath(asPath).setCNextHop(nextHop).build());
237 final UpdateBuilder correct = new UpdateBuilder(wrongMessage.build());
238 correct.setAttributes(ab.setLocalPref(new LocalPrefBuilder().setPref((long) 100).build()).build());
240 bgpSession.handleMessage(correct.build());
241 verify(this.tx, times(2)).merge(eq(LogicalDatastoreType.OPERATIONAL),
242 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
243 bgpSession.handleMessage(wrongMessage.build());
244 verify(this.tx, times(2)).merge(eq(LogicalDatastoreType.OPERATIONAL),
245 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
246 bgpSession.handleMessage(new UpdateBuilder().build());
247 verify(this.tx, times(2)).merge(eq(LogicalDatastoreType.OPERATIONAL),
248 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
249 verify(this.tx).delete(eq(LogicalDatastoreType.OPERATIONAL), eq(PEER_PATH));
250 verify(this.tx, times(0)).merge(eq(LogicalDatastoreType.OPERATIONAL), eq(TABLE_PATH),
251 eq(ImmutableNodes.leafNode(ATTRIBUTES_UPTODATE_FALSE.getNodeType(), Boolean.TRUE)));
255 public void testUseCase1() {
256 final Map<TablesKey, PathSelectionMode> pathTables = ImmutableMap.of(TABLES_KEY,
257 BasePathSelectionModeFactory.createBestPathSelectionStrategy(this.peerTracker));
258 final RIBImpl ribImpl = new RIBImpl(new RibId(RIB_ID), AS_NUMBER, new BgpId(RIB_ID), this.ribExtension,
259 this.serverDispatcher, this.codecsRegistry, this.domBroker, getDataBroker(), this.policies,
260 this.peerTracker, ImmutableList.of(this.ipv4tt), pathTables);
261 ribImpl.instantiateServiceInstance();
262 ribImpl.onGlobalContextUpdated(this.schemaContext);
264 final BGPPeer bgpPeer = new BGPPeer(neighbor, ribImpl, PeerRole.Ibgp, null, AFI_SAFIS_ADVERTIZED,
265 Collections.emptySet());
266 bgpPeer.instantiateServiceInstance();
267 final BGPSessionImpl bgpSession = new BGPSessionImpl(bgpPeer, this.speakerListener, this.classicOpen,
268 this.classicOpen.getHoldTimer(), null);
269 bgpSession.setChannelExtMsgCoder(this.classicOpen);
270 bgpPeer.onSessionUp(bgpSession);
272 final Nlri n1 = new NlriBuilder().setPrefix(new Ipv4Prefix("8.0.1.0/28")).build();
273 final Nlri n2 = new NlriBuilder().setPrefix( new Ipv4Prefix("127.0.0.1/32")).build();
274 final Nlri n3 = new NlriBuilder().setPrefix( new Ipv4Prefix("2.2.2.2/24")).build();
275 final List<Nlri> nlris = Lists.newArrayList(n1, n2, n3);
276 final UpdateBuilder wrongMessage = new UpdateBuilder();
277 wrongMessage.setNlri(nlris);
278 final Origin origin = new OriginBuilder().setValue(BgpOrigin.Igp).build();
279 final AsPath asPath = new AsPathBuilder().setSegments(Collections.emptyList()).build();
280 final CNextHop nextHop = new Ipv4NextHopCaseBuilder().setIpv4NextHop(new Ipv4NextHopBuilder()
281 .setGlobal(new Ipv4Address("127.0.0.1")).build()).build();
282 final AttributesBuilder ab = new AttributesBuilder();
283 wrongMessage.setAttributes(ab.setOrigin(origin).setAsPath(asPath).setCNextHop(nextHop).build());
285 final UpdateBuilder correct = new UpdateBuilder(wrongMessage.build());
286 correct.setAttributes(ab.setLocalPref(new LocalPrefBuilder().setPref((long) 100).build()).build());
288 bgpSession.handleMessage(correct.build());
289 verify(this.tx, times(2)).merge(eq(LogicalDatastoreType.OPERATIONAL),
290 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
291 bgpSession.handleMessage(new UpdateBuilder().build());
292 verify(this.tx, times(3)).merge(eq(LogicalDatastoreType.OPERATIONAL),
293 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
295 verify(this.tx).merge(eq(LogicalDatastoreType.OPERATIONAL), eq(TABLE_PATH),
296 eq(ImmutableNodes.leafNode(ATTRIBUTES_UPTODATE_FALSE.getNodeType(), Boolean.TRUE)));
297 verify(this.tx, times(0)).delete(eq(LogicalDatastoreType.OPERATIONAL), eq(PEER_PATH));