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.After;
28 import org.junit.Before;
29 import org.mockito.Mock;
30 import org.mockito.MockitoAnnotations;
31 import org.opendaylight.mdsal.binding.api.ReadTransaction;
32 import org.opendaylight.mdsal.binding.api.TransactionChain;
33 import org.opendaylight.mdsal.binding.api.WriteTransaction;
34 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeFactory;
35 import org.opendaylight.mdsal.binding.dom.codec.impl.BindingNormalizedNodeCodecRegistry;
36 import org.opendaylight.mdsal.binding.generator.impl.GeneratedClassLoadingStrategy;
37 import org.opendaylight.mdsal.binding.generator.impl.ModuleInfoBackedContext;
38 import org.opendaylight.mdsal.binding.generator.util.BindingRuntimeContext;
39 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
40 import org.opendaylight.mdsal.common.api.CommitInfo;
41 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
42 import org.opendaylight.mdsal.dom.api.ClusteredDOMDataTreeChangeListener;
43 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
44 import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeService;
45 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
46 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
47 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
48 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonService;
49 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
50 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceRegistration;
51 import org.opendaylight.protocol.bgp.inet.RIBActivator;
52 import org.opendaylight.protocol.bgp.mode.impl.base.BasePathSelectionModeFactory;
53 import org.opendaylight.protocol.bgp.parser.BgpTableTypeImpl;
54 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPDispatcher;
55 import org.opendaylight.protocol.bgp.rib.spi.RIBExtensionProviderContext;
56 import org.opendaylight.protocol.bgp.rib.spi.RIBSupport;
57 import org.opendaylight.protocol.bgp.rib.spi.SimpleRIBExtensionProviderContext;
58 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
59 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv4.routes.ipv4.routes.Ipv4Route;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.BgpTableType;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.BgpRib;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.RibId;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.AddressFamily;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.BgpId;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.Ipv4AddressFamily;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.Ipv6AddressFamily;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.SubsequentAddressFamily;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.UnicastSubsequentAddressFamily;
71 import org.opendaylight.yangtools.concepts.ListenerRegistration;
72 import org.opendaylight.yangtools.util.concurrent.FluentFutures;
73 import org.opendaylight.yangtools.yang.binding.DataObject;
74 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
75 import org.opendaylight.yangtools.yang.common.QName;
76 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
77 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
78 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
79 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
80 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
81 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
82 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
83 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode;
84 import org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType;
85 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
86 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
87 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
88 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
90 public class AbstractRIBTestSetup extends DefaultRibPoliciesMockTest {
92 static final Class<? extends AddressFamily> IPV4_AFI = Ipv4AddressFamily.class;
93 private static final Class<? extends AddressFamily> IPV6_AFI = Ipv6AddressFamily.class;
94 static final Class<? extends SubsequentAddressFamily> SAFI = UnicastSubsequentAddressFamily.class;
95 static final TablesKey KEY = new TablesKey(IPV4_AFI, SAFI);
96 static final QName PREFIX_QNAME = QName.create(Ipv4Route.QNAME, "prefix").intern();
97 private static final BgpId RIB_ID = new BgpId("127.0.0.1");
99 private BindingCodecTreeFactory codecFactory;
100 private RIBActivator a1;
101 private RIBSupport<?, ?, ?, ?> ribSupport;
103 private BGPDispatcher dispatcher;
106 private DOMDataBroker dom;
109 private TransactionChain chain;
112 private WriteTransaction transWrite;
115 private DOMTransactionChain domChain;
118 private DOMDataTreeWriteTransaction domTransWrite;
121 private FluentFuture<? extends CommitInfo> future;
124 private DOMDataTreeChangeService service;
127 private ClusterSingletonServiceProvider clusterSingletonServiceProvider;
129 private static ModuleInfoBackedContext createClassLoadingStrategy() throws Exception {
130 final ModuleInfoBackedContext ctx = ModuleInfoBackedContext.create();
131 ctx.registerModuleInfo(BindingReflections.getModuleInfo(Ipv4Route.class));
137 public void setUp() throws Exception {
142 public void mockRib() throws Exception {
143 final RIBExtensionProviderContext context = new SimpleRIBExtensionProviderContext();
144 final ModuleInfoBackedContext strategy = createClassLoadingStrategy();
145 final SchemaContext schemaContext = strategy.tryToCreateSchemaContext().get();
146 this.codecFactory = new BindingNormalizedNodeCodecRegistry(
147 BindingRuntimeContext.create(strategy, schemaContext));
148 final List<BgpTableType> localTables = new ArrayList<>();
149 localTables.add(new BgpTableTypeImpl(IPV4_AFI, SAFI));
150 localTables.add(new BgpTableTypeImpl(IPV6_AFI, SAFI));
152 this.a1 = new RIBActivator();
153 this.a1.startRIBExtensionProvider(context, this.mappingService);
155 final CodecsRegistryImpl codecsRegistry = CodecsRegistryImpl.create(this.codecFactory,
156 GeneratedClassLoadingStrategy.getTCCLClassLoadingStrategy());
159 doReturn(mock(ClusterSingletonServiceRegistration.class)).when(this.clusterSingletonServiceProvider)
160 .registerClusterSingletonService(any(ClusterSingletonService.class));
161 this.rib = new RIBImpl(this.tableRegistry, new RibId("test"), new AsNumber(5L), RIB_ID, context,
162 this.dispatcher, codecsRegistry, this.dom, getDataBroker(), this.policies,
163 localTables, Collections.singletonMap(KEY,
164 BasePathSelectionModeFactory.createBestPathSelectionStrategy()));
165 this.rib.onGlobalContextUpdated(schemaContext);
166 this.ribSupport = getRib().getRibSupportContext().getRIBSupport(KEY);
169 @SuppressWarnings("unchecked")
170 private void mockedMethods() throws Exception {
171 MockitoAnnotations.initMocks(this);
172 final ReadTransaction readTx = mock(ReadTransaction.class);
173 doReturn(new TestListenerRegistration()).when(this.service)
174 .registerDataTreeChangeListener(any(DOMDataTreeIdentifier.class),
175 any(ClusteredDOMDataTreeChangeListener.class));
176 doNothing().when(readTx).close();
177 doNothing().when(this.domTransWrite).put(eq(LogicalDatastoreType.OPERATIONAL),
178 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
179 doNothing().when(this.domTransWrite).delete(eq(LogicalDatastoreType.OPERATIONAL),
180 any(YangInstanceIdentifier.class));
181 doNothing().when(this.domTransWrite).merge(eq(LogicalDatastoreType.OPERATIONAL),
182 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
183 doReturn(FluentFutures.immediateFluentFuture(Optional.empty())).when(readTx)
184 .read(eq(LogicalDatastoreType.OPERATIONAL), any(InstanceIdentifier.class));
185 doNothing().when(this.domChain).close();
186 doReturn(this.domTransWrite).when(this.domChain).newWriteOnlyTransaction();
187 doNothing().when(getTransaction()).put(eq(LogicalDatastoreType.OPERATIONAL),
188 eq(YangInstanceIdentifier.of(BgpRib.QNAME)), any(NormalizedNode.class));
189 doReturn(ImmutableClassToInstanceMap.of(DOMDataTreeChangeService.class, this.service)).when(this.dom)
191 doReturn(this.domChain).when(this.dom).createMergingTransactionChain(any(AbstractPeer.class));
192 doReturn(this.transWrite).when(this.chain).newWriteOnlyTransaction();
193 doReturn(Optional.empty()).when(this.future).get();
194 doReturn(this.future).when(this.domTransWrite).commit();
195 doNothing().when(this.future).addListener(any(Runnable.class), any(Executor.class));
196 doNothing().when(this.transWrite).put(eq(LogicalDatastoreType.OPERATIONAL),
197 any(InstanceIdentifier.class), any(DataObject.class), eq(true));
198 doNothing().when(this.transWrite).put(eq(LogicalDatastoreType.OPERATIONAL),
199 any(InstanceIdentifier.class), any(DataObject.class));
200 doReturn(this.future).when(this.transWrite).commit();
203 public Collection<DataTreeCandidate> ipv4Input(final YangInstanceIdentifier target,
204 final ModificationType type, final Ipv4Prefix... prefix) {
205 final Collection<DataTreeCandidate> col = new HashSet<>();
206 final DataTreeCandidate candidate = mock(DataTreeCandidate.class);
207 final DataTreeCandidateNode rootNode = mock(DataTreeCandidateNode.class);
208 doReturn(rootNode).when(candidate).getRootNode();
209 doReturn(type).when(rootNode).getModificationType();
210 doCallRealMethod().when(rootNode).toString();
211 doReturn(target).when(candidate).getRootPath();
212 doCallRealMethod().when(candidate).toString();
213 final Collection<DataTreeCandidateNode> children = new HashSet<>();
214 for (final Ipv4Prefix p : prefix) {
215 final NodeIdentifierWithPredicates routekey =
216 NodeIdentifierWithPredicates.of(Ipv4Route.QNAME, PREFIX_QNAME, p);
217 final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> b =
218 ImmutableNodes.mapEntryBuilder();
219 b.withNodeIdentifier(routekey);
220 b.addChild(Builders.leafBuilder()
221 .withNodeIdentifier(new NodeIdentifier(PREFIX_QNAME)).withValue(p).build());
223 final DataTreeCandidateNode child = mock(DataTreeCandidateNode.class);
224 doReturn(createIdentifier(p)).when(child).getIdentifier();
225 doReturn(java.util.Optional.of(b.build())).when(child).getDataAfter();
226 doReturn(type).when(child).getModificationType();
229 doReturn(children).when(rootNode).getChildNodes();
234 public PathArgument createIdentifier(final Ipv4Prefix prefix) {
235 final NodeIdentifierWithPredicates routekey =
236 NodeIdentifierWithPredicates.of(Ipv4Route.QNAME, PREFIX_QNAME, prefix);
237 return YangInstanceIdentifier.of(PREFIX_QNAME).node(routekey).getLastPathArgument();
240 public RIBImpl getRib() {
244 public DOMDataTreeWriteTransaction getTransaction() {
245 return this.domTransWrite;
250 public void tearDown() {
254 private class TestListenerRegistration implements ListenerRegistration<EventListener> {
256 public EventListener getInstance() {
261 public void close() {