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
   9 package org.opendaylight.protocol.bgp.rib.spi;
  10
  11 import static org.mockito.Matchers.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.junit.Before;
  22 import org.mockito.Mock;
  23 import org.opendaylight.controller.md.sal.binding.test.AbstractConcurrentDataBrokerTest;
  24 import org.opendaylight.controller.md.sal.binding.test.AbstractDataBrokerTestCustomizer;
  25 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  26 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  27 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
  28 import org.opendaylight.mdsal.binding.generator.impl.ModuleInfoBackedContext;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.PathId;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.Update;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.Attributes;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.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.DataObject;
  53 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  54 import org.opendaylight.yangtools.yang.binding.util.BindingReflections;
  55 import org.opendaylight.yangtools.yang.common.QName;
  56 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  57 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  58 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  59 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
  60 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  61 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  62 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  63 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  64
  65 public abstract class AbstractRIBSupportTest<R extends Route> extends AbstractConcurrentDataBrokerTest {
  66     protected static final PathId PATH_ID = new PathId(1L);
  67     protected static final Attributes ATTRIBUTES = new AttributesBuilder().build();
  68     private static final InstanceIdentifier<LocRib> RIB = InstanceIdentifier.builder(BgpRib.class)
  69             .child(Rib.class, new RibKey(new RibId("rib"))).child(LocRib.class).build();
  70     private static final InstanceIdentifier<Attributes> ATTRIBUTES_IID = InstanceIdentifier.create(Update.class)
  71             .child(Attributes.class);
  72     private static final InstanceIdentifier<MpUnreachNlri> MP_UNREACH_IID = ATTRIBUTES_IID
  73             .augmentation(Attributes2.class).child(MpUnreachNlri.class);
  74     private static final InstanceIdentifier<MpReachNlri> MP_REACH_IID = ATTRIBUTES_IID.augmentation(Attributes1.class)
  75             .child(MpReachNlri.class);
  76     @Mock
  77     protected DOMDataWriteTransaction tx;
  78     protected List<InstanceIdentifier<R>> deletedRoutes;
  79     protected List<Map.Entry<InstanceIdentifier<?>, DataObject>> insertedRoutes;
  80
  81     protected BindingNormalizedNodeSerializer mappingService;
  82     private AbstractRIBSupport abstractRIBSupport;
  83     private ModuleInfoBackedContext moduleInfoBackedContext;
  84
  85     protected final void setUpTestCustomizer(final AbstractRIBSupport ribSupport) throws Exception {
  86         this.abstractRIBSupport = ribSupport;
  87         this.moduleInfoBackedContext
  88                 .registerModuleInfo(BindingReflections.getModuleInfo(this.abstractRIBSupport.routesContainerClass()));
  89         this.moduleInfoBackedContext
  90                 .registerModuleInfo(BindingReflections.getModuleInfo(this.abstractRIBSupport.routesCaseClass()));
  91         this.moduleInfoBackedContext
  92                 .registerModuleInfo(BindingReflections.getModuleInfo(this.abstractRIBSupport.routesListClass()));
  93     }
  94
  95     @Before
  96     public void setUp() throws Exception {
  97         initMocks(this);
  98         doAnswer(invocation -> {
  99             final Object[] args = invocation.getArguments();
 100             AbstractRIBSupportTest.this.insertedRoutes.add(AbstractRIBSupportTest.this.mappingService
 101                     .fromNormalizedNode((YangInstanceIdentifier) args[1], (NormalizedNode<?, ?>) args[2]));
 102             return args[1];
 103         }).when(this.tx).put(any(LogicalDatastoreType.class), any(YangInstanceIdentifier.class),
 104                 any(NormalizedNode.class));
 105
 106         doAnswer(invocation -> {
 107             final Object[] args = invocation.getArguments();
 108             AbstractRIBSupportTest.this.deletedRoutes.add((InstanceIdentifier<R>)
 109                     this.mappingService.fromYangInstanceIdentifier((YangInstanceIdentifier) args[1]));
 110             return args[1];
 111         }).when(this.tx).delete(any(LogicalDatastoreType.class), any(YangInstanceIdentifier.class));
 112         this.deletedRoutes = new ArrayList<>();
 113         this.insertedRoutes = new ArrayList<>();
 114         this.moduleInfoBackedContext = ModuleInfoBackedContext.create();
 115     }
 116
 117     @Override
 118     protected final AbstractDataBrokerTestCustomizer createDataBrokerTestCustomizer() {
 119         final AbstractDataBrokerTestCustomizer customizer = super.createDataBrokerTestCustomizer();
 120         this.mappingService = customizer.getBindingToNormalized();
 121         return customizer;
 122     }
 123
 124     protected final ContainerNode createNlriWithDrawnRoute(final DestinationType destUnreach) {
 125         final MpUnreachNlri mpReach = new MpUnreachNlriBuilder().setWithdrawnRoutes(new WithdrawnRoutesBuilder()
 126                 .setDestinationType(destUnreach).build()).build();
 127         final Map.Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> result = this.mappingService
 128                 .toNormalizedNode(MP_UNREACH_IID, mpReach);
 129         return (ContainerNode) result.getValue();
 130     }
 131
 132     protected final ContainerNode createNlriAdvertiseRoute(final DestinationType destReach) {
 133         final MpReachNlri mpReach = new MpReachNlriBuilder().setAdvertizedRoutes(new AdvertizedRoutesBuilder()
 134                 .setDestinationType(destReach).build()).build();
 135         final Map.Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> result = this.mappingService
 136                 .toNormalizedNode(MP_REACH_IID, mpReach);
 137         return (ContainerNode) result.getValue();
 138     }
 139
 140     protected final ContainerNode createAttributes() {
 141         return (ContainerNode) this.mappingService.toNormalizedNode(ATTRIBUTES_IID, ATTRIBUTES).getValue();
 142     }
 143
 144     protected final ChoiceNode createRoutes(final Routes routes) {
 145         final Tables tables = new TablesBuilder().setKey(getTablesKey()).setRoutes(routes).build();
 146         return (ChoiceNode) ((MapEntryNode) this.mappingService.toNormalizedNode(tablesIId(), tables).getValue())
 147             .getChild(new NodeIdentifier(BindingReflections.findQName(Routes.class))).get();
 148     }
 149
 150     private TablesKey getTablesKey() {
 151         return new TablesKey(this.abstractRIBSupport.getAfi(), this.abstractRIBSupport.getSafi());
 152     }
 153
 154     private InstanceIdentifier<Tables> tablesIId() {
 155         return RIB.child(Tables.class, getTablesKey());
 156     }
 157
 158     private InstanceIdentifier<DataObject> routesIId() {
 159         final InstanceIdentifier<Tables> tables = tablesIId();
 160         return tables.child((Class) this.abstractRIBSupport.routesContainerClass());
 161     }
 162
 163     protected final YangInstanceIdentifier getTablePath() {
 164         final InstanceIdentifier<Tables> tables = tablesIId();
 165         return this.mappingService.toYangInstanceIdentifier(tables);
 166     }
 167
 168     protected final YangInstanceIdentifier getRoutePath() {
 169         final InstanceIdentifier<DataObject> routesIId = routesIId();
 170         return this.mappingService.toYangInstanceIdentifier(routesIId).node(getRouteListQname());
 171     }
 172
 173     @SuppressWarnings("checkstyle:OverloadMethodsDeclarationOrder")
 174     protected final Collection<MapEntryNode> createRoutes(final DataObject routes) {
 175         Preconditions.checkArgument(routes.getImplementedInterface()
 176                 .equals(this.abstractRIBSupport.routesContainerClass()));
 177         final InstanceIdentifier<DataObject> routesIId = routesIId();
 178         final Map.Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> normalizedNode = this.mappingService
 179                 .toNormalizedNode(routesIId, routes);
 180         final ContainerNode container = (ContainerNode) normalizedNode.getValue();
 181         final NodeIdentifier routeNid = new NodeIdentifier(getRouteListQname());
 182         return ((MapNode) container.getChild(routeNid).get()).getValue();
 183     }
 184
 185     private QName getRouteListQname() {
 186         return QName.create(BindingReflections.findQName(this.abstractRIBSupport.routesContainerClass()),
 187                 BindingReflections.findQName(this.abstractRIBSupport.routesListClass()).intern().getLocalName());
 188     }
 189
 190     protected final NodeIdentifierWithPredicates createRouteNIWP(final DataObject routes) {
 191         final Collection<MapEntryNode> map = createRoutes(routes);
 192         return Iterables.getOnlyElement(map).getIdentifier();
 193     }
 194 }