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.netconf.topology.singleton.impl;
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.doNothing;
16 import static org.mockito.Mockito.doReturn;
17 import static org.mockito.Mockito.doThrow;
18 import static org.mockito.Mockito.mock;
19 import static org.mockito.Mockito.times;
20 import static org.mockito.Mockito.verify;
21 import static org.mockito.MockitoAnnotations.initMocks;
22 import static org.opendaylight.controller.md.sal.binding.api.DataObjectModification.ModificationType.DELETE;
23 import static org.opendaylight.controller.md.sal.binding.api.DataObjectModification.ModificationType.WRITE;
25 import com.google.common.util.concurrent.Futures;
26 import io.netty.util.concurrent.EventExecutor;
27 import java.lang.reflect.Field;
28 import java.util.ArrayList;
29 import java.util.Collection;
31 import javax.annotation.Nonnull;
32 import org.junit.Before;
33 import org.junit.Test;
34 import org.mockito.Mock;
35 import org.opendaylight.controller.cluster.ActorSystemProvider;
36 import org.opendaylight.controller.config.threadpool.ScheduledThreadPool;
37 import org.opendaylight.controller.config.threadpool.ThreadPool;
38 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
39 import org.opendaylight.controller.md.sal.binding.api.DataObjectModification;
40 import org.opendaylight.controller.md.sal.binding.api.DataTreeIdentifier;
41 import org.opendaylight.controller.md.sal.binding.api.DataTreeModification;
42 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
43 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
44 import org.opendaylight.controller.md.sal.dom.api.DOMMountPointService;
45 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
46 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
47 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceRegistration;
48 import org.opendaylight.netconf.client.NetconfClientDispatcher;
49 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologyUtils;
50 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host;
51 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
52 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
53 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeBuilder;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.topology.singleton.config.rev170419.Config;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.topology.singleton.config.rev170419.ConfigBuilder;
58 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
59 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
60 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
61 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
62 import org.opendaylight.yangtools.yang.binding.Identifier;
63 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
65 public class NetconfTopologyManagerTest {
67 private final String topologyId = "topologyID";
68 private NetconfTopologyManager netconfTopologyManager;
71 private DataBroker dataBroker;
74 private ClusterSingletonServiceProvider clusterSingletonServiceProvider;
80 final RpcProviderRegistry rpcProviderRegistry = mock(RpcProviderRegistry.class);
81 final ScheduledThreadPool keepaliveExecutor = mock(ScheduledThreadPool.class);
82 final ThreadPool processingExecutor = mock(ThreadPool.class);
83 final ActorSystemProvider actorSystemProvider = mock(ActorSystemProvider.class);
84 final EventExecutor eventExecutor = mock(EventExecutor.class);
85 final NetconfClientDispatcher clientDispatcher = mock(NetconfClientDispatcher.class);
86 final DOMMountPointService mountPointService = mock(DOMMountPointService.class);
88 final Config config = new ConfigBuilder().setWriteTransactionIdleTimeout(0).build();
89 netconfTopologyManager = new NetconfTopologyManager(dataBroker, rpcProviderRegistry,
90 clusterSingletonServiceProvider, keepaliveExecutor, processingExecutor,
91 actorSystemProvider, eventExecutor, clientDispatcher, topologyId, config, mountPointService);
95 public void testWriteConfiguration() throws Exception {
96 writeConfiguration(false);
100 public void testWriteConfigurationFail() throws Exception {
101 writeConfiguration(true);
105 public void testRegisterDataTreeChangeListener() {
107 final WriteTransaction wtx = mock(WriteTransaction.class);
109 doReturn(wtx).when(dataBroker).newWriteOnlyTransaction();
110 doNothing().when(wtx).merge(any(), any(), any());
111 doReturn(Futures.immediateCheckedFuture(null)).when(wtx).submit();
112 doReturn(null).when(dataBroker).registerDataChangeListener(any(), any(), any(), any());
114 netconfTopologyManager.init();
116 // verify if listener is called with right parameters = registered on right path
118 verify(dataBroker, times(1)).registerDataTreeChangeListener(
119 new DataTreeIdentifier<>(LogicalDatastoreType.CONFIGURATION, NetconfTopologyUtils
120 .createTopologyListPath(topologyId).child(Node.class)), netconfTopologyManager);
125 public void testClose() throws Exception {
127 final Field fieldContexts = NetconfTopologyManager.class.getDeclaredField("contexts");
128 fieldContexts.setAccessible(true);
129 @SuppressWarnings("unchecked") final Map<InstanceIdentifier<Node>, NetconfTopologyContext> contexts =
130 (Map<InstanceIdentifier<Node>, NetconfTopologyContext>) fieldContexts.get(netconfTopologyManager);
132 final Field fieldClusterRegistrations =
133 NetconfTopologyManager.class.getDeclaredField("clusterRegistrations");
134 fieldClusterRegistrations.setAccessible(true);
135 @SuppressWarnings("unchecked")
136 final Map<InstanceIdentifier<Node>, ClusterSingletonServiceRegistration> clusterRegistrations =
137 (Map<InstanceIdentifier<Node>, ClusterSingletonServiceRegistration>)
138 fieldClusterRegistrations.get(netconfTopologyManager);
140 final InstanceIdentifier<Node> instanceIdentifier = NetconfTopologyUtils.createTopologyNodeListPath(
141 new NodeKey(new NodeId("node-id-1")), "topology-1");
144 final NetconfTopologyContext context = mock(NetconfTopologyContext.class);
145 final ClusterSingletonServiceRegistration clusterRegistration =
146 mock(ClusterSingletonServiceRegistration.class);
147 contexts.put(instanceIdentifier, context);
148 clusterRegistrations.put(instanceIdentifier, clusterRegistration);
150 doNothing().when(context).closeFinal();
151 doNothing().when(clusterRegistration).close();
153 netconfTopologyManager.close();
154 verify(context, times(1)).closeFinal();
155 verify(clusterRegistration, times(1)).close();
157 assertTrue(contexts.isEmpty());
158 assertTrue(clusterRegistrations.isEmpty());
162 private void writeConfiguration(final boolean fail) throws Exception {
164 final ClusterSingletonServiceRegistration clusterRegistration = mock(ClusterSingletonServiceRegistration.class);
166 final Field fieldContexts = NetconfTopologyManager.class.getDeclaredField("contexts");
167 fieldContexts.setAccessible(true);
168 @SuppressWarnings("unchecked") final Map<InstanceIdentifier<Node>, NetconfTopologyContext> contexts =
169 (Map<InstanceIdentifier<Node>, NetconfTopologyContext>) fieldContexts.get(netconfTopologyManager);
171 final Field fieldClusterRegistrations =
172 NetconfTopologyManager.class.getDeclaredField("clusterRegistrations");
173 fieldClusterRegistrations.setAccessible(true);
174 @SuppressWarnings("unchecked")
175 final Map<InstanceIdentifier<Node>, ClusterSingletonServiceRegistration> clusterRegistrations =
176 (Map<InstanceIdentifier<Node>, ClusterSingletonServiceRegistration>)
177 fieldClusterRegistrations.get(netconfTopologyManager);
179 final Collection<DataTreeModification<Node>> changes = new ArrayList<>();
181 final InstanceIdentifier<Node> instanceIdentifier = NetconfTopologyUtils.createTopologyNodeListPath(
182 new NodeKey(new NodeId("node-id-1")), "topology-1");
184 final InstanceIdentifier<Node> instanceIdentifierDiferent = NetconfTopologyUtils.createTopologyNodeListPath(
185 new NodeKey(new NodeId("node-id-2")), "topology-2");
187 final DataTreeIdentifier<Node> rootIdentifier =
188 new DataTreeIdentifier<>(LogicalDatastoreType.CONFIGURATION, instanceIdentifier);
190 final DataTreeIdentifier<Node> rootIdentifierDifferent =
191 new DataTreeIdentifier<>(LogicalDatastoreType.CONFIGURATION, instanceIdentifierDiferent);
193 @SuppressWarnings("unchecked") final DataObjectModification<Node> objectModification =
194 mock(DataObjectModification.class);
196 final NetconfNode netconfNode = new NetconfNodeBuilder()
197 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
198 .setPort(new PortNumber(9999))
199 .setReconnectOnChangedSchema(true)
200 .setDefaultRequestTimeoutMillis(1000L)
201 .setBetweenAttemptsTimeoutMillis(100)
202 .setSchemaless(false)
204 .setActorResponseWaitTime(10)
206 final Node node = new NodeBuilder().setNodeId(new NodeId("node-id"))
207 .addAugmentation(NetconfNode.class, netconfNode).build();
209 final Identifier key = new NodeKey(new NodeId("node-id"));
211 @SuppressWarnings("unchecked") final InstanceIdentifier.IdentifiableItem<Node, NodeKey> pathArgument =
212 new InstanceIdentifier.IdentifiableItem(Node.class, key);
215 // testing WRITE on two identical rootIdentifiers and one different
217 changes.add(new CustomTreeModification(rootIdentifier, objectModification));
219 changes.add(new CustomTreeModification(rootIdentifier, objectModification));
220 changes.add(new CustomTreeModification(rootIdentifier, objectModification));
221 changes.add(new CustomTreeModification(rootIdentifierDifferent, objectModification));
223 doReturn(WRITE).when(objectModification).getModificationType();
224 doReturn(node).when(objectModification).getDataAfter();
225 doReturn(pathArgument).when(objectModification).getIdentifier();
228 doThrow(new RuntimeException("error")).when(clusterSingletonServiceProvider)
229 .registerClusterSingletonService(any());
231 doReturn(clusterRegistration).when(clusterSingletonServiceProvider).registerClusterSingletonService(any());
233 netconfTopologyManager.onDataTreeChanged(changes);
236 verify(clusterSingletonServiceProvider, times(3))
237 .registerClusterSingletonService(any());
238 assertTrue(contexts.isEmpty());
239 assertTrue(clusterRegistrations.isEmpty());
241 verify(clusterSingletonServiceProvider, times(2))
242 .registerClusterSingletonService(any());
244 // only two created contexts
245 assertEquals(2, contexts.size());
246 assertTrue(contexts.containsKey(rootIdentifier.getRootIdentifier()));
247 assertTrue(contexts.containsKey(rootIdentifierDifferent.getRootIdentifier()));
249 // only two created cluster registrations
250 assertEquals(2, clusterRegistrations.size());
251 assertTrue(clusterRegistrations.containsKey(rootIdentifier.getRootIdentifier()));
252 assertTrue(clusterRegistrations.containsKey(rootIdentifierDifferent.getRootIdentifier()));
254 // after delete there should be no context and clustered registrations
255 doReturn(DELETE).when(objectModification).getModificationType();
257 doNothing().when(clusterRegistration).close();
259 netconfTopologyManager.onDataTreeChanged(changes);
261 verify(clusterRegistration, times(2)).close();
263 // empty map of contexts
264 assertTrue(contexts.isEmpty());
265 assertFalse(contexts.containsKey(rootIdentifier.getRootIdentifier()));
266 assertFalse(contexts.containsKey(rootIdentifierDifferent.getRootIdentifier()));
268 // empty map of clustered registrations
269 assertTrue(clusterRegistrations.isEmpty());
270 assertFalse(clusterRegistrations.containsKey(rootIdentifier.getRootIdentifier()));
271 assertFalse(clusterRegistrations.containsKey(rootIdentifierDifferent.getRootIdentifier()));
275 private class CustomTreeModification implements DataTreeModification<Node> {
277 private final DataTreeIdentifier<Node> rootPath;
278 private final DataObjectModification<Node> rootNode;
280 CustomTreeModification(final DataTreeIdentifier<Node> rootPath, final DataObjectModification<Node> rootNode) {
281 this.rootPath = rootPath;
282 this.rootNode = rootNode;
287 public DataTreeIdentifier<Node> getRootPath() {
293 public DataObjectModification<Node> getRootNode() {