BUG-5685: Register BGP Peer Cluster Singleton Service
[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.assertArrayEquals;
11 import static org.junit.Assert.assertEquals;
12 import static org.junit.Assert.assertNotNull;
13 import static org.junit.Assert.fail;
14 import static org.mockito.Matchers.any;
15 import com.google.common.collect.Lists;
16 import io.netty.channel.Channel;
17 import io.netty.channel.ChannelHandler;
18 import io.netty.channel.ChannelPipeline;
19 import io.netty.channel.DefaultChannelPromise;
20 import io.netty.channel.EventLoop;
21 import java.net.InetSocketAddress;
22 import java.util.Collections;
23 import java.util.HashMap;
24 import java.util.List;
25 import java.util.Map;
26 import java.util.concurrent.TimeUnit;
27 import org.junit.Assert;
28 import org.junit.Before;
29 import org.junit.Test;
30 import org.mockito.Mockito;
31 import org.mockito.invocation.InvocationOnMock;
32 import org.mockito.stubbing.Answer;
33 import org.opendaylight.controller.config.api.IdentityAttributeRef;
34 import org.opendaylight.controller.config.yang.bgp.rib.impl.RouteTable;
35 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
36 import org.opendaylight.protocol.bgp.parser.BGPDocumentedException;
37 import org.opendaylight.protocol.bgp.parser.BGPError;
38 import org.opendaylight.protocol.bgp.parser.impl.message.update.LocalPreferenceAttributeParser;
39 import org.opendaylight.protocol.bgp.rib.spi.RibSupportUtils;
40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.routes.ipv4.routes.Ipv4Route;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.KeepaliveBuilder;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.OpenBuilder;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.UpdateBuilder;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.BgpParameters;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.BgpParametersBuilder;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.bgp.parameters.OptionalCapabilitiesBuilder;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.bgp.parameters.optional.capabilities.CParametersBuilder;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.AttributesBuilder;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.AsPath;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.AsPathBuilder;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.LocalPref;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.LocalPrefBuilder;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.Origin;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.OriginBuilder;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.update.message.NlriBuilder;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.update.message.WithdrawnRoutesBuilder;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.Attributes2;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.Attributes2Builder;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.CParameters1;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.CParameters1Builder;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.RouteRefreshBuilder;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.mp.capabilities.MultiprotocolCapabilityBuilder;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpUnreachNlriBuilder;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.ApplicationRibId;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerRole;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.LocRib;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.Tables;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.BgpOrigin;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Ipv4AddressFamily;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Ipv6AddressFamily;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.UnicastSubsequentAddressFamily;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.next.hop.CNextHop;
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.next.hop.c.next.hop.Ipv4NextHopCaseBuilder;
76 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;
77 import org.opendaylight.yangtools.yang.binding.Notification;
78 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
79 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
80 import org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType;
81
82 public class PeerTest extends AbstractRIBTestSetup {
83
84     private ApplicationPeer peer;
85
86     private BGPSessionImpl session;
87
88     private Map<YangInstanceIdentifier, NormalizedNode<?,?>> routes;
89
90     private BGPPeer classic;
91
92     @Override
93     @Before
94     public void setUp() throws Exception {
95         super.setUp();
96         this.routes = new HashMap<>();
97         overrideMockedBehaviour();
98     }
99
100     private void overrideMockedBehaviour() {
101         Mockito.doAnswer(new Answer<Object>() {
102             @Override
103             public Object answer(final InvocationOnMock invocation) throws Throwable {
104                 final Object[] args = invocation.getArguments();
105                 final NormalizedNode<?,?>node = (NormalizedNode<?,?>)args[2];
106                 if (node.getIdentifier().getNodeType().equals(Ipv4Route.QNAME) || node.getNodeType().equals(PREFIX_QNAME)) {
107                     PeerTest.this.routes.put((YangInstanceIdentifier) args[1], node);
108                 }
109                 return args[1];
110             }
111         }).when(getTransaction()).put(Mockito.eq(LogicalDatastoreType.OPERATIONAL), Mockito.any(YangInstanceIdentifier.class), Mockito.any(NormalizedNode.class));
112
113         Mockito.doAnswer(new Answer<Object>() {
114             @Override
115             public Object answer(final InvocationOnMock invocation) throws Throwable {
116                 final Object[] args = invocation.getArguments();
117                 PeerTest.this.routes.remove(args[1]);
118                 return args[1];
119             }
120         }).when(getTransaction()).delete(Mockito.eq(LogicalDatastoreType.OPERATIONAL), Mockito.any(YangInstanceIdentifier.class));
121     }
122
123
124     @Test
125     public void testAppPeer() {
126         final Ipv4Prefix first = new Ipv4Prefix("127.0.0.2/32");
127         final Ipv4Prefix second = new Ipv4Prefix("127.0.0.1/32");
128         final Ipv4Prefix third = new Ipv4Prefix("127.0.0.3/32");
129         this.peer = new ApplicationPeer(new ApplicationRibId("t"), new Ipv4Address("127.0.0.1"), getRib());
130         final YangInstanceIdentifier base = getRib().getYangRibId().node(LocRib.QNAME).node(Tables.QNAME).node(RibSupportUtils.toYangTablesKey(KEY));
131         this.peer.onDataTreeChanged(ipv4Input(base, ModificationType.WRITE, first, second, third));
132         assertEquals(3, this.routes.size());
133
134         this.peer.onDataTreeChanged(ipv4Input(base, ModificationType.DELETE, third));
135         assertEquals(2, this.routes.size());
136     }
137
138     @Test
139     public void testClassicPeer() throws Exception {
140         this.classic = new BGPPeer("testPeer", getRib(), PeerRole.Ibgp, null);
141         this.classic.instantiateServiceInstance();
142         this.mockSession();
143         assertEquals("testPeer", this.classic.getName());
144         this.classic.onSessionUp(this.session);
145         assertEquals(1, this.classic.getBgpPeerState().getSessionEstablishedCount().getValue().intValue());
146         Assert.assertArrayEquals(new byte[] {1, 1, 1, 1}, this.classic.getRawIdentifier());
147         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());
148
149         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"));
150         final UpdateBuilder ub = new UpdateBuilder();
151         ub.setNlri(new NlriBuilder().setNlri(prefs).build());
152         final Origin origin = new OriginBuilder().setValue(BgpOrigin.Igp).build();
153         final AsPath asPath = new AsPathBuilder().setSegments(Collections.emptyList()).build();
154         final CNextHop nextHop = new Ipv4NextHopCaseBuilder().setIpv4NextHop(new Ipv4NextHopBuilder().setGlobal(new Ipv4Address("127.0.0.1")).build()).build();
155         final AttributesBuilder ab = new AttributesBuilder();
156         ub.setAttributes(ab.setOrigin(origin).setAsPath(asPath).setCNextHop(nextHop).build());
157         try {
158             this.classic.onMessage(this.session, ub.build());
159             fail();
160         } catch (BGPDocumentedException e) {
161             assertEquals(BGPError.MANDATORY_ATTR_MISSING_MSG + "LOCAL_PREF", e.getMessage());
162             assertEquals(BGPError.WELL_KNOWN_ATTR_MISSING.getCode(), e.getError().getCode());
163             assertEquals(BGPError.WELL_KNOWN_ATTR_MISSING.getSubcode(), e.getError().getSubcode());
164             assertArrayEquals(new byte[] { LocalPreferenceAttributeParser.TYPE }, e.getData());
165         }
166         assertEquals(0, this.routes.size());
167
168         final LocalPref localPref = new LocalPrefBuilder().setPref((long)100).build();
169         ub.setAttributes(ab.setLocalPref(localPref).build());
170         this.classic.onMessage(this.session, ub.build());
171         assertEquals(3, this.routes.size());
172
173         //create new peer so that it gets advertized routes from RIB
174         try (final BGPPeer testingPeer = new BGPPeer("testingPeer", getRib(), PeerRole.Ibgp, null)) {
175             testingPeer.instantiateServiceInstance();
176             testingPeer.onSessionUp(this.session);
177             assertEquals(3, this.routes.size());
178             assertEquals(1, testingPeer.getBgpPeerState().getSessionEstablishedCount().getValue().intValue());
179             final List<RouteTable> routeTables = testingPeer.getBgpPeerState().getRouteTable();
180             assertEquals(1, routeTables.size());
181             final RouteTable routeTable = routeTables.get(0);
182             assertEquals(AFI_QNAME.toString(), routeTable.getAfi().getqNameOfIdentity());
183             assertEquals(SAFI_QNAME.toString(), routeTable.getSafi().getqNameOfIdentity());
184             assertNotNull(testingPeer.getBgpSessionState());
185         }
186
187         final List<Ipv4Prefix> prefs2 = Lists.newArrayList(new Ipv4Prefix("8.0.1.0/28"), new Ipv4Prefix("8.0.1.16/28"));
188         ub.setNlri(new NlriBuilder().setNlri(prefs2).build());
189         ub.setWithdrawnRoutes(new WithdrawnRoutesBuilder().setWithdrawnRoutes(prefs).build());
190         this.classic.onMessage(this.session, ub.build());
191         assertEquals(2, this.routes.size());
192         this.classic.onMessage(this.session, new KeepaliveBuilder().build());
193         this.classic.onMessage(this.session, new UpdateBuilder().setAttributes(
194             new AttributesBuilder().addAugmentation(
195                     Attributes2.class,
196                     new Attributes2Builder().setMpUnreachNlri(
197                             new MpUnreachNlriBuilder().setAfi(AFI).setSafi(SAFI).build()).build()).build()).build());
198         this.classic.onMessage(this.session, new RouteRefreshBuilder().setAfi(AFI).setSafi(SAFI).build());
199         this.classic.onMessage(this.session, new RouteRefreshBuilder().setAfi(Ipv6AddressFamily.class).setSafi(SAFI).build());
200         assertEquals(2, this.routes.size());
201         this.classic.releaseConnection();
202     }
203
204     private void mockSession() {
205         final EventLoop eventLoop = Mockito.mock(EventLoop.class);
206         final Channel channel = Mockito.mock(Channel.class);
207         final ChannelPipeline pipeline = Mockito.mock(ChannelPipeline.class);
208         Mockito.doReturn(null).when(eventLoop).schedule(any(Runnable.class), any(long.class), any(TimeUnit.class));
209         Mockito.doReturn(eventLoop).when(channel).eventLoop();
210         Mockito.doReturn(Boolean.TRUE).when(channel).isWritable();
211         Mockito.doReturn(null).when(channel).close();
212         Mockito.doReturn(pipeline).when(channel).pipeline();
213         Mockito.doCallRealMethod().when(channel).toString();
214         Mockito.doReturn(pipeline).when(pipeline).addLast(Mockito.any(ChannelHandler.class));
215         Mockito.doReturn(new DefaultChannelPromise(channel)).when(channel).writeAndFlush(any(Notification.class));
216         Mockito.doReturn(new InetSocketAddress("localhost", 12345)).when(channel).remoteAddress();
217         Mockito.doReturn(new InetSocketAddress("localhost", 12345)).when(channel).localAddress();
218         final List<BgpParameters> params = Lists.newArrayList(new BgpParametersBuilder().setOptionalCapabilities(
219             Lists.newArrayList(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().addAugmentation(
220                 CParameters1.class, new CParameters1Builder().setMultiprotocolCapability(new MultiprotocolCapabilityBuilder()
221                     .setAfi(Ipv4AddressFamily.class).setSafi(UnicastSubsequentAddressFamily.class).build()).build()).build()).build())).build());
222         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);
223     }
224 }