bgp/rib-spi/src/test/java/org/opendaylight/protocol/bgp/rib/spi/AbstractRIBSupportTest.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.protocol.bgp.rib.spi;
   9
  10 import static org.mockito.ArgumentMatchers.any;
  11 import static org.mockito.Mockito.doAnswer;
  12 import static org.mockito.MockitoAnnotations.initMocks;
  13
  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;
  19 import java.util.Map;
  20 import org.junit.Before;
  21 import org.mockito.Mock;
  22 import org.opendaylight.mdsal.binding.dom.adapter.test.AbstractConcurrentDataBrokerTest;
  23 import org.opendaylight.mdsal.binding.dom.adapter.test.AbstractDataBrokerTestCustomizer;
  24 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
  25 import org.opendaylight.mdsal.binding.generator.impl.ModuleInfoBackedContext;
  26 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
  27 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  28 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.PathId;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.Update;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.Attributes;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.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.common.Uint32;
  60 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  61 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  62 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  63 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
  64 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  65 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  66 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  67 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  68
  69 public abstract class AbstractRIBSupportTest<C extends Routes & DataObject & ChoiceIn<Tables>,
  70         S extends ChildOf<? super C>,
  71         R extends Route & ChildOf<? super S> & Identifiable<I>,
  72         I extends Identifier<R>> 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();
  77     private static final InstanceIdentifier<Attributes> ATTRIBUTES_IID = InstanceIdentifier.create(Update.class)
  78             .child(Attributes.class);
  79     private static final InstanceIdentifier<MpUnreachNlri> MP_UNREACH_IID = ATTRIBUTES_IID
  80             .augmentation(Attributes2.class).child(MpUnreachNlri.class);
  81     private static final InstanceIdentifier<MpReachNlri> MP_REACH_IID = ATTRIBUTES_IID.augmentation(Attributes1.class)
  82             .child(MpReachNlri.class);
  83     @Mock
  84     protected DOMDataTreeWriteTransaction tx;
  85     protected List<InstanceIdentifier<R>> deletedRoutes;
  86     protected List<Map.Entry<InstanceIdentifier<?>, DataObject>> insertedRoutes;
  87
  88     protected BindingNormalizedNodeSerializer mappingService;
  89     private AbstractRIBSupport<C, S, R, I> abstractRIBSupport;
  90     private ModuleInfoBackedContext moduleInfoBackedContext;
  91
  92     protected final void setUpTestCustomizer(final AbstractRIBSupport<C, S, R, I> ribSupport) throws Exception {
  93         this.abstractRIBSupport = ribSupport;
  94         this.moduleInfoBackedContext
  95                 .registerModuleInfo(BindingReflections.getModuleInfo(this.abstractRIBSupport.routesContainerClass()));
  96         this.moduleInfoBackedContext
  97                 .registerModuleInfo(BindingReflections.getModuleInfo(this.abstractRIBSupport.routesCaseClass()));
  98         this.moduleInfoBackedContext
  99                 .registerModuleInfo(BindingReflections.getModuleInfo(this.abstractRIBSupport.routesListClass()));
 100     }
 101
 102     @Before
 103     public void setUp() throws Exception {
 104         initMocks(this);
 105         doAnswer(invocation -> {
 106             final Object[] args = invocation.getArguments();
 107             AbstractRIBSupportTest.this.insertedRoutes.add(AbstractRIBSupportTest.this.mappingService
 108                     .fromNormalizedNode((YangInstanceIdentifier) args[1], (NormalizedNode<?, ?>) args[2]));
 109             return args[1];
 110         }).when(this.tx).put(any(LogicalDatastoreType.class), any(YangInstanceIdentifier.class),
 111                 any(NormalizedNode.class));
 112
 113         doAnswer(invocation -> {
 114             final Object[] args = invocation.getArguments();
 115             AbstractRIBSupportTest.this.deletedRoutes.add((InstanceIdentifier)
 116                     this.mappingService.fromYangInstanceIdentifier((YangInstanceIdentifier) args[1]));
 117             return args[1];
 118         }).when(this.tx).delete(any(LogicalDatastoreType.class), any(YangInstanceIdentifier.class));
 119         this.deletedRoutes = new ArrayList<>();
 120         this.insertedRoutes = new ArrayList<>();
 121         this.moduleInfoBackedContext = ModuleInfoBackedContext.create();
 122     }
 123
 124     @Override
 125     protected final AbstractDataBrokerTestCustomizer createDataBrokerTestCustomizer() {
 126         final AbstractDataBrokerTestCustomizer customizer = super.createDataBrokerTestCustomizer();
 127         this.mappingService = customizer.getBindingToNormalized();
 128         return customizer;
 129     }
 130
 131     protected final ContainerNode createNlriWithDrawnRoute(final DestinationType destUnreach) {
 132         final MpUnreachNlri mpReach = new MpUnreachNlriBuilder().setWithdrawnRoutes(new WithdrawnRoutesBuilder()
 133                 .setDestinationType(destUnreach).build()).build();
 134         final Map.Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> result = this.mappingService
 135                 .toNormalizedNode(MP_UNREACH_IID, mpReach);
 136         return (ContainerNode) result.getValue();
 137     }
 138
 139     protected final ContainerNode createNlriAdvertiseRoute(final DestinationType destReach) {
 140         final MpReachNlri mpReach = new MpReachNlriBuilder().setAdvertizedRoutes(new AdvertizedRoutesBuilder()
 141                 .setDestinationType(destReach).build()).build();
 142         final Map.Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> result = this.mappingService
 143                 .toNormalizedNode(MP_REACH_IID, mpReach);
 144         return (ContainerNode) result.getValue();
 145     }
 146
 147     protected final ContainerNode createAttributes() {
 148         return (ContainerNode) this.mappingService.toNormalizedNode(ATTRIBUTES_IID, ATTRIBUTES).getValue();
 149     }
 150
 151     protected final MapEntryNode createEmptyTable() {
 152         final Tables tables = new TablesBuilder().withKey(getTablesKey())
 153             .setAttributes(new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329
 154                 .rib.tables.AttributesBuilder().build()).build();
 155         return (MapEntryNode) this.mappingService.toNormalizedNode(tablesIId(), tables).getValue();
 156     }
 157
 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();
 162     }
 163
 164     protected final Collection<MapEntryNode> createRoutes(final S routes) {
 165         Preconditions.checkArgument(routes.implementedInterface()
 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();
 173     }
 174
 175     private TablesKey getTablesKey() {
 176         return new TablesKey(this.abstractRIBSupport.getAfi(), this.abstractRIBSupport.getSafi());
 177     }
 178
 179     private InstanceIdentifier<Tables> tablesIId() {
 180         return RIB.child(Tables.class, getTablesKey());
 181     }
 182
 183     private InstanceIdentifier<S> routesIId() {
 184         final InstanceIdentifier<Tables> tables = tablesIId();
 185         return tables.child(this.abstractRIBSupport.routesCaseClass(), this.abstractRIBSupport.routesContainerClass());
 186     }
 187
 188     protected final YangInstanceIdentifier getTablePath() {
 189         final InstanceIdentifier<Tables> tables = tablesIId();
 190         return this.mappingService.toYangInstanceIdentifier(tables);
 191     }
 192
 193     protected final YangInstanceIdentifier getRoutePath() {
 194         final InstanceIdentifier<S> routesIId = routesIId();
 195         return this.mappingService.toYangInstanceIdentifier(routesIId).node(getRouteListQname());
 196     }
 197
 198     private QName getRouteListQname() {
 199         return BindingReflections.findQName(this.abstractRIBSupport.routesListClass())
 200                 .withModule(BindingReflections.getQNameModule(this.abstractRIBSupport.routesCaseClass()));
 201     }
 202
 203     protected final NodeIdentifierWithPredicates createRouteNIWP(final S routes) {
 204         final Collection<MapEntryNode> map = createRoutes(routes);
 205         return Iterables.getOnlyElement(map).getIdentifier();
 206     }
 207 }