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