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.dom.codec.api.BindingNormalizedNodeSerializer.NodeResult;
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.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.InstanceIdentifier;
57 import org.opendaylight.yangtools.yang.binding.KeyAware;
58 import org.opendaylight.yangtools.yang.common.Uint32;
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> & KeyAware<?>> extends AbstractConcurrentDataBrokerTest {
71 protected static final @NonNull PathId PATH_ID = new PathId(Uint32.ONE);
72 protected static final @NonNull Attributes ATTRIBUTES = new AttributesBuilder().build();
73 private static final InstanceIdentifier<LocRib> RIB = InstanceIdentifier.builder(BgpRib.class)
74 .child(Rib.class, new RibKey(new RibId("rib"))).child(LocRib.class).build();
77 protected DOMDataTreeWriteTransaction tx;
78 protected List<InstanceIdentifier<R>> deletedRoutes;
79 protected List<Map.Entry<InstanceIdentifier<?>, DataObject>> insertedRoutes;
81 protected AdapterContext adapter;
82 private AbstractRIBSupport<C, S, R> abstractRIBSupport;
84 protected final void setUpTestCustomizer(final AbstractRIBSupport<C, S, R> ribSupport) throws Exception {
85 abstractRIBSupport = ribSupport;
89 public void setUp() throws Exception {
91 doAnswer(invocation -> {
92 final var path = invocation.getArgument(1, YangInstanceIdentifier.class);
93 final var data = invocation.getArgument(2, NormalizedNode.class);
95 AbstractRIBSupportTest.this.insertedRoutes.add(adapter.currentSerializer().fromNormalizedNode(path, data));
97 }).when(tx).put(any(LogicalDatastoreType.class), any(YangInstanceIdentifier.class),
98 any(NormalizedNode.class));
100 doAnswer(invocation -> {
101 final var path = invocation.getArgument(1, YangInstanceIdentifier.class);
103 AbstractRIBSupportTest.this.deletedRoutes.add((InstanceIdentifier)
104 adapter.currentSerializer().fromYangInstanceIdentifier(path));
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().getStreamChild(Update.class).getStreamDataObject(Attributes.class);
122 protected final ContainerNode createNlriWithDrawnRoute(final DestinationType destUnreach) {
123 return (ContainerNode) updateAttributesCodec()
124 .getStreamChild(AttributesUnreach.class).getStreamDataObject(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 .getStreamChild(AttributesReach.class).getStreamDataObject(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(abstractRIBSupport.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().toNormalizedDataObject(tablesIId(), tables).node();
149 protected final ChoiceNode createRoutes(final Routes routes) {
150 final Tables tables = new TablesBuilder().withKey(abstractRIBSupport.getTablesKey()).setRoutes(routes).build();
151 return (ChoiceNode) verifyNotNull(((MapEntryNode) adapter.currentSerializer()
152 .toNormalizedDataObject(tablesIId(), tables).node())
153 .childByArg(new NodeIdentifier(Routes.QNAME)));
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 NodeResult normalizedNode = adapter.currentSerializer().toNormalizedDataObject(routesIId, routes);
161 final ContainerNode container = (ContainerNode) normalizedNode.node();
162 final NodeIdentifier routeNid = new NodeIdentifier(abstractRIBSupport.routeQName());
163 return ((MapNode) container.getChildByArg(routeNid)).body();
166 private InstanceIdentifier<Tables> tablesIId() {
167 return RIB.child(Tables.class, abstractRIBSupport.getTablesKey());
170 private InstanceIdentifier<S> routesIId() {
171 final InstanceIdentifier<Tables> tables = tablesIId();
172 return tables.child(abstractRIBSupport.routesCaseClass(), abstractRIBSupport.routesContainerClass());
175 protected final YangInstanceIdentifier getTablePath() {
176 final InstanceIdentifier<Tables> tables = tablesIId();
177 return adapter.currentSerializer().toYangInstanceIdentifier(tables);
180 protected final YangInstanceIdentifier getRoutePath() {
181 final InstanceIdentifier<S> routesIId = routesIId();
182 return adapter.currentSerializer().toYangInstanceIdentifier(routesIId).node(abstractRIBSupport.routeQName());
185 protected final NodeIdentifierWithPredicates createRouteNIWP(final S routes) {
186 final Collection<MapEntryNode> map = createRoutes(routes);
187 return Iterables.getOnlyElement(map).name();