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