Rework BGP timers to work with channel
[bgpcep.git] / bgp / rib-impl / src / test / java / org / opendaylight / protocol / bgp / rib / impl / FSMTest.java
1 /*
2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
3  *
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
7  */
8 package org.opendaylight.protocol.bgp.rib.impl;
9
10 import static org.junit.Assert.assertEquals;
11 import static org.junit.Assert.assertTrue;
12 import static org.mockito.Matchers.any;
13 import static org.mockito.Mockito.doAnswer;
14 import static org.mockito.Mockito.doReturn;
15 import static org.mockito.Mockito.mock;
16
17 import com.google.common.collect.Lists;
18 import io.netty.channel.Channel;
19 import io.netty.channel.ChannelFuture;
20 import io.netty.channel.ChannelHandler;
21 import io.netty.channel.ChannelPipeline;
22 import io.netty.channel.EventLoop;
23 import io.netty.util.concurrent.DefaultPromise;
24 import io.netty.util.concurrent.GenericFutureListener;
25 import io.netty.util.concurrent.GlobalEventExecutor;
26 import java.net.InetAddress;
27 import java.net.InetSocketAddress;
28 import java.net.UnknownHostException;
29 import java.util.List;
30 import java.util.concurrent.TimeUnit;
31 import org.junit.After;
32 import org.junit.Before;
33 import org.junit.Test;
34 import org.mockito.Mock;
35 import org.mockito.MockitoAnnotations;
36 import org.mockito.invocation.InvocationOnMock;
37 import org.mockito.stubbing.Answer;
38 import org.opendaylight.protocol.bgp.parser.BGPError;
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.rev100924.AsNumber;
43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress;
44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Address;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev131125.LinkstateAddressFamily;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev131125.LinkstateSubsequentAddressFamily;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Keepalive;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.KeepaliveBuilder;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Notify;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Open;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.OpenBuilder;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.ProtocolVersion;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.BgpParameters;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.BgpParametersBuilder;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.bgp.parameters.c.parameters.As4BytesCaseBuilder;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.bgp.parameters.c.parameters.as4.bytes._case.As4BytesCapabilityBuilder;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.BgpTableType;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.open.bgp.parameters.c.parameters.MultiprotocolCaseBuilder;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.open.bgp.parameters.c.parameters.multiprotocol._case.MultiprotocolCapabilityBuilder;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Ipv4AddressFamily;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.UnicastSubsequentAddressFamily;
62 import org.opendaylight.yangtools.yang.binding.Notification;
63
64 public class FSMTest {
65
66
67     @Mock
68     private EventLoop eventLoop;
69
70     private BGPClientSessionNegotiator clientSession;
71
72     @Mock
73     private Channel speakerListener;
74
75     @Mock
76     private ChannelPipeline pipeline;
77
78     private final BgpTableType ipv4tt = new BgpTableTypeImpl(Ipv4AddressFamily.class, UnicastSubsequentAddressFamily.class);
79
80     private final BgpTableType linkstatett = new BgpTableTypeImpl(LinkstateAddressFamily.class, LinkstateSubsequentAddressFamily.class);
81
82     private final List<Notification> receivedMsgs = Lists.newArrayList();
83
84     private Open classicOpen;
85
86     @Before
87     public void setUp() throws UnknownHostException {
88         MockitoAnnotations.initMocks(this);
89         final List<BgpParameters> tlvs = Lists.newArrayList();
90
91         tlvs.add(new BgpParametersBuilder().setCParameters(
92             new MultiprotocolCaseBuilder().setMultiprotocolCapability(
93                 new MultiprotocolCapabilityBuilder().setAfi(this.ipv4tt.getAfi()).setSafi(this.ipv4tt.getSafi()).build()).build()).build());
94         tlvs.add(new BgpParametersBuilder().setCParameters(
95             new MultiprotocolCaseBuilder().setMultiprotocolCapability(
96                 new MultiprotocolCapabilityBuilder().setAfi(this.linkstatett.getAfi()).setSafi(this.linkstatett.getSafi()).build()).build()).build());
97         tlvs.add(new BgpParametersBuilder().setCParameters(new As4BytesCaseBuilder().setAs4BytesCapability(new As4BytesCapabilityBuilder().setAsNumber(
98             new AsNumber(30L)).build()).build()).build());
99         final BGPSessionPreferences prefs = new BGPSessionPreferences(new AsNumber(30L), (short) 3, new Ipv4Address("1.1.1.1"), tlvs);
100
101         final ChannelFuture f = mock(ChannelFuture.class);
102         doReturn(null).when(f).addListener(any(GenericFutureListener.class));
103
104         final InetAddress peerAddress = InetAddress.getByName("1.1.1.2");
105         final BGPPeerRegistry peerRegistry = new StrictBGPPeerRegistry();
106         peerRegistry.addPeer(new IpAddress(new Ipv4Address(peerAddress.getHostAddress())), new SimpleSessionListener(), prefs);
107
108         this.clientSession = new BGPClientSessionNegotiator(new DefaultPromise<BGPSessionImpl>(GlobalEventExecutor.INSTANCE), this.speakerListener, peerRegistry, new BGPClientSessionValidator(new AsNumber(30L)));
109         doAnswer(new Answer<Object>() {
110             @Override
111             public Object answer(final InvocationOnMock invocation) {
112                 final Object[] args = invocation.getArguments();
113                 FSMTest.this.receivedMsgs.add((Notification) args[0]);
114                 return f;
115             }
116         }).when(this.speakerListener).writeAndFlush(any(Notification.class));
117         doReturn(this.eventLoop).when(this.speakerListener).eventLoop();
118         doReturn(null).when(this.eventLoop).schedule(any(Runnable.class), any(long.class), any(TimeUnit.class));
119         doReturn("TestingChannel").when(this.speakerListener).toString();
120         doReturn(new InetSocketAddress(peerAddress, 179)).when(this.speakerListener).remoteAddress();
121         doReturn(this.pipeline).when(this.speakerListener).pipeline();
122         doReturn(this.pipeline).when(this.pipeline).replace(any(ChannelHandler.class), any(String.class), any(ChannelHandler.class));
123         doReturn(mock(ChannelFuture.class)).when(this.speakerListener).close();
124         this.classicOpen = new OpenBuilder().setMyAsNumber(30).setHoldTimer(3).setVersion(new ProtocolVersion((short) 4)).setBgpParameters(
125             tlvs).setBgpIdentifier(new Ipv4Address("1.1.1.2")).build();
126     }
127
128     @Test
129     public void testAccSessionChar() throws InterruptedException {
130         this.clientSession.channelActive(null);
131         assertEquals(1, this.receivedMsgs.size());
132         assertTrue(this.receivedMsgs.get(0) instanceof Open);
133         this.clientSession.handleMessage(this.classicOpen);
134         assertEquals(2, this.receivedMsgs.size());
135         assertTrue(this.receivedMsgs.get(1) instanceof Keepalive);
136         this.clientSession.handleMessage(new KeepaliveBuilder().build());
137         assertEquals(this.clientSession.getState(), BGPClientSessionNegotiator.State.Finished);
138         Thread.sleep(1000);
139         Thread.sleep(100);
140     }
141
142     @Test
143     public void testNotAccChars() throws InterruptedException {
144         this.clientSession.channelActive(null);
145         assertEquals(1, this.receivedMsgs.size());
146         assertTrue(this.receivedMsgs.get(0) instanceof Open);
147         this.clientSession.handleMessage(new OpenBuilder().setMyAsNumber(30).setHoldTimer(1).setVersion(new ProtocolVersion((short) 4)).build());
148         assertEquals(2, this.receivedMsgs.size());
149         assertTrue(this.receivedMsgs.get(1) instanceof Notify);
150         final Notification m = this.receivedMsgs.get(this.receivedMsgs.size() - 1);
151         assertEquals(BGPError.UNSPECIFIC_OPEN_ERROR, BGPError.forValue(((Notify) m).getErrorCode(), ((Notify) m).getErrorSubcode()));
152     }
153
154     @Test
155     public void testNoAs4BytesCapability() {
156         this.clientSession.channelActive(null);
157         assertEquals(1, this.receivedMsgs.size());
158         assertTrue(this.receivedMsgs.get(0) instanceof Open);
159
160         final List<BgpParameters> tlvs = Lists.newArrayList();
161         tlvs.add(new BgpParametersBuilder().setCParameters(
162             new MultiprotocolCaseBuilder().setMultiprotocolCapability(
163                 new MultiprotocolCapabilityBuilder().setAfi(this.ipv4tt.getAfi()).setSafi(this.ipv4tt.getSafi()).build()).build()).build());
164         // Open Message without advertised four-octet AS Number capability
165         this.clientSession.handleMessage(new OpenBuilder().setMyAsNumber(30).setHoldTimer(1).setVersion(new ProtocolVersion((short) 4)).setBgpParameters(tlvs).build());
166         assertEquals(2, this.receivedMsgs.size());
167         assertTrue(this.receivedMsgs.get(1) instanceof Notify);
168         final Notification m = this.receivedMsgs.get(this.receivedMsgs.size() - 1);
169         assertEquals(BGPError.UNSPECIFIC_OPEN_ERROR, BGPError.forValue(((Notify) m).getErrorCode(), ((Notify) m).getErrorSubcode()));
170     }
171
172     @Test
173     public void sendNotification() {
174         this.clientSession.channelActive(null);
175         this.clientSession.handleMessage(this.classicOpen);
176         this.clientSession.handleMessage(new KeepaliveBuilder().build());
177         assertEquals(this.clientSession.getState(), BGPClientSessionNegotiator.State.Finished);
178         this.clientSession.handleMessage(new OpenBuilder().setMyAsNumber(30).setHoldTimer(3).setVersion(new ProtocolVersion((short) 4)).build());
179         assertEquals(3, this.receivedMsgs.size());
180         assertTrue(this.receivedMsgs.get(2) instanceof Notify);
181         final Notification m = this.receivedMsgs.get(2);
182         assertEquals(BGPError.FSM_ERROR.getCode(), ((Notify) m).getErrorCode().shortValue());
183         assertEquals(BGPError.FSM_ERROR.getSubcode(), ((Notify) m).getErrorSubcode().shortValue());
184     }
185
186     @After
187     public void tearDown() {
188
189     }
190 }