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.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.AttributesReach;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.AttributesUnreach;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.reach.MpReachNlri;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.reach.MpReachNlriBuilder;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.reach.mp.reach.nlri.AdvertizedRoutesBuilder;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.unreach.MpUnreachNlri;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.unreach.MpUnreachNlriBuilder;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.unreach.mp.unreach.nlri.WithdrawnRoutesBuilder;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.destination.DestinationType;
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.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.InstanceIdentifier;
57 import org.opendaylight.yangtools.yang.common.Uint32;
58 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
59 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
60 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
61 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
62 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
63 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
64 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
65 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
67 public abstract class AbstractRIBSupportTest<C extends Routes & DataObject & ChoiceIn<Tables>,
68 S extends ChildOf<? super C>,
69 R extends Route & ChildOf<? super S> & Identifiable<?>> extends AbstractConcurrentDataBrokerTest {
70 protected static final PathId PATH_ID = new PathId(Uint32.ONE);
71 protected static final Attributes ATTRIBUTES = new AttributesBuilder().build();
72 private static final InstanceIdentifier<LocRib> RIB = InstanceIdentifier.builder(BgpRib.class)
73 .child(Rib.class, new RibKey(new RibId("rib"))).child(LocRib.class).build();
76 protected DOMDataTreeWriteTransaction tx;
77 protected List<InstanceIdentifier<R>> deletedRoutes;
78 protected List<Map.Entry<InstanceIdentifier<?>, DataObject>> insertedRoutes;
80 protected AdapterContext adapter;
81 private AbstractRIBSupport<C, S, R> abstractRIBSupport;
83 protected final void setUpTestCustomizer(final AbstractRIBSupport<C, S, R> ribSupport) throws Exception {
84 abstractRIBSupport = ribSupport;
88 public void setUp() throws Exception {
90 doAnswer(invocation -> {
91 final var path = invocation.getArgument(1, YangInstanceIdentifier.class);
92 final var data = invocation.getArgument(2, NormalizedNode.class);
94 AbstractRIBSupportTest.this.insertedRoutes.add(adapter.currentSerializer().fromNormalizedNode(path, data));
96 }).when(tx).put(any(LogicalDatastoreType.class), any(YangInstanceIdentifier.class),
97 any(NormalizedNode.class));
99 doAnswer(invocation -> {
100 final var path = invocation.getArgument(1, YangInstanceIdentifier.class);
102 AbstractRIBSupportTest.this.deletedRoutes.add((InstanceIdentifier)
103 adapter.currentSerializer().fromYangInstanceIdentifier(path));
105 }).when(tx).delete(any(LogicalDatastoreType.class), any(YangInstanceIdentifier.class));
106 deletedRoutes = new ArrayList<>();
107 insertedRoutes = new ArrayList<>();
111 protected final AbstractDataBrokerTestCustomizer createDataBrokerTestCustomizer() {
112 final AbstractDataBrokerTestCustomizer customizer = super.createDataBrokerTestCustomizer();
113 adapter = customizer.getAdapterContext();
117 private @NonNull BindingDataObjectCodecTreeNode<Attributes> updateAttributesCodec() {
118 return adapter.currentSerializer().streamChild(Update.class).streamChild(Attributes.class);
121 protected final ContainerNode createNlriWithDrawnRoute(final DestinationType destUnreach) {
122 return (ContainerNode) updateAttributesCodec()
123 .streamChild(AttributesUnreach.class).streamChild(MpUnreachNlri.class)
124 .serialize(new MpUnreachNlriBuilder()
125 .setWithdrawnRoutes(new WithdrawnRoutesBuilder().setDestinationType(destUnreach).build())
129 protected final ContainerNode createNlriAdvertiseRoute(final DestinationType destReach) {
130 return (ContainerNode) updateAttributesCodec()
131 .streamChild(AttributesReach.class).streamChild(MpReachNlri.class)
132 .serialize(new MpReachNlriBuilder()
133 .setAdvertizedRoutes(new AdvertizedRoutesBuilder().setDestinationType(destReach).build())
137 protected final ContainerNode createAttributes() {
138 return (ContainerNode) updateAttributesCodec().serialize(ATTRIBUTES);
141 protected final MapEntryNode createEmptyTable() {
142 final Tables tables = new TablesBuilder().withKey(abstractRIBSupport.getTablesKey())
143 .setAttributes(new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329
144 .rib.tables.AttributesBuilder().build()).build();
145 return (MapEntryNode) adapter.currentSerializer().toNormalizedNode(tablesIId(), tables).getValue();
148 protected final ChoiceNode createRoutes(final Routes routes) {
149 final Tables tables = new TablesBuilder().withKey(abstractRIBSupport.getTablesKey()).setRoutes(routes).build();
150 return (ChoiceNode) verifyNotNull(((MapEntryNode) adapter.currentSerializer()
151 .toNormalizedNode(tablesIId(), tables).getValue())
152 .childByArg(new NodeIdentifier(Routes.QNAME)));
155 protected final Collection<MapEntryNode> createRoutes(final S routes) {
156 Preconditions.checkArgument(routes.implementedInterface()
157 .equals(abstractRIBSupport.routesContainerClass()));
158 final InstanceIdentifier<S> routesIId = routesIId();
159 final Map.Entry<YangInstanceIdentifier, NormalizedNode> normalizedNode = adapter.currentSerializer()
160 .toNormalizedNode(routesIId, routes);
161 final ContainerNode container = (ContainerNode) normalizedNode.getValue();
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).getIdentifier();