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 com.google.common.base.Optional;
11 import com.google.common.base.Throwables;
12 import com.google.common.util.concurrent.CheckedFuture;
13 import java.util.ArrayList;
14 import java.util.Collection;
15 import java.util.Collections;
16 import java.util.HashMap;
17 import java.util.HashSet;
18 import java.util.List;
20 import java.util.concurrent.Executor;
21 import javassist.ClassPool;
22 import org.junit.After;
23 import org.junit.Before;
24 import org.mockito.Mock;
25 import org.mockito.Mockito;
26 import org.mockito.MockitoAnnotations;
27 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
28 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
29 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
30 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
31 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
32 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
33 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
34 import org.opendaylight.controller.md.sal.dom.api.DOMDataBrokerExtension;
35 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeListener;
36 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeService;
37 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeIdentifier;
38 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
39 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
40 import org.opendaylight.protocol.bgp.mode.impl.base.BasePathSelectionModeFactory;
41 import org.opendaylight.protocol.bgp.parser.BgpTableTypeImpl;
42 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPDispatcher;
43 import org.opendaylight.protocol.bgp.rib.spi.RIBExtensionProviderContext;
44 import org.opendaylight.protocol.bgp.rib.spi.RIBSupport;
45 import org.opendaylight.protocol.bgp.rib.spi.SimpleRIBExtensionProviderContext;
46 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.AsNumber;
47 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Address;
48 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Prefix;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.routes.ipv4.routes.Ipv4Route;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.BgpTableType;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.BgpRib;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.RibId;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.Rib;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.AddressFamily;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Ipv4AddressFamily;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.SubsequentAddressFamily;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.UnicastSubsequentAddressFamily;
59 import org.opendaylight.yangtools.binding.data.codec.api.BindingCodecTreeFactory;
60 import org.opendaylight.yangtools.binding.data.codec.gen.impl.DataObjectSerializerGenerator;
61 import org.opendaylight.yangtools.binding.data.codec.gen.impl.StreamWriterGenerator;
62 import org.opendaylight.yangtools.binding.data.codec.impl.BindingNormalizedNodeCodecRegistry;
63 import org.opendaylight.yangtools.concepts.ListenerRegistration;
64 import org.opendaylight.yangtools.sal.binding.generator.api.ClassLoadingStrategy;
65 import org.opendaylight.yangtools.sal.binding.generator.impl.GeneratedClassLoadingStrategy;
66 import org.opendaylight.yangtools.sal.binding.generator.impl.ModuleInfoBackedContext;
67 import org.opendaylight.yangtools.sal.binding.generator.util.BindingRuntimeContext;
68 import org.opendaylight.yangtools.sal.binding.generator.util.JavassistUtils;
69 import org.opendaylight.yangtools.yang.binding.DataObject;
70 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
71 import org.opendaylight.yangtools.yang.binding.util.BindingReflections;
72 import org.opendaylight.yangtools.yang.common.QName;
73 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
74 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
75 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
76 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
77 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
78 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
79 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
80 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode;
81 import org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType;
82 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
83 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
84 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
85 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
87 public class AbstractRIBTestSetup {
90 private final Ipv4Address clusterId = new Ipv4Address("128.0.0.1");
91 private final Ipv4Address ribId = new Ipv4Address("127.0.0.1");
92 static final Class<? extends AddressFamily> AFI = Ipv4AddressFamily.class;
93 static final Class<? extends SubsequentAddressFamily> SAFI = UnicastSubsequentAddressFamily.class;
94 static final TablesKey KEY = new TablesKey(AFI, SAFI);
95 private BindingCodecTreeFactory codecFactory;
96 private RIBActivator a1;
97 RIBSupport ribSupport;
98 static final QName PREFIX_QNAME = QName.create(Ipv4Route.QNAME, "prefix").intern();
101 private BGPDispatcher dispatcher;
104 private DataBroker dps;
107 private DOMDataBroker dom;
110 private BindingTransactionChain chain;
113 private WriteTransaction transWrite;
116 private DOMTransactionChain domChain;
119 private DOMDataWriteTransaction domTransWrite;
122 private CheckedFuture<?,?> future;
125 private Optional<Rib> o;
128 private DOMDataTreeChangeService service;
131 public void setUp() throws Exception {
135 public void mockRib() throws Exception {
136 final RIBExtensionProviderContext context = new SimpleRIBExtensionProviderContext();
137 final ModuleInfoBackedContext strategy = createClassLoadingStrategy();
138 final SchemaContext schemaContext = strategy.tryToCreateSchemaContext().get();
139 this.codecFactory = createCodecFactory(strategy,schemaContext);
140 final List<BgpTableType> localTables = new ArrayList<>();
141 localTables.add(new BgpTableTypeImpl(AFI, SAFI));
143 this.a1 = new RIBActivator();
144 this.a1.startRIBExtensionProvider(context);
146 this.rib = new RIBImpl(new RibId("test"), new AsNumber(5L), this.ribId,
147 this.clusterId, context , this.dispatcher, this.codecFactory, this.dps, this.dom,
148 localTables, Collections.singletonMap(new TablesKey(AFI, SAFI), BasePathSelectionModeFactory.createBestPathSelectionStrategy()),
149 GeneratedClassLoadingStrategy.getTCCLClassLoadingStrategy());
150 this.rib.onGlobalContextUpdated(schemaContext);
151 this.ribSupport = getRib().getRibSupportContext().getRIBSupportContext(KEY).getRibSupport();
154 private static ModuleInfoBackedContext createClassLoadingStrategy() {
155 final ModuleInfoBackedContext ctx = ModuleInfoBackedContext.create();
157 ctx.registerModuleInfo(BindingReflections.getModuleInfo(Ipv4Route.class));
158 } catch (final Exception e) {
159 throw Throwables.propagate(e);
164 private static BindingCodecTreeFactory createCodecFactory(final ClassLoadingStrategy str, final SchemaContext ctx) {
165 final DataObjectSerializerGenerator generator = StreamWriterGenerator.create(JavassistUtils.forClassPool(ClassPool.getDefault()));
166 final BindingNormalizedNodeCodecRegistry codec = new BindingNormalizedNodeCodecRegistry(generator);
167 codec.onBindingRuntimeContextUpdated(BindingRuntimeContext.create(str, ctx));
171 @SuppressWarnings("unchecked")
172 private void mockedMethods() throws Exception {
173 MockitoAnnotations.initMocks(this);
174 final ReadOnlyTransaction readTx = Mockito.mock(ReadOnlyTransaction.class);
175 Mockito.doReturn(new listenerRegistration()).when(this.service).registerDataTreeChangeListener(Mockito.any(DOMDataTreeIdentifier.class), Mockito.any(DOMDataTreeChangeListener.class));
176 final Map<Class<? extends DOMDataBrokerExtension>, DOMDataBrokerExtension> map = new HashMap<>();
177 map.put(DOMDataTreeChangeService.class, this.service);
178 Mockito.doNothing().when(readTx).close();
179 Mockito.doReturn(readTx).when(this.dps).newReadOnlyTransaction();
180 final CheckedFuture<Optional<DataObject>, ReadFailedException> readFuture = Mockito.mock(CheckedFuture.class);
181 Mockito.doNothing().when(this.domTransWrite).put(Mockito.eq(LogicalDatastoreType.OPERATIONAL), Mockito.any(YangInstanceIdentifier.class), Mockito.any(NormalizedNode.class));
182 Mockito.doNothing().when(this.domTransWrite).delete(Mockito.eq(LogicalDatastoreType.OPERATIONAL), Mockito.any(YangInstanceIdentifier.class));
183 Mockito.doNothing().when(this.domTransWrite).merge(Mockito.eq(LogicalDatastoreType.OPERATIONAL), Mockito.any(YangInstanceIdentifier.class), Mockito.any(NormalizedNode.class));
184 Mockito.doReturn(Optional.<DataObject>absent()).when(readFuture).checkedGet();
185 Mockito.doReturn(readFuture).when(readTx).read(Mockito.eq(LogicalDatastoreType.OPERATIONAL), Mockito.any(InstanceIdentifier.class));
186 Mockito.doReturn(this.chain).when(this.dps).createTransactionChain(Mockito.any(RIBImpl.class));
187 Mockito.doNothing().when(this.domChain).close();
188 Mockito.doReturn(this.domTransWrite).when(this.domChain).newWriteOnlyTransaction();
189 Mockito.doNothing().when(getTransaction()).put(Mockito.eq(LogicalDatastoreType.OPERATIONAL), Mockito.eq(YangInstanceIdentifier.of(BgpRib.QNAME)), Mockito.any(NormalizedNode.class));
190 Mockito.doReturn(map).when(this.dom).getSupportedExtensions();
191 Mockito.doReturn(this.domChain).when(this.dom).createTransactionChain(Mockito.any(BGPPeer.class));
192 Mockito.doReturn(this.transWrite).when(this.chain).newWriteOnlyTransaction();
193 Mockito.doReturn(false).when(this.o).isPresent();
194 Mockito.doReturn(this.o).when(this.future).checkedGet();
195 Mockito.doReturn(this.future).when(this.domTransWrite).submit();
196 Mockito.doNothing().when(this.future).addListener(Mockito.any(Runnable.class), Mockito.any(Executor.class));
197 Mockito.doNothing().when(this.transWrite).put(Mockito.eq(LogicalDatastoreType.OPERATIONAL), Mockito.any(InstanceIdentifier.class), Mockito.any(DataObject.class), Mockito.eq(true));
198 Mockito.doNothing().when(this.transWrite).put(Mockito.eq(LogicalDatastoreType.OPERATIONAL), Mockito.any(InstanceIdentifier.class), Mockito.any(DataObject.class));
199 Mockito.doReturn(this.future).when(this.transWrite).submit();
202 public Collection<DataTreeCandidate> ipv4Input(final YangInstanceIdentifier target, final ModificationType type, final Ipv4Prefix... prefix) {
203 final Collection<DataTreeCandidate> col = new HashSet<>();
204 final DataTreeCandidate candidate = Mockito.mock(DataTreeCandidate.class);
205 final DataTreeCandidateNode rootNode = Mockito.mock(DataTreeCandidateNode.class);
206 Mockito.doReturn(rootNode).when(candidate).getRootNode();
207 Mockito.doReturn(type).when(rootNode).getModificationType();
208 Mockito.doCallRealMethod().when(rootNode).toString();
209 Mockito.doReturn(target).when(candidate).getRootPath();
210 Mockito.doCallRealMethod().when(candidate).toString();
211 final Collection<DataTreeCandidateNode> children = new HashSet<>();
212 for (final Ipv4Prefix p : prefix) {
213 final NodeIdentifierWithPredicates routekey = new NodeIdentifierWithPredicates(Ipv4Route.QNAME, PREFIX_QNAME, p);
214 final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> b = ImmutableNodes.mapEntryBuilder();
215 b.withNodeIdentifier(routekey);
216 b.addChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(PREFIX_QNAME)).withValue(p).build());
218 final DataTreeCandidateNode child = Mockito.mock(DataTreeCandidateNode.class);
219 Mockito.doReturn(createIdentifier(target, p)).when(child).getIdentifier();
220 Mockito.doReturn(Optional.of(b.build())).when(child).getDataAfter();
221 Mockito.doReturn(type).when(child).getModificationType();
224 Mockito.doReturn(children).when(rootNode).getChildNodes();
229 public PathArgument createIdentifier(final YangInstanceIdentifier base, final Ipv4Prefix prefix) {
230 final NodeIdentifierWithPredicates routekey = new NodeIdentifierWithPredicates(Ipv4Route.QNAME, PREFIX_QNAME, prefix);
231 return YangInstanceIdentifier.of(PREFIX_QNAME).node(routekey).getLastPathArgument();
234 public RIBImpl getRib() {
238 public DOMDataBroker getDOMBroker() {
242 public DOMDataWriteTransaction getTransaction() {
243 return this.domTransWrite;
247 public void tearDown() {
251 private class listenerRegistration implements ListenerRegistration {
253 public Object getInstance() {
257 public void close() {