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.base.Optional;
18 import com.google.common.util.concurrent.CheckedFuture;
19 import com.google.common.util.concurrent.FluentFuture;
20 import java.util.ArrayList;
21 import java.util.Collection;
22 import java.util.Collections;
23 import java.util.EventListener;
24 import java.util.HashMap;
25 import java.util.HashSet;
26 import java.util.List;
28 import java.util.concurrent.Executor;
29 import javassist.ClassPool;
30 import org.junit.After;
31 import org.junit.Before;
32 import org.mockito.Mock;
33 import org.mockito.MockitoAnnotations;
34 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
35 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
36 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
37 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
38 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
39 import org.opendaylight.controller.md.sal.dom.api.ClusteredDOMDataTreeChangeListener;
40 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
41 import org.opendaylight.controller.md.sal.dom.api.DOMDataBrokerExtension;
42 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeService;
43 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeIdentifier;
44 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
45 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
46 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeFactory;
47 import org.opendaylight.mdsal.binding.dom.codec.gen.impl.DataObjectSerializerGenerator;
48 import org.opendaylight.mdsal.binding.dom.codec.gen.impl.StreamWriterGenerator;
49 import org.opendaylight.mdsal.binding.dom.codec.impl.BindingNormalizedNodeCodecRegistry;
50 import org.opendaylight.mdsal.binding.generator.api.ClassLoadingStrategy;
51 import org.opendaylight.mdsal.binding.generator.impl.GeneratedClassLoadingStrategy;
52 import org.opendaylight.mdsal.binding.generator.impl.ModuleInfoBackedContext;
53 import org.opendaylight.mdsal.binding.generator.util.BindingRuntimeContext;
54 import org.opendaylight.mdsal.binding.generator.util.JavassistUtils;
55 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
56 import org.opendaylight.mdsal.common.api.CommitInfo;
57 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonService;
58 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
59 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceRegistration;
60 import org.opendaylight.protocol.bgp.inet.RIBActivator;
61 import org.opendaylight.protocol.bgp.mode.impl.base.BasePathSelectionModeFactory;
62 import org.opendaylight.protocol.bgp.parser.BgpTableTypeImpl;
63 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPDispatcher;
64 import org.opendaylight.protocol.bgp.rib.spi.RIBExtensionProviderContext;
65 import org.opendaylight.protocol.bgp.rib.spi.RIBSupport;
66 import org.opendaylight.protocol.bgp.rib.spi.SimpleRIBExtensionProviderContext;
67 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
68 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv4.routes.ipv4.routes.Ipv4Route;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.BgpTableType;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.BgpRib;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.RibId;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.Rib;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.AddressFamily;
76 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.BgpId;
77 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.Ipv4AddressFamily;
78 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.Ipv6AddressFamily;
79 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.SubsequentAddressFamily;
80 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.UnicastSubsequentAddressFamily;
81 import org.opendaylight.yangtools.concepts.ListenerRegistration;
82 import org.opendaylight.yangtools.yang.binding.DataObject;
83 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
84 import org.opendaylight.yangtools.yang.common.QName;
85 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
86 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
87 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
88 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
89 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
90 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
91 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
92 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode;
93 import org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType;
94 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
95 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
96 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
97 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
99 public class AbstractRIBTestSetup extends DefaultRibPoliciesMockTest {
101 static final Class<? extends AddressFamily> IPV4_AFI = Ipv4AddressFamily.class;
102 private static final Class<? extends AddressFamily> IPV6_AFI = Ipv6AddressFamily.class;
103 static final Class<? extends SubsequentAddressFamily> SAFI = UnicastSubsequentAddressFamily.class;
104 static final TablesKey KEY = new TablesKey(IPV4_AFI, SAFI);
105 static final QName PREFIX_QNAME = QName.create(Ipv4Route.QNAME, "prefix").intern();
106 private static final BgpId RIB_ID = new BgpId("127.0.0.1");
108 private BindingCodecTreeFactory codecFactory;
109 private RIBActivator a1;
110 private RIBSupport<?, ?, ?, ?> ribSupport;
112 private BGPDispatcher dispatcher;
115 private DOMDataBroker dom;
118 private BindingTransactionChain chain;
121 private WriteTransaction transWrite;
124 private DOMTransactionChain domChain;
127 private DOMDataWriteTransaction domTransWrite;
130 private FluentFuture<? extends CommitInfo> future;
133 private Optional<Rib> optRib;
136 private DOMDataTreeChangeService service;
139 private ClusterSingletonServiceProvider clusterSingletonServiceProvider;
141 private static ModuleInfoBackedContext createClassLoadingStrategy() throws Exception {
142 final ModuleInfoBackedContext ctx = ModuleInfoBackedContext.create();
143 ctx.registerModuleInfo(BindingReflections.getModuleInfo(Ipv4Route.class));
147 private static BindingCodecTreeFactory createCodecFactory(final ClassLoadingStrategy str, final SchemaContext ctx) {
148 final DataObjectSerializerGenerator generator = StreamWriterGenerator
149 .create(JavassistUtils.forClassPool(ClassPool.getDefault()));
150 final BindingNormalizedNodeCodecRegistry codec = new BindingNormalizedNodeCodecRegistry(generator);
151 codec.onBindingRuntimeContextUpdated(BindingRuntimeContext.create(str, ctx));
157 public void setUp() throws Exception {
162 public void mockRib() throws Exception {
163 final RIBExtensionProviderContext context = new SimpleRIBExtensionProviderContext();
164 final ModuleInfoBackedContext strategy = createClassLoadingStrategy();
165 final SchemaContext schemaContext = strategy.tryToCreateSchemaContext().get();
166 this.codecFactory = createCodecFactory(strategy, schemaContext);
167 final List<BgpTableType> localTables = new ArrayList<>();
168 localTables.add(new BgpTableTypeImpl(IPV4_AFI, SAFI));
169 localTables.add(new BgpTableTypeImpl(IPV6_AFI, SAFI));
171 this.a1 = new RIBActivator();
172 this.a1.startRIBExtensionProvider(context, this.mappingService);
174 final CodecsRegistryImpl codecsRegistry = CodecsRegistryImpl.create(this.codecFactory,
175 GeneratedClassLoadingStrategy.getTCCLClassLoadingStrategy());
178 doReturn(mock(ClusterSingletonServiceRegistration.class)).when(this.clusterSingletonServiceProvider)
179 .registerClusterSingletonService(any(ClusterSingletonService.class));
180 this.rib = new RIBImpl(this.tableRegistry, new RibId("test"), new AsNumber(5L), RIB_ID, context,
181 this.dispatcher, codecsRegistry, this.dom, getDataBroker(), this.policies,
182 localTables, Collections.singletonMap(KEY,
183 BasePathSelectionModeFactory.createBestPathSelectionStrategy()));
184 this.rib.onGlobalContextUpdated(schemaContext);
185 this.ribSupport = getRib().getRibSupportContext().getRIBSupport(KEY);
188 @SuppressWarnings("unchecked")
189 private void mockedMethods() throws Exception {
190 MockitoAnnotations.initMocks(this);
191 final ReadOnlyTransaction readTx = mock(ReadOnlyTransaction.class);
192 doReturn(new TestListenerRegistration()).when(this.service)
193 .registerDataTreeChangeListener(any(DOMDataTreeIdentifier.class),
194 any(ClusteredDOMDataTreeChangeListener.class));
195 final Map<Class<? extends DOMDataBrokerExtension>, DOMDataBrokerExtension> map = new HashMap<>();
196 map.put(DOMDataTreeChangeService.class, this.service);
197 doNothing().when(readTx).close();
198 final CheckedFuture<Optional<DataObject>, ReadFailedException> readFuture = mock(CheckedFuture.class);
199 doNothing().when(this.domTransWrite).put(eq(LogicalDatastoreType.OPERATIONAL),
200 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
201 doNothing().when(this.domTransWrite).delete(eq(LogicalDatastoreType.OPERATIONAL),
202 any(YangInstanceIdentifier.class));
203 doNothing().when(this.domTransWrite).merge(eq(LogicalDatastoreType.OPERATIONAL),
204 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
205 doReturn(Optional.absent()).when(readFuture).checkedGet();
206 doReturn(readFuture).when(readTx).read(eq(LogicalDatastoreType.OPERATIONAL), any(InstanceIdentifier.class));
207 doNothing().when(this.domChain).close();
208 doReturn(this.domTransWrite).when(this.domChain).newWriteOnlyTransaction();
209 doNothing().when(getTransaction()).put(eq(LogicalDatastoreType.OPERATIONAL),
210 eq(YangInstanceIdentifier.of(BgpRib.QNAME)), any(NormalizedNode.class));
211 doReturn(map).when(this.dom).getSupportedExtensions();
212 doReturn(this.domChain).when(this.dom).createTransactionChain(any(AbstractPeer.class));
213 doReturn(this.transWrite).when(this.chain).newWriteOnlyTransaction();
214 doReturn(false).when(this.optRib).isPresent();
215 doReturn(this.optRib).when(this.future).get();
216 doReturn(this.future).when(this.domTransWrite).commit();
217 doNothing().when(this.future).addListener(any(Runnable.class), any(Executor.class));
218 doNothing().when(this.transWrite).put(eq(LogicalDatastoreType.OPERATIONAL),
219 any(InstanceIdentifier.class), any(DataObject.class), eq(true));
220 doNothing().when(this.transWrite).put(eq(LogicalDatastoreType.OPERATIONAL),
221 any(InstanceIdentifier.class), any(DataObject.class));
222 doReturn(this.future).when(this.transWrite).commit();
225 public Collection<DataTreeCandidate> ipv4Input(final YangInstanceIdentifier target,
226 final ModificationType type, final Ipv4Prefix... prefix) {
227 final Collection<DataTreeCandidate> col = new HashSet<>();
228 final DataTreeCandidate candidate = mock(DataTreeCandidate.class);
229 final DataTreeCandidateNode rootNode = mock(DataTreeCandidateNode.class);
230 doReturn(rootNode).when(candidate).getRootNode();
231 doReturn(type).when(rootNode).getModificationType();
232 doCallRealMethod().when(rootNode).toString();
233 doReturn(target).when(candidate).getRootPath();
234 doCallRealMethod().when(candidate).toString();
235 final Collection<DataTreeCandidateNode> children = new HashSet<>();
236 for (final Ipv4Prefix p : prefix) {
237 final NodeIdentifierWithPredicates routekey =
238 new NodeIdentifierWithPredicates(Ipv4Route.QNAME, PREFIX_QNAME, p);
239 final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> b =
240 ImmutableNodes.mapEntryBuilder();
241 b.withNodeIdentifier(routekey);
242 b.addChild(Builders.leafBuilder()
243 .withNodeIdentifier(new NodeIdentifier(PREFIX_QNAME)).withValue(p).build());
245 final DataTreeCandidateNode child = mock(DataTreeCandidateNode.class);
246 doReturn(createIdentifier(p)).when(child).getIdentifier();
247 doReturn(java.util.Optional.of(b.build())).when(child).getDataAfter();
248 doReturn(type).when(child).getModificationType();
251 doReturn(children).when(rootNode).getChildNodes();
256 public PathArgument createIdentifier(final Ipv4Prefix prefix) {
257 final NodeIdentifierWithPredicates routekey =
258 new NodeIdentifierWithPredicates(Ipv4Route.QNAME, PREFIX_QNAME, prefix);
259 return YangInstanceIdentifier.of(PREFIX_QNAME).node(routekey).getLastPathArgument();
262 public RIBImpl getRib() {
266 public DOMDataWriteTransaction getTransaction() {
267 return this.domTransWrite;
272 public void tearDown() {
276 private class TestListenerRegistration implements ListenerRegistration<EventListener> {
278 public EventListener getInstance() {
283 public void close() {