BUG-5097: Error trying to update EffectiveRibIn from a removed Peer
[bgpcep.git] / bgp / rib-impl / src / test / java / org / opendaylight / protocol / bgp / rib / impl / LocRibWriterTest.java
1 /*
2  * Copyright (c) 2015 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 com.google.common.base.Optional;
11 import com.google.common.collect.Lists;
12 import com.google.common.util.concurrent.CheckedFuture;
13 import java.util.ArrayList;
14 import java.util.List;
15 import org.junit.Before;
16 import org.junit.Test;
17 import org.mockito.Mock;
18 import org.mockito.Mockito;
19 import org.mockito.MockitoAnnotations;
20 import org.mockito.invocation.InvocationOnMock;
21 import org.mockito.stubbing.Answer;
22 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
23 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeListener;
24 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeService;
25 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeIdentifier;
26 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
27 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
28 import org.opendaylight.protocol.bgp.rib.impl.spi.RIBSupportContext;
29 import org.opendaylight.protocol.bgp.rib.impl.spi.RIBSupportContextRegistry;
30 import org.opendaylight.protocol.bgp.rib.spi.RibSupportUtils;
31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.AsNumber;
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.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.routes.Ipv4Routes;
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.rib.rev130925.BgpRib;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.Peer;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.peer.EffectiveRibIn;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.peer.SupportedTables;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.tables.Routes;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.ClusterIdentifier;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Ipv4AddressFamily;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.UnicastSubsequentAddressFamily;
44 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
45 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
46 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
47 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
48 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode;
49 import org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType;
50 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
51 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
52
53 public class LocRibWriterTest {
54
55     @Mock
56     DOMDataWriteTransaction domTransWrite;
57
58     private final PolicyDatabase pd = new PolicyDatabase((long) 35, new Ipv4Address("10.25.2.9"), new ClusterIdentifier(new Ipv4Address("10.25.2.9")));
59
60     @Mock
61     private RIBSupportContextRegistry registry;
62
63     @Mock
64     private DOMTransactionChain chain;
65
66     @Mock
67     private DOMDataTreeChangeService service;
68
69     @Mock
70     private RIBSupportContext context;
71
72     @Mock
73     private AbstractIPRIBSupport ribSupport;
74
75     @Mock
76     CheckedFuture<?, ?> future;
77
78     private LocRibWriter locRibWriter;
79
80     private final List<YangInstanceIdentifier> routes = new ArrayList<>();
81     private final TablesKey tablesKey = new TablesKey(Ipv4AddressFamily.class, UnicastSubsequentAddressFamily.class);
82
83     @Before
84     public void setUp() throws Exception {
85         MockitoAnnotations.initMocks(this);
86         Mockito.doAnswer(new Answer<Object>() {
87             @Override
88             public Object answer(final InvocationOnMock invocation) throws Throwable {
89                 final Object[] args = invocation.getArguments();
90                 final NormalizedNode<?, ?> node = (NormalizedNode<?, ?>) args[2];
91                 if (node.getNodeType().equals(Ipv4Route.QNAME) || node.getNodeType().equals(IPv4RIBSupport.PREFIX_QNAME)) {
92                     LocRibWriterTest.this.routes.add((YangInstanceIdentifier) args[1]);
93                 }
94                 return args[1];
95             }
96         }).when(this.domTransWrite).put(Mockito.eq(LogicalDatastoreType.OPERATIONAL), Mockito.any(YangInstanceIdentifier.class), Mockito.any(NormalizedNode.class));
97         Mockito.doAnswer(new Answer<Object>() {
98             @Override
99             public Object answer(final InvocationOnMock invocation) throws Throwable {
100                 final Object[] args = invocation.getArguments();
101                 final NormalizedNode<?, ?> node = (NormalizedNode<?, ?>) args[2];
102                 if (node.getNodeType().equals(Ipv4Route.QNAME) || node.getNodeType().equals(IPv4RIBSupport.PREFIX_QNAME)) {
103                     LocRibWriterTest.this.routes.add((YangInstanceIdentifier) args[1]);
104                 }
105                 return args[1];
106             }
107         }).when(this.domTransWrite).merge(Mockito.eq(LogicalDatastoreType.OPERATIONAL), Mockito.any(YangInstanceIdentifier.class), Mockito.any(NormalizedNode.class));
108         Mockito.doAnswer(new Answer<Object>() {
109
110             @Override
111             public Object answer(final InvocationOnMock invocation) throws Throwable {
112                 final Object[] args = invocation.getArguments();
113                 LocRibWriterTest.this.routes.remove(args[1]);
114                 return args[1];
115             }
116         }).when(this.domTransWrite).delete(Mockito.eq(LogicalDatastoreType.OPERATIONAL), Mockito.any(YangInstanceIdentifier.class));
117         Mockito.doReturn(this.context).when(this.registry).getRIBSupportContext(this.tablesKey);
118         Mockito.doReturn(this.ribSupport).when(this.context).getRibSupport();
119         Mockito.doReturn(this.domTransWrite).when(this.chain).newWriteOnlyTransaction();
120         Mockito.doReturn(this.future).when(this.domTransWrite).submit();
121         Mockito.doReturn(null).when(this.service).registerDataTreeChangeListener(Mockito.any(DOMDataTreeIdentifier.class), Mockito.any(DOMDataTreeChangeListener.class));
122         Mockito.doReturn(Builders.choiceBuilder().withNodeIdentifier(new NodeIdentifier(Routes.QNAME)).addChild(Builders.containerBuilder().withNodeIdentifier(new NodeIdentifier(Ipv4Routes.QNAME)).withChild(ImmutableNodes.mapNodeBuilder(Ipv4Route.QNAME).build()).build()).build()).when(this.ribSupport).emptyRoutes();
123         this.locRibWriter = LocRibWriter.create(this.registry, this.tablesKey, this.chain, YangInstanceIdentifier.of(BgpRib.QNAME),
124             new AsNumber((long) 35), this.service, this.pd, new CacheDisconnectedPeersImpl());
125     }
126
127     private DataTreeCandidate prepareUpdate() {
128         final DataTreeCandidate candidate = Mockito.mock(DataTreeCandidate.class);
129         Mockito.doReturn("candidate").when(candidate).toString();
130         final YangInstanceIdentifier rootPath = YangInstanceIdentifier.builder().node(BgpRib.QNAME).node(Peer.QNAME).nodeWithKey(Peer.QNAME, AdjRibInWriter.PEER_ID_QNAME, "12.12.12.12").build();
131         Mockito.doReturn(rootPath).when(candidate).getRootPath();
132         return candidate;
133     }
134
135     @Test
136     public void testUpdateSupportedTables() {
137         final DataTreeCandidate candidate = prepareUpdate();
138         final DataTreeCandidateNode node = Mockito.mock(DataTreeCandidateNode.class);
139         Mockito.doReturn("node").when(node).toString();
140         final DataTreeCandidateNode tableChange = Mockito.mock(DataTreeCandidateNode.class);
141         // add
142         final DataTreeCandidateNode table = Mockito.mock(DataTreeCandidateNode.class);
143         final NormalizedNode<?, ?> dataAfter = Mockito.mock(NormalizedNode.class);
144         Mockito.doReturn(RibSupportUtils.toYangTablesKey(Ipv4AddressFamily.class, UnicastSubsequentAddressFamily.class)).when(dataAfter).getIdentifier();
145         Mockito.doReturn(Optional.of(dataAfter)).when(table).getDataAfter();
146         Mockito.doReturn(Lists.newArrayList(table)).when(tableChange).getChildNodes();
147         Mockito.doReturn("table change").when(tableChange).toString();
148         Mockito.doReturn(tableChange).when(node).getModifiedChild(YangInstanceIdentifier.of(SupportedTables.QNAME).getLastPathArgument());
149         Mockito.doReturn(null).when(node).getModifiedChild(AbstractPeerRoleTracker.PEER_ROLE_NID);
150         Mockito.doReturn(null).when(node).getModifiedChild(YangInstanceIdentifier.of(EffectiveRibIn.QNAME).getLastPathArgument());
151         Mockito.doReturn(node).when(candidate).getRootNode();
152         Mockito.doReturn(ModificationType.SUBTREE_MODIFIED).when(node).getModificationType();
153         this.locRibWriter.onDataTreeChanged(Lists.newArrayList(candidate));
154         // delete
155         final DataTreeCandidateNode tableDelete = Mockito.mock(DataTreeCandidateNode.class);
156         Mockito.doReturn(Optional.absent()).when(tableDelete).getDataAfter();
157         Mockito.doReturn(Lists.newArrayList(tableDelete)).when(tableChange).getChildNodes();
158         Mockito.doReturn("table change").when(tableChange).toString();
159         Mockito.doReturn(node).when(candidate).getRootNode();
160         this.locRibWriter.onDataTreeChanged(Lists.newArrayList(candidate));
161         Mockito.verify(node, Mockito.times(2)).getModifiedChild(YangInstanceIdentifier.of(SupportedTables.QNAME).getLastPathArgument());
162     }
163 }