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.Matchers.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.After;
33 import org.junit.Before;
34 import org.junit.Test;
35 import org.mockito.Matchers;
36 import org.mockito.Mock;
37 import org.mockito.MockitoAnnotations;
38 import org.mockito.invocation.InvocationOnMock;
39 import org.mockito.stubbing.Answer;
40 import org.opendaylight.protocol.bgp.parser.BGPError;
41 import org.opendaylight.protocol.bgp.parser.BgpExtendedMessageUtil;
42 import org.opendaylight.protocol.bgp.parser.BgpTableTypeImpl;
43 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPPeerRegistry;
44 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPSessionPreferences;
45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
46 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
47 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.LinkstateAddressFamily;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.LinkstateSubsequentAddressFamily;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Keepalive;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.KeepaliveBuilder;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Notify;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Open;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.OpenBuilder;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.ProtocolVersion;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.BgpParameters;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.BgpParametersBuilder;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.bgp.parameters.OptionalCapabilities;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.bgp.parameters.OptionalCapabilitiesBuilder;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.bgp.parameters.optional.capabilities.CParametersBuilder;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.bgp.parameters.optional.capabilities.c.parameters.As4BytesCapabilityBuilder;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.BgpTableType;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.CParameters1;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.CParameters1Builder;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.mp.capabilities.GracefulRestartCapabilityBuilder;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.mp.capabilities.MultiprotocolCapabilityBuilder;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Ipv4AddressFamily;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.UnicastSubsequentAddressFamily;
69 import org.opendaylight.yangtools.yang.binding.Notification;
71 public class FSMTest {
75 private EventLoop eventLoop;
77 private BGPClientSessionNegotiator clientSession;
80 private Channel speakerListener;
83 private ChannelPipeline pipeline;
85 private final BgpTableType ipv4tt = new BgpTableTypeImpl(Ipv4AddressFamily.class, UnicastSubsequentAddressFamily.class);
87 private final BgpTableType linkstatett = 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().setCParameters(new CParametersBuilder().addAugmentation(CParameters1.class,
100 new CParameters1Builder().setMultiprotocolCapability(new MultiprotocolCapabilityBuilder()
101 .setAfi(this.ipv4tt.getAfi()).setSafi(this.ipv4tt.getSafi()).build()).build()).build()).build());
102 capas.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().addAugmentation(CParameters1.class,
103 new CParameters1Builder().setMultiprotocolCapability(new MultiprotocolCapabilityBuilder()
104 .setAfi(this.linkstatett.getAfi()).setSafi(this.linkstatett.getSafi()).build()).build()).build()).build());
105 capas.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().setAs4BytesCapability(
106 new As4BytesCapabilityBuilder().setAsNumber(new AsNumber(30L)).build()).build()).build());
107 capas.add(new OptionalCapabilitiesBuilder().setCParameters(BgpExtendedMessageUtil.EXTENDED_MESSAGE_CAPABILITY).build());
108 capas.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().addAugmentation(CParameters1.class,
109 new CParameters1Builder().setGracefulRestartCapability(new GracefulRestartCapabilityBuilder().build()).build()).build()).build());
112 tlvs.add(new BgpParametersBuilder().setOptionalCapabilities(capas).build());
113 final BGPSessionPreferences prefs = new BGPSessionPreferences(new AsNumber(30L), (short) 3, new Ipv4Address("1.1.1.1"), new AsNumber(30L), tlvs);
115 final ChannelFuture f = mock(ChannelFuture.class);
116 doReturn(null).when(f).addListener(any(GenericFutureListener.class));
118 final InetAddress peerAddress = InetAddress.getByName("1.1.1.2");
119 doAnswer(new Answer<Object>() {
121 public Object answer(final InvocationOnMock invocation) {
122 final Object[] args = invocation.getArguments();
123 FSMTest.this.receivedMsgs.add((Notification) args[0]);
126 }).when(this.speakerListener).writeAndFlush(any(Notification.class));
127 doReturn(this.eventLoop).when(this.speakerListener).eventLoop();
128 doReturn(null).when(this.eventLoop).schedule(any(Runnable.class), any(long.class), any(TimeUnit.class));
129 doReturn("TestingChannel").when(this.speakerListener).toString();
130 doReturn(new InetSocketAddress(peerAddress, 179)).when(this.speakerListener).remoteAddress();
131 doReturn(new InetSocketAddress(peerAddress, 179)).when(this.speakerListener).localAddress();
132 doReturn(this.pipeline).when(this.speakerListener).pipeline();
133 doReturn(this.pipeline).when(this.pipeline).replace(any(ChannelHandler.class), any(String.class), any(ChannelHandler.class));
134 doReturn(null).when(this.pipeline).replace(Matchers.<Class<ChannelHandler>>any(), any(String.class), any(ChannelHandler.class));
135 doReturn(this.pipeline).when(this.pipeline).addLast(any(ChannelHandler.class));
136 doReturn(mock(ChannelFuture.class)).when(this.speakerListener).close();
138 final BGPPeerRegistry peerRegistry = new StrictBGPPeerRegistry();
139 peerRegistry.addPeer(new IpAddress(new Ipv4Address(peerAddress.getHostAddress())), new SimpleSessionListener(), prefs);
141 this.clientSession = new BGPClientSessionNegotiator(new DefaultPromise<BGPSessionImpl>(GlobalEventExecutor.INSTANCE), this.speakerListener, peerRegistry);
143 this.classicOpen = new OpenBuilder().setMyAsNumber(30).setHoldTimer(3).setVersion(new ProtocolVersion((short) 4)).setBgpParameters(
144 tlvs).setBgpIdentifier(new Ipv4Address("1.1.1.2")).build();
148 public void testDenyPeer() {
149 this.clientSession = new BGPClientSessionNegotiator(new DefaultPromise<BGPSessionImpl>(GlobalEventExecutor.INSTANCE), this.speakerListener, new StrictBGPPeerRegistry());
150 this.clientSession.channelActive(null);
151 assertEquals(1, this.receivedMsgs.size());
152 assertTrue(this.receivedMsgs.get(0) instanceof Notify);
156 public void testAccSessionChar() throws InterruptedException {
157 this.clientSession.channelActive(null);
158 assertEquals(1, this.receivedMsgs.size());
159 assertTrue(this.receivedMsgs.get(0) instanceof Open);
160 this.clientSession.handleMessage(this.classicOpen);
161 assertEquals(2, this.receivedMsgs.size());
162 assertTrue(this.receivedMsgs.get(1) instanceof Keepalive);
163 this.clientSession.handleMessage(new KeepaliveBuilder().build());
164 assertEquals(this.clientSession.getState(), BGPClientSessionNegotiator.State.FINISHED);
170 public void testNotAccChars() throws InterruptedException {
171 this.clientSession.channelActive(null);
172 assertEquals(1, this.receivedMsgs.size());
173 assertTrue(this.receivedMsgs.get(0) instanceof Open);
174 this.clientSession.handleMessage(new OpenBuilder().setMyAsNumber(30).setHoldTimer(1).setBgpIdentifier(new Ipv4Address("127.0.0.1")).setVersion(new ProtocolVersion((short) 4)).build());
175 assertEquals(2, this.receivedMsgs.size());
176 assertTrue(this.receivedMsgs.get(1) instanceof Notify);
177 final Notification m = this.receivedMsgs.get(this.receivedMsgs.size() - 1);
178 assertEquals(BGPError.UNSPECIFIC_OPEN_ERROR, BGPError.forValue(((Notify) m).getErrorCode(), ((Notify) m).getErrorSubcode()));
182 public void testNoAs4BytesCapability() {
183 this.clientSession.channelActive(null);
184 assertEquals(1, this.receivedMsgs.size());
185 assertTrue(this.receivedMsgs.get(0) instanceof Open);
187 final List<BgpParameters> tlvs = Lists.newArrayList();
188 final List<OptionalCapabilities> capas = Lists.newArrayList();
189 capas.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().addAugmentation(CParameters1.class,
190 new CParameters1Builder().setMultiprotocolCapability(new MultiprotocolCapabilityBuilder()
191 .setAfi(this.ipv4tt.getAfi()).setSafi(this.ipv4tt.getSafi()).build()).build()).build()).build());
192 capas.add(new OptionalCapabilitiesBuilder().setCParameters(BgpExtendedMessageUtil.EXTENDED_MESSAGE_CAPABILITY).build());
193 tlvs.add(new BgpParametersBuilder().setOptionalCapabilities(capas).build());
194 // Open Message without advertised four-octet AS Number capability
195 this.clientSession.handleMessage(new OpenBuilder().setMyAsNumber(30).setHoldTimer(1).setVersion(
196 new ProtocolVersion((short) 4)).setBgpParameters(tlvs).setBgpIdentifier(new Ipv4Address("1.1.1.2")).build());
197 assertEquals(2, this.receivedMsgs.size());
198 assertTrue(this.receivedMsgs.get(1) instanceof Notify);
199 final Notification m = this.receivedMsgs.get(this.receivedMsgs.size() - 1);
200 assertEquals(BGPError.UNSUPPORTED_CAPABILITY, BGPError.forValue(((Notify) m).getErrorCode(), ((Notify) m).getErrorSubcode()));
201 assertNotNull(((Notify) m).getData());
205 public void testBgpExtendedMessageCapability() {
206 this.clientSession.channelActive(null);
207 assertEquals(1, this.receivedMsgs.size());
208 assertTrue(this.receivedMsgs.get(0) instanceof Open);
210 final List<BgpParameters> tlvs = Lists.newArrayList();
211 final List<OptionalCapabilities> capas = Lists.newArrayList();
212 capas.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().addAugmentation(CParameters1.class,
213 new CParameters1Builder().setMultiprotocolCapability(new MultiprotocolCapabilityBuilder()
214 .setAfi(this.ipv4tt.getAfi()).setSafi(this.ipv4tt.getSafi()).build()).build()).build()).build());
215 capas.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().setAs4BytesCapability(
216 new As4BytesCapabilityBuilder().setAsNumber(new AsNumber(30L)).build()).build()).build());
217 tlvs.add(new BgpParametersBuilder().setOptionalCapabilities(capas).build());
218 this.clientSession.handleMessage(new OpenBuilder().setMyAsNumber(30).setHoldTimer(1).setVersion(
219 new ProtocolVersion((short) 4)).setBgpParameters(tlvs).setBgpIdentifier(new Ipv4Address("1.1.1.2")).build());
220 assertEquals(2, this.receivedMsgs.size());
221 assertTrue(this.receivedMsgs.get(1) instanceof Keepalive);
226 public void sendNotification() {
227 this.clientSession.channelActive(null);
228 this.clientSession.handleMessage(this.classicOpen);
229 this.clientSession.handleMessage(new KeepaliveBuilder().build());
230 assertEquals(this.clientSession.getState(), BGPClientSessionNegotiator.State.FINISHED);
231 this.clientSession.handleMessage(new OpenBuilder().setMyAsNumber(30).setHoldTimer(3).setVersion(new ProtocolVersion((short) 4)).build());
232 assertEquals(3, this.receivedMsgs.size());
233 assertTrue(this.receivedMsgs.get(2) instanceof Notify);
234 final Notification m = this.receivedMsgs.get(2);
235 assertEquals(BGPError.FSM_ERROR.getCode(), ((Notify) m).getErrorCode().shortValue());
236 assertEquals(BGPError.FSM_ERROR.getSubcode(), ((Notify) m).getErrorSubcode().shortValue());
240 public void sameBGPIDs() {
241 this.clientSession.channelActive(null);
242 assertEquals(1, this.receivedMsgs.size());
243 assertTrue(this.receivedMsgs.get(0) instanceof Open);
245 this.clientSession.handleMessage(new OpenBuilder(this.classicOpen).setBgpIdentifier(new Ipv4Address("1.1.1.1")).build());
246 assertEquals(2, this.receivedMsgs.size());
247 assertTrue(this.receivedMsgs.get(1) instanceof Notify);
248 final Notification m = this.receivedMsgs.get(this.receivedMsgs.size() - 1);
249 assertEquals(BGPError.BAD_BGP_ID, BGPError.forValue(((Notify) m).getErrorCode(), ((Notify) m).getErrorSubcode()));
253 public void tearDown() {