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 com.google.common.base.Verify.verifyNotNull;
11 import static org.mockito.ArgumentMatchers.any;
12 import static org.mockito.Mockito.doAnswer;
13 import static org.mockito.MockitoAnnotations.initMocks;
15 import com.google.common.base.Preconditions;
16 import com.google.common.collect.Iterables;
17 import java.util.ArrayList;
18 import java.util.Collection;
19 import java.util.List;
21 import org.eclipse.jdt.annotation.NonNull;
22 import org.junit.Before;
23 import org.mockito.Mock;
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.dom.codec.api.BindingDataObjectCodecTreeNode;
28 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
29 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
30 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.PathId;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.Update;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.Attributes;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.AttributesBuilder;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.AttributesReach;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.AttributesUnreach;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.reach.MpReachNlri;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.reach.MpReachNlriBuilder;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.reach.mp.reach.nlri.AdvertizedRoutesBuilder;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.unreach.MpUnreachNlri;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.unreach.MpUnreachNlriBuilder;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.unreach.mp.unreach.nlri.WithdrawnRoutesBuilder;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.destination.DestinationType;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.BgpRib;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.RibId;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.Route;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.Rib;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.RibKey;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.rib.LocRib;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.Tables;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesBuilder;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.tables.Routes;
54 import org.opendaylight.yangtools.yang.binding.ChildOf;
55 import org.opendaylight.yangtools.yang.binding.ChoiceIn;
56 import org.opendaylight.yangtools.yang.binding.DataObject;
57 import org.opendaylight.yangtools.yang.binding.Identifiable;
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<?>> extends AbstractConcurrentDataBrokerTest {
73 protected static final PathId PATH_ID = new PathId(Uint32.ONE);
74 protected static final Attributes ATTRIBUTES = new AttributesBuilder().build();
75 private static final InstanceIdentifier<LocRib> RIB = InstanceIdentifier.builder(BgpRib.class)
76 .child(Rib.class, new RibKey(new RibId("rib"))).child(LocRib.class).build();
79 protected DOMDataTreeWriteTransaction tx;
80 protected List<InstanceIdentifier<R>> deletedRoutes;
81 protected List<Map.Entry<InstanceIdentifier<?>, DataObject>> insertedRoutes;
83 protected AdapterContext adapter;
84 private AbstractRIBSupport<C, S, R> abstractRIBSupport;
86 protected final void setUpTestCustomizer(final AbstractRIBSupport<C, S, R> ribSupport) throws Exception {
87 abstractRIBSupport = ribSupport;
91 public void setUp() throws Exception {
93 doAnswer(invocation -> {
94 final Object[] args = invocation.getArguments();
95 AbstractRIBSupportTest.this.insertedRoutes.add(adapter.currentSerializer()
96 .fromNormalizedNode((YangInstanceIdentifier) args[1], (NormalizedNode) args[2]));
98 }).when(tx).put(any(LogicalDatastoreType.class), any(YangInstanceIdentifier.class),
99 any(NormalizedNode.class));
101 doAnswer(invocation -> {
102 final Object[] args = invocation.getArguments();
103 AbstractRIBSupportTest.this.deletedRoutes.add((InstanceIdentifier)
104 adapter.currentSerializer().fromYangInstanceIdentifier((YangInstanceIdentifier) args[1]));
106 }).when(tx).delete(any(LogicalDatastoreType.class), any(YangInstanceIdentifier.class));
107 deletedRoutes = new ArrayList<>();
108 insertedRoutes = new ArrayList<>();
112 protected final AbstractDataBrokerTestCustomizer createDataBrokerTestCustomizer() {
113 final AbstractDataBrokerTestCustomizer customizer = super.createDataBrokerTestCustomizer();
114 adapter = customizer.getAdapterContext();
118 private @NonNull BindingDataObjectCodecTreeNode<Attributes> updateAttributesCodec() {
119 return adapter.currentSerializer().streamChild(Update.class).streamChild(Attributes.class);
122 protected final ContainerNode createNlriWithDrawnRoute(final DestinationType destUnreach) {
123 return (ContainerNode) updateAttributesCodec()
124 .streamChild(AttributesUnreach.class).streamChild(MpUnreachNlri.class)
125 .serialize(new MpUnreachNlriBuilder()
126 .setWithdrawnRoutes(new WithdrawnRoutesBuilder().setDestinationType(destUnreach).build())
130 protected final ContainerNode createNlriAdvertiseRoute(final DestinationType destReach) {
131 return (ContainerNode) updateAttributesCodec()
132 .streamChild(AttributesReach.class).streamChild(MpReachNlri.class)
133 .serialize(new MpReachNlriBuilder()
134 .setAdvertizedRoutes(new AdvertizedRoutesBuilder().setDestinationType(destReach).build())
138 protected final ContainerNode createAttributes() {
139 return (ContainerNode) updateAttributesCodec().serialize(ATTRIBUTES);
142 protected final MapEntryNode createEmptyTable() {
143 final Tables tables = new TablesBuilder().withKey(getTablesKey())
144 .setAttributes(new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329
145 .rib.tables.AttributesBuilder().build()).build();
146 return (MapEntryNode) adapter.currentSerializer().toNormalizedNode(tablesIId(), tables).getValue();
149 protected final ChoiceNode createRoutes(final Routes routes) {
150 final Tables tables = new TablesBuilder().withKey(getTablesKey()).setRoutes(routes).build();
151 return (ChoiceNode) verifyNotNull(((MapEntryNode) adapter.currentSerializer()
152 .toNormalizedNode(tablesIId(), tables).getValue())
153 .childByArg(new NodeIdentifier(BindingReflections.findQName(Routes.class))));
156 protected final Collection<MapEntryNode> createRoutes(final S routes) {
157 Preconditions.checkArgument(routes.implementedInterface()
158 .equals(abstractRIBSupport.routesContainerClass()));
159 final InstanceIdentifier<S> routesIId = routesIId();
160 final Map.Entry<YangInstanceIdentifier, NormalizedNode> normalizedNode = adapter.currentSerializer()
161 .toNormalizedNode(routesIId, routes);
162 final ContainerNode container = (ContainerNode) normalizedNode.getValue();
163 final NodeIdentifier routeNid = new NodeIdentifier(getRouteListQname());
164 return ((MapNode) container.getChildByArg(routeNid)).body();
167 private TablesKey getTablesKey() {
168 return new TablesKey(abstractRIBSupport.getAfi(), abstractRIBSupport.getSafi());
171 private InstanceIdentifier<Tables> tablesIId() {
172 return RIB.child(Tables.class, getTablesKey());
175 private InstanceIdentifier<S> routesIId() {
176 final InstanceIdentifier<Tables> tables = tablesIId();
177 return tables.child(abstractRIBSupport.routesCaseClass(), abstractRIBSupport.routesContainerClass());
180 protected final YangInstanceIdentifier getTablePath() {
181 final InstanceIdentifier<Tables> tables = tablesIId();
182 return adapter.currentSerializer().toYangInstanceIdentifier(tables);
185 protected final YangInstanceIdentifier getRoutePath() {
186 final InstanceIdentifier<S> routesIId = routesIId();
187 return adapter.currentSerializer().toYangInstanceIdentifier(routesIId).node(getRouteListQname());
190 private QName getRouteListQname() {
191 return BindingReflections.findQName(abstractRIBSupport.routesListClass())
192 .bindTo(BindingReflections.getQNameModule(abstractRIBSupport.routesCaseClass()));
195 protected final NodeIdentifierWithPredicates createRouteNIWP(final S routes) {
196 final Collection<MapEntryNode> map = createRoutes(routes);
197 return Iterables.getOnlyElement(map).getIdentifier();