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
8 package org.opendaylight.netconf.topology.singleton.impl;
10 import static org.awaitility.Awaitility.await;
11 import static org.junit.Assert.assertEquals;
12 import static org.mockito.ArgumentMatchers.any;
13 import static org.mockito.Mockito.doNothing;
14 import static org.mockito.Mockito.doReturn;
15 import static org.mockito.Mockito.doThrow;
16 import static org.mockito.Mockito.mock;
17 import static org.mockito.Mockito.reset;
18 import static org.mockito.Mockito.spy;
19 import static org.mockito.Mockito.times;
20 import static org.mockito.Mockito.verify;
21 import static org.mockito.Mockito.verifyNoMoreInteractions;
22 import static org.mockito.MockitoAnnotations.initMocks;
23 import static org.opendaylight.mdsal.binding.api.DataObjectModification.ModificationType.DELETE;
24 import static org.opendaylight.mdsal.binding.api.DataObjectModification.ModificationType.SUBTREE_MODIFIED;
25 import static org.opendaylight.mdsal.binding.api.DataObjectModification.ModificationType.WRITE;
27 import akka.util.Timeout;
28 import com.google.common.collect.ImmutableSet;
29 import io.netty.util.concurrent.EventExecutor;
30 import java.util.Arrays;
31 import java.util.HashMap;
33 import java.util.Objects;
34 import java.util.Optional;
36 import java.util.concurrent.ExecutorService;
37 import java.util.concurrent.TimeUnit;
38 import java.util.function.Function;
39 import org.junit.Before;
40 import org.junit.Test;
41 import org.mockito.ArgumentCaptor;
42 import org.mockito.Mock;
43 import org.opendaylight.aaa.encrypt.AAAEncryptionService;
44 import org.opendaylight.controller.cluster.ActorSystemProvider;
45 import org.opendaylight.controller.config.threadpool.ScheduledThreadPool;
46 import org.opendaylight.controller.config.threadpool.ThreadPool;
47 import org.opendaylight.mdsal.binding.api.DataBroker;
48 import org.opendaylight.mdsal.binding.api.DataObjectModification;
49 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
50 import org.opendaylight.mdsal.binding.api.DataTreeModification;
51 import org.opendaylight.mdsal.binding.api.ReadTransaction;
52 import org.opendaylight.mdsal.binding.dom.adapter.test.AbstractDataBrokerTest;
53 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
54 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
55 import org.opendaylight.mdsal.dom.api.DOMActionProviderService;
56 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
57 import org.opendaylight.mdsal.dom.api.DOMRpcProviderService;
58 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
59 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceRegistration;
60 import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
61 import org.opendaylight.netconf.client.NetconfClientDispatcher;
62 import org.opendaylight.netconf.sal.connect.api.DeviceActionFactory;
63 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologySetup;
64 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologyUtils;
65 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host;
66 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
67 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
68 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeBuilder;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.topology.singleton.config.rev170419.Config;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.topology.singleton.config.rev170419.ConfigBuilder;
73 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
74 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
75 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
76 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
77 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
78 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
79 import org.opendaylight.yangtools.concepts.ListenerRegistration;
80 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
81 import org.opendaylight.yangtools.yang.binding.YangModuleInfo;
82 import org.opendaylight.yangtools.yang.common.Uint16;
84 public class NetconfTopologyManagerTest {
85 private static final int ACTOR_RESPONSE_WAIT_TIME = 10;
86 private static final String TOPOLOGY_ID = "topologyID";
88 private NetconfTopologyManager netconfTopologyManager;
91 private ClusterSingletonServiceProvider clusterSingletonServiceProvider;
94 private ListenerRegistration<?> mockListenerReg;
96 private DataBroker dataBroker;
98 private final Map<InstanceIdentifier<Node>, Function<NetconfTopologySetup, NetconfTopologyContext>>
99 mockContextMap = new HashMap<>();
102 public void setUp() throws Exception {
105 AbstractDataBrokerTest dataBrokerTest = new AbstractDataBrokerTest() {
107 protected Set<YangModuleInfo> getModuleInfos() throws Exception {
108 return ImmutableSet.of(BindingReflections.getModuleInfo(NetworkTopology.class),
109 BindingReflections.getModuleInfo(Topology.class));
113 dataBrokerTest.setup();
114 dataBroker = spy(dataBrokerTest.getDataBroker());
116 final DOMRpcProviderService rpcProviderRegistry = mock(DOMRpcProviderService.class);
117 final ScheduledThreadPool keepaliveExecutor = mock(ScheduledThreadPool.class);
118 final DOMActionProviderService actionProviderRegistry = mock(DOMActionProviderService.class);
119 final ThreadPool processingThreadPool = mock(ThreadPool.class);
120 final ExecutorService processingService = mock(ExecutorService.class);
121 doReturn(processingService).when(processingThreadPool).getExecutor();
122 final ActorSystemProvider actorSystemProvider = mock(ActorSystemProvider.class);
123 final EventExecutor eventExecutor = mock(EventExecutor.class);
124 final NetconfClientDispatcher clientDispatcher = mock(NetconfClientDispatcher.class);
125 final DOMMountPointService mountPointService = mock(DOMMountPointService.class);
126 final AAAEncryptionService encryptionService = mock(AAAEncryptionService.class);
127 final DeviceActionFactory deviceActionFactory = mock(DeviceActionFactory.class);
129 final Config config = new ConfigBuilder().setWriteTransactionIdleTimeout(0).build();
130 netconfTopologyManager = new NetconfTopologyManager(dataBroker, rpcProviderRegistry, actionProviderRegistry,
131 clusterSingletonServiceProvider, keepaliveExecutor, processingThreadPool,
132 actorSystemProvider, eventExecutor, clientDispatcher, TOPOLOGY_ID, config,
133 mountPointService, encryptionService, deviceActionFactory) {
135 protected NetconfTopologyContext newNetconfTopologyContext(final NetconfTopologySetup setup,
136 final ServiceGroupIdentifier serviceGroupIdent, final Timeout actorResponseWaitTime,
137 final DeviceActionFactory deviceActionFactory) {
138 assertEquals(ACTOR_RESPONSE_WAIT_TIME, actorResponseWaitTime.duration().toSeconds());
139 return Objects.requireNonNull(mockContextMap.get(setup.getInstanceIdentifier()),
140 "No mock context for " + setup.getInstanceIdentifier()).apply(setup);
144 doNothing().when(mockListenerReg).close();
145 doReturn(mockListenerReg).when(dataBroker).registerDataTreeChangeListener(any(), any());
149 public void testRegisterDataTreeChangeListener() throws Exception {
151 netconfTopologyManager.init();
153 await().atMost(5, TimeUnit.SECONDS).until(() -> {
154 ReadTransaction readTx = dataBroker.newReadOnlyTransaction();
155 Optional<Topology> config = readTx.read(LogicalDatastoreType.CONFIGURATION,
156 NetconfTopologyUtils.createTopologyListPath(TOPOLOGY_ID)).get(3, TimeUnit.SECONDS);
157 Optional<Topology> oper = readTx.read(LogicalDatastoreType.OPERATIONAL,
158 NetconfTopologyUtils.createTopologyListPath(TOPOLOGY_ID)).get(3, TimeUnit.SECONDS);
159 return config.isPresent() && oper.isPresent();
162 // verify registration is called with right parameters
164 verify(dataBroker).registerDataTreeChangeListener(
165 DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION, NetconfTopologyUtils
166 .createTopologyListPath(TOPOLOGY_ID).child(Node.class)), netconfTopologyManager);
168 netconfTopologyManager.close();
169 verify(mockListenerReg).close();
171 netconfTopologyManager.close();
172 verifyNoMoreInteractions(mockListenerReg);
175 @SuppressWarnings("unchecked")
177 public void testOnDataTreeChanged() throws Exception {
179 // Notify of 2 created Node objects.
181 final NodeId nodeId1 = new NodeId("node-id-1");
182 final InstanceIdentifier<Node> nodeInstanceId1 = NetconfTopologyUtils.createTopologyNodeListPath(
183 new NodeKey(nodeId1), TOPOLOGY_ID);
185 final NodeId nodeId2 = new NodeId("node-id-2");
186 final InstanceIdentifier<Node> nodeInstanceId2 = NetconfTopologyUtils.createTopologyNodeListPath(
187 new NodeKey(nodeId2), TOPOLOGY_ID);
189 final NetconfNode netconfNode1 = new NetconfNodeBuilder()
190 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
191 .setPort(new PortNumber(Uint16.valueOf(1111)))
192 .setActorResponseWaitTime(ACTOR_RESPONSE_WAIT_TIME)
194 final Node node1 = new NodeBuilder().setNodeId(nodeId1).addAugmentation(NetconfNode.class,
195 netconfNode1).build();
197 final DataObjectModification<Node> dataObjectModification1 = mock(DataObjectModification.class);
198 doReturn(WRITE).when(dataObjectModification1).getModificationType();
199 doReturn(node1).when(dataObjectModification1).getDataAfter();
200 doReturn(InstanceIdentifier.IdentifiableItem.of(Node.class, new NodeKey(nodeId1)))
201 .when(dataObjectModification1).getIdentifier();
203 final NetconfNode netconfNode2 = new NetconfNodeBuilder()
204 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
205 .setPort(new PortNumber(Uint16.valueOf(2222)))
206 .setActorResponseWaitTime(ACTOR_RESPONSE_WAIT_TIME)
208 final Node node2 = new NodeBuilder().setNodeId(nodeId2).addAugmentation(NetconfNode.class,
209 netconfNode2).build();
211 final DataObjectModification<Node> dataObjectModification2 = mock(DataObjectModification.class);
212 doReturn(WRITE).when(dataObjectModification2).getModificationType();
213 doReturn(node2).when(dataObjectModification2).getDataAfter();
214 doReturn(InstanceIdentifier.IdentifiableItem.of(Node.class, new NodeKey(nodeId2)))
215 .when(dataObjectModification2).getIdentifier();
217 final NetconfTopologyContext mockContext1 = mock(NetconfTopologyContext.class);
218 mockContextMap.put(nodeInstanceId1, setup -> {
219 assertEquals(node1, setup.getNode());
220 assertEquals(TOPOLOGY_ID, setup.getTopologyId());
224 final NetconfTopologyContext mockContext2 = mock(NetconfTopologyContext.class);
225 mockContextMap.put(nodeInstanceId2, setup -> {
226 assertEquals(node2, setup.getNode());
227 assertEquals(TOPOLOGY_ID, setup.getTopologyId());
231 ClusterSingletonServiceRegistration mockClusterRegistration1 = mock(ClusterSingletonServiceRegistration.class);
232 ClusterSingletonServiceRegistration mockClusterRegistration2 = mock(ClusterSingletonServiceRegistration.class);
234 doReturn(mockClusterRegistration1).when(clusterSingletonServiceProvider)
235 .registerClusterSingletonService(mockContext1);
236 doReturn(mockClusterRegistration2).when(clusterSingletonServiceProvider)
237 .registerClusterSingletonService(mockContext2);
239 netconfTopologyManager.onDataTreeChanged(Arrays.asList(
240 new CustomTreeModification(DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION,
241 nodeInstanceId1), dataObjectModification1),
242 new CustomTreeModification(DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION,
243 nodeInstanceId2), dataObjectModification2)));
245 verify(clusterSingletonServiceProvider).registerClusterSingletonService(mockContext1);
246 verify(clusterSingletonServiceProvider).registerClusterSingletonService(mockContext2);
248 // Notify of Node 1 replaced and Node 2 subtree modified.
250 mockContextMap.clear();
252 final NetconfNode updatedNetconfNode1 = new NetconfNodeBuilder(netconfNode1)
253 .setPort(new PortNumber(Uint16.valueOf(33333))).build();
254 final Node updatedNode1 = new NodeBuilder().setNodeId(nodeId1).addAugmentation(NetconfNode.class,
255 updatedNetconfNode1).build();
257 doReturn(WRITE).when(dataObjectModification1).getModificationType();
258 doReturn(node1).when(dataObjectModification1).getDataBefore();
259 doReturn(updatedNode1).when(dataObjectModification1).getDataAfter();
261 doReturn(SUBTREE_MODIFIED).when(dataObjectModification2).getModificationType();
262 doReturn(node2).when(dataObjectModification2).getDataBefore();
263 doReturn(node2).when(dataObjectModification2).getDataAfter();
265 doNothing().when(mockContext1).refresh(any());
266 doNothing().when(mockContext2).refresh(any());
268 netconfTopologyManager.onDataTreeChanged(Arrays.asList(
269 new CustomTreeModification(DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION,
270 nodeInstanceId1), dataObjectModification1),
271 new CustomTreeModification(DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION,
272 nodeInstanceId2), dataObjectModification2)));
274 ArgumentCaptor<NetconfTopologySetup> mockContext1Setup = ArgumentCaptor.forClass(NetconfTopologySetup.class);
275 verify(mockContext1).refresh(mockContext1Setup.capture());
276 assertEquals(updatedNode1, mockContext1Setup.getValue().getNode());
278 verify(mockContext2).refresh(any());
280 verifyNoMoreInteractions(clusterSingletonServiceProvider);
282 // Notify of Node 1 deleted.
284 doReturn(DELETE).when(dataObjectModification1).getModificationType();
285 doReturn(updatedNode1).when(dataObjectModification1).getDataBefore();
286 doReturn(null).when(dataObjectModification1).getDataAfter();
288 netconfTopologyManager.onDataTreeChanged(Arrays.asList(
289 new CustomTreeModification(DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION,
290 nodeInstanceId1), dataObjectModification1)));
292 verify(mockClusterRegistration1).close();
293 verify(mockContext1).close();
294 verifyNoMoreInteractions(clusterSingletonServiceProvider, mockClusterRegistration2, mockContext2);
296 // Notify of Node 1 created again.
298 reset(clusterSingletonServiceProvider);
300 final NetconfTopologyContext newMockContext1 = mock(NetconfTopologyContext.class);
301 final ClusterSingletonServiceRegistration newMockClusterRegistration1 =
302 mock(ClusterSingletonServiceRegistration.class);
304 doThrow(new RuntimeException("mock error")).doReturn(newMockClusterRegistration1)
305 .when(clusterSingletonServiceProvider).registerClusterSingletonService(newMockContext1);
307 doReturn(WRITE).when(dataObjectModification1).getModificationType();
308 doReturn(null).when(dataObjectModification1).getDataBefore();
309 doReturn(node1).when(dataObjectModification1).getDataAfter();
311 mockContextMap.put(nodeInstanceId1, setup -> {
312 assertEquals(node1, setup.getNode());
313 assertEquals(TOPOLOGY_ID, setup.getTopologyId());
314 return newMockContext1;
317 netconfTopologyManager.onDataTreeChanged(Arrays.asList(
318 new CustomTreeModification(DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION,
319 nodeInstanceId1), dataObjectModification1)));
321 verify(clusterSingletonServiceProvider, times(2)).registerClusterSingletonService(newMockContext1);
323 verifyNoMoreInteractions(mockClusterRegistration1, mockContext1, mockClusterRegistration2, mockContext2,
324 newMockContext1, newMockClusterRegistration1, clusterSingletonServiceProvider);
328 netconfTopologyManager.close();
330 verify(newMockClusterRegistration1).close();
331 verify(newMockContext1).close();
332 verify(mockClusterRegistration2).close();
333 verify(mockContext2).close();
335 netconfTopologyManager.close();
337 verifyNoMoreInteractions(mockClusterRegistration1, mockContext1, mockClusterRegistration2, mockContext2,
338 newMockContext1, newMockClusterRegistration1, clusterSingletonServiceProvider);
342 public void testClusterSingletonServiceRegistrationFailure() throws Exception {
343 final NodeId nodeId = new NodeId("node-id");
344 final InstanceIdentifier<Node> nodeInstanceId = NetconfTopologyUtils.createTopologyNodeListPath(
345 new NodeKey(nodeId), TOPOLOGY_ID);
347 final NetconfNode netconfNode = new NetconfNodeBuilder()
348 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
349 .setPort(new PortNumber(Uint16.valueOf(10)))
350 .setActorResponseWaitTime(ACTOR_RESPONSE_WAIT_TIME).build();
351 final Node node = new NodeBuilder().setNodeId(nodeId).addAugmentation(NetconfNode.class,
352 netconfNode).build();
354 final DataObjectModification<Node> dataObjectModification = mock(DataObjectModification.class);
355 doReturn(WRITE).when(dataObjectModification).getModificationType();
356 doReturn(node).when(dataObjectModification).getDataAfter();
357 doReturn(InstanceIdentifier.IdentifiableItem.of(Node.class, new NodeKey(nodeId)))
358 .when(dataObjectModification).getIdentifier();
360 final NetconfTopologyContext mockContext = mock(NetconfTopologyContext.class);
361 mockContextMap.put(nodeInstanceId, setup -> mockContext);
363 doThrow(new RuntimeException("mock error")).when(clusterSingletonServiceProvider)
364 .registerClusterSingletonService(mockContext);
366 netconfTopologyManager.init();
368 netconfTopologyManager.onDataTreeChanged(Arrays.asList(
369 new CustomTreeModification(DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION,
370 nodeInstanceId), dataObjectModification)));
372 verify(clusterSingletonServiceProvider, times(3)).registerClusterSingletonService(mockContext);
373 verify(mockContext).close();
374 verifyNoMoreInteractions(mockListenerReg);
376 netconfTopologyManager.close();
377 verifyNoMoreInteractions(mockContext);
380 static class CustomTreeModification implements DataTreeModification<Node> {
382 private final DataTreeIdentifier<Node> rootPath;
383 private final DataObjectModification<Node> rootNode;
385 CustomTreeModification(final DataTreeIdentifier<Node> rootPath, final DataObjectModification<Node> rootNode) {
386 this.rootPath = rootPath;
387 this.rootNode = rootNode;
391 public DataTreeIdentifier<Node> getRootPath() {
396 public DataObjectModification<Node> getRootNode() {