/*
- * 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,
*/
package org.opendaylight.protocol.bgp.rib.spi;
-import static org.junit.Assert.assertEquals;
-
-import com.google.common.collect.ImmutableCollection;
-
-import org.junit.Test;
+import static com.google.common.base.Verify.verifyNotNull;
+import static org.mockito.ArgumentMatchers.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 java.util.List;
+import java.util.Map;
+import org.eclipse.jdt.annotation.NonNull;
+import org.junit.Before;
import org.mockito.Mock;
-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.AdapterContext;
+import org.opendaylight.mdsal.binding.dom.adapter.test.AbstractConcurrentDataBrokerTest;
+import org.opendaylight.mdsal.binding.dom.adapter.test.AbstractDataBrokerTestCustomizer;
+import org.opendaylight.mdsal.binding.dom.codec.api.BindingDataObjectCodecTreeNode;
+import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer.NodeResult;
+import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
+import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.PathId;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.Update;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.Attributes;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.AttributesBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.AttributesReach;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.AttributesUnreach;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.reach.MpReachNlri;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.reach.MpReachNlriBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.reach.mp.reach.nlri.AdvertizedRoutesBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.unreach.MpUnreachNlri;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.unreach.MpUnreachNlriBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.unreach.mp.unreach.nlri.WithdrawnRoutesBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.destination.DestinationType;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.BgpRib;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.RibId;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.Route;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.Rib;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.RibKey;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.rib.LocRib;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.Tables;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.tables.Routes;
+import org.opendaylight.yangtools.yang.binding.ChildOf;
+import org.opendaylight.yangtools.yang.binding.ChoiceIn;
import org.opendaylight.yangtools.yang.binding.DataObject;
-import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import org.opendaylight.yangtools.yang.binding.KeyAware;
+import org.opendaylight.yangtools.yang.common.Uint32;
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;
+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<C extends Routes & DataObject & ChoiceIn<Tables>,
+ S extends ChildOf<? super C>,
+ R extends Route & ChildOf<? super S> & KeyAware<?>> extends AbstractConcurrentDataBrokerTest {
+ protected static final @NonNull PathId PATH_ID = new PathId(Uint32.ONE);
+ protected static final @NonNull 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();
-public class AbstractRIBSupportTest {
+ @Mock
+ protected DOMDataTreeWriteTransaction tx;
+ protected List<InstanceIdentifier<R>> deletedRoutes;
+ protected List<Map.Entry<InstanceIdentifier<?>, DataObject>> insertedRoutes;
- 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();
+ protected AdapterContext adapter;
+ private AbstractRIBSupport<C, S, R> abstractRIBSupport;
- static ContainerNode dest;
+ protected final void setUpTestCustomizer(final AbstractRIBSupport<C, S, R> ribSupport) throws Exception {
+ abstractRIBSupport = ribSupport;
+ }
- private final RIBSupport testSupport = new AbstractRIBSupport(Ipv4Routes.QNAME) {
+ @Before
+ public void setUp() throws Exception {
+ initMocks(this);
+ doAnswer(invocation -> {
+ final var path = invocation.getArgument(1, YangInstanceIdentifier.class);
+ final var data = invocation.getArgument(2, NormalizedNode.class);
- @Override
- public ChoiceNode emptyRoutes() {
+ AbstractRIBSupportTest.this.insertedRoutes.add(adapter.currentSerializer().fromNormalizedNode(path, data));
return null;
- }
+ }).when(tx).put(any(LogicalDatastoreType.class), any(YangInstanceIdentifier.class),
+ any(NormalizedNode.class));
- @Override
- public ImmutableCollection<Class<? extends DataObject>> cacheableAttributeObjects() {
- return null;
- }
+ doAnswer(invocation -> {
+ final var path = invocation.getArgument(1, YangInstanceIdentifier.class);
- @Override
- public ImmutableCollection<Class<? extends DataObject>> cacheableNlriObjects() {
+ AbstractRIBSupportTest.this.deletedRoutes.add((InstanceIdentifier)
+ adapter.currentSerializer().fromYangInstanceIdentifier(path));
return null;
- }
-
- @Override
- protected NodeIdentifier destinationContainerIdentifier() {
- return new NodeIdentifier(DestinationIpv4.QNAME);
- }
-
- @Override
- protected void deleteDestinationRoutes(final DOMDataWriteTransaction tx, final YangInstanceIdentifier tablePath,
- final ContainerNode destination) {
- AbstractRIBSupportTest.dest = destination;
- }
-
- @Override
- protected void putDestinationRoutes(final DOMDataWriteTransaction tx, final YangInstanceIdentifier tablePath,
- final ContainerNode destination, final ContainerNode attributes) {
- AbstractRIBSupportTest.dest = destination;
- }
- };
+ }).when(tx).delete(any(LogicalDatastoreType.class), any(YangInstanceIdentifier.class));
+ deletedRoutes = new ArrayList<>();
+ insertedRoutes = new ArrayList<>();
+ }
- @Mock
- private DOMDataWriteTransaction tx;
+ @Override
+ protected final AbstractDataBrokerTestCustomizer createDataBrokerTestCustomizer() {
+ final AbstractDataBrokerTestCustomizer customizer = super.createDataBrokerTestCustomizer();
+ adapter = customizer.getAdapterContext();
+ return customizer;
+ }
- @Test
- public void testRouteAttributesIdentifier() {
- assertEquals(new NodeIdentifier(QName.create(Ipv4Routes.QNAME, Attributes.QNAME.getLocalName())), this.testSupport.routeAttributesIdentifier());
+ private @NonNull BindingDataObjectCodecTreeNode<Attributes> updateAttributesCodec() {
+ return adapter.currentSerializer().getStreamChild(Update.class).getStreamDataObject(Attributes.class);
}
- @Test
- public void testChangedRoutes() {
- // TODO:
+ protected final ContainerNode createNlriWithDrawnRoute(final DestinationType destUnreach) {
+ return (ContainerNode) updateAttributesCodec()
+ .getStreamChild(AttributesUnreach.class).getStreamDataObject(MpUnreachNlri.class)
+ .serialize(new MpUnreachNlriBuilder()
+ .setWithdrawnRoutes(new WithdrawnRoutesBuilder().setDestinationType(destUnreach).build())
+ .build());
}
+ protected final ContainerNode createNlriAdvertiseRoute(final DestinationType destReach) {
+ return (ContainerNode) updateAttributesCodec()
+ .getStreamChild(AttributesReach.class).getStreamDataObject(MpReachNlri.class)
+ .serialize(new MpReachNlriBuilder()
+ .setAdvertizedRoutes(new AdvertizedRoutesBuilder().setDestinationType(destReach).build())
+ .build());
+ }
+
+ protected final ContainerNode createAttributes() {
+ return (ContainerNode) updateAttributesCodec().serialize(ATTRIBUTES);
+ }
+
+ protected final MapEntryNode createEmptyTable() {
+ final Tables tables = new TablesBuilder().withKey(abstractRIBSupport.getTablesKey())
+ .setAttributes(new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329
+ .rib.tables.AttributesBuilder().build()).build();
+ return (MapEntryNode) adapter.currentSerializer().toNormalizedDataObject(tablesIId(), tables).node();
+ }
+
+ protected final ChoiceNode createRoutes(final Routes routes) {
+ final Tables tables = new TablesBuilder().withKey(abstractRIBSupport.getTablesKey()).setRoutes(routes).build();
+ return (ChoiceNode) verifyNotNull(((MapEntryNode) adapter.currentSerializer()
+ .toNormalizedDataObject(tablesIId(), tables).node())
+ .childByArg(new NodeIdentifier(Routes.QNAME)));
+ }
+
+ protected final Collection<MapEntryNode> createRoutes(final S routes) {
+ Preconditions.checkArgument(routes.implementedInterface()
+ .equals(abstractRIBSupport.routesContainerClass()));
+ final InstanceIdentifier<S> routesIId = routesIId();
+ final NodeResult normalizedNode = adapter.currentSerializer().toNormalizedDataObject(routesIId, routes);
+ final ContainerNode container = (ContainerNode) normalizedNode.node();
+ final NodeIdentifier routeNid = new NodeIdentifier(abstractRIBSupport.routeQName());
+ return ((MapNode) container.getChildByArg(routeNid)).body();
+ }
+
+ private InstanceIdentifier<Tables> tablesIId() {
+ return RIB.child(Tables.class, abstractRIBSupport.getTablesKey());
+ }
+
+ private InstanceIdentifier<S> routesIId() {
+ final InstanceIdentifier<Tables> tables = tablesIId();
+ return tables.child(abstractRIBSupport.routesCaseClass(), abstractRIBSupport.routesContainerClass());
+ }
- @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());
+ protected final YangInstanceIdentifier getTablePath() {
+ final InstanceIdentifier<Tables> tables = tablesIId();
+ return adapter.currentSerializer().toYangInstanceIdentifier(tables);
}
- @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 YangInstanceIdentifier getRoutePath() {
+ final InstanceIdentifier<S> routesIId = routesIId();
+ return adapter.currentSerializer().toYangInstanceIdentifier(routesIId).node(abstractRIBSupport.routeQName());
}
- @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);
+ protected final NodeIdentifierWithPredicates createRouteNIWP(final S routes) {
+ final Collection<MapEntryNode> map = createRoutes(routes);
+ return Iterables.getOnlyElement(map).name();
}
}