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 javassist.ClassPool;
  22 import org.junit.After;
  23 import org.junit.Before;
  24 import org.mockito.Mock;
  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.adapter.BindingToNormalizedNodeCodec;
  28 import org.opendaylight.mdsal.binding.dom.codec.gen.impl.StreamWriterGenerator;
  29 import org.opendaylight.mdsal.binding.dom.codec.impl.BindingNormalizedNodeCodecRegistry;
  30 import org.opendaylight.mdsal.binding.generator.impl.GeneratedClassLoadingStrategy;
  31 import org.opendaylight.mdsal.binding.generator.impl.ModuleInfoBackedContext;
  32 import org.opendaylight.mdsal.binding.generator.util.JavassistUtils;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.PathId;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.Update;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.path.attributes.Attributes;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.path.attributes.AttributesBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.Attributes1;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.Attributes2;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.destination.DestinationType;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.update.attributes.MpReachNlri;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.update.attributes.MpReachNlriBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.update.attributes.MpUnreachNlri;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.update.attributes.MpUnreachNlriBuilder;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.update.attributes.mp.reach.nlri.AdvertizedRoutesBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.update.attributes.mp.unreach.nlri.WithdrawnRoutesBuilder;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.BgpRib;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.RibId;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.Rib;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.RibKey;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.rib.LocRib;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.Tables;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesBuilder;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.tables.Routes;
  55 import org.opendaylight.yangtools.yang.binding.DataObject;
  56 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  57 import org.opendaylight.yangtools.yang.binding.util.BindingReflections;
  58 import org.opendaylight.yangtools.yang.common.QName;
  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;
  67
  68 public abstract class AbstractRIBSupportTest {
  69     protected static final PathId PATH_ID = new PathId(1L);
  70     protected static final Attributes ATTRIBUTES = new AttributesBuilder().build();
  71     private static final InstanceIdentifier<LocRib> RIB = InstanceIdentifier.builder(BgpRib.class)
  72             .child(Rib.class, new RibKey(new RibId("rib"))).child(LocRib.class).build();
  73     private static final InstanceIdentifier<Attributes> ATTRIBUTES_IID = InstanceIdentifier.create(Update.class)
  74             .child(Attributes.class);
  75     private static final InstanceIdentifier<MpUnreachNlri> MP_UNREACH_IID = ATTRIBUTES_IID
  76             .augmentation(Attributes2.class).child(MpUnreachNlri.class);
  77     private static final InstanceIdentifier<MpReachNlri> MP_REACH_IID = ATTRIBUTES_IID.augmentation(Attributes1.class)
  78             .child(MpReachNlri.class);
  79
  80     @Mock
  81     protected DOMDataWriteTransaction tx;
  82     protected List<InstanceIdentifier<?>> deletedRoutes;
  83     protected List<Map.Entry<InstanceIdentifier<?>, DataObject>> insertedRoutes;
  84
  85     private BindingToNormalizedNodeCodec mappingService;
  86     private AbstractRIBSupport abstractRIBSupport;
  87     private ModuleInfoBackedContext moduleInfoBackedContext;
  88
  89     protected final void setUpTestCustomizer(final AbstractRIBSupport ribSupport) throws Exception {
  90         this.abstractRIBSupport = ribSupport;
  91         this.moduleInfoBackedContext.registerModuleInfo(BindingReflections.getModuleInfo(this.abstractRIBSupport
  92                 .routesContainerClass()));
  93         this.mappingService.onGlobalContextUpdated(this.moduleInfoBackedContext.tryToCreateSchemaContext().get());
  94     }
  95
  96     @Before
  97     public void setUp() throws Exception {
  98         initMocks(this);
  99         doAnswer(invocation -> {
 100             final Object[] args = invocation.getArguments();
 101             AbstractRIBSupportTest.this.insertedRoutes.add(AbstractRIBSupportTest.this.mappingService
 102                     .fromNormalizedNode((YangInstanceIdentifier) args[1], (NormalizedNode<?, ?>) args[2]));
 103             return args[1];
 104         }).when(this.tx).put(any(LogicalDatastoreType.class), any(YangInstanceIdentifier.class),
 105                 any(NormalizedNode.class));
 106
 107         doAnswer(invocation -> {
 108             final Object[] args = invocation.getArguments();
 109             AbstractRIBSupportTest.this.deletedRoutes.add(AbstractRIBSupportTest.this.mappingService
 110                     .fromYangInstanceIdentifier((YangInstanceIdentifier) args[1]));
 111             return args[1];
 112         }).when(this.tx).delete(any(LogicalDatastoreType.class), any(YangInstanceIdentifier.class));
 113         this.deletedRoutes = new ArrayList<>();
 114         this.insertedRoutes = new ArrayList<>();
 115
 116         this.mappingService = new BindingToNormalizedNodeCodec(GeneratedClassLoadingStrategy
 117                 .getTCCLClassLoadingStrategy(),
 118             new BindingNormalizedNodeCodecRegistry(StreamWriterGenerator
 119                     .create(JavassistUtils.forClassPool(ClassPool.getDefault()))));
 120         this.moduleInfoBackedContext = ModuleInfoBackedContext.create();
 121     }
 122
 123     protected final ContainerNode createNlriWithDrawnRoute(final DestinationType destUnreach) {
 124         final MpUnreachNlri mpReach = new MpUnreachNlriBuilder().setWithdrawnRoutes(new WithdrawnRoutesBuilder()
 125                 .setDestinationType(destUnreach).build()).build();
 126         final Map.Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> result = this.mappingService
 127                 .toNormalizedNode(MP_UNREACH_IID, mpReach);
 128         return (ContainerNode) result.getValue();
 129     }
 130
 131     protected final ContainerNode createNlriAdvertiseRoute(final DestinationType destReach) {
 132         final MpReachNlri mpReach = new MpReachNlriBuilder().setAdvertizedRoutes(new AdvertizedRoutesBuilder()
 133                 .setDestinationType(destReach).build()).build();
 134         final Map.Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> result = this.mappingService
 135                 .toNormalizedNode(MP_REACH_IID, mpReach);
 136         return (ContainerNode) result.getValue();
 137     }
 138
 139     protected final ContainerNode createAttributes() {
 140         return (ContainerNode) this.mappingService.toNormalizedNode(ATTRIBUTES_IID, ATTRIBUTES).getValue();
 141     }
 142
 143     protected final ChoiceNode createRoutes(final Routes routes) {
 144         final Tables tables = new TablesBuilder().setKey(getTablesKey()).setRoutes(routes).build();
 145         return (ChoiceNode) ((MapEntryNode) this.mappingService.toNormalizedNode(tablesIId(), tables).getValue())
 146             .getChild(new NodeIdentifier(BindingReflections.findQName(Routes.class))).get();
 147     }
 148
 149     private TablesKey getTablesKey() {
 150         return new TablesKey(this.abstractRIBSupport.getAfi(), this.abstractRIBSupport.getSafi());
 151     }
 152
 153     private InstanceIdentifier<Tables> tablesIId() {
 154         return RIB.child(Tables.class, getTablesKey());
 155     }
 156
 157     private InstanceIdentifier<DataObject> routesIId() {
 158         final InstanceIdentifier<Tables> tables = tablesIId();
 159         return tables.child((Class) this.abstractRIBSupport.routesContainerClass());
 160     }
 161
 162     protected final YangInstanceIdentifier getTablePath() {
 163         final InstanceIdentifier<Tables> tables = tablesIId();
 164         return this.mappingService.toYangInstanceIdentifier(tables);
 165     }
 166
 167     protected final YangInstanceIdentifier getRoutePath() {
 168         final InstanceIdentifier<DataObject> routesIId = routesIId();
 169         return this.mappingService.toYangInstanceIdentifier(routesIId).node(getRouteListQname());
 170     }
 171
 172     @SuppressWarnings("checkstyle:OverloadMethodsDeclarationOrder")
 173     protected final Collection<MapEntryNode> createRoutes(final DataObject routes) {
 174         Preconditions.checkArgument(routes.getImplementedInterface()
 175                 .equals(this.abstractRIBSupport.routesContainerClass()));
 176         final InstanceIdentifier<DataObject> routesIId = routesIId();
 177         final Map.Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> normalizedNode = this.mappingService
 178                 .toNormalizedNode(routesIId, routes);
 179         final ContainerNode container = (ContainerNode) normalizedNode.getValue();
 180         final NodeIdentifier routeNid = new NodeIdentifier(getRouteListQname());
 181         return ((MapNode) container.getChild(routeNid).get()).getValue();
 182     }
 183
 184     private QName getRouteListQname() {
 185         return QName.create(BindingReflections.findQName(this.abstractRIBSupport.routesContainerClass()),
 186                 BindingReflections.findQName(this.abstractRIBSupport.routesListClass()).intern().getLocalName());
 187     }
 188
 189     protected final NodeIdentifierWithPredicates createRouteNIWP(final DataObject routes) {
 190         final Collection<MapEntryNode> map = createRoutes(routes);
 191         return Iterables.getOnlyElement(map).getIdentifier();
 192     }
 193
 194     @After
 195     public final void tearDown() {
 196         this.mappingService.close();
 197     }
 198 }