2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.protocol.bgp.rib.impl;
10 import static org.mockito.ArgumentMatchers.any;
11 import static org.mockito.ArgumentMatchers.eq;
12 import static org.mockito.Mockito.doCallRealMethod;
13 import static org.mockito.Mockito.doNothing;
14 import static org.mockito.Mockito.doReturn;
15 import static org.mockito.Mockito.mock;
17 import com.google.common.collect.ImmutableClassToInstanceMap;
18 import com.google.common.util.concurrent.FluentFuture;
19 import java.util.ArrayList;
20 import java.util.Collection;
21 import java.util.Collections;
22 import java.util.EventListener;
23 import java.util.HashSet;
24 import java.util.List;
25 import java.util.Optional;
26 import java.util.concurrent.Executor;
27 import org.junit.Before;
28 import org.mockito.Mock;
29 import org.mockito.MockitoAnnotations;
30 import org.opendaylight.mdsal.binding.dom.adapter.CurrentAdapterSerializer;
31 import org.opendaylight.mdsal.common.api.CommitInfo;
32 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
33 import org.opendaylight.mdsal.dom.api.ClusteredDOMDataTreeChangeListener;
34 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
35 import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeService;
36 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
37 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
38 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
39 import org.opendaylight.mdsal.dom.api.DOMTransactionChainListener;
40 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonService;
41 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
42 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceRegistration;
43 import org.opendaylight.protocol.bgp.inet.RIBActivator;
44 import org.opendaylight.protocol.bgp.mode.impl.base.BasePathSelectionModeFactory;
45 import org.opendaylight.protocol.bgp.parser.BgpTableTypeImpl;
46 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPDispatcher;
47 import org.opendaylight.protocol.bgp.rib.spi.RIBExtensionProviderContext;
48 import org.opendaylight.protocol.bgp.rib.spi.SimpleRIBExtensionProviderContext;
49 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
50 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv4.routes.ipv4.routes.Ipv4Route;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.BgpTableType;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.BgpRib;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.RibId;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.AddressFamily;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.BgpId;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.Ipv4AddressFamily;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.Ipv6AddressFamily;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.SubsequentAddressFamily;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.UnicastSubsequentAddressFamily;
62 import org.opendaylight.yangtools.concepts.ListenerRegistration;
63 import org.opendaylight.yangtools.yang.common.QName;
64 import org.opendaylight.yangtools.yang.common.Uint32;
65 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
66 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
67 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
68 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
69 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
70 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
71 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
72 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode;
73 import org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType;
74 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
75 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
76 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
78 public class AbstractRIBTestSetup extends DefaultRibPoliciesMockTest {
80 static final Class<? extends AddressFamily> IPV4_AFI = Ipv4AddressFamily.class;
81 private static final Class<? extends AddressFamily> IPV6_AFI = Ipv6AddressFamily.class;
82 static final Class<? extends SubsequentAddressFamily> SAFI = UnicastSubsequentAddressFamily.class;
83 static final TablesKey KEY = new TablesKey(IPV4_AFI, SAFI);
84 static final QName PREFIX_QNAME = QName.create(Ipv4Route.QNAME, "prefix").intern();
85 private static final BgpId RIB_ID = new BgpId("127.0.0.1");
87 private final RIBActivator a1 = new RIBActivator();
89 private BGPDispatcher dispatcher;
92 private DOMDataBroker dom;
95 private DOMTransactionChain domChain;
98 private DOMDataTreeWriteTransaction domTransWrite;
101 private FluentFuture<? extends CommitInfo> future;
104 private DOMDataTreeChangeService service;
107 private ClusterSingletonServiceProvider clusterSingletonServiceProvider;
111 public void setUp() throws Exception {
116 public void mockRib() throws Exception {
117 final RIBExtensionProviderContext context = new SimpleRIBExtensionProviderContext();
118 final List<BgpTableType> localTables = new ArrayList<>();
119 localTables.add(new BgpTableTypeImpl(IPV4_AFI, SAFI));
120 localTables.add(new BgpTableTypeImpl(IPV6_AFI, SAFI));
122 final CurrentAdapterSerializer serializer = mappingService.currentSerializer();
123 this.a1.startRIBExtensionProvider(context, serializer);
126 doReturn(mock(ClusterSingletonServiceRegistration.class)).when(this.clusterSingletonServiceProvider)
127 .registerClusterSingletonService(any(ClusterSingletonService.class));
128 this.rib = new RIBImpl(this.tableRegistry, new RibId("test"), new AsNumber(Uint32.valueOf(5)), RIB_ID, context,
129 this.dispatcher, new ConstantCodecsRegistry(serializer), this.dom, this.policies,
130 localTables, Collections.singletonMap(KEY,
131 BasePathSelectionModeFactory.createBestPathSelectionStrategy()));
134 private void mockedMethods() throws Exception {
135 MockitoAnnotations.initMocks(this);
136 doReturn(new TestListenerRegistration()).when(this.service)
137 .registerDataTreeChangeListener(any(DOMDataTreeIdentifier.class),
138 any(ClusteredDOMDataTreeChangeListener.class));
139 doNothing().when(this.domTransWrite).put(eq(LogicalDatastoreType.OPERATIONAL),
140 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
141 doNothing().when(this.domTransWrite).delete(eq(LogicalDatastoreType.OPERATIONAL),
142 any(YangInstanceIdentifier.class));
143 doNothing().when(this.domTransWrite).merge(eq(LogicalDatastoreType.OPERATIONAL),
144 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
145 doNothing().when(this.domChain).close();
146 doReturn(this.domTransWrite).when(this.domChain).newWriteOnlyTransaction();
147 doNothing().when(getTransaction()).put(eq(LogicalDatastoreType.OPERATIONAL),
148 eq(YangInstanceIdentifier.of(BgpRib.QNAME)), any(NormalizedNode.class));
149 doReturn(ImmutableClassToInstanceMap.of(DOMDataTreeChangeService.class, this.service)).when(this.dom)
151 doReturn(this.domChain).when(this.dom).createMergingTransactionChain(any(DOMTransactionChainListener.class));
152 doReturn(Optional.empty()).when(this.future).get();
153 doReturn(this.future).when(this.domTransWrite).commit();
154 doNothing().when(this.future).addListener(any(Runnable.class), any(Executor.class));
157 public Collection<DataTreeCandidate> ipv4Input(final YangInstanceIdentifier target,
158 final ModificationType type, final Ipv4Prefix... prefix) {
159 final Collection<DataTreeCandidate> col = new HashSet<>();
160 final DataTreeCandidate candidate = mock(DataTreeCandidate.class);
161 final DataTreeCandidateNode rootNode = mock(DataTreeCandidateNode.class);
162 doReturn(rootNode).when(candidate).getRootNode();
163 doReturn(type).when(rootNode).getModificationType();
164 doCallRealMethod().when(rootNode).toString();
165 doReturn(target).when(candidate).getRootPath();
166 doCallRealMethod().when(candidate).toString();
167 final Collection<DataTreeCandidateNode> children = new HashSet<>();
168 for (final Ipv4Prefix p : prefix) {
169 final NodeIdentifierWithPredicates routekey =
170 NodeIdentifierWithPredicates.of(Ipv4Route.QNAME, PREFIX_QNAME, p);
171 final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> b =
172 ImmutableNodes.mapEntryBuilder();
173 b.withNodeIdentifier(routekey);
174 b.addChild(Builders.leafBuilder()
175 .withNodeIdentifier(new NodeIdentifier(PREFIX_QNAME)).withValue(p).build());
177 final DataTreeCandidateNode child = mock(DataTreeCandidateNode.class);
178 doReturn(createIdentifier(p)).when(child).getIdentifier();
179 doReturn(java.util.Optional.of(b.build())).when(child).getDataAfter();
180 doReturn(type).when(child).getModificationType();
183 doReturn(children).when(rootNode).getChildNodes();
188 public PathArgument createIdentifier(final Ipv4Prefix prefix) {
189 final NodeIdentifierWithPredicates routekey =
190 NodeIdentifierWithPredicates.of(Ipv4Route.QNAME, PREFIX_QNAME, prefix);
191 return YangInstanceIdentifier.of(PREFIX_QNAME).node(routekey).getLastPathArgument();
194 public RIBImpl getRib() {
198 public DOMDataTreeWriteTransaction getTransaction() {
199 return this.domTransWrite;
202 private class TestListenerRegistration implements ListenerRegistration<EventListener> {
204 public EventListener getInstance() {
209 public void close() {