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 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;
  14
  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;
  20 import java.util.Map;
  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.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.Identifiable;
  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<?>> extends AbstractConcurrentDataBrokerTest {
  72     protected static final PathId PATH_ID = new PathId(Uint32.ONE);
  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
  77     @Mock
  78     protected DOMDataTreeWriteTransaction tx;
  79     protected List<InstanceIdentifier<R>> deletedRoutes;
  80     protected List<Map.Entry<InstanceIdentifier<?>, DataObject>> insertedRoutes;
  81
  82     protected AdapterContext adapter;
  83     private AbstractRIBSupport<C, S, R> abstractRIBSupport;
  84
  85     protected final void setUpTestCustomizer(final AbstractRIBSupport<C, S, R> ribSupport) throws Exception {
  86         abstractRIBSupport = ribSupport;
  87     }
  88
  89     @Before
  90     public void setUp() throws Exception {
  91         initMocks(this);
  92         doAnswer(invocation -> {
  93             final Object[] args = invocation.getArguments();
  94             AbstractRIBSupportTest.this.insertedRoutes.add(adapter.currentSerializer()
  95                     .fromNormalizedNode((YangInstanceIdentifier) args[1], (NormalizedNode) args[2]));
  96             return args[1];
  97         }).when(tx).put(any(LogicalDatastoreType.class), any(YangInstanceIdentifier.class),
  98                 any(NormalizedNode.class));
  99
 100         doAnswer(invocation -> {
 101             final Object[] args = invocation.getArguments();
 102             AbstractRIBSupportTest.this.deletedRoutes.add((InstanceIdentifier)
 103                 adapter.currentSerializer().fromYangInstanceIdentifier((YangInstanceIdentifier) args[1]));
 104             return args[1];
 105         }).when(tx).delete(any(LogicalDatastoreType.class), any(YangInstanceIdentifier.class));
 106         deletedRoutes = new ArrayList<>();
 107         insertedRoutes = new ArrayList<>();
 108     }
 109
 110     @Override
 111     protected final AbstractDataBrokerTestCustomizer createDataBrokerTestCustomizer() {
 112         final AbstractDataBrokerTestCustomizer customizer = super.createDataBrokerTestCustomizer();
 113         adapter = customizer.getAdapterContext();
 114         return customizer;
 115     }
 116
 117     private @NonNull BindingDataObjectCodecTreeNode<Attributes> updateAttributesCodec() {
 118         return adapter.currentSerializer().streamChild(Update.class).streamChild(Attributes.class);
 119     }
 120
 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())
 126                 .build());
 127     }
 128
 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())
 134                 .build());
 135     }
 136
 137     protected final ContainerNode createAttributes() {
 138         return (ContainerNode) updateAttributesCodec().serialize(ATTRIBUTES);
 139     }
 140
 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();
 146     }
 147
 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(BindingReflections.findQName(Routes.class))));
 153     }
 154
 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(getRouteListQname());
 163         return ((MapNode) container.getChildByArg(routeNid)).body();
 164     }
 165
 166     private InstanceIdentifier<Tables> tablesIId() {
 167         return RIB.child(Tables.class, abstractRIBSupport.getTablesKey());
 168     }
 169
 170     private InstanceIdentifier<S> routesIId() {
 171         final InstanceIdentifier<Tables> tables = tablesIId();
 172         return tables.child(abstractRIBSupport.routesCaseClass(), abstractRIBSupport.routesContainerClass());
 173     }
 174
 175     protected final YangInstanceIdentifier getTablePath() {
 176         final InstanceIdentifier<Tables> tables = tablesIId();
 177         return adapter.currentSerializer().toYangInstanceIdentifier(tables);
 178     }
 179
 180     protected final YangInstanceIdentifier getRoutePath() {
 181         final InstanceIdentifier<S> routesIId = routesIId();
 182         return adapter.currentSerializer().toYangInstanceIdentifier(routesIId).node(getRouteListQname());
 183     }
 184
 185     private QName getRouteListQname() {
 186         return BindingReflections.findQName(abstractRIBSupport.routesListClass())
 187                 .bindTo(BindingReflections.getQNameModule(abstractRIBSupport.routesCaseClass()));
 188     }
 189
 190     protected final NodeIdentifierWithPredicates createRouteNIWP(final S routes) {
 191         final Collection<MapEntryNode> map = createRoutes(routes);
 192         return Iterables.getOnlyElement(map).getIdentifier();
 193     }
 194 }