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.Collections;
  20 import java.util.HashMap;
  21 import java.util.HashSet;
  22 import java.util.Map;
  23 import java.util.Optional;
  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.destination.DestinationType;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpReachNlri;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpReachNlriBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpUnreachNlri;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpUnreachNlriBuilder;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.mp.reach.nlri.AdvertizedRoutes;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.mp.reach.nlri.AdvertizedRoutesBuilder;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.mp.unreach.nlri.WithdrawnRoutes;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.mp.unreach.nlri.WithdrawnRoutesBuilder;
  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.api.schema.tree.DataTreeCandidateNode;
  71 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
  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 QName PATH_ID_QNAME = QName.create(Ipv4Route.QNAME, "path-id").intern();
  77     private static final NodeIdentifierWithPredicates PREFIX_NII = NodeIdentifierWithPredicates.of(Ipv4Route.QNAME,
  78         QName.create(Ipv4Route.QNAME, ROUTE_KEY).intern(), PREFIX);
  79     private RIBSupportTestImp ribSupportTestImp;
  80     private static final TablesKey TABLES_KEY = new TablesKey(Ipv4AddressFamily.class,
  81             UnicastSubsequentAddressFamily.class);
  82     private static final YangInstanceIdentifier LOC_RIB_TARGET = YangInstanceIdentifier
  83             .create(YangInstanceIdentifier.of(BgpRib.QNAME)
  84         .node(LocRib.QNAME).node(Tables.QNAME).node(RibSupportUtils.toYangTablesKey(TABLES_KEY)).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     private DataTreeCandidateNode emptyTree;
  88     private DataTreeCandidateNode emptySubTree;
  89     private DataTreeCandidateNode subTree;
  90     private DOMDataTreeWriteTransaction tx;
  91     private ContainerNode nlri;
  92     private final Map<YangInstanceIdentifier, NormalizedNode<?, ?>> routesMap = new HashMap<>();
  93     private ContainerNode attributes;
  94     private MapEntryNode mapEntryNode;
  95     private AdapterContext context;
  96
  97     @Before
  98     public void setUp() throws Exception {
  99         super.setup();
 100         MockitoAnnotations.initMocks(this);
 101         this.ribSupportTestImp = new RIBSupportTestImp(context.currentSerializer());
 102         this.emptyTree = Mockito.mock(DataTreeCandidateNode.class);
 103         this.emptySubTree = Mockito.mock(DataTreeCandidateNode.class);
 104         this.subTree = Mockito.mock(DataTreeCandidateNode.class);
 105         final DataTreeCandidateNode emptyNode = Mockito.mock(DataTreeCandidateNode.class);
 106         final DataTreeCandidateNode node = Mockito.mock(DataTreeCandidateNode.class);
 107         doReturn(Optional.empty()).when(this.emptyTree).getModifiedChild(IPV4_ROUTES_IDENTIFIER);
 108
 109         doReturn(Optional.of(emptyNode)).when(this.emptySubTree).getModifiedChild(IPV4_ROUTES_IDENTIFIER);
 110         doReturn(Optional.empty()).when(emptyNode).getModifiedChild(new NodeIdentifier(Ipv4Route.QNAME));
 111
 112         doReturn(Optional.of(node)).when(this.subTree).getModifiedChild(IPV4_ROUTES_IDENTIFIER);
 113         doReturn(Optional.of(node)).when(node).getModifiedChild(new NodeIdentifier(Ipv4Route.QNAME));
 114         final Collection<DataTreeCandidateNode> emptyCollection = new HashSet<>();
 115         doReturn(emptyCollection).when(node).getChildNodes();
 116
 117         this.tx = Mockito.mock(DOMDataTreeWriteTransaction.class);
 118         this.nlri = Mockito.mock(ContainerNode.class);
 119         this.attributes = ImmutableContainerNodeBuilder.create()
 120                 .withNodeIdentifier(new NodeIdentifier(QName.create(Ipv4Routes.QNAME, Attributes.QNAME
 121             .getLocalName().intern()))).build();
 122         final ContainerNode destination = Mockito.mock(ContainerNode.class);
 123         final ChoiceNode destinations = Mockito.mock(ChoiceNode.class);
 124         final ContainerNode route = Mockito.mock(ContainerNode.class);
 125         final Optional<?> optional = Optional.of(destination);
 126         final Optional<?> destinationOptional = Optional.of(destinations);
 127         final Optional<?> destinationsOptional = Optional.of(route);
 128
 129         doReturn(optional).when(this.nlri).getChild(new NodeIdentifier(WithdrawnRoutes.QNAME));
 130         doReturn(optional).when(this.nlri).getChild(new NodeIdentifier(AdvertizedRoutes.QNAME));
 131         doReturn(destinationOptional).when(destination).getChild(new NodeIdentifier(DestinationType.QNAME));
 132         doReturn(destinationsOptional).when(destinations).getChild(new NodeIdentifier(Ipv4Prefixes.QNAME));
 133         doReturn(emptyCollection).when(route).getValue();
 134
 135         doAnswer(invocation -> {
 136             final Object[] args = invocation.getArguments();
 137             this.routesMap.remove(args[1]);
 138             return args[1];
 139         }).when(this.tx).delete(Mockito.eq(LogicalDatastoreType.OPERATIONAL), any(YangInstanceIdentifier.class));
 140         doAnswer(invocation -> {
 141             final Object[] args = invocation.getArguments();
 142             final NormalizedNode<?, ?> node1 = (NormalizedNode<?, ?>) args[2];
 143             this.routesMap.put((YangInstanceIdentifier) args[1], node1);
 144             return args[1];
 145         }).when(this.tx).put(Mockito.eq(LogicalDatastoreType.OPERATIONAL), any(YangInstanceIdentifier.class),
 146                 any(NormalizedNode.class));
 147
 148         this.mapEntryNode = Mockito.mock(MapEntryNode.class);
 149     }
 150
 151     @Override
 152     protected final AbstractDataBrokerTestCustomizer createDataBrokerTestCustomizer() {
 153         final AbstractDataBrokerTestCustomizer customizer = super.createDataBrokerTestCustomizer();
 154         this.context = customizer.getAdapterContext();
 155         return customizer;
 156     }
 157
 158     @Test
 159     public void routesCaseClass() {
 160         assertEquals(Ipv4RoutesCase.class, this.ribSupportTestImp.routesCaseClass());
 161     }
 162
 163     @Test
 164     public void routesContainerClass() {
 165         assertEquals(Ipv4Routes.class, this.ribSupportTestImp.routesContainerClass());
 166     }
 167
 168     @Test
 169     public void routesListClass() {
 170         assertEquals(Ipv4Route.class, this.ribSupportTestImp.routesListClass());
 171     }
 172
 173     @Test
 174     public void routeQName() {
 175         assertEquals(Ipv4Route.QNAME, this.ribSupportTestImp.routeQName());
 176     }
 177
 178     @Test
 179     public void routeNid() {
 180         assertEquals(new NodeIdentifier(Ipv4Route.QNAME),this.ribSupportTestImp.routeNid());
 181     }
 182
 183     @Test
 184     public void getAfi() {
 185         assertEquals(Ipv4AddressFamily.class,this.ribSupportTestImp.getAfi());
 186     }
 187
 188     @Test
 189     public void getSafi() {
 190         assertEquals(UnicastSubsequentAddressFamily.class,this.ribSupportTestImp.getSafi());
 191     }
 192
 193     @Test
 194     public void routesContainerIdentifier() {
 195         assertEquals(IPV4_ROUTES_IDENTIFIER,this.ribSupportTestImp.routesContainerIdentifier());
 196
 197     }
 198
 199     @Test
 200     public void routeAttributesIdentifier() {
 201         assertEquals(new NodeIdentifier(QName.create(Ipv4Routes.QNAME,
 202                 Attributes.QNAME.getLocalName().intern())),this.ribSupportTestImp.routeAttributesIdentifier());
 203     }
 204
 205     @Test
 206     public void routePath() {
 207         assertEquals(LOC_RIB_TARGET.node(ROUTES_IDENTIFIER)
 208                         .node(Ipv4Routes.QNAME).node(Ipv4Route.QNAME).node(PREFIX_NII),
 209                 this.ribSupportTestImp.routePath(LOC_RIB_TARGET, PREFIX_NII));
 210     }
 211
 212     @Test
 213     public void changedRoutes() {
 214         assertTrue(ribSupportTestImp.changedRoutes(this.emptyTree).isEmpty());
 215         assertTrue(ribSupportTestImp.changedRoutes(this.emptySubTree).isEmpty());
 216         assertNotNull(ribSupportTestImp.changedRoutes(this.subTree));
 217     }
 218
 219     @Test
 220     public void putRoutes() {
 221         this.ribSupportTestImp.putRoutes(this.tx, LOC_RIB_TARGET, this.nlri, this.attributes);
 222         assertFalse(this.routesMap.isEmpty());
 223     }
 224
 225     @Test
 226     public void deleteRoutes() {
 227         this.ribSupportTestImp.deleteRoutes(this.tx, LOC_RIB_TARGET, this.nlri);
 228         assertTrue(this.routesMap.isEmpty());
 229     }
 230
 231
 232     @Test
 233     public void buildUpdate() {
 234         final Ipv4NextHopCase nextHop = new Ipv4NextHopCaseBuilder().setIpv4NextHop(new Ipv4NextHopBuilder()
 235                 .setGlobal(new Ipv4AddressNoZone("10.0.0.2")).build()).build();
 236         final Attributes attr = new AttributesBuilder().setCNextHop(nextHop).build();
 237         final Collection<MapEntryNode> routes = new HashSet<>();
 238
 239         assertEquals(new UpdateBuilder().setAttributes(new AttributesBuilder().build()).build(),
 240                this.ribSupportTestImp.buildUpdate(routes, routes, attr));
 241
 242         routes.add(this.mapEntryNode);
 243         final MpReachNlri mpReach = new MpReachNlriBuilder().setAfi(Ipv4AddressFamily.class)
 244                 .setSafi(UnicastSubsequentAddressFamily.class)
 245                 .setCNextHop(nextHop).setAdvertizedRoutes(new AdvertizedRoutesBuilder().build()).build();
 246
 247         final Attributes attMpR = new AttributesBuilder().addAugmentation(
 248             new AttributesReachBuilder().setMpReachNlri(mpReach).build()).build();
 249         assertEquals(new UpdateBuilder().setAttributes(attMpR).build(),
 250                this.ribSupportTestImp.buildUpdate(routes, Collections.emptySet(), attr));
 251
 252         final MpUnreachNlri mpUnreach = new MpUnreachNlriBuilder().setAfi(Ipv4AddressFamily.class)
 253                 .setSafi(UnicastSubsequentAddressFamily.class)
 254                 .setWithdrawnRoutes(new WithdrawnRoutesBuilder().build()).build();
 255
 256         final Attributes attMpU = new AttributesBuilder().addAugmentation(
 257                 new AttributesUnreachBuilder().setMpUnreachNlri(mpUnreach).build()).build();
 258         assertEquals(new UpdateBuilder().setAttributes(attMpU).build(),
 259                this.ribSupportTestImp.buildUpdate(Collections.emptySet(), routes, attr));
 260     }
 261 }