2 * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.protocol.bgp.rib.spi;
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;
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;
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.rev180329.ipv4.routes.ipv4.routes.Ipv4Prefixes;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv4.routes.ipv4.routes.Ipv4Route;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv4.routes.ipv4.routes.Ipv4Routes;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv4.routes.ipv4.routes.Ipv4RoutesCase;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv4.routes.ipv4.routes.RIBSupportTestImp;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.UpdateBuilder;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.Attributes;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.AttributesBuilder;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.Attributes1;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.Attributes1Builder;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.Attributes2;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.Attributes2Builder;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.destination.DestinationType;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpReachNlri;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpReachNlriBuilder;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpUnreachNlri;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpUnreachNlriBuilder;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.mp.reach.nlri.AdvertizedRoutes;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.mp.reach.nlri.AdvertizedRoutesBuilder;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.mp.unreach.nlri.WithdrawnRoutes;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.mp.unreach.nlri.WithdrawnRoutesBuilder;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.BgpRib;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.rib.LocRib;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.Tables;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.tables.Routes;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.Ipv4AddressFamily;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.UnicastSubsequentAddressFamily;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.next.hop.c.next.hop.Ipv4NextHopCase;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.next.hop.c.next.hop.Ipv4NextHopCaseBuilder;
63 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;
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;
77 public class RIBSupportTest {
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 RIBSupportTestImp ABSTRACT_RIB_SUPP_TEST = new RIBSupportTestImp();
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;
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);
111 doReturn(emptyNode).when(this.emptySubTree).getModifiedChild(IPV4_ROUTES_IDENTIFIER);
112 doReturn(null).when(emptyNode).getModifiedChild(new NodeIdentifier(Ipv4Route.QNAME));
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();
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);
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();
137 doAnswer(invocation -> {
138 final Object[] args = invocation.getArguments();
139 RIBSupportTest.this.routesMap.remove(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 RIBSupportTest.this.routesMap.put((YangInstanceIdentifier) args[1], node1);
147 }).when(this.tx).put(Mockito.eq(LogicalDatastoreType.OPERATIONAL), any(YangInstanceIdentifier.class),
148 any(NormalizedNode.class));
150 this.mapEntryNode = Mockito.mock(MapEntryNode.class);
154 public void pathIdQName() {
155 assertEquals(PATH_ID_QNAME, ABSTRACT_RIB_SUPP_TEST.pathIdQName());
159 public void routesCaseClass() {
160 assertEquals(Ipv4RoutesCase.class, ABSTRACT_RIB_SUPP_TEST.routesCaseClass());
164 public void routesContainerClass() {
165 assertEquals(Ipv4Routes.class, ABSTRACT_RIB_SUPP_TEST.routesContainerClass());
169 public void routesListClass() {
170 assertEquals(Ipv4Route.class, ABSTRACT_RIB_SUPP_TEST.routesListClass());
174 public void routeQName() {
175 assertEquals(Ipv4Route.QNAME, ABSTRACT_RIB_SUPP_TEST.routeQName());
179 public void emptyRoutes() {
180 final ChoiceNode emptyRoutes = Builders.choiceBuilder().withNodeIdentifier(ROUTES_IDENTIFIER)
181 .addChild(Builders.containerBuilder().withNodeIdentifier(IPV4_ROUTES_IDENTIFIER)
182 .withChild(ImmutableNodes.mapNodeBuilder(ABSTRACT_RIB_SUPP_TEST.routeQName())
183 .build()).build()).build();
184 assertEquals(emptyRoutes, ABSTRACT_RIB_SUPP_TEST.emptyRoutes());
188 public void routeNid() {
189 assertEquals(new NodeIdentifier(Ipv4Route.QNAME), ABSTRACT_RIB_SUPP_TEST.routeNid());
193 public void getAfi() {
194 assertEquals(Ipv4AddressFamily.class, ABSTRACT_RIB_SUPP_TEST.getAfi());
198 public void getSafi() {
199 assertEquals(UnicastSubsequentAddressFamily.class, ABSTRACT_RIB_SUPP_TEST.getSafi());
203 public void routesContainerIdentifier() {
204 assertEquals(IPV4_ROUTES_IDENTIFIER, ABSTRACT_RIB_SUPP_TEST.routesContainerIdentifier());
209 public void routeAttributesIdentifier() {
210 assertEquals(new NodeIdentifier(QName.create(Ipv4Routes.QNAME,
211 Attributes.QNAME.getLocalName().intern())), ABSTRACT_RIB_SUPP_TEST.routeAttributesIdentifier());
215 public void routePath() {
216 Assert.assertEquals(LOC_RIB_TARGET.node(ROUTES_IDENTIFIER)
217 .node(Ipv4Routes.QNAME).node(Ipv4Route.QNAME).node(PREFIX_NII),
218 ABSTRACT_RIB_SUPP_TEST.routePath(LOC_RIB_TARGET.node(Routes.QNAME), PREFIX_NII));
222 public void changedRoutes() {
223 Assert.assertTrue(ABSTRACT_RIB_SUPP_TEST.changedRoutes(this.emptyTree).isEmpty());
224 Assert.assertTrue(ABSTRACT_RIB_SUPP_TEST.changedRoutes(this.emptySubTree).isEmpty());
225 Assert.assertNotNull(ABSTRACT_RIB_SUPP_TEST.changedRoutes(this.subTree));
229 public void putRoutes() {
230 ABSTRACT_RIB_SUPP_TEST.putRoutes(this.tx, LOC_RIB_TARGET, this.nlri, this.attributes);
231 assertFalse(this.routesMap.isEmpty());
235 public void deleteRoutes() {
236 ABSTRACT_RIB_SUPP_TEST.deleteRoutes(this.tx, LOC_RIB_TARGET, this.nlri);
237 assertTrue(this.routesMap.isEmpty());
242 public void buildUpdate() {
243 final Ipv4NextHopCase nextHop = new Ipv4NextHopCaseBuilder().setIpv4NextHop(new Ipv4NextHopBuilder()
244 .setGlobal(new Ipv4Address("10.0.0.2")).build()).build();
245 final Attributes attr = new AttributesBuilder().setCNextHop(nextHop).build();
246 final Collection<MapEntryNode> routes = new HashSet<>();
248 assertEquals(new UpdateBuilder().setAttributes(new AttributesBuilder().build()).build(),
249 ABSTRACT_RIB_SUPP_TEST.buildUpdate(routes, routes, attr));
251 routes.add(this.mapEntryNode);
252 final MpReachNlri mpReach = new MpReachNlriBuilder().setAfi(Ipv4AddressFamily.class)
253 .setSafi(UnicastSubsequentAddressFamily.class)
254 .setCNextHop(nextHop).setAdvertizedRoutes(new AdvertizedRoutesBuilder().build()).build();
256 final Attributes attMpR = new AttributesBuilder().addAugmentation(Attributes1.class,
257 new Attributes1Builder().setMpReachNlri(mpReach).build()).build();
258 assertEquals(new UpdateBuilder().setAttributes(attMpR).build(),
259 ABSTRACT_RIB_SUPP_TEST.buildUpdate(routes, Collections.emptySet(), attr));
261 final MpUnreachNlri mpUnreach = new MpUnreachNlriBuilder().setAfi(Ipv4AddressFamily.class)
262 .setSafi(UnicastSubsequentAddressFamily.class)
263 .setWithdrawnRoutes(new WithdrawnRoutesBuilder().build()).build();
265 final Attributes attMpU = new AttributesBuilder().addAugmentation(Attributes2.class,
266 new Attributes2Builder().setMpUnreachNlri(mpUnreach).build()).build();
267 assertEquals(new UpdateBuilder().setAttributes(attMpU).build(),
268 ABSTRACT_RIB_SUPP_TEST.buildUpdate(Collections.emptySet(), routes, attr));