2 * Copyright (c) 2016 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.spi;
10 import static org.mockito.ArgumentMatchers.any;
11 import static org.mockito.Mockito.doAnswer;
12 import static org.mockito.MockitoAnnotations.initMocks;
14 import com.google.common.base.Preconditions;
15 import com.google.common.collect.Iterables;
16 import java.util.ArrayList;
17 import java.util.Arrays;
18 import java.util.Collection;
19 import java.util.List;
21 import org.junit.Before;
22 import org.mockito.Mock;
23 import org.opendaylight.binding.runtime.spi.ModuleInfoBackedContext;
24 import org.opendaylight.mdsal.binding.dom.adapter.AdapterContext;
25 import org.opendaylight.mdsal.binding.dom.adapter.test.AbstractConcurrentDataBrokerTest;
26 import org.opendaylight.mdsal.binding.dom.adapter.test.AbstractDataBrokerTestCustomizer;
27 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
28 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
29 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.PathId;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.Update;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.Attributes;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.AttributesBuilder;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.Attributes1;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.Attributes2;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.destination.DestinationType;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpReachNlri;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpReachNlriBuilder;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpUnreachNlri;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpUnreachNlriBuilder;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.mp.reach.nlri.AdvertizedRoutesBuilder;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.mp.unreach.nlri.WithdrawnRoutesBuilder;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.BgpRib;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.RibId;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.Route;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.Rib;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.RibKey;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.rib.LocRib;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.Tables;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesBuilder;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.tables.Routes;
53 import org.opendaylight.yangtools.yang.binding.ChildOf;
54 import org.opendaylight.yangtools.yang.binding.ChoiceIn;
55 import org.opendaylight.yangtools.yang.binding.DataObject;
56 import org.opendaylight.yangtools.yang.binding.Identifiable;
57 import org.opendaylight.yangtools.yang.binding.Identifier;
58 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
59 import org.opendaylight.yangtools.yang.common.QName;
60 import org.opendaylight.yangtools.yang.common.Uint32;
61 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
62 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
63 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
64 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
65 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
66 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
67 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
68 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
70 public abstract class AbstractRIBSupportTest<C extends Routes & DataObject & ChoiceIn<Tables>,
71 S extends ChildOf<? super C>,
72 R extends Route & ChildOf<? super S> & Identifiable<I>,
73 I extends Identifier<R>> extends AbstractConcurrentDataBrokerTest {
74 protected static final PathId PATH_ID = new PathId(Uint32.ONE);
75 protected static final Attributes ATTRIBUTES = new AttributesBuilder().build();
76 private static final InstanceIdentifier<LocRib> RIB = InstanceIdentifier.builder(BgpRib.class)
77 .child(Rib.class, new RibKey(new RibId("rib"))).child(LocRib.class).build();
78 private static final InstanceIdentifier<Attributes> ATTRIBUTES_IID = InstanceIdentifier.create(Update.class)
79 .child(Attributes.class);
80 private static final InstanceIdentifier<MpUnreachNlri> MP_UNREACH_IID = ATTRIBUTES_IID
81 .augmentation(Attributes2.class).child(MpUnreachNlri.class);
82 private static final InstanceIdentifier<MpReachNlri> MP_REACH_IID = ATTRIBUTES_IID.augmentation(Attributes1.class)
83 .child(MpReachNlri.class);
85 protected DOMDataTreeWriteTransaction tx;
86 protected List<InstanceIdentifier<R>> deletedRoutes;
87 protected List<Map.Entry<InstanceIdentifier<?>, DataObject>> insertedRoutes;
89 protected AdapterContext adapter;
90 private AbstractRIBSupport<C, S, R, I> abstractRIBSupport;
91 private ModuleInfoBackedContext moduleInfoBackedContext;
93 protected final void setUpTestCustomizer(final AbstractRIBSupport<C, S, R, I> ribSupport) throws Exception {
94 this.abstractRIBSupport = ribSupport;
95 this.moduleInfoBackedContext.registerModuleInfos(Arrays.asList(
96 BindingReflections.getModuleInfo(this.abstractRIBSupport.routesContainerClass()),
97 BindingReflections.getModuleInfo(this.abstractRIBSupport.routesCaseClass()),
98 BindingReflections.getModuleInfo(this.abstractRIBSupport.routesListClass())));
102 public void setUp() throws Exception {
104 doAnswer(invocation -> {
105 final Object[] args = invocation.getArguments();
106 AbstractRIBSupportTest.this.insertedRoutes.add(adapter.currentSerializer()
107 .fromNormalizedNode((YangInstanceIdentifier) args[1], (NormalizedNode<?, ?>) args[2]));
109 }).when(this.tx).put(any(LogicalDatastoreType.class), any(YangInstanceIdentifier.class),
110 any(NormalizedNode.class));
112 doAnswer(invocation -> {
113 final Object[] args = invocation.getArguments();
114 AbstractRIBSupportTest.this.deletedRoutes.add((InstanceIdentifier)
115 adapter.currentSerializer().fromYangInstanceIdentifier((YangInstanceIdentifier) args[1]));
117 }).when(this.tx).delete(any(LogicalDatastoreType.class), any(YangInstanceIdentifier.class));
118 this.deletedRoutes = new ArrayList<>();
119 this.insertedRoutes = new ArrayList<>();
120 this.moduleInfoBackedContext = ModuleInfoBackedContext.create();
124 protected final AbstractDataBrokerTestCustomizer createDataBrokerTestCustomizer() {
125 final AbstractDataBrokerTestCustomizer customizer = super.createDataBrokerTestCustomizer();
126 this.adapter = customizer.getAdapterContext();
130 protected final ContainerNode createNlriWithDrawnRoute(final DestinationType destUnreach) {
131 final MpUnreachNlri mpReach = new MpUnreachNlriBuilder().setWithdrawnRoutes(new WithdrawnRoutesBuilder()
132 .setDestinationType(destUnreach).build()).build();
133 final Map.Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> result = this.adapter.currentSerializer()
134 .toNormalizedNode(MP_UNREACH_IID, mpReach);
135 return (ContainerNode) result.getValue();
138 protected final ContainerNode createNlriAdvertiseRoute(final DestinationType destReach) {
139 final MpReachNlri mpReach = new MpReachNlriBuilder().setAdvertizedRoutes(new AdvertizedRoutesBuilder()
140 .setDestinationType(destReach).build()).build();
141 final Map.Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> result = this.adapter.currentSerializer()
142 .toNormalizedNode(MP_REACH_IID, mpReach);
143 return (ContainerNode) result.getValue();
146 protected final ContainerNode createAttributes() {
147 return (ContainerNode) this.adapter.currentSerializer().toNormalizedNode(ATTRIBUTES_IID, ATTRIBUTES).getValue();
150 protected final MapEntryNode createEmptyTable() {
151 final Tables tables = new TablesBuilder().withKey(getTablesKey())
152 .setAttributes(new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329
153 .rib.tables.AttributesBuilder().build()).build();
154 return (MapEntryNode) this.adapter.currentSerializer().toNormalizedNode(tablesIId(), tables).getValue();
157 protected final ChoiceNode createRoutes(final Routes routes) {
158 final Tables tables = new TablesBuilder().withKey(getTablesKey()).setRoutes(routes).build();
159 return (ChoiceNode) ((MapEntryNode) this.adapter.currentSerializer().toNormalizedNode(tablesIId(), tables)
160 .getValue()).getChild(new NodeIdentifier(BindingReflections.findQName(Routes.class))).get();
163 protected final Collection<MapEntryNode> createRoutes(final S routes) {
164 Preconditions.checkArgument(routes.implementedInterface()
165 .equals(this.abstractRIBSupport.routesContainerClass()));
166 final InstanceIdentifier<S> routesIId = routesIId();
167 final Map.Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> normalizedNode = this.adapter.currentSerializer()
168 .toNormalizedNode(routesIId, routes);
169 final ContainerNode container = (ContainerNode) normalizedNode.getValue();
170 final NodeIdentifier routeNid = new NodeIdentifier(getRouteListQname());
171 return ((MapNode) container.getChild(routeNid).get()).getValue();
174 private TablesKey getTablesKey() {
175 return new TablesKey(this.abstractRIBSupport.getAfi(), this.abstractRIBSupport.getSafi());
178 private InstanceIdentifier<Tables> tablesIId() {
179 return RIB.child(Tables.class, getTablesKey());
182 private InstanceIdentifier<S> routesIId() {
183 final InstanceIdentifier<Tables> tables = tablesIId();
184 return tables.child(this.abstractRIBSupport.routesCaseClass(), this.abstractRIBSupport.routesContainerClass());
187 protected final YangInstanceIdentifier getTablePath() {
188 final InstanceIdentifier<Tables> tables = tablesIId();
189 return this.adapter.currentSerializer().toYangInstanceIdentifier(tables);
192 protected final YangInstanceIdentifier getRoutePath() {
193 final InstanceIdentifier<S> routesIId = routesIId();
194 return this.adapter.currentSerializer().toYangInstanceIdentifier(routesIId).node(getRouteListQname());
197 private QName getRouteListQname() {
198 return BindingReflections.findQName(this.abstractRIBSupport.routesListClass())
199 .withModule(BindingReflections.getQNameModule(this.abstractRIBSupport.routesCaseClass()));
202 protected final NodeIdentifierWithPredicates createRouteNIWP(final S routes) {
203 final Collection<MapEntryNode> map = createRoutes(routes);
204 return Iterables.getOnlyElement(map).getIdentifier();