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