BUG-5511: Support Route Refresh operation from BGP
[bgpcep.git] / bgp / rib-impl / src / test / java / org / opendaylight / protocol / bgp / rib / impl / PeerTest.java
1 /*
2  * Copyright (c) 2014 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.assertNotNull;
12 import static org.mockito.Matchers.any;
13 import com.google.common.collect.Lists;
14 import io.netty.channel.Channel;
15 import io.netty.channel.ChannelHandler;
16 import io.netty.channel.ChannelPipeline;
17 import io.netty.channel.DefaultChannelPromise;
18 import io.netty.channel.EventLoop;
19 import java.net.InetSocketAddress;
20 import java.util.HashMap;
21 import java.util.List;
22 import java.util.Map;
23 import java.util.concurrent.TimeUnit;
24 import org.junit.Assert;
25 import org.junit.Before;
26 import org.junit.Test;
27 import org.mockito.Mockito;
28 import org.mockito.invocation.InvocationOnMock;
29 import org.mockito.stubbing.Answer;
30 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
31 import org.opendaylight.protocol.bgp.rib.spi.RibSupportUtils;
32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Address;
33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Prefix;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.routes.ipv4.routes.Ipv4Route;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.KeepaliveBuilder;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.OpenBuilder;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.UpdateBuilder;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.BgpParameters;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.BgpParametersBuilder;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.bgp.parameters.OptionalCapabilitiesBuilder;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.bgp.parameters.optional.capabilities.CParametersBuilder;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.AttributesBuilder;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.update.message.NlriBuilder;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.update.message.WithdrawnRoutesBuilder;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.Attributes2;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.Attributes2Builder;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.CParameters1;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.CParameters1Builder;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.RouteRefreshBuilder;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.mp.capabilities.MultiprotocolCapabilityBuilder;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpUnreachNlriBuilder;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.ApplicationRibId;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerRole;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.LocRib;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.Tables;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Ipv4AddressFamily;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Ipv6AddressFamily;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.UnicastSubsequentAddressFamily;
59 import org.opendaylight.yangtools.yang.binding.Notification;
60 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
61 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
62 import org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType;
63
64 public class PeerTest extends AbstractRIBTestSetup {
65
66     private ApplicationPeer peer;
67
68     private BGPSessionImpl session;
69
70     private Map<YangInstanceIdentifier, NormalizedNode<?,?>> routes;
71
72     private BGPPeer classic;
73
74     @Override
75     @Before
76     public void setUp() throws Exception {
77         super.setUp();
78         this.routes = new HashMap<>();
79         overrideMockedBehaviour();
80     }
81
82     private void overrideMockedBehaviour() {
83         Mockito.doAnswer(new Answer<Object>() {
84             @Override
85             public Object answer(final InvocationOnMock invocation) throws Throwable {
86                 final Object[] args = invocation.getArguments();
87                 final NormalizedNode<?,?>node = (NormalizedNode<?,?>)args[2];
88                 if (node.getIdentifier().getNodeType().equals(Ipv4Route.QNAME) || node.getNodeType().equals(IPv4RIBSupport.PREFIX_QNAME)) {
89                     PeerTest.this.routes.put((YangInstanceIdentifier) args[1], node);
90                 }
91                 return args[1];
92             }
93         }).when(getTransaction()).put(Mockito.eq(LogicalDatastoreType.OPERATIONAL), Mockito.any(YangInstanceIdentifier.class), Mockito.any(NormalizedNode.class));
94
95         Mockito.doAnswer(new Answer<Object>() {
96             @Override
97             public Object answer(final InvocationOnMock invocation) throws Throwable {
98                 final Object[] args = invocation.getArguments();
99                 PeerTest.this.routes.remove(args[1]);
100                 return args[1];
101             }
102         }).when(getTransaction()).delete(Mockito.eq(LogicalDatastoreType.OPERATIONAL), Mockito.any(YangInstanceIdentifier.class));
103     }
104
105
106     @Test
107     public void testAppPeer() {
108         final Ipv4Prefix first = new Ipv4Prefix("127.0.0.2/32");
109         final Ipv4Prefix second = new Ipv4Prefix("127.0.0.1/32");
110         final Ipv4Prefix third = new Ipv4Prefix("127.0.0.3/32");
111         this.peer = new ApplicationPeer(new ApplicationRibId("t"), new Ipv4Address("127.0.0.1"), getRib());
112         final YangInstanceIdentifier base = getRib().getYangRibId().node(LocRib.QNAME).node(Tables.QNAME).node(RibSupportUtils.toYangTablesKey(KEY));
113         this.peer.onDataTreeChanged(ipv4Input(base, ModificationType.WRITE, first, second, third));
114         assertEquals(3, this.routes.size());
115
116         this.peer.onDataTreeChanged(ipv4Input(base, ModificationType.DELETE, third));
117         assertEquals(2, this.routes.size());
118     }
119
120     @Test
121     public void testClassicPeer() throws Exception {
122         this.classic = new BGPPeer("testPeer", getRib(), PeerRole.Ibgp, null);
123         this.mockSession();
124         assertEquals("testPeer", this.classic.getName());
125         this.classic.onSessionUp(this.session);
126         Assert.assertArrayEquals(new byte[] {1, 1, 1, 1}, this.classic.getRawIdentifier());
127         assertEquals("BGPPeer{name=testPeer, tables=[TablesKey [_afi=class org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Ipv4AddressFamily, _safi=class org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.UnicastSubsequentAddressFamily]]}", this.classic.toString());
128         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"));
129         final UpdateBuilder ub = new UpdateBuilder();
130         ub.setNlri(new NlriBuilder().setNlri(prefs).build());
131         ub.setAttributes(new AttributesBuilder().build());
132         this.classic.onMessage(this.session, ub.build());
133         assertEquals(3, this.routes.size());
134
135         //create new peer so that it gets advertized routes from RIB
136         try (final BGPPeer testingPeer = new BGPPeer("testingPeer", getRib(), PeerRole.Ibgp, null)) {
137             testingPeer.onSessionUp(this.session);
138             assertEquals(3, this.routes.size());
139             assertEquals(1, testingPeer.getBgpPeerState().getSessionEstablishedCount().intValue());
140             assertEquals(1, testingPeer.getBgpPeerState().getRouteTable().size());
141             assertNotNull(testingPeer.getBgpSessionState());
142         }
143
144         final List<Ipv4Prefix> prefs2 = Lists.newArrayList(new Ipv4Prefix("8.0.1.0/28"), new Ipv4Prefix("8.0.1.16/28"));
145         ub.setNlri(new NlriBuilder().setNlri(prefs2).build());
146         ub.setWithdrawnRoutes(new WithdrawnRoutesBuilder().setWithdrawnRoutes(prefs).build());
147         this.classic.onMessage(this.session, ub.build());
148         assertEquals(2, this.routes.size());
149         this.classic.onMessage(this.session, new KeepaliveBuilder().build());
150         this.classic.onMessage(this.session, new UpdateBuilder().setAttributes(
151             new AttributesBuilder().addAugmentation(
152                     Attributes2.class,
153                     new Attributes2Builder().setMpUnreachNlri(
154                             new MpUnreachNlriBuilder().setAfi(AFI).setSafi(SAFI).build()).build()).build()).build());
155         this.classic.onMessage(this.session, new RouteRefreshBuilder().setAfi(AFI).setSafi(SAFI).build());
156         this.classic.onMessage(this.session, new RouteRefreshBuilder().setAfi(Ipv6AddressFamily.class).setSafi(SAFI).build());
157         assertEquals(2, this.routes.size());
158         this.classic.releaseConnection();
159     }
160
161     private void mockSession() {
162         final EventLoop eventLoop = Mockito.mock(EventLoop.class);
163         final Channel channel = Mockito.mock(Channel.class);
164         final ChannelPipeline pipeline = Mockito.mock(ChannelPipeline.class);
165         Mockito.doReturn(null).when(eventLoop).schedule(any(Runnable.class), any(long.class), any(TimeUnit.class));
166         Mockito.doReturn(eventLoop).when(channel).eventLoop();
167         Mockito.doReturn(Boolean.TRUE).when(channel).isWritable();
168         Mockito.doReturn(null).when(channel).close();
169         Mockito.doReturn(pipeline).when(channel).pipeline();
170         Mockito.doCallRealMethod().when(channel).toString();
171         Mockito.doReturn(pipeline).when(pipeline).addLast(Mockito.any(ChannelHandler.class));
172         Mockito.doReturn(new DefaultChannelPromise(channel)).when(channel).writeAndFlush(any(Notification.class));
173         Mockito.doReturn(new InetSocketAddress("localhost", 12345)).when(channel).remoteAddress();
174         Mockito.doReturn(new InetSocketAddress("localhost", 12345)).when(channel).localAddress();
175         final List<BgpParameters> params = Lists.newArrayList(new BgpParametersBuilder().setOptionalCapabilities(
176             Lists.newArrayList(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().addAugmentation(
177                 CParameters1.class, new CParameters1Builder().setMultiprotocolCapability(new MultiprotocolCapabilityBuilder()
178                     .setAfi(Ipv4AddressFamily.class).setSafi(UnicastSubsequentAddressFamily.class).build()).build()).build()).build())).build());
179         this.session = new BGPSessionImpl(this.classic, channel, new OpenBuilder().setBgpIdentifier(new Ipv4Address("1.1.1.1")).setHoldTimer(50).setMyAsNumber(72).setBgpParameters(params).build(), 30, null);
180     }
181 }