BUG-6747: Race condition on peer connection
[bgpcep.git] / bgp / path-selection-mode / src / test / java / org / opendaylight / protocol / bgp / mode / impl / AbstractRouteEntryTest.java
1 /*
2  * Copyright (c) 2016 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
9 package org.opendaylight.protocol.bgp.mode.impl;
10
11 import static org.opendaylight.protocol.bgp.mode.impl.base.BasePathSelectorTest.ATTRS_EXTENSION_Q;
12 import static org.opendaylight.protocol.bgp.mode.impl.base.BasePathSelectorTest.SEGMENTS_NID;
13
14 import com.google.common.collect.ImmutableList;
15 import com.google.common.collect.ImmutableMap;
16 import com.google.common.primitives.UnsignedInteger;
17 import java.util.ArrayList;
18 import java.util.HashMap;
19 import java.util.List;
20 import java.util.Map;
21 import org.mockito.Mock;
22 import org.mockito.Mockito;
23 import org.mockito.MockitoAnnotations;
24 import org.mockito.invocation.InvocationOnMock;
25 import org.mockito.stubbing.Answer;
26 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
27 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
28 import org.opendaylight.protocol.bgp.rib.spi.ExportPolicyPeerTracker;
29 import org.opendaylight.protocol.bgp.rib.spi.PeerExportGroup;
30 import org.opendaylight.protocol.bgp.rib.spi.RIBSupport;
31 import org.opendaylight.protocol.bgp.rib.spi.RibSupportUtils;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.routes.Ipv4Routes;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.routes.ipv4.routes.Ipv4Route;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.Attributes;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.AsPath;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.AtomicAggregate;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.Origin;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.BgpRib;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerId;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerRole;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.LocRib;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.peer.AdjRibOut;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.Tables;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.tables.Routes;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Ipv4AddressFamily;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.UnicastSubsequentAddressFamily;
48 import org.opendaylight.yangtools.yang.binding.util.BindingReflections;
49 import org.opendaylight.yangtools.yang.common.QName;
50 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
51 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
52 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
53 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
54 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
55 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
56 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
57 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
58
59 public class AbstractRouteEntryTest {
60     protected static final long REMOTE_PATH_ID = 1;
61     protected static final PeerId PEER_ID = new PeerId("bgp://42.42.42.42");
62     protected static final YangInstanceIdentifier PEER_YII2 = YangInstanceIdentifier.of(QName.create("urn:opendaylight:params:xml:ns:yang:bgp-inet:test", "2015-03-05", "peer2"));
63     protected static final long AS = 64444;
64     protected static final UnsignedInteger ROUTER_ID = UnsignedInteger.ONE;
65     protected static final TablesKey TABLES_KEY = new TablesKey(Ipv4AddressFamily.class, UnicastSubsequentAddressFamily.class);
66     protected static final YangInstanceIdentifier LOC_RIB_TARGET = YangInstanceIdentifier.create(YangInstanceIdentifier.of(BgpRib.QNAME)
67         .node(LocRib.QNAME).node(Tables.QNAME).node(RibSupportUtils.toYangTablesKey(TABLES_KEY)).getPathArguments());
68     private static final long PATH_ID = 1;
69     private static final PeerId PEER_ID2 = new PeerId("bgp://43.43.43.43");
70     private static final PeerId PEER_DISCONNECTED = new PeerId("bgp://44.44.44.44");
71     private static final String PREFIX = "1.2.3.4/32";
72     private static final String PREFIX2 = "2.2.2.2/32";
73     private static final YangInstanceIdentifier PEER_YII = YangInstanceIdentifier.of(QName.create("urn:opendaylight:params:xml:ns:yang:bgp-inet:test", "2015-03-05", "peer1"));
74     private static final NodeIdentifier ROUTES_IDENTIFIER = new NodeIdentifier(Routes.QNAME);
75     private static final NodeIdentifier ORIGIN_NID = new NodeIdentifier(QName.create(ATTRS_EXTENSION_Q, Origin.QNAME.getLocalName()).intern());
76     private static final NodeIdentifier ORIGIN_VALUE_NID = new NodeIdentifier(QName.create(ATTRS_EXTENSION_Q, "value").intern());
77     private static final NodeIdentifier AS_PATH_NID = new NodeIdentifier(QName.create(ATTRS_EXTENSION_Q, AsPath.QNAME.getLocalName()).intern());
78     private static final NodeIdentifier ATOMIC_NID = new NodeIdentifier(QName.create(ATTRS_EXTENSION_Q, AtomicAggregate.QNAME.getLocalName()));
79     private static final QName Q_NAME = BindingReflections.findQName(Ipv4Routes.class).intern();
80     private static final NodeIdentifier ROUTE_ATTRIBUTES_IDENTIFIER = new NodeIdentifier(QName.create(Q_NAME, Attributes.QNAME.getLocalName().intern()));
81     private static final QName PREFIX_QNAME = QName.create(Ipv4Route.QNAME, "prefix").intern();
82     protected static final NodeIdentifierWithPredicates ROUTE_ID_PA = new NodeIdentifierWithPredicates(Ipv4Route.QNAME, ImmutableMap.of(PREFIX_QNAME, PREFIX));
83     private static final QName PATHID_QNAME = QName.create(Ipv4Route.QNAME, "path-id").intern();
84     protected static final NodeIdentifierWithPredicates ROUTE_ID_PA_ADD_PATH = new NodeIdentifierWithPredicates(Ipv4Route.QNAME, ImmutableMap.of(PATHID_QNAME, PATH_ID, PREFIX_QNAME, PREFIX2));
85     @Mock
86     protected RIBSupport ribSupport;
87     @Mock
88     protected DOMDataWriteTransaction tx;
89     @Mock
90     protected ExportPolicyPeerTracker peerPT;
91     @Mock
92     protected PeerExportGroup peg;
93     protected List<YangInstanceIdentifier> yIIChanges;
94     protected NormalizedNode<?, ?> attributes;
95     protected YangInstanceIdentifier routePaYii;
96     protected YangInstanceIdentifier routePaAddPathYii;
97     protected YangInstanceIdentifier routeRiboutYii;
98     protected YangInstanceIdentifier routeAddRiboutYii;
99     protected YangInstanceIdentifier routeRiboutAttYii;
100     protected YangInstanceIdentifier routeAddRiboutAttYii;
101     protected YangInstanceIdentifier routeRiboutAttYiiPeer2;
102     protected YangInstanceIdentifier routeRiboutYiiPeer2;
103     protected YangInstanceIdentifier routeAddRiboutYiiPeer2;
104     @Mock
105     private PeerExportGroup pegNot;
106     private YangInstanceIdentifier locRibTargetYii;
107     private YangInstanceIdentifier locRibOutTargetYii;
108     private YangInstanceIdentifier locRibOutTargetYiiPeer2;
109
110     protected void setUp() {
111         MockitoAnnotations.initMocks(this);
112         this.yIIChanges = new ArrayList<>();
113         this.peerPT = Mockito.mock(ExportPolicyPeerTracker.class);
114         this.attributes = createAttr();
115         this.locRibTargetYii = LOC_RIB_TARGET.node(ROUTES_IDENTIFIER);
116         this.locRibOutTargetYii = PEER_YII.node(AdjRibOut.QNAME).node(Tables.QNAME).node(RibSupportUtils.toYangTablesKey(TABLES_KEY)).node(ROUTES_IDENTIFIER);
117         this.routePaYii = locRibTargetYii.node(ROUTE_ID_PA);
118         this.routePaAddPathYii = locRibTargetYii.node(ROUTE_ID_PA_ADD_PATH);
119         this.routeRiboutYii = locRibOutTargetYii.node(ROUTE_ID_PA);
120         this.routeAddRiboutYii = locRibOutTargetYii.node(ROUTE_ID_PA_ADD_PATH);
121         this.routeRiboutAttYii = locRibOutTargetYii.node(ROUTE_ID_PA).node(ATTRS_EXTENSION_Q);
122         this.routeAddRiboutAttYii = locRibOutTargetYii.node(ROUTE_ID_PA_ADD_PATH).node(ATTRS_EXTENSION_Q);
123         this.locRibOutTargetYiiPeer2 = PEER_YII2.node(AdjRibOut.QNAME).node(Tables.QNAME).node(RibSupportUtils.toYangTablesKey(TABLES_KEY)).node(ROUTES_IDENTIFIER);
124         this.routeRiboutYiiPeer2 = locRibOutTargetYiiPeer2.node(ROUTE_ID_PA);
125         this.routeRiboutAttYiiPeer2 = locRibOutTargetYiiPeer2.node(ROUTE_ID_PA).node(ATTRS_EXTENSION_Q);
126         this.routeAddRiboutYiiPeer2 = locRibOutTargetYiiPeer2.node(ROUTE_ID_PA_ADD_PATH);
127         mockRibSupport();
128         mockExportPolicies();
129         mockExportGroup();
130         mockTransactionChain();
131     }
132
133     private void mockTransactionChain() {
134         Mockito.doAnswer(new Answer<Object>() {
135             @Override
136             public Object answer(final InvocationOnMock invocation) throws Throwable {
137                 final Object[] args = invocation.getArguments();
138                 yIIChanges.add((YangInstanceIdentifier) args[1]);
139                 return args[1];
140             }
141         }).when(this.tx).put(Mockito.any(LogicalDatastoreType.class), Mockito.any(YangInstanceIdentifier.class), Mockito.any(NormalizedNode.class));
142
143         Mockito.doAnswer(new Answer<Object>() {
144             @Override
145             public Object answer(final InvocationOnMock invocation) throws Throwable {
146                 final Object[] args = invocation.getArguments();
147                 if (routePaYii.equals(args[1])) {
148                     yIIChanges.remove(routePaYii);
149                 } else if (routePaAddPathYii.equals(args[1])) {
150                     yIIChanges.remove(routePaAddPathYii);
151                 } else if (routeRiboutYii.equals(args[1])) {
152                     yIIChanges.remove(routeRiboutYii);
153                     yIIChanges.remove(routeAddRiboutAttYii);
154                 } else if (routeAddRiboutYii.equals(args[1])) {
155                     yIIChanges.remove(routeAddRiboutYii);
156                     yIIChanges.remove(routeAddRiboutAttYii);
157                 }
158                 return args[1];
159             }
160         }).when(this.tx).delete(Mockito.any(LogicalDatastoreType.class), Mockito.any(YangInstanceIdentifier.class));
161     }
162
163     private void mockExportGroup() {
164         Mockito.doReturn(this.attributes).when(this.peg).effectiveAttributes(Mockito.any(PeerRole.class), Mockito.any(ContainerNode.class));
165         Mockito.doReturn(null).when(this.pegNot).effectiveAttributes(Mockito.any(PeerRole.class), Mockito.any(ContainerNode.class));
166
167         Map<PeerId, PeerExportGroup.PeerExporTuple> peers = new HashMap<>();
168         Mockito.doReturn(ImmutableList.copyOf(peers.entrySet())).when(this.pegNot).getPeers();
169         Mockito.doReturn(true).when(this.pegNot).containsPeer(Mockito.any(PeerId.class));
170
171         peers.put(PEER_ID, new PeerExportGroup.PeerExporTuple(PEER_YII, PeerRole.Ibgp));
172         peers.put(PEER_ID2, new PeerExportGroup.PeerExporTuple(PEER_YII2, PeerRole.Ibgp));
173
174         Mockito.doReturn(ImmutableList.copyOf(peers.entrySet())).when(this.peg).getPeers();
175     }
176
177     private void mockExportPolicies() {
178         Mockito.doReturn(true).when(this.peerPT).isTableSupported(PEER_ID);
179         Mockito.doReturn(false).when(this.peerPT).isTableSupported(PEER_ID2);
180         Mockito.doAnswer(new Answer<Object>() {
181             @Override
182             public Object answer(final InvocationOnMock invocation) throws Throwable {
183                 final Object[] args = invocation.getArguments();
184                 if (PeerRole.Ibgp.equals(args[0])) {
185                     return peg;
186                 } else if (PeerRole.Ebgp.equals(args[0])) {
187                     return pegNot;
188                 } else {
189                     return null;
190                 }
191             }
192         }).when(this.peerPT).getPeerGroup(Mockito.any(PeerRole.class));
193
194         Mockito.doReturn(true).when(this.peerPT).isAddPathSupportedByPeer(PEER_ID);
195         Mockito.doReturn(false).when(this.peerPT).isAddPathSupportedByPeer(PEER_ID2);
196     }
197
198     private void mockRibSupport() {
199         Mockito.doReturn(ROUTE_ATTRIBUTES_IDENTIFIER).when(this.ribSupport).routeAttributesIdentifier();
200         Mockito.doReturn(ROUTE_ID_PA_ADD_PATH).when(this.ribSupport).getRouteIdAddPath(Mockito.any(Long.class), Mockito.eq(ROUTE_ID_PA_ADD_PATH));
201         Mockito.doReturn(null).when(this.ribSupport).getRouteIdAddPath(Mockito.any(Long.class), Mockito.eq(ROUTE_ID_PA));
202         Mockito.doAnswer(new Answer<Object>() {
203             @Override
204             public Object answer(final InvocationOnMock invocation) throws Throwable {
205                 final Object[] args = invocation.getArguments();
206                 final YangInstanceIdentifier yii = (YangInstanceIdentifier) args[0];
207                 final PathArgument paa = (PathArgument) args[1];
208
209                 if (ROUTE_ID_PA.equals(paa)) {
210                     if (yii.equals(locRibTargetYii)) {
211                         return routePaYii;
212                     } else if (yii.equals(locRibOutTargetYii)) {
213                         return routeRiboutYii;
214                     } else if (yii.equals(locRibOutTargetYiiPeer2)) {
215                         return routeRiboutYiiPeer2;
216                     }
217                 } else if (ROUTE_ID_PA_ADD_PATH.equals(paa)) {
218                     if (yii.equals(locRibTargetYii)) {
219                         return routePaAddPathYii;
220                     } else if (yii.equals(locRibOutTargetYii)) {
221                         return routeAddRiboutYii;
222                     } else if (yii.equals(locRibOutTargetYiiPeer2)) {
223                         return routeAddRiboutYiiPeer2;
224                     }
225                 }
226                 return null;
227             }
228         }).when(this.ribSupport).routePath(Mockito.any(YangInstanceIdentifier.class), Mockito.any(PathArgument.class));
229     }
230
231     private NormalizedNode<?, ?> createAttr() {
232         final ContainerNode attributes = Builders.containerBuilder().withNodeIdentifier(new NodeIdentifier(ATTRS_EXTENSION_Q))
233             .addChild(Builders.containerBuilder().withNodeIdentifier(ORIGIN_NID)
234                 .addChild(Builders.leafBuilder().withNodeIdentifier(ORIGIN_VALUE_NID).withValue("igp").build()).build())
235             .addChild(Builders.containerBuilder().withNodeIdentifier(AS_PATH_NID)
236                 .addChild(Builders.unkeyedListBuilder().withNodeIdentifier(SEGMENTS_NID).build()).build())
237             .addChild(Builders.containerBuilder().withNodeIdentifier(ATOMIC_NID).build()).build();
238         return ImmutableContainerNodeBuilder.create().withNodeIdentifier(ROUTE_ATTRIBUTES_IDENTIFIER)
239             .withChild(attributes).build();
240     }
241 }