2 * Copyright (c) 2013 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.junit.Assert.assertEquals;
11 import static org.junit.Assert.assertNotNull;
12 import static org.junit.Assert.assertTrue;
13 import static org.mockito.ArgumentMatchers.any;
14 import static org.mockito.Mockito.doAnswer;
15 import static org.mockito.Mockito.doReturn;
16 import static org.mockito.Mockito.mock;
18 import com.google.common.collect.Lists;
19 import io.netty.channel.Channel;
20 import io.netty.channel.ChannelFuture;
21 import io.netty.channel.ChannelHandler;
22 import io.netty.channel.ChannelPipeline;
23 import io.netty.channel.EventLoop;
24 import io.netty.util.concurrent.DefaultPromise;
25 import io.netty.util.concurrent.GenericFutureListener;
26 import io.netty.util.concurrent.GlobalEventExecutor;
27 import java.net.InetAddress;
28 import java.net.InetSocketAddress;
29 import java.net.UnknownHostException;
30 import java.util.List;
31 import java.util.concurrent.TimeUnit;
32 import org.junit.Before;
33 import org.junit.Test;
34 import org.mockito.ArgumentMatchers;
35 import org.mockito.Mock;
36 import org.mockito.MockitoAnnotations;
37 import org.opendaylight.protocol.bgp.parser.BGPError;
38 import org.opendaylight.protocol.bgp.parser.BgpExtendedMessageUtil;
39 import org.opendaylight.protocol.bgp.parser.BgpTableTypeImpl;
40 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPPeerRegistry;
41 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPSessionPreferences;
42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.LinkstateAddressFamily;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.LinkstateSubsequentAddressFamily;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.Keepalive;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.KeepaliveBuilder;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.Notify;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.Open;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.OpenBuilder;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.ProtocolVersion;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.BgpParameters;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.BgpParametersBuilder;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.bgp.parameters.OptionalCapabilities;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.bgp.parameters.OptionalCapabilitiesBuilder;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.bgp.parameters.optional.capabilities.CParametersBuilder;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.bgp.parameters.optional.capabilities.c.parameters.As4BytesCapabilityBuilder;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.BgpTableType;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.CParameters1;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.CParameters1Builder;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.GracefulRestartCapabilityBuilder;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.MultiprotocolCapabilityBuilder;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.BgpId;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.Ipv4AddressFamily;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.UnicastSubsequentAddressFamily;
67 import org.opendaylight.yangtools.yang.binding.Notification;
69 public class FSMTest {
73 private EventLoop eventLoop;
75 private BGPClientSessionNegotiator clientSession;
78 private Channel speakerListener;
81 private ChannelPipeline pipeline;
83 private final BgpTableType ipv4tt
84 = new BgpTableTypeImpl(Ipv4AddressFamily.class, UnicastSubsequentAddressFamily.class);
86 private final BgpTableType linkstatett
87 = new BgpTableTypeImpl(LinkstateAddressFamily.class, LinkstateSubsequentAddressFamily.class);
89 private final List<Notification> receivedMsgs = Lists.newArrayList();
91 private Open classicOpen;
94 public void setUp() throws UnknownHostException {
95 MockitoAnnotations.initMocks(this);
96 final List<BgpParameters> tlvs = Lists.newArrayList();
97 final List<OptionalCapabilities> capas = Lists.newArrayList();
99 capas.add(new OptionalCapabilitiesBuilder()
100 .setCParameters(new CParametersBuilder().addAugmentation(CParameters1.class,
101 new CParameters1Builder().setMultiprotocolCapability(new MultiprotocolCapabilityBuilder()
102 .setAfi(this.ipv4tt.getAfi()).setSafi(this.ipv4tt.getSafi()).build()).build())
104 capas.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder()
105 .addAugmentation(CParameters1.class,
106 new CParameters1Builder().setMultiprotocolCapability(new MultiprotocolCapabilityBuilder()
107 .setAfi(this.linkstatett.getAfi()).setSafi(this.linkstatett.getSafi())
108 .build()).build()).build()).build());
109 capas.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().setAs4BytesCapability(
110 new As4BytesCapabilityBuilder().setAsNumber(new AsNumber(30L)).build()).build()).build());
111 capas.add(new OptionalCapabilitiesBuilder()
112 .setCParameters(BgpExtendedMessageUtil.EXTENDED_MESSAGE_CAPABILITY).build());
113 capas.add(new OptionalCapabilitiesBuilder()
114 .setCParameters(new CParametersBuilder().addAugmentation(CParameters1.class,
115 new CParameters1Builder().setGracefulRestartCapability(new GracefulRestartCapabilityBuilder()
116 .build()).build()).build()).build());
119 tlvs.add(new BgpParametersBuilder().setOptionalCapabilities(capas).build());
120 final BGPSessionPreferences prefs = new BGPSessionPreferences(new AsNumber(30L), (short) 3,
121 new BgpId("1.1.1.1"), new AsNumber(30L), tlvs);
123 final ChannelFuture f = mock(ChannelFuture.class);
124 doReturn(null).when(f).addListener(any(GenericFutureListener.class));
126 final InetAddress peerAddress = InetAddress.getByName("1.1.1.2");
127 doAnswer(invocation -> {
128 final Object[] args = invocation.getArguments();
129 FSMTest.this.receivedMsgs.add((Notification) args[0]);
131 }).when(this.speakerListener).writeAndFlush(any(Notification.class));
132 doReturn(this.eventLoop).when(this.speakerListener).eventLoop();
133 doReturn(null).when(this.eventLoop).schedule(any(Runnable.class), any(long.class),
134 any(TimeUnit.class));
135 doReturn("TestingChannel").when(this.speakerListener).toString();
136 doReturn(new InetSocketAddress(peerAddress, 179)).when(this.speakerListener).remoteAddress();
137 doReturn(new InetSocketAddress(peerAddress, 179)).when(this.speakerListener).localAddress();
138 doReturn(this.pipeline).when(this.speakerListener).pipeline();
139 doReturn(this.pipeline).when(this.pipeline).replace(any(ChannelHandler.class), any(String.class),
140 any(ChannelHandler.class));
141 doReturn(null).when(this.pipeline).replace(ArgumentMatchers.<Class<ChannelHandler>>any(), any(String.class),
142 any(ChannelHandler.class));
143 doReturn(this.pipeline).when(this.pipeline).addLast(any(ChannelHandler.class));
144 doReturn(mock(ChannelFuture.class)).when(this.speakerListener).close();
146 final BGPPeerRegistry peerRegistry = new StrictBGPPeerRegistry();
147 peerRegistry.addPeer(new IpAddress(new Ipv4Address(peerAddress.getHostAddress())),
148 new SimpleSessionListener(), prefs);
150 this.clientSession = new BGPClientSessionNegotiator(new DefaultPromise<>(GlobalEventExecutor.INSTANCE),
151 this.speakerListener, peerRegistry);
153 this.classicOpen = new OpenBuilder().setMyAsNumber(30).setHoldTimer(3)
154 .setVersion(new ProtocolVersion((short) 4)).setBgpParameters(
155 tlvs).setBgpIdentifier(new Ipv4Address("1.1.1.2")).build();
159 public void testDenyPeer() {
160 this.clientSession = new BGPClientSessionNegotiator(new DefaultPromise<>(GlobalEventExecutor.INSTANCE),
161 this.speakerListener, new StrictBGPPeerRegistry());
162 this.clientSession.channelActive(null);
163 assertEquals(1, this.receivedMsgs.size());
164 assertTrue(this.receivedMsgs.get(0) instanceof Notify);
168 public void testAccSessionChar() {
169 this.clientSession.channelActive(null);
170 assertEquals(1, this.receivedMsgs.size());
171 assertTrue(this.receivedMsgs.get(0) instanceof Open);
172 this.clientSession.handleMessage(this.classicOpen);
173 assertEquals(2, this.receivedMsgs.size());
174 assertTrue(this.receivedMsgs.get(1) instanceof Keepalive);
175 this.clientSession.handleMessage(new KeepaliveBuilder().build());
176 assertEquals(this.clientSession.getState(), BGPClientSessionNegotiator.State.FINISHED);
180 public void testNotAccChars() {
181 this.clientSession.channelActive(null);
182 assertEquals(1, this.receivedMsgs.size());
183 assertTrue(this.receivedMsgs.get(0) instanceof Open);
184 this.clientSession.handleMessage(new OpenBuilder().setMyAsNumber(30)
186 .setBgpIdentifier(new Ipv4Address("127.0.0.1")).setVersion(new ProtocolVersion((short) 4)).build());
187 assertEquals(2, this.receivedMsgs.size());
188 assertTrue(this.receivedMsgs.get(1) instanceof Notify);
189 final Notification m = this.receivedMsgs.get(this.receivedMsgs.size() - 1);
190 assertEquals(BGPError.UNSPECIFIC_OPEN_ERROR,
191 BGPError.forValue(((Notify) m).getErrorCode(), ((Notify) m).getErrorSubcode()));
195 public void testNoAs4BytesCapability() {
196 this.clientSession.channelActive(null);
197 assertEquals(1, this.receivedMsgs.size());
198 assertTrue(this.receivedMsgs.get(0) instanceof Open);
200 final List<BgpParameters> tlvs = Lists.newArrayList();
201 final List<OptionalCapabilities> capas = Lists.newArrayList();
202 capas.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder()
203 .addAugmentation(CParameters1.class,
204 new CParameters1Builder().setMultiprotocolCapability(new MultiprotocolCapabilityBuilder()
205 .setAfi(this.ipv4tt.getAfi()).setSafi(this.ipv4tt.getSafi())
206 .build()).build()).build()).build());
207 capas.add(new OptionalCapabilitiesBuilder()
208 .setCParameters(BgpExtendedMessageUtil.EXTENDED_MESSAGE_CAPABILITY).build());
209 tlvs.add(new BgpParametersBuilder().setOptionalCapabilities(capas).build());
210 // Open Message without advertised four-octet AS Number capability
211 this.clientSession.handleMessage(new OpenBuilder().setMyAsNumber(30).setHoldTimer(1).setVersion(
212 new ProtocolVersion((short) 4)).setBgpParameters(tlvs)
213 .setBgpIdentifier(new Ipv4Address("1.1.1.2")).build());
214 assertEquals(2, this.receivedMsgs.size());
215 assertTrue(this.receivedMsgs.get(1) instanceof Notify);
216 final Notification m = this.receivedMsgs.get(this.receivedMsgs.size() - 1);
217 assertEquals(BGPError.UNSUPPORTED_CAPABILITY,
218 BGPError.forValue(((Notify) m).getErrorCode(), ((Notify) m).getErrorSubcode()));
219 assertNotNull(((Notify) m).getData());
223 public void testBgpExtendedMessageCapability() {
224 this.clientSession.channelActive(null);
225 assertEquals(1, this.receivedMsgs.size());
226 assertTrue(this.receivedMsgs.get(0) instanceof Open);
228 final List<BgpParameters> tlvs = Lists.newArrayList();
229 final List<OptionalCapabilities> capas = Lists.newArrayList();
230 capas.add(new OptionalCapabilitiesBuilder()
231 .setCParameters(new CParametersBuilder().addAugmentation(CParameters1.class,
232 new CParameters1Builder().setMultiprotocolCapability(new MultiprotocolCapabilityBuilder()
233 .setAfi(this.ipv4tt.getAfi()).setSafi(this.ipv4tt.getSafi()).build()).build())
235 capas.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().setAs4BytesCapability(
236 new As4BytesCapabilityBuilder().setAsNumber(new AsNumber(30L)).build()).build()).build());
237 tlvs.add(new BgpParametersBuilder().setOptionalCapabilities(capas).build());
238 this.clientSession.handleMessage(new OpenBuilder().setMyAsNumber(30).setHoldTimer(1).setVersion(
239 new ProtocolVersion((short) 4)).setBgpParameters(tlvs)
240 .setBgpIdentifier(new Ipv4Address("1.1.1.2")).build());
241 assertEquals(2, this.receivedMsgs.size());
242 assertTrue(this.receivedMsgs.get(1) instanceof Keepalive);
246 public void sendNotification() {
247 this.clientSession.channelActive(null);
248 this.clientSession.handleMessage(this.classicOpen);
249 this.clientSession.handleMessage(new KeepaliveBuilder().build());
250 assertEquals(this.clientSession.getState(), BGPClientSessionNegotiator.State.FINISHED);
251 this.clientSession.handleMessage(new OpenBuilder().setMyAsNumber(30)
252 .setHoldTimer(3).setVersion(new ProtocolVersion((short) 4)).build());
253 assertEquals(3, this.receivedMsgs.size());
254 assertTrue(this.receivedMsgs.get(2) instanceof Notify);
255 final Notification m = this.receivedMsgs.get(2);
256 assertEquals(BGPError.FSM_ERROR.getCode(), ((Notify) m).getErrorCode().shortValue());
257 assertEquals(BGPError.FSM_ERROR.getSubcode(), ((Notify) m).getErrorSubcode().shortValue());
261 public void sameBGPIDs() {
262 this.clientSession.channelActive(null);
263 assertEquals(1, this.receivedMsgs.size());
264 assertTrue(this.receivedMsgs.get(0) instanceof Open);
266 this.clientSession.handleMessage(new OpenBuilder(this.classicOpen)
267 .setBgpIdentifier(new Ipv4Address("1.1.1.1")).build());
268 assertEquals(2, this.receivedMsgs.size());
269 assertTrue(this.receivedMsgs.get(1) instanceof Notify);
270 final Notification m = this.receivedMsgs.get(this.receivedMsgs.size() - 1);
271 assertEquals(BGPError.BAD_BGP_ID, BGPError.forValue(((Notify) m).getErrorCode(),
272 ((Notify) m).getErrorSubcode()));