Fix checkstyle issues under rib-spi
[bgpcep.git] / bgp / rib-spi / src / test / java / org / opendaylight / protocol / bgp / rib / spi / AbstractRIBSupportTest.java
index 821d7969145fd2d34d1ae000f7a25848ca66e4ba..5ee0feaf5e69db6a014641a862c79ab2530155a8 100644 (file)
 /*
- * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
+ * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
  * and is available at http://www.eclipse.org/legal/epl-v10.html
  */
+
 package org.opendaylight.protocol.bgp.rib.spi;
 
-import static org.junit.Assert.assertEquals;
+import static org.mockito.Matchers.any;
+import static org.mockito.Mockito.doAnswer;
+import static org.mockito.MockitoAnnotations.initMocks;
 
+import com.google.common.base.Preconditions;
+import com.google.common.collect.Iterables;
+import java.util.ArrayList;
 import java.util.Collection;
-import org.junit.Test;
+import java.util.List;
+import java.util.Map;
+import java.util.concurrent.ExecutionException;
+import javassist.ClassPool;
+import org.junit.After;
+import org.junit.Before;
 import org.mockito.Mock;
+import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.prefixes.DestinationIpv4;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.prefixes.destination.ipv4.Ipv4Prefixes;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.routes.Ipv4Routes;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.routes.ipv4.routes.Ipv4Route;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.update.Nlri;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.destination.DestinationType;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.path.attributes.mp.reach.nlri.AdvertizedRoutes;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.path.attributes.mp.unreach.nlri.WithdrawnRoutes;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.tables.Routes;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.route.Attributes;
+import org.opendaylight.mdsal.binding.dom.adapter.BindingToNormalizedNodeCodec;
+import org.opendaylight.mdsal.binding.dom.codec.gen.impl.StreamWriterGenerator;
+import org.opendaylight.mdsal.binding.dom.codec.impl.BindingNormalizedNodeCodecRegistry;
+import org.opendaylight.mdsal.binding.generator.impl.GeneratedClassLoadingStrategy;
+import org.opendaylight.mdsal.binding.generator.impl.ModuleInfoBackedContext;
+import org.opendaylight.mdsal.binding.generator.util.JavassistUtils;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.Update;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.path.attributes.Attributes;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.path.attributes.AttributesBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.Attributes1;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.Attributes2;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.destination.DestinationType;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.update.attributes.MpReachNlri;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.update.attributes.MpReachNlriBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.update.attributes.MpUnreachNlri;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.update.attributes.MpUnreachNlriBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.update.attributes.mp.reach.nlri.AdvertizedRoutesBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.update.attributes.mp.unreach.nlri.WithdrawnRoutesBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.BgpRib;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.RibId;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.bgp.rib.Rib;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.bgp.rib.RibKey;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.bgp.rib.rib.LocRib;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.rib.Tables;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.rib.TablesBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.rib.TablesKey;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.rib.tables.Routes;
 import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import org.opendaylight.yangtools.yang.binding.util.BindingReflections;
 import org.opendaylight.yangtools.yang.common.QName;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
-import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableChoiceNodeBuilder;
-import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
-
-public class AbstractRIBSupportTest {
+import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
+import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
+import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
+
+public abstract class AbstractRIBSupportTest {
+    protected static final long PATH_ID = 1;
+    protected static final Attributes ATTRIBUTES = new AttributesBuilder().build();
+    private static final InstanceIdentifier<LocRib> RIB = InstanceIdentifier.builder(BgpRib.class)
+            .child(Rib.class, new RibKey(new RibId("rib"))).child(LocRib.class).build();
+    private static final InstanceIdentifier<Attributes> ATTRIBUTES_IID = InstanceIdentifier.create(Update.class)
+            .child(Attributes.class);
+    private static final InstanceIdentifier<MpUnreachNlri> MP_UNREACH_IID = ATTRIBUTES_IID
+            .augmentation(Attributes2.class).child(MpUnreachNlri.class);
+    private static final InstanceIdentifier<MpReachNlri> MP_REACH_IID = ATTRIBUTES_IID.augmentation(Attributes1.class)
+            .child(MpReachNlri.class);
 
-    private final ContainerNode ipv4p = ImmutableContainerNodeBuilder.create().withNodeIdentifier(new NodeIdentifier(Ipv4Prefixes.QNAME)).build();
-    private final ContainerNode destination = ImmutableContainerNodeBuilder.create().withNodeIdentifier(new NodeIdentifier(DestinationIpv4.QNAME)).addChild(this.ipv4p).build();
-    private final ChoiceNode choiceNode = ImmutableChoiceNodeBuilder.create().withNodeIdentifier(new NodeIdentifier(DestinationType.QNAME)).addChild(this.destination).build();
-
-    static ContainerNode dest;
+    @Mock
+    protected DOMDataWriteTransaction tx;
+    protected List<InstanceIdentifier<?>> deletedRoutes;
+    protected List<Map.Entry<InstanceIdentifier<?>, DataObject>> insertedRoutes;
+
+    private BindingToNormalizedNodeCodec mappingService;
+    private AbstractRIBSupport abstractRIBSupport;
+    private ModuleInfoBackedContext moduleInfoBackedContext;
+
+    protected final void setUpTestCustomizer(final AbstractRIBSupport ribSupport) throws Exception {
+        this.abstractRIBSupport = ribSupport;
+        this.moduleInfoBackedContext.registerModuleInfo(BindingReflections.getModuleInfo(this.abstractRIBSupport
+                .routesContainerClass()));
+        this.mappingService.onGlobalContextUpdated(this.moduleInfoBackedContext.tryToCreateSchemaContext().get());
+    }
 
-    private final RIBSupport testSupport = new AbstractRIBSupport(Ipv4Routes.QNAME) {
+    @Before
+    public void setUp() throws Exception {
+        initMocks(this);
+        doAnswer(invocation -> {
+            final Object[] args = invocation.getArguments();
+            AbstractRIBSupportTest.this.insertedRoutes.add(AbstractRIBSupportTest.this.mappingService
+                    .fromNormalizedNode((YangInstanceIdentifier) args[1], (NormalizedNode<?, ?>) args[2]));
+            return args[1];
+        }).when(this.tx).put(any(LogicalDatastoreType.class), any(YangInstanceIdentifier.class),
+                any(NormalizedNode.class));
+
+        doAnswer(invocation -> {
+            final Object[] args = invocation.getArguments();
+            AbstractRIBSupportTest.this.deletedRoutes.add(AbstractRIBSupportTest.this.mappingService
+                    .fromYangInstanceIdentifier((YangInstanceIdentifier) args[1]));
+            return args[1];
+        }).when(this.tx).delete(any(LogicalDatastoreType.class), any(YangInstanceIdentifier.class));
+        this.deletedRoutes = new ArrayList<>();
+        this.insertedRoutes = new ArrayList<>();
+
+        this.mappingService = new BindingToNormalizedNodeCodec(GeneratedClassLoadingStrategy
+                .getTCCLClassLoadingStrategy(),
+            new BindingNormalizedNodeCodecRegistry(StreamWriterGenerator
+                    .create(JavassistUtils.forClassPool(ClassPool.getDefault()))));
+        this.moduleInfoBackedContext = ModuleInfoBackedContext.create();
+    }
 
-        @Override
-        public ChoiceNode emptyRoutes() {
-            return null;
-        }
+    protected final ContainerNode createNlriWithDrawnRoute(final DestinationType destUnreach) {
+        final MpUnreachNlri mpReach = new MpUnreachNlriBuilder().setWithdrawnRoutes(new WithdrawnRoutesBuilder()
+                .setDestinationType(destUnreach).build()).build();
+        final Map.Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> result = this.mappingService
+                .toNormalizedNode(MP_UNREACH_IID, mpReach);
+        return (ContainerNode) result.getValue();
+    }
 
-        @Override
-        public Collection<Class<? extends DataObject>> cacheableAttributeObjects() {
-            return null;
-        }
+    protected final ContainerNode createNlriAdvertiseRoute(final DestinationType destReach) {
+        final MpReachNlri mpReach = new MpReachNlriBuilder().setAdvertizedRoutes(new AdvertizedRoutesBuilder()
+                .setDestinationType(destReach).build()).build();
+        final Map.Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> result = this.mappingService
+                .toNormalizedNode(MP_REACH_IID, mpReach);
+        return (ContainerNode) result.getValue();
+    }
 
-        @Override
-        public Collection<Class<? extends DataObject>> cacheableNlriObjects() {
-            return null;
-        }
+    protected final ContainerNode createAttributes() {
+        return (ContainerNode) this.mappingService.toNormalizedNode(ATTRIBUTES_IID, ATTRIBUTES).getValue();
+    }
 
-        @Override
-        protected NodeIdentifier destinationContainerIdentifier() {
-            return new NodeIdentifier(DestinationIpv4.QNAME);
-        }
+    protected final ChoiceNode createRoutes(final Routes routes) {
+        final Tables tables = new TablesBuilder().setKey(getTablesKey()).setRoutes(routes).build();
+        return (ChoiceNode) ((MapEntryNode) this.mappingService.toNormalizedNode(tablesIId(), tables).getValue())
+            .getChild(new NodeIdentifier(BindingReflections.findQName(Routes.class))).get();
+    }
 
-        @Override
-        protected void deleteDestinationRoutes(final DOMDataWriteTransaction tx, final YangInstanceIdentifier tablePath,
-            final ContainerNode destination) {
-            AbstractRIBSupportTest.dest = destination;
-        }
+    private TablesKey getTablesKey() {
+        return new TablesKey(this.abstractRIBSupport.getAfi(), this.abstractRIBSupport.getSafi());
+    }
 
-        @Override
-        protected void putDestinationRoutes(final DOMDataWriteTransaction tx, final YangInstanceIdentifier tablePath,
-            final ContainerNode destination, final ContainerNode attributes) {
-            AbstractRIBSupportTest.dest = destination;
-        }
-    };
+    private InstanceIdentifier<Tables> tablesIId() {
+        return RIB.child(Tables.class, getTablesKey());
+    }
 
-    @Mock
-    private DOMDataWriteTransaction tx;
+    private InstanceIdentifier<DataObject> routesIId() {
+        final InstanceIdentifier<Tables> tables = tablesIId();
+        return tables.child((Class) this.abstractRIBSupport.routesContainerClass());
+    }
 
-    @Test
-    public void testRouteAttributesIdentifier() {
-        assertEquals(new NodeIdentifier(QName.create(Ipv4Routes.QNAME, Attributes.QNAME.getLocalName())), this.testSupport.routeAttributesIdentifier());
+    protected final YangInstanceIdentifier getTablePath() {
+        final InstanceIdentifier<Tables> tables = tablesIId();
+        return this.mappingService.toYangInstanceIdentifier(tables);
     }
 
-    @Test
-    public void testChangedRoutes() {
-        // TODO:
+    protected final YangInstanceIdentifier getRoutePath() {
+        final InstanceIdentifier<DataObject> routesIId = routesIId();
+        return this.mappingService.toYangInstanceIdentifier(routesIId).node(getRouteListQname());
     }
 
+    @SuppressWarnings("checkstyle:OverloadMethodsDeclarationOrder")
+    protected final Collection<MapEntryNode> createRoutes(final DataObject routes) {
+        Preconditions.checkArgument(routes.getImplementedInterface()
+                .equals(this.abstractRIBSupport.routesContainerClass()));
+        final InstanceIdentifier<DataObject> routesIId = routesIId();
+        final Map.Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> normalizedNode = this.mappingService
+                .toNormalizedNode(routesIId, routes);
+        final ContainerNode container = (ContainerNode) normalizedNode.getValue();
+        final NodeIdentifier routeNid = new NodeIdentifier(getRouteListQname());
+        return ((MapNode) container.getChild(routeNid).get()).getValue();
+    }
 
-    @Test
-    public void testRoutePath() {
-        final YangInstanceIdentifier routePath = YangInstanceIdentifier.of(Routes.QNAME);
-        final NodeIdentifier routeId = new NodeIdentifier(Ipv4Route.QNAME);
-        final String result = "/(urn:opendaylight:params:xml:ns:yang:bgp-rib?revision=2013-09-25)routes/(urn:opendaylight:params:xml:ns:yang:bgp-inet?revision=2015-03-05)ipv4-routes/ipv4-route";
-        assertEquals(result, this.testSupport.routePath(routePath, routeId).toString());
+    private QName getRouteListQname() {
+        return QName.create(BindingReflections.findQName(this.abstractRIBSupport.routesContainerClass()),
+                BindingReflections.findQName(this.abstractRIBSupport.routesListClass()).intern().getLocalName());
     }
 
-    @Test
-    public void testDeleteRoutes() {
-        final ContainerNode advertised = ImmutableContainerNodeBuilder.create().addChild(this.choiceNode).withNodeIdentifier(new NodeIdentifier(WithdrawnRoutes.QNAME)).build();
-        final ContainerNode nlri = ImmutableContainerNodeBuilder.create().addChild(advertised).withNodeIdentifier(new NodeIdentifier(Nlri.QNAME)).build();
-        this.testSupport.deleteRoutes(null, null, nlri);
-        assertEquals(dest, this.destination);
+    protected final NodeIdentifierWithPredicates createRouteNIWP(final DataObject routes) {
+        final Collection<MapEntryNode> map = createRoutes(routes);
+        return Iterables.getOnlyElement(map).getIdentifier();
     }
 
-    @Test
-    public void testPutRoutes() {
-        final ContainerNode advertised = ImmutableContainerNodeBuilder.create().addChild(this.choiceNode).withNodeIdentifier(new NodeIdentifier(AdvertizedRoutes.QNAME)).build();
-        final ContainerNode nlri = ImmutableContainerNodeBuilder.create().addChild(advertised).withNodeIdentifier(new NodeIdentifier(Nlri.QNAME)).build();
-        this.testSupport.putRoutes(null, null, nlri, null);
-        assertEquals(dest, this.destination);
+    @After
+    public final void tearDown() throws InterruptedException, ExecutionException {
+        this.mappingService.close();
     }
 }