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