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.opendaylight.mdsal.binding.api.DataObjectModification.ModificationType.DELETE;
23 import static org.opendaylight.mdsal.binding.api.DataObjectModification.ModificationType.SUBTREE_MODIFIED;
24 import static org.opendaylight.mdsal.binding.api.DataObjectModification.ModificationType.WRITE;
26 import akka.util.Timeout;
27 import com.google.common.collect.ImmutableSet;
28 import io.netty.util.concurrent.EventExecutor;
29 import java.util.Arrays;
30 import java.util.HashMap;
32 import java.util.Objects;
33 import java.util.Optional;
35 import java.util.concurrent.ExecutorService;
36 import java.util.concurrent.TimeUnit;
37 import java.util.function.Function;
38 import org.junit.Before;
39 import org.junit.Test;
40 import org.junit.runner.RunWith;
41 import org.mockito.ArgumentCaptor;
42 import org.mockito.Mock;
43 import org.mockito.junit.MockitoJUnitRunner;
44 import org.opendaylight.aaa.encrypt.AAAEncryptionService;
45 import org.opendaylight.controller.cluster.ActorSystemProvider;
46 import org.opendaylight.controller.config.threadpool.ScheduledThreadPool;
47 import org.opendaylight.controller.config.threadpool.ThreadPool;
48 import org.opendaylight.mdsal.binding.api.DataBroker;
49 import org.opendaylight.mdsal.binding.api.DataObjectModification;
50 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
51 import org.opendaylight.mdsal.binding.api.DataTreeModification;
52 import org.opendaylight.mdsal.binding.api.ReadTransaction;
53 import org.opendaylight.mdsal.binding.api.RpcProviderService;
54 import org.opendaylight.mdsal.binding.dom.adapter.test.AbstractDataBrokerTest;
55 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
56 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
57 import org.opendaylight.mdsal.dom.api.DOMActionProviderService;
58 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
59 import org.opendaylight.mdsal.dom.api.DOMRpcProviderService;
60 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
61 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceRegistration;
62 import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
63 import org.opendaylight.netconf.client.NetconfClientDispatcher;
64 import org.opendaylight.netconf.sal.connect.api.DeviceActionFactory;
65 import org.opendaylight.netconf.sal.connect.impl.DefaultSchemaResourceManager;
66 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologySetup;
67 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologyUtils;
68 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host;
69 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
70 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
71 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeBuilder;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.topology.singleton.config.rev170419.Config;
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.topology.singleton.config.rev170419.ConfigBuilder;
76 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
77 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
78 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
79 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
80 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
81 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
82 import org.opendaylight.yangtools.concepts.ListenerRegistration;
83 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
84 import org.opendaylight.yangtools.yang.binding.YangModuleInfo;
85 import org.opendaylight.yangtools.yang.common.Uint16;
86 import org.opendaylight.yangtools.yang.parser.impl.DefaultYangParserFactory;
88 @RunWith(MockitoJUnitRunner.StrictStubs.class)
89 public class NetconfTopologyManagerTest extends AbstractBaseSchemasTest {
90 private static final Uint16 ACTOR_RESPONSE_WAIT_TIME = Uint16.valueOf(10);
91 private static final String TOPOLOGY_ID = "topologyID";
93 private NetconfTopologyManager netconfTopologyManager;
96 private ClusterSingletonServiceProvider clusterSingletonServiceProvider;
99 private ListenerRegistration<?> mockListenerReg;
101 private DataBroker dataBroker;
103 private final Map<InstanceIdentifier<Node>, Function<NetconfTopologySetup, NetconfTopologyContext>>
104 mockContextMap = new HashMap<>();
107 public void setUp() throws Exception {
108 AbstractDataBrokerTest dataBrokerTest = new AbstractDataBrokerTest() {
110 protected Set<YangModuleInfo> getModuleInfos() throws Exception {
111 return ImmutableSet.of(BindingReflections.getModuleInfo(NetworkTopology.class),
112 BindingReflections.getModuleInfo(Topology.class));
116 dataBrokerTest.setup();
117 dataBroker = spy(dataBrokerTest.getDataBroker());
119 final DOMRpcProviderService rpcProviderRegistry = mock(DOMRpcProviderService.class);
120 final ScheduledThreadPool keepaliveExecutor = mock(ScheduledThreadPool.class);
121 final DOMActionProviderService actionProviderRegistry = mock(DOMActionProviderService.class);
122 final ThreadPool processingThreadPool = mock(ThreadPool.class);
123 final ExecutorService processingService = mock(ExecutorService.class);
124 doReturn(processingService).when(processingThreadPool).getExecutor();
125 final ActorSystemProvider actorSystemProvider = mock(ActorSystemProvider.class);
126 final EventExecutor eventExecutor = mock(EventExecutor.class);
127 final NetconfClientDispatcher clientDispatcher = mock(NetconfClientDispatcher.class);
128 final DOMMountPointService mountPointService = mock(DOMMountPointService.class);
129 final AAAEncryptionService encryptionService = mock(AAAEncryptionService.class);
130 final DeviceActionFactory deviceActionFactory = mock(DeviceActionFactory.class);
131 final RpcProviderService rpcProviderService = mock(RpcProviderService.class);
133 final Config config = new ConfigBuilder().setWriteTransactionIdleTimeout(Uint16.ZERO).build();
134 netconfTopologyManager = new NetconfTopologyManager(BASE_SCHEMAS, dataBroker, rpcProviderRegistry,
135 actionProviderRegistry, clusterSingletonServiceProvider, keepaliveExecutor, processingThreadPool,
136 actorSystemProvider, eventExecutor, clientDispatcher, TOPOLOGY_ID, config,
137 mountPointService, encryptionService, rpcProviderService, deviceActionFactory,
138 new DefaultSchemaResourceManager(new DefaultYangParserFactory())) {
140 protected NetconfTopologyContext newNetconfTopologyContext(final NetconfTopologySetup setup,
141 final ServiceGroupIdentifier serviceGroupIdent, final Timeout actorResponseWaitTime,
142 final DeviceActionFactory deviceActionFactory) {
143 assertEquals(ACTOR_RESPONSE_WAIT_TIME.toJava(), actorResponseWaitTime.duration().toSeconds());
144 return Objects.requireNonNull(mockContextMap.get(setup.getInstanceIdentifier()),
145 "No mock context for " + setup.getInstanceIdentifier()).apply(setup);
149 doNothing().when(mockListenerReg).close();
150 doReturn(mockListenerReg).when(dataBroker).registerDataTreeChangeListener(any(), any());
154 public void testRegisterDataTreeChangeListener() throws Exception {
156 netconfTopologyManager.init();
158 await().atMost(5, TimeUnit.SECONDS).until(() -> {
159 ReadTransaction readTx = dataBroker.newReadOnlyTransaction();
160 Optional<Topology> config = readTx.read(LogicalDatastoreType.CONFIGURATION,
161 NetconfTopologyUtils.createTopologyListPath(TOPOLOGY_ID)).get(3, TimeUnit.SECONDS);
162 Optional<Topology> oper = readTx.read(LogicalDatastoreType.OPERATIONAL,
163 NetconfTopologyUtils.createTopologyListPath(TOPOLOGY_ID)).get(3, TimeUnit.SECONDS);
164 return config.isPresent() && oper.isPresent();
167 // verify registration is called with right parameters
169 verify(dataBroker).registerDataTreeChangeListener(
170 DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION, NetconfTopologyUtils
171 .createTopologyListPath(TOPOLOGY_ID).child(Node.class)), netconfTopologyManager);
173 netconfTopologyManager.close();
174 verify(mockListenerReg).close();
176 netconfTopologyManager.close();
177 verifyNoMoreInteractions(mockListenerReg);
180 @SuppressWarnings("unchecked")
182 public void testOnDataTreeChanged() throws Exception {
184 // Notify of 2 created Node objects.
186 final NodeId nodeId1 = new NodeId("node-id-1");
187 final InstanceIdentifier<Node> nodeInstanceId1 = NetconfTopologyUtils.createTopologyNodeListPath(
188 new NodeKey(nodeId1), TOPOLOGY_ID);
190 final NodeId nodeId2 = new NodeId("node-id-2");
191 final InstanceIdentifier<Node> nodeInstanceId2 = NetconfTopologyUtils.createTopologyNodeListPath(
192 new NodeKey(nodeId2), TOPOLOGY_ID);
194 final NetconfNode netconfNode1 = new NetconfNodeBuilder()
195 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
196 .setPort(new PortNumber(Uint16.valueOf(1111)))
197 .setActorResponseWaitTime(ACTOR_RESPONSE_WAIT_TIME)
199 final Node node1 = new NodeBuilder().setNodeId(nodeId1).addAugmentation(netconfNode1).build();
201 final DataObjectModification<Node> dataObjectModification1 = mock(DataObjectModification.class);
202 doReturn(WRITE).when(dataObjectModification1).getModificationType();
203 doReturn(node1).when(dataObjectModification1).getDataAfter();
204 doReturn(InstanceIdentifier.IdentifiableItem.of(Node.class, new NodeKey(nodeId1)))
205 .when(dataObjectModification1).getIdentifier();
207 final NetconfNode netconfNode2 = new NetconfNodeBuilder()
208 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
209 .setPort(new PortNumber(Uint16.valueOf(2222)))
210 .setActorResponseWaitTime(ACTOR_RESPONSE_WAIT_TIME)
212 final Node node2 = new NodeBuilder().setNodeId(nodeId2).addAugmentation(netconfNode2).build();
214 final DataObjectModification<Node> dataObjectModification2 = mock(DataObjectModification.class);
215 doReturn(WRITE).when(dataObjectModification2).getModificationType();
216 doReturn(node2).when(dataObjectModification2).getDataAfter();
217 doReturn(InstanceIdentifier.IdentifiableItem.of(Node.class, new NodeKey(nodeId2)))
218 .when(dataObjectModification2).getIdentifier();
220 final NetconfTopologyContext mockContext1 = mock(NetconfTopologyContext.class);
221 mockContextMap.put(nodeInstanceId1, setup -> {
222 assertEquals(node1, setup.getNode());
223 assertEquals(TOPOLOGY_ID, setup.getTopologyId());
227 final NetconfTopologyContext mockContext2 = mock(NetconfTopologyContext.class);
228 mockContextMap.put(nodeInstanceId2, setup -> {
229 assertEquals(node2, setup.getNode());
230 assertEquals(TOPOLOGY_ID, setup.getTopologyId());
234 ClusterSingletonServiceRegistration mockClusterRegistration1 = mock(ClusterSingletonServiceRegistration.class);
235 ClusterSingletonServiceRegistration mockClusterRegistration2 = mock(ClusterSingletonServiceRegistration.class);
237 doReturn(mockClusterRegistration1).when(clusterSingletonServiceProvider)
238 .registerClusterSingletonService(mockContext1);
239 doReturn(mockClusterRegistration2).when(clusterSingletonServiceProvider)
240 .registerClusterSingletonService(mockContext2);
242 netconfTopologyManager.onDataTreeChanged(Arrays.asList(
243 new CustomTreeModification(DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION,
244 nodeInstanceId1), dataObjectModification1),
245 new CustomTreeModification(DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION,
246 nodeInstanceId2), dataObjectModification2)));
248 verify(clusterSingletonServiceProvider).registerClusterSingletonService(mockContext1);
249 verify(clusterSingletonServiceProvider).registerClusterSingletonService(mockContext2);
251 // Notify of Node 1 replaced and Node 2 subtree modified.
253 mockContextMap.clear();
255 final NetconfNode updatedNetconfNode1 = new NetconfNodeBuilder(netconfNode1)
256 .setPort(new PortNumber(Uint16.valueOf(33333))).build();
257 final Node updatedNode1 = new NodeBuilder().setNodeId(nodeId1).addAugmentation(updatedNetconfNode1).build();
259 doReturn(WRITE).when(dataObjectModification1).getModificationType();
260 doReturn(updatedNode1).when(dataObjectModification1).getDataAfter();
262 doReturn(SUBTREE_MODIFIED).when(dataObjectModification2).getModificationType();
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();
286 netconfTopologyManager.onDataTreeChanged(Arrays.asList(
287 new CustomTreeModification(DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION,
288 nodeInstanceId1), dataObjectModification1)));
290 verify(mockClusterRegistration1).close();
291 verify(mockContext1).close();
292 verifyNoMoreInteractions(clusterSingletonServiceProvider, mockClusterRegistration2, mockContext2);
294 // Notify of Node 1 created again.
296 reset(clusterSingletonServiceProvider);
298 final NetconfTopologyContext newMockContext1 = mock(NetconfTopologyContext.class);
299 final ClusterSingletonServiceRegistration newMockClusterRegistration1 =
300 mock(ClusterSingletonServiceRegistration.class);
302 doThrow(new RuntimeException("mock error")).doReturn(newMockClusterRegistration1)
303 .when(clusterSingletonServiceProvider).registerClusterSingletonService(newMockContext1);
305 doReturn(WRITE).when(dataObjectModification1).getModificationType();
306 doReturn(node1).when(dataObjectModification1).getDataAfter();
308 mockContextMap.put(nodeInstanceId1, setup -> {
309 assertEquals(node1, setup.getNode());
310 assertEquals(TOPOLOGY_ID, setup.getTopologyId());
311 return newMockContext1;
314 netconfTopologyManager.onDataTreeChanged(Arrays.asList(
315 new CustomTreeModification(DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION,
316 nodeInstanceId1), dataObjectModification1)));
318 verify(clusterSingletonServiceProvider, times(2)).registerClusterSingletonService(newMockContext1);
320 verifyNoMoreInteractions(mockClusterRegistration1, mockContext1, mockClusterRegistration2, mockContext2,
321 newMockContext1, newMockClusterRegistration1, clusterSingletonServiceProvider);
325 netconfTopologyManager.close();
327 verify(newMockClusterRegistration1).close();
328 verify(newMockContext1).close();
329 verify(mockClusterRegistration2).close();
330 verify(mockContext2).close();
332 netconfTopologyManager.close();
334 verifyNoMoreInteractions(mockClusterRegistration1, mockContext1, mockClusterRegistration2, mockContext2,
335 newMockContext1, newMockClusterRegistration1, clusterSingletonServiceProvider);
339 public void testClusterSingletonServiceRegistrationFailure() throws Exception {
340 final NodeId nodeId = new NodeId("node-id");
341 final InstanceIdentifier<Node> nodeInstanceId = NetconfTopologyUtils.createTopologyNodeListPath(
342 new NodeKey(nodeId), TOPOLOGY_ID);
344 final Node node = new NodeBuilder()
346 .addAugmentation(new NetconfNodeBuilder()
347 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
348 .setPort(new PortNumber(Uint16.valueOf(10)))
349 .setActorResponseWaitTime(ACTOR_RESPONSE_WAIT_TIME)
353 final DataObjectModification<Node> dataObjectModification = mock(DataObjectModification.class);
354 doReturn(WRITE).when(dataObjectModification).getModificationType();
355 doReturn(node).when(dataObjectModification).getDataAfter();
356 doReturn(InstanceIdentifier.IdentifiableItem.of(Node.class, new NodeKey(nodeId)))
357 .when(dataObjectModification).getIdentifier();
359 final NetconfTopologyContext mockContext = mock(NetconfTopologyContext.class);
360 mockContextMap.put(nodeInstanceId, setup -> mockContext);
362 doThrow(new RuntimeException("mock error")).when(clusterSingletonServiceProvider)
363 .registerClusterSingletonService(mockContext);
365 netconfTopologyManager.init();
367 netconfTopologyManager.onDataTreeChanged(Arrays.asList(
368 new CustomTreeModification(DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION,
369 nodeInstanceId), dataObjectModification)));
371 verify(clusterSingletonServiceProvider, times(3)).registerClusterSingletonService(mockContext);
372 verify(mockContext).close();
373 verifyNoMoreInteractions(mockListenerReg);
375 netconfTopologyManager.close();
376 verifyNoMoreInteractions(mockContext);
379 static class CustomTreeModification implements DataTreeModification<Node> {
381 private final DataTreeIdentifier<Node> rootPath;
382 private final DataObjectModification<Node> rootNode;
384 CustomTreeModification(final DataTreeIdentifier<Node> rootPath, final DataObjectModification<Node> rootNode) {
385 this.rootPath = rootPath;
386 this.rootNode = rootNode;
390 public DataTreeIdentifier<Node> getRootPath() {
395 public DataObjectModification<Node> getRootNode() {