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.Mockito.any;
12 import static org.mockito.Mockito.doAnswer;
13 import static org.mockito.Mockito.doReturn;
14 import static org.mockito.Mockito.eq;
15 import static org.mockito.Mockito.mock;
16 import static org.mockito.internal.verification.VerificationModeFactory.times;
17 import static org.opendaylight.protocol.bgp.rib.impl.AdjRibInWriter.ATTRIBUTES_UPTODATE_FALSE;
19 import com.google.common.base.Optional;
20 import com.google.common.collect.ImmutableList;
21 import com.google.common.collect.ImmutableMap;
22 import com.google.common.collect.Lists;
23 import com.google.common.util.concurrent.CheckedFuture;
24 import io.netty.channel.Channel;
25 import io.netty.channel.ChannelFuture;
26 import io.netty.channel.ChannelHandler;
27 import io.netty.channel.ChannelPipeline;
28 import io.netty.channel.EventLoop;
29 import io.netty.channel.embedded.EmbeddedChannel;
30 import io.netty.util.concurrent.GlobalEventExecutor;
31 import java.net.InetAddress;
32 import java.net.InetSocketAddress;
33 import java.util.Collections;
34 import java.util.List;
36 import java.util.concurrent.Executor;
37 import java.util.concurrent.TimeUnit;
38 import org.junit.Before;
39 import org.junit.Test;
40 import org.mockito.Matchers;
41 import org.mockito.Mock;
42 import org.mockito.Mockito;
43 import org.mockito.invocation.InvocationOnMock;
44 import org.mockito.stubbing.Answer;
45 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
46 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
47 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeService;
48 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
49 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
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.rev130919.Notify;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Open;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.OpenBuilder;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.ProtocolVersion;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.UpdateBuilder;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.BgpParameters;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.BgpParametersBuilder;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.bgp.parameters.OptionalCapabilities;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.bgp.parameters.OptionalCapabilitiesBuilder;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.bgp.parameters.optional.capabilities.CParametersBuilder;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.bgp.parameters.optional.capabilities.c.parameters.As4BytesCapabilityBuilder;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.AttributesBuilder;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.AsPath;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.AsPathBuilder;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.LocalPrefBuilder;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.Origin;
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.OriginBuilder;
76 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.update.message.NlriBuilder;
77 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.BgpTableType;
78 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.CParameters1;
79 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.CParameters1Builder;
80 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.mp.capabilities.GracefulRestartCapabilityBuilder;
81 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.mp.capabilities.MultiprotocolCapabilityBuilder;
82 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.BgpRib;
83 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerRole;
84 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.RibId;
85 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.Rib;
86 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.Peer;
87 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.peer.AdjRibIn;
88 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.Tables;
89 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
90 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.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 final IpAddress neighbor = new IpAddress(new Ipv4Address(LOCAL_IP));
110 private static final int LOCAL_PORT = 12345;
111 private final BgpTableType ipv4tt = new BgpTableTypeImpl(Ipv4AddressFamily.class, UnicastSubsequentAddressFamily.class);
112 private Open classicOpen;
114 private EventLoop eventLoop;
116 private ChannelPipeline pipeline;
118 private Channel speakerListener;
120 private DOMDataBroker domBroker;
122 private DOMTransactionChain domChain;
124 private DOMDataWriteTransaction tx;
125 private static final String RIB_ID = "1.1.1.2";
126 private static final YangInstanceIdentifier PEER_PATH = YangInstanceIdentifier.builder().node(BgpRib.QNAME).node(Rib.QNAME)
127 .nodeWithKey(Rib.QNAME, QName.create(Rib.QNAME, "id").intern(), RIB_ID)
128 .node(Peer.QNAME).nodeWithKey(Peer.QNAME, AdjRibInWriter.PEER_ID_QNAME, "bgp://1.1.1.2").build();
129 private static final YangInstanceIdentifier TABLE_PATH = PEER_PATH.node(AdjRibIn.QNAME).node(Tables.QNAME)
130 .node(RibSupportUtils.toYangTablesKey(new TablesKey(Ipv4AddressFamily.class,
131 UnicastSubsequentAddressFamily.class))).node(Attributes.QNAME).node(QName.create(Attributes.QNAME, "uptodate"));
134 public void setUp() throws Exception {
136 new EmbeddedChannel();
137 final List<BgpParameters> tlvs = Lists.newArrayList();
138 this.classicOpen = new OpenBuilder().setMyAsNumber(AS_NUMBER.getValue().intValue()).setHoldTimer(HOLD_TIMER)
139 .setVersion(new ProtocolVersion((short) 4)).setBgpParameters(tlvs).setBgpIdentifier(BGP_ID).build();
141 final List<OptionalCapabilities> capa = Lists.newArrayList();
142 capa.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().addAugmentation(CParameters1.class,
143 new CParameters1Builder().setMultiprotocolCapability(new MultiprotocolCapabilityBuilder()
144 .setAfi(this.ipv4tt.getAfi()).setSafi(this.ipv4tt.getSafi()).build())
145 .setGracefulRestartCapability(new GracefulRestartCapabilityBuilder().build()).build())
146 .setAs4BytesCapability(new As4BytesCapabilityBuilder().setAsNumber(AS_NUMBER).build()).build()).build());
147 capa.add(new OptionalCapabilitiesBuilder().setCParameters(BgpExtendedMessageUtil.EXTENDED_MESSAGE_CAPABILITY).build());
148 tlvs.add(new BgpParametersBuilder().setOptionalCapabilities(capa).build());
150 doReturn(null).when(mock(ChannelFuture.class)).addListener(any());
151 doReturn(this.eventLoop).when(this.speakerListener).eventLoop();
152 doReturn(true).when(this.speakerListener).isActive();
153 doAnswer(new Answer<Void>() {
155 public Void answer(final InvocationOnMock invocation) throws Throwable {
156 final Runnable command = (Runnable) invocation.getArguments()[0];
157 final long delay = (long) invocation.getArguments()[1];
158 final TimeUnit unit = (TimeUnit) invocation.getArguments()[2];
159 GlobalEventExecutor.INSTANCE.schedule(command, delay, unit);
162 }).when(this.eventLoop).schedule(any(Runnable.class), any(long.class), any(TimeUnit.class));
163 doReturn("TestingChannel").when(this.speakerListener).toString();
164 doReturn(true).when(this.speakerListener).isWritable();
165 doReturn(new InetSocketAddress(InetAddress.getByName(BGP_ID.getValue()), 179)).when(this.speakerListener).remoteAddress();
166 doReturn(new InetSocketAddress(InetAddress.getByName(LOCAL_IP), LOCAL_PORT)).when(this.speakerListener).localAddress();
167 doReturn(this.pipeline).when(this.speakerListener).pipeline();
168 doReturn(this.pipeline).when(this.pipeline).replace(any(ChannelHandler.class), any(String.class), any(ChannelHandler.class));
169 doReturn(null).when(this.pipeline).replace(Matchers.<Class<ChannelHandler>>any(), any(String.class), any(ChannelHandler.class));
170 doReturn(this.pipeline).when(this.pipeline).addLast(any(ChannelHandler.class));
171 final ChannelFuture futureChannel = mock(ChannelFuture.class);
172 doReturn(null).when(futureChannel).addListener(any());
173 doReturn(futureChannel).when(this.speakerListener).close();
174 doReturn(futureChannel).when(this.speakerListener).writeAndFlush(any(Notify.class));
175 doReturn(this.domChain).when(this.domBroker).createTransactionChain(any());
176 doReturn(this.tx).when(this.domChain).newWriteOnlyTransaction();
177 final DOMDataTreeChangeService dOMDataTreeChangeService = mock(DOMDataTreeChangeService.class);
178 final ListenerRegistration listener = mock(ListenerRegistration.class);
179 Mockito.doReturn(listener).when(dOMDataTreeChangeService).registerDataTreeChangeListener(any(), any());
180 Mockito.doNothing().when(listener).close();
182 Mockito.doReturn(Collections.singletonMap(DOMDataTreeChangeService.class, dOMDataTreeChangeService))
183 .when(this.domBroker).getSupportedExtensions();
184 Mockito.doNothing().when(this.tx).merge(eq(LogicalDatastoreType.OPERATIONAL),
185 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
186 Mockito.doNothing().when(this.tx).put(Mockito.eq(LogicalDatastoreType.OPERATIONAL),
187 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
188 Mockito.doNothing().when(this.tx).delete(Mockito.any(LogicalDatastoreType.class), Mockito.any(YangInstanceIdentifier.class));
189 final CheckedFuture future = mock(CheckedFuture.class);
190 Mockito.doAnswer(new Answer<Void>() {
192 public Void answer(final InvocationOnMock invocation) throws Throwable {
193 final Runnable callback = (Runnable) invocation.getArguments()[0];
197 }).when(future).addListener(Mockito.any(Runnable.class), Mockito.any(Executor.class));
198 Mockito.doReturn(future).when(this.tx).submit();
199 Mockito.doReturn(mock(Optional.class)).when(future).checkedGet();
203 public void testHandleMessageAfterException() throws InterruptedException {
204 final Map<TablesKey, PathSelectionMode> pathTables = ImmutableMap.of(TABLES_KEY,
205 BasePathSelectionModeFactory.createBestPathSelectionStrategy());
206 final RIBImpl ribImpl = new RIBImpl(this.clusterSingletonServiceProvider, new RibId(RIB_ID), AS_NUMBER,
207 new BgpId(RIB_ID), null, this.ribExtension, this.serverDispatcher, this.mappingService.getCodecFactory(),
208 this.domBroker, ImmutableList.of(this.ipv4tt), pathTables, this.ribExtension.getClassLoadingStrategy(),
210 ribImpl.instantiateServiceInstance();
211 ribImpl.onGlobalContextUpdated(this.schemaContext);
213 final BGPPeer bgpPeer = new BGPPeer(LOCAL_IP, ribImpl, PeerRole.Ibgp, null, AFI_SAFIS_ADVERTIZED,
214 Collections.emptySet());
215 bgpPeer.instantiateServiceInstance();
216 final BGPSessionImpl bgpSession = new BGPSessionImpl(bgpPeer, this.speakerListener, this.classicOpen, this.classicOpen.getHoldTimer(), null);
217 bgpSession.setChannelExtMsgCoder(this.classicOpen);
218 bgpPeer.onSessionUp(bgpSession);
220 final List<Ipv4Prefix> prefs = Lists.newArrayList(new Ipv4Prefix("8.0.1.0/28"), new Ipv4Prefix("127.0.0.1/32"), new Ipv4Prefix("2.2.2.2/24"));
221 final UpdateBuilder wrongMessage = new UpdateBuilder();
222 wrongMessage.setNlri(new NlriBuilder().setNlri(prefs).build());
223 final Origin origin = new OriginBuilder().setValue(BgpOrigin.Igp).build();
224 final AsPath asPath = new AsPathBuilder().setSegments(Collections.emptyList()).build();
225 final CNextHop nextHop = new Ipv4NextHopCaseBuilder().setIpv4NextHop(new Ipv4NextHopBuilder().setGlobal(new Ipv4Address("127.0.0.1")).build()).build();
226 final AttributesBuilder ab = new AttributesBuilder();
227 wrongMessage.setAttributes(ab.setOrigin(origin).setAsPath(asPath).setCNextHop(nextHop).build());
229 final UpdateBuilder correct = new UpdateBuilder(wrongMessage.build());
230 correct.setAttributes(ab.setLocalPref(new LocalPrefBuilder().setPref((long) 100).build()).build());
232 bgpSession.handleMessage(correct.build());
233 Mockito.verify(this.tx, times(4)).merge(eq(LogicalDatastoreType.OPERATIONAL), any(YangInstanceIdentifier.class), any(NormalizedNode.class));
234 bgpSession.handleMessage(wrongMessage.build());
235 Mockito.verify(this.tx, times(4)).merge(eq(LogicalDatastoreType.OPERATIONAL), any(YangInstanceIdentifier.class), any(NormalizedNode.class));
236 bgpSession.handleMessage(new UpdateBuilder().build());
237 Mockito.verify(this.tx, times(4)).merge(eq(LogicalDatastoreType.OPERATIONAL), any(YangInstanceIdentifier.class), any(NormalizedNode.class));
238 Mockito.verify(this.tx).delete(eq(LogicalDatastoreType.OPERATIONAL), eq(PEER_PATH));
239 Mockito.verify(this.tx, times(0)).merge(eq(LogicalDatastoreType.OPERATIONAL), eq(TABLE_PATH),
240 eq(ImmutableNodes.leafNode(ATTRIBUTES_UPTODATE_FALSE.getNodeType(), Boolean.TRUE)));
244 public void testUseCase1() throws InterruptedException {
245 final Map<TablesKey, PathSelectionMode> pathTables = ImmutableMap.of(TABLES_KEY,
246 BasePathSelectionModeFactory.createBestPathSelectionStrategy());
247 final RIBImpl ribImpl = new RIBImpl(this.clusterSingletonServiceProvider, new RibId(RIB_ID), AS_NUMBER,
248 new BgpId(RIB_ID), null, this.ribExtension, this.serverDispatcher, this.mappingService.getCodecFactory(),
249 this.domBroker, ImmutableList.of(this.ipv4tt), pathTables, this.ribExtension.getClassLoadingStrategy(),
251 ribImpl.instantiateServiceInstance();
252 ribImpl.onGlobalContextUpdated(this.schemaContext);
254 final BGPPeer bgpPeer = new BGPPeer(LOCAL_IP, ribImpl, PeerRole.Ibgp, null, AFI_SAFIS_ADVERTIZED,
255 Collections.emptySet());
256 bgpPeer.instantiateServiceInstance();
257 final BGPSessionImpl bgpSession = new BGPSessionImpl(bgpPeer, this.speakerListener, this.classicOpen, this.classicOpen.getHoldTimer(), null);
258 bgpSession.setChannelExtMsgCoder(this.classicOpen);
259 bgpPeer.onSessionUp(bgpSession);
261 final List<Ipv4Prefix> prefs = Lists.newArrayList(new Ipv4Prefix("8.0.1.0/28"), new Ipv4Prefix("127.0.0.1/32"), new Ipv4Prefix("2.2.2.2/24"));
262 final UpdateBuilder wrongMessage = new UpdateBuilder();
263 wrongMessage.setNlri(new NlriBuilder().setNlri(prefs).build());
264 final Origin origin = new OriginBuilder().setValue(BgpOrigin.Igp).build();
265 final AsPath asPath = new AsPathBuilder().setSegments(Collections.emptyList()).build();
266 final CNextHop nextHop = new Ipv4NextHopCaseBuilder().setIpv4NextHop(new Ipv4NextHopBuilder().setGlobal(new Ipv4Address("127.0.0.1")).build()).build();
267 final AttributesBuilder ab = new AttributesBuilder();
268 wrongMessage.setAttributes(ab.setOrigin(origin).setAsPath(asPath).setCNextHop(nextHop).build());
270 final UpdateBuilder correct = new UpdateBuilder(wrongMessage.build());
271 correct.setAttributes(ab.setLocalPref(new LocalPrefBuilder().setPref((long) 100).build()).build());
273 bgpSession.handleMessage(correct.build());
274 Mockito.verify(this.tx, times(4)).merge(eq(LogicalDatastoreType.OPERATIONAL), any(YangInstanceIdentifier.class), any(NormalizedNode.class));
275 bgpSession.handleMessage(new UpdateBuilder().build());
276 Mockito.verify(this.tx, times(5)).merge(eq(LogicalDatastoreType.OPERATIONAL), any(YangInstanceIdentifier.class), any(NormalizedNode.class));
278 Mockito.verify(this.tx).merge(eq(LogicalDatastoreType.OPERATIONAL), eq(TABLE_PATH),
279 eq(ImmutableNodes.leafNode(ATTRIBUTES_UPTODATE_FALSE.getNodeType(), Boolean.TRUE)));
280 Mockito.verify(this.tx, times(0)).delete(eq(LogicalDatastoreType.OPERATIONAL), eq(PEER_PATH));