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.Matchers.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.Collection;
18 import java.util.List;
20 import org.junit.Before;
21 import org.mockito.Mock;
22 import org.opendaylight.controller.md.sal.binding.test.AbstractConcurrentDataBrokerTest;
23 import org.opendaylight.controller.md.sal.binding.test.AbstractDataBrokerTestCustomizer;
24 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
25 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
26 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
27 import org.opendaylight.mdsal.binding.generator.impl.ModuleInfoBackedContext;
28 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.PathId;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.Update;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.Attributes;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.AttributesBuilder;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.Attributes1;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.Attributes2;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.destination.DestinationType;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpReachNlri;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpReachNlriBuilder;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpUnreachNlri;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpUnreachNlriBuilder;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.mp.reach.nlri.AdvertizedRoutesBuilder;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.mp.unreach.nlri.WithdrawnRoutesBuilder;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.BgpRib;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.RibId;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.Route;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.Rib;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.RibKey;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.rib.LocRib;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.Tables;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesBuilder;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.tables.Routes;
52 import org.opendaylight.yangtools.yang.binding.ChildOf;
53 import org.opendaylight.yangtools.yang.binding.ChoiceIn;
54 import org.opendaylight.yangtools.yang.binding.DataObject;
55 import org.opendaylight.yangtools.yang.binding.Identifiable;
56 import org.opendaylight.yangtools.yang.binding.Identifier;
57 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
58 import org.opendaylight.yangtools.yang.common.QName;
59 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
60 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
61 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
62 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
63 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
64 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
65 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
66 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
68 public abstract class AbstractRIBSupportTest<C extends Routes & DataObject & ChoiceIn<Tables>,
69 S extends ChildOf<? super C>,
70 R extends Route & ChildOf<? super S> & Identifiable<I>,
71 I extends Identifier<R>> extends AbstractConcurrentDataBrokerTest {
72 protected static final PathId PATH_ID = new PathId(1L);
73 protected static final Attributes ATTRIBUTES = new AttributesBuilder().build();
74 private static final InstanceIdentifier<LocRib> RIB = InstanceIdentifier.builder(BgpRib.class)
75 .child(Rib.class, new RibKey(new RibId("rib"))).child(LocRib.class).build();
76 private static final InstanceIdentifier<Attributes> ATTRIBUTES_IID = InstanceIdentifier.create(Update.class)
77 .child(Attributes.class);
78 private static final InstanceIdentifier<MpUnreachNlri> MP_UNREACH_IID = ATTRIBUTES_IID
79 .augmentation(Attributes2.class).child(MpUnreachNlri.class);
80 private static final InstanceIdentifier<MpReachNlri> MP_REACH_IID = ATTRIBUTES_IID.augmentation(Attributes1.class)
81 .child(MpReachNlri.class);
83 protected DOMDataWriteTransaction tx;
84 protected List<InstanceIdentifier<R>> deletedRoutes;
85 protected List<Map.Entry<InstanceIdentifier<?>, DataObject>> insertedRoutes;
87 protected BindingNormalizedNodeSerializer mappingService;
88 private AbstractRIBSupport<C, S, R, I> abstractRIBSupport;
89 private ModuleInfoBackedContext moduleInfoBackedContext;
91 protected final void setUpTestCustomizer(final AbstractRIBSupport<C, S, R, I> ribSupport) throws Exception {
92 this.abstractRIBSupport = ribSupport;
93 this.moduleInfoBackedContext
94 .registerModuleInfo(BindingReflections.getModuleInfo(this.abstractRIBSupport.routesContainerClass()));
95 this.moduleInfoBackedContext
96 .registerModuleInfo(BindingReflections.getModuleInfo(this.abstractRIBSupport.routesCaseClass()));
97 this.moduleInfoBackedContext
98 .registerModuleInfo(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(AbstractRIBSupportTest.this.mappingService
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 this.mappingService.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.mappingService = customizer.getBindingToNormalized();
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.mappingService
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.mappingService
142 .toNormalizedNode(MP_REACH_IID, mpReach);
143 return (ContainerNode) result.getValue();
146 protected final ContainerNode createAttributes() {
147 return (ContainerNode) this.mappingService.toNormalizedNode(ATTRIBUTES_IID, ATTRIBUTES).getValue();
150 protected final MapEntryNode createEmptyTable(final Routes routes) {
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())
154 .setRoutes(routes).build();
155 return (MapEntryNode) this.mappingService.toNormalizedNode(tablesIId(), tables).getValue();
158 protected final ChoiceNode createRoutes(final Routes routes) {
159 final Tables tables = new TablesBuilder().withKey(getTablesKey()).setRoutes(routes).build();
160 return (ChoiceNode) ((MapEntryNode) this.mappingService.toNormalizedNode(tablesIId(), tables).getValue())
161 .getChild(new NodeIdentifier(BindingReflections.findQName(Routes.class))).get();
164 protected final Collection<MapEntryNode> createRoutes(final S routes) {
165 Preconditions.checkArgument(routes.getImplementedInterface()
166 .equals(this.abstractRIBSupport.routesContainerClass()));
167 final InstanceIdentifier<S> routesIId = routesIId();
168 final Map.Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> normalizedNode = this.mappingService
169 .toNormalizedNode(routesIId, routes);
170 final ContainerNode container = (ContainerNode) normalizedNode.getValue();
171 final NodeIdentifier routeNid = new NodeIdentifier(getRouteListQname());
172 return ((MapNode) container.getChild(routeNid).get()).getValue();
175 private TablesKey getTablesKey() {
176 return new TablesKey(this.abstractRIBSupport.getAfi(), this.abstractRIBSupport.getSafi());
179 private InstanceIdentifier<Tables> tablesIId() {
180 return RIB.child(Tables.class, getTablesKey());
183 private InstanceIdentifier<S> routesIId() {
184 final InstanceIdentifier<Tables> tables = tablesIId();
185 return tables.child(this.abstractRIBSupport.routesCaseClass(), this.abstractRIBSupport.routesContainerClass());
188 protected final YangInstanceIdentifier getTablePath() {
189 final InstanceIdentifier<Tables> tables = tablesIId();
190 return this.mappingService.toYangInstanceIdentifier(tables);
193 protected final YangInstanceIdentifier getRoutePath() {
194 final InstanceIdentifier<S> routesIId = routesIId();
195 return this.mappingService.toYangInstanceIdentifier(routesIId).node(getRouteListQname());
198 private QName getRouteListQname() {
199 return BindingReflections.findQName(this.abstractRIBSupport.routesListClass())
200 .withModule(BindingReflections.getQNameModule(this.abstractRIBSupport.routesCaseClass()));
203 protected final NodeIdentifierWithPredicates createRouteNIWP(final S routes) {
204 final Collection<MapEntryNode> map = createRoutes(routes);
205 return Iterables.getOnlyElement(map).getIdentifier();