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