bgp/rib-spi/src/test/java/org/opendaylight/protocol/bgp/rib/spi/RIBSupportTest.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 package org.opendaylight.protocol.bgp.rib.spi;
   9
  10 import static junit.framework.TestCase.assertFalse;
  11 import static org.junit.Assert.assertEquals;
  12 import static org.junit.Assert.assertNotNull;
  13 import static org.junit.Assert.assertTrue;
  14 import static org.mockito.ArgumentMatchers.any;
  15 import static org.mockito.Mockito.doAnswer;
  16 import static org.mockito.Mockito.doReturn;
  17
  18 import java.util.Collection;
  19 import java.util.HashMap;
  20 import java.util.HashSet;
  21 import java.util.Map;
  22 import java.util.Optional;
  23 import java.util.Set;
  24 import org.junit.Before;
  25 import org.junit.Test;
  26 import org.mockito.Mockito;
  27 import org.mockito.MockitoAnnotations;
  28 import org.opendaylight.mdsal.binding.dom.adapter.AdapterContext;
  29 import org.opendaylight.mdsal.binding.dom.adapter.test.AbstractConcurrentDataBrokerTest;
  30 import org.opendaylight.mdsal.binding.dom.adapter.test.AbstractDataBrokerTestCustomizer;
  31 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  32 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
  33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.UpdateBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.Attributes;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.AttributesBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.AttributesReachBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.AttributesUnreachBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.reach.MpReachNlri;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.reach.MpReachNlriBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.reach.mp.reach.nlri.AdvertizedRoutes;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.reach.mp.reach.nlri.AdvertizedRoutesBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.unreach.MpUnreachNlri;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.unreach.MpUnreachNlriBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.unreach.mp.unreach.nlri.WithdrawnRoutes;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.unreach.mp.unreach.nlri.WithdrawnRoutesBuilder;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.destination.DestinationType;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.BgpRib;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.rib.LocRib;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.Tables;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.tables.Routes;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.test.rev180515.Ipv4Prefixes;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.test.rev180515.bgp.rib.rib.loc.rib.tables.routes.Ipv4RoutesCase;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.test.rev180515.ipv4.routes.Ipv4Routes;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.test.rev180515.ipv4.routes.ipv4.routes.Ipv4Route;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.Ipv4AddressFamily;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.UnicastSubsequentAddressFamily;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.next.hop.c.next.hop.Ipv4NextHopCase;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.next.hop.c.next.hop.Ipv4NextHopCaseBuilder;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.next.hop.c.next.hop.ipv4.next.hop._case.Ipv4NextHopBuilder;
  62 import org.opendaylight.yangtools.yang.common.QName;
  63 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  64 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  65 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  66 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
  67 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  68 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  69 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  70 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  71 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidateNode;
  72
  73 public class RIBSupportTest extends AbstractConcurrentDataBrokerTest {
  74     private static final String ROUTE_KEY = "prefix";
  75     private static final String PREFIX = "1.2.3.4/32";
  76     private static final NodeIdentifierWithPredicates PREFIX_NII = NodeIdentifierWithPredicates.of(Ipv4Route.QNAME,
  77         QName.create(Ipv4Route.QNAME, ROUTE_KEY).intern(), PREFIX);
  78     private RIBSupportTestImp ribSupportTestImp;
  79     private static final YangInstanceIdentifier LOC_RIB_TARGET =
  80         YangInstanceIdentifier.create(YangInstanceIdentifier.of(BgpRib.QNAME).node(LocRib.QNAME).node(Tables.QNAME)
  81             .node(NodeIdentifierWithPredicates.of(Tables.QNAME, Map.of(
  82                 QName.create(Tables.QNAME, "afi"), Ipv4AddressFamily.QNAME,
  83                 QName.create(Tables.QNAME, "safi"), UnicastSubsequentAddressFamily.QNAME)))
  84             .getPathArguments());
  85     private static final NodeIdentifier ROUTES_IDENTIFIER = new NodeIdentifier(Routes.QNAME);
  86     private static final NodeIdentifier IPV4_ROUTES_IDENTIFIER = new NodeIdentifier(Ipv4Routes.QNAME);
  87
  88     private DataTreeCandidateNode emptyTree;
  89     private DataTreeCandidateNode emptySubTree;
  90     private DataTreeCandidateNode subTree;
  91     private DOMDataTreeWriteTransaction tx;
  92     private ContainerNode nlri;
  93     private final Map<YangInstanceIdentifier, NormalizedNode> routesMap = new HashMap<>();
  94     private ContainerNode attributes;
  95     private MapEntryNode mapEntryNode;
  96     private AdapterContext context;
  97
  98     @Before
  99     public void setUp() throws Exception {
 100         super.setup();
 101         MockitoAnnotations.initMocks(this);
 102         ribSupportTestImp = new RIBSupportTestImp(context.currentSerializer());
 103         emptyTree = Mockito.mock(DataTreeCandidateNode.class);
 104         emptySubTree = Mockito.mock(DataTreeCandidateNode.class);
 105         subTree = Mockito.mock(DataTreeCandidateNode.class);
 106         final DataTreeCandidateNode emptyNode = Mockito.mock(DataTreeCandidateNode.class);
 107         final DataTreeCandidateNode node = Mockito.mock(DataTreeCandidateNode.class);
 108         doReturn(Optional.empty()).when(emptyTree).getModifiedChild(IPV4_ROUTES_IDENTIFIER);
 109
 110         doReturn(Optional.of(emptyNode)).when(emptySubTree).getModifiedChild(IPV4_ROUTES_IDENTIFIER);
 111         doReturn(Optional.empty()).when(emptyNode).getModifiedChild(new NodeIdentifier(Ipv4Route.QNAME));
 112
 113         doReturn(Optional.of(node)).when(subTree).getModifiedChild(IPV4_ROUTES_IDENTIFIER);
 114         doReturn(Optional.of(node)).when(node).getModifiedChild(new NodeIdentifier(Ipv4Route.QNAME));
 115         final Collection<DataTreeCandidateNode> emptyCollection = new HashSet<>();
 116         doReturn(emptyCollection).when(node).getChildNodes();
 117
 118         tx = Mockito.mock(DOMDataTreeWriteTransaction.class);
 119         nlri = Mockito.mock(ContainerNode.class);
 120         attributes = Builders.containerBuilder()
 121                 .withNodeIdentifier(new NodeIdentifier(QName.create(Ipv4Routes.QNAME, Attributes.QNAME
 122                     .getLocalName().intern())))
 123                 .build();
 124         final ContainerNode destination = Mockito.mock(ContainerNode.class);
 125         final ChoiceNode destinations = Mockito.mock(ChoiceNode.class);
 126         final ContainerNode route = Mockito.mock(ContainerNode.class);
 127
 128         doReturn(destination).when(nlri).childByArg(new NodeIdentifier(WithdrawnRoutes.QNAME));
 129         doReturn(destination).when(nlri).childByArg(new NodeIdentifier(AdvertizedRoutes.QNAME));
 130         doReturn(destinations).when(destination).childByArg(new NodeIdentifier(DestinationType.QNAME));
 131         doReturn(route).when(destinations).childByArg(new NodeIdentifier(Ipv4Prefixes.QNAME));
 132         doReturn(emptyCollection).when(route).body();
 133
 134         doAnswer(invocation -> {
 135             final Object[] args = invocation.getArguments();
 136             routesMap.remove(args[1]);
 137             return args[1];
 138         }).when(tx).delete(Mockito.eq(LogicalDatastoreType.OPERATIONAL), any(YangInstanceIdentifier.class));
 139         doAnswer(invocation -> {
 140             final Object[] args = invocation.getArguments();
 141             final NormalizedNode node1 = (NormalizedNode) args[2];
 142             routesMap.put((YangInstanceIdentifier) args[1], node1);
 143             return args[1];
 144         }).when(tx).put(Mockito.eq(LogicalDatastoreType.OPERATIONAL), any(YangInstanceIdentifier.class),
 145                 any(NormalizedNode.class));
 146
 147         mapEntryNode = Mockito.mock(MapEntryNode.class);
 148     }
 149
 150     @Override
 151     protected final AbstractDataBrokerTestCustomizer createDataBrokerTestCustomizer() {
 152         final AbstractDataBrokerTestCustomizer customizer = super.createDataBrokerTestCustomizer();
 153         context = customizer.getAdapterContext();
 154         return customizer;
 155     }
 156
 157     @Test
 158     public void routesCaseClass() {
 159         assertEquals(Ipv4RoutesCase.class, ribSupportTestImp.routesCaseClass());
 160     }
 161
 162     @Test
 163     public void routesContainerClass() {
 164         assertEquals(Ipv4Routes.class, ribSupportTestImp.routesContainerClass());
 165     }
 166
 167     @Test
 168     public void routesListClass() {
 169         assertEquals(Ipv4Route.class, ribSupportTestImp.routesListClass());
 170     }
 171
 172     @Test
 173     public void routeQName() {
 174         assertEquals(Ipv4Route.QNAME, ribSupportTestImp.routeQName());
 175     }
 176
 177     @Test
 178     public void routeNid() {
 179         assertEquals(new NodeIdentifier(Ipv4Route.QNAME),ribSupportTestImp.routeNid());
 180     }
 181
 182     @Test
 183     public void getTablesKey() {
 184         assertEquals(new TablesKey(Ipv4AddressFamily.VALUE, UnicastSubsequentAddressFamily.VALUE),
 185             ribSupportTestImp.getTablesKey());
 186     }
 187
 188     @Test
 189     public void routesContainerIdentifier() {
 190         assertEquals(IPV4_ROUTES_IDENTIFIER, ribSupportTestImp.routesContainerIdentifier());
 191     }
 192
 193     @Test
 194     public void routeAttributesIdentifier() {
 195         assertEquals(new NodeIdentifier(QName.create(Ipv4Routes.QNAME,
 196                 Attributes.QNAME.getLocalName().intern())),ribSupportTestImp.routeAttributesIdentifier());
 197     }
 198
 199     @Test
 200     public void routePath() {
 201         assertEquals(LOC_RIB_TARGET.node(ROUTES_IDENTIFIER)
 202                         .node(Ipv4Routes.QNAME).node(Ipv4Route.QNAME).node(PREFIX_NII),
 203                 ribSupportTestImp.routePath(LOC_RIB_TARGET, PREFIX_NII));
 204     }
 205
 206     @Test
 207     public void changedRoutes() {
 208         assertTrue(ribSupportTestImp.changedRoutes(emptyTree).isEmpty());
 209         assertTrue(ribSupportTestImp.changedRoutes(emptySubTree).isEmpty());
 210         assertNotNull(ribSupportTestImp.changedRoutes(subTree));
 211     }
 212
 213     @Test
 214     public void putRoutes() {
 215         ribSupportTestImp.putRoutes(tx, LOC_RIB_TARGET, nlri, attributes);
 216         assertFalse(routesMap.isEmpty());
 217     }
 218
 219     @Test
 220     public void deleteRoutes() {
 221         ribSupportTestImp.deleteRoutes(tx, LOC_RIB_TARGET, nlri);
 222         assertTrue(routesMap.isEmpty());
 223     }
 224
 225
 226     @Test
 227     public void buildUpdate() {
 228         final Ipv4NextHopCase nextHop = new Ipv4NextHopCaseBuilder().setIpv4NextHop(new Ipv4NextHopBuilder()
 229                 .setGlobal(new Ipv4AddressNoZone("10.0.0.2")).build()).build();
 230         final Attributes attr = new AttributesBuilder().setCNextHop(nextHop).build();
 231         final Collection<MapEntryNode> routes = new HashSet<>();
 232
 233         assertEquals(new UpdateBuilder().setAttributes(new AttributesBuilder().build()).build(),
 234                ribSupportTestImp.buildUpdate(routes, routes, attr));
 235
 236         routes.add(mapEntryNode);
 237         final MpReachNlri mpReach = new MpReachNlriBuilder().setAfi(Ipv4AddressFamily.VALUE)
 238                 .setSafi(UnicastSubsequentAddressFamily.VALUE)
 239                 .setCNextHop(nextHop).setAdvertizedRoutes(new AdvertizedRoutesBuilder().build()).build();
 240
 241         final Attributes attMpR = new AttributesBuilder().addAugmentation(
 242             new AttributesReachBuilder().setMpReachNlri(mpReach).build()).build();
 243         assertEquals(new UpdateBuilder().setAttributes(attMpR).build(),
 244                ribSupportTestImp.buildUpdate(routes, Set.of(), attr));
 245
 246         final MpUnreachNlri mpUnreach = new MpUnreachNlriBuilder()
 247                 .setAfi(Ipv4AddressFamily.VALUE)
 248                 .setSafi(UnicastSubsequentAddressFamily.VALUE)
 249                 .setWithdrawnRoutes(new WithdrawnRoutesBuilder().build())
 250                 .build();
 251
 252         final Attributes attMpU = new AttributesBuilder().addAugmentation(
 253                 new AttributesUnreachBuilder().setMpUnreachNlri(mpUnreach).build()).build();
 254         assertEquals(new UpdateBuilder().setAttributes(attMpU).build(),
 255                ribSupportTestImp.buildUpdate(Set.of(), routes, attr));
 256     }
 257 }