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.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 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeSchemaAwareBuilder;
77 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafNodeBuilder;
79 public class MultiPathAbstractRIBSupportTest {
80 private static final long PATH_ID = 0;
81 private static final String ROUTE_KEY = "prefix";
82 private static final String PREFIX = "1.2.3.4/32";
83 private static final QName PATH_ID_QNAME = QName.create(Ipv4Route.QNAME, "path-id").intern();
84 private static final QName PREFIX_QNAME = QName.create(Ipv4Route.QNAME, ROUTE_KEY).intern();
85 private static final NodeIdentifierWithPredicates PREFIX_NII = new NodeIdentifierWithPredicates(Ipv4Route.QNAME,
86 ImmutableMap.of(QName.create(Ipv4Route.QNAME, ROUTE_KEY).intern(), PREFIX));
87 private static final MultiPathAbstractTest MULTI_PATH_ABSTRACT_TEST = new MultiPathAbstractTest();
88 private static final TablesKey TABLES_KEY = new TablesKey(Ipv4AddressFamily.class,
89 UnicastSubsequentAddressFamily.class);
90 private static final YangInstanceIdentifier LOC_RIB_TARGET = YangInstanceIdentifier
91 .create(YangInstanceIdentifier.of(BgpRib.QNAME)
92 .node(LocRib.QNAME).node(Tables.QNAME).node(RibSupportUtils.toYangTablesKey(TABLES_KEY)).getPathArguments());
93 private static final NodeIdentifier ROUTES_IDENTIFIER = new NodeIdentifier(Routes.QNAME);
94 private static final NodeIdentifier IPV4_ROUTES_IDENTIFIER = new NodeIdentifier(Ipv4Routes.QNAME);
95 private DataTreeCandidateNode emptyTree;
96 private DataTreeCandidateNode emptySubTree;
97 private DataTreeCandidateNode subTree;
98 private DOMDataWriteTransaction tx;
99 private ContainerNode nlri;
100 private Map<YangInstanceIdentifier, NormalizedNode<?, ?>> routes;
101 private ContainerNode attributes;
102 private MapEntryNode mapEntryNode;
105 public void setUp() {
106 this.routes = new HashMap<>();
107 MockitoAnnotations.initMocks(this);
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);
115 doReturn(emptyNode).when(this.emptySubTree).getModifiedChild(IPV4_ROUTES_IDENTIFIER);
116 doReturn(null).when(emptyNode).getModifiedChild(new NodeIdentifier(Ipv4Route.QNAME));
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();
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);
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();
141 doAnswer(invocation -> {
142 final Object[] args = invocation.getArguments();
143 MultiPathAbstractRIBSupportTest.this.routes.remove(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 MultiPathAbstractRIBSupportTest.this.routes.put((YangInstanceIdentifier) args[1], node1);
151 }).when(this.tx).put(Mockito.eq(LogicalDatastoreType.OPERATIONAL), any(YangInstanceIdentifier.class),
152 any(NormalizedNode.class));
154 this.mapEntryNode = Mockito.mock(MapEntryNode.class);
158 public void pathIdQName() {
159 final MultiPathAbstractTest multiPath = MULTI_PATH_ABSTRACT_TEST;
160 assertEquals(PATH_ID_QNAME, multiPath.pathIdQName());
164 public void extractPathId() {
165 final NodeIdentifier nii = new NodeIdentifier(PATH_ID_QNAME);
166 final ContainerNode cont = ImmutableContainerNodeSchemaAwareBuilder.create().withNodeIdentifier(nii)
167 .addChild(new ImmutableLeafNodeBuilder<>().withNodeIdentifier(nii).withValue(PATH_ID).build()).build();
168 assertEquals(PATH_ID, MULTI_PATH_ABSTRACT_TEST.extractPathId(cont));
172 public void getRouteIdAddPath() {
173 final NodeIdentifierWithPredicates routeIdPa =
174 new NodeIdentifierWithPredicates(Ipv4Route.QNAME,
175 ImmutableMap.of(PATH_ID_QNAME, PATH_ID, PREFIX_QNAME, PREFIX));
176 assertEquals(routeIdPa, MULTI_PATH_ABSTRACT_TEST.getRouteIdAddPath(PATH_ID, PREFIX_NII));
181 public void createRouteKeyPathArgument() {
182 assertEquals(PREFIX_NII, MULTI_PATH_ABSTRACT_TEST.createRouteKeyPathArgument(PREFIX_NII));
186 public void routesCaseClass() throws Exception {
187 assertEquals(Ipv4RoutesCase.class, MULTI_PATH_ABSTRACT_TEST.routesCaseClass());
191 public void routesContainerClass() throws Exception {
192 assertEquals(Ipv4Routes.class, MULTI_PATH_ABSTRACT_TEST.routesContainerClass());
196 public void routesListClass() throws Exception {
197 assertEquals(Ipv4Route.class, MULTI_PATH_ABSTRACT_TEST.routesListClass());
201 public void routeQName() throws Exception {
202 assertEquals(Ipv4Route.QNAME, MULTI_PATH_ABSTRACT_TEST.routeQName());
206 public void emptyRoutes() throws Exception {
207 final ChoiceNode emptyRoutes = Builders.choiceBuilder().withNodeIdentifier(ROUTES_IDENTIFIER)
208 .addChild(Builders.containerBuilder().withNodeIdentifier(IPV4_ROUTES_IDENTIFIER)
209 .withChild(ImmutableNodes.mapNodeBuilder(MULTI_PATH_ABSTRACT_TEST.routeQName())
210 .build()).build()).build();
211 assertEquals(emptyRoutes, MULTI_PATH_ABSTRACT_TEST.emptyRoutes());
215 public void routeNid() throws Exception {
216 assertEquals(new NodeIdentifier(Ipv4Route.QNAME), MULTI_PATH_ABSTRACT_TEST.routeNid());
220 public void getAfi() throws Exception {
221 assertEquals(Ipv4AddressFamily.class, MULTI_PATH_ABSTRACT_TEST.getAfi());
225 public void getSafi() throws Exception {
226 assertEquals(UnicastSubsequentAddressFamily.class, MULTI_PATH_ABSTRACT_TEST.getSafi());
230 public void routesContainerIdentifier() throws Exception {
231 assertEquals(IPV4_ROUTES_IDENTIFIER, MULTI_PATH_ABSTRACT_TEST.routesContainerIdentifier());
236 public void routeAttributesIdentifier() throws Exception {
237 assertEquals(new NodeIdentifier(QName.create(Ipv4Routes.QNAME,
238 Attributes.QNAME.getLocalName().intern())), MULTI_PATH_ABSTRACT_TEST.routeAttributesIdentifier());
242 public void routePath() throws Exception {
243 Assert.assertEquals(LOC_RIB_TARGET.node(ROUTES_IDENTIFIER)
244 .node(Ipv4Routes.QNAME).node(Ipv4Route.QNAME).node(PREFIX_NII),
245 MULTI_PATH_ABSTRACT_TEST.routePath(LOC_RIB_TARGET.node(Routes.QNAME), PREFIX_NII));
249 public void changedRoutes() throws Exception {
250 Assert.assertTrue(MULTI_PATH_ABSTRACT_TEST.changedDOMRoutes(this.emptyTree).isEmpty());
251 Assert.assertTrue(MULTI_PATH_ABSTRACT_TEST.changedDOMRoutes(this.emptySubTree).isEmpty());
252 Assert.assertNotNull(MULTI_PATH_ABSTRACT_TEST.changedDOMRoutes(this.subTree));
256 public void putRoutes() throws Exception {
257 MULTI_PATH_ABSTRACT_TEST.putRoutes(this.tx, LOC_RIB_TARGET, this.nlri, this.attributes);
258 assertFalse(this.routes.isEmpty());
262 public void deleteRoutes() throws Exception {
263 MULTI_PATH_ABSTRACT_TEST.deleteRoutes(this.tx, LOC_RIB_TARGET, this.nlri);
264 assertTrue(this.routes.isEmpty());
269 public void buildUpdate() throws Exception {
270 final Ipv4NextHopCase nextHop = new Ipv4NextHopCaseBuilder().setIpv4NextHop(new Ipv4NextHopBuilder()
271 .setGlobal(new Ipv4Address("10.0.0.2")).build()).build();
272 final Attributes attr = new AttributesBuilder().setCNextHop(nextHop).build();
273 final Collection<MapEntryNode> routes = new HashSet<>();
275 assertEquals(new UpdateBuilder().setAttributes(new AttributesBuilder().build()).build(),
276 MULTI_PATH_ABSTRACT_TEST.buildUpdate(routes, routes, attr));
278 routes.add(this.mapEntryNode);
279 final MpReachNlri mpReach = new MpReachNlriBuilder().setAfi(Ipv4AddressFamily.class)
280 .setSafi(UnicastSubsequentAddressFamily.class)
281 .setCNextHop(nextHop).setAdvertizedRoutes(new AdvertizedRoutesBuilder().build()).build();
283 final Attributes attMpR = new AttributesBuilder().addAugmentation(Attributes1.class,
284 new Attributes1Builder().setMpReachNlri(mpReach).build()).build();
285 assertEquals(new UpdateBuilder().setAttributes(attMpR).build(),
286 MULTI_PATH_ABSTRACT_TEST.buildUpdate(routes, Collections.emptySet(), attr));
288 final MpUnreachNlri mpUnreach = new MpUnreachNlriBuilder().setAfi(Ipv4AddressFamily.class)
289 .setSafi(UnicastSubsequentAddressFamily.class)
290 .setWithdrawnRoutes(new WithdrawnRoutesBuilder().build()).build();
292 final Attributes attMpU = new AttributesBuilder().addAugmentation(Attributes2.class,
293 new Attributes2Builder().setMpUnreachNlri(mpUnreach).build()).build();
294 assertEquals(new UpdateBuilder().setAttributes(attMpU).build(),
295 MULTI_PATH_ABSTRACT_TEST.buildUpdate(Collections.emptySet(), routes, attr));