2 * Copyright (c) 2018 Inocybe Technologies 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.junit.Assert.assertFalse;
13 import static org.junit.Assert.assertNotNull;
14 import static org.junit.Assert.assertNull;
15 import static org.junit.Assert.assertTrue;
16 import static org.junit.Assert.fail;
17 import static org.mockito.Matchers.any;
18 import static org.mockito.Mockito.doAnswer;
19 import static org.mockito.Mockito.doReturn;
20 import static org.mockito.Mockito.never;
21 import static org.mockito.Mockito.spy;
22 import static org.mockito.Mockito.timeout;
23 import static org.mockito.Mockito.verify;
24 import static org.mockito.MockitoAnnotations.initMocks;
26 import akka.actor.ActorSystem;
27 import akka.testkit.javadsl.TestKit;
28 import akka.util.Timeout;
29 import com.google.common.base.Optional;
30 import com.google.common.collect.ImmutableList;
31 import com.google.common.collect.ImmutableSet;
32 import com.google.common.util.concurrent.CheckedFuture;
33 import com.google.common.util.concurrent.Futures;
34 import com.google.common.util.concurrent.ListenableFuture;
35 import com.google.common.util.concurrent.MoreExecutors;
36 import com.google.common.util.concurrent.SettableFuture;
37 import com.typesafe.config.ConfigFactory;
38 import io.netty.util.concurrent.EventExecutor;
39 import io.netty.util.concurrent.GlobalEventExecutor;
40 import io.netty.util.concurrent.SucceededFuture;
42 import java.util.AbstractMap.SimpleEntry;
43 import java.util.Arrays;
44 import java.util.Collections;
45 import java.util.Iterator;
46 import java.util.Map.Entry;
48 import java.util.concurrent.ExecutionException;
49 import java.util.concurrent.TimeUnit;
50 import java.util.concurrent.TimeoutException;
51 import org.apache.commons.io.FileUtils;
52 import org.junit.After;
53 import org.junit.Before;
54 import org.junit.Test;
55 import org.mockito.Mock;
56 import org.opendaylight.aaa.encrypt.AAAEncryptionService;
57 import org.opendaylight.controller.cluster.ActorSystemProvider;
58 import org.opendaylight.controller.config.threadpool.ScheduledThreadPool;
59 import org.opendaylight.controller.config.threadpool.ThreadPool;
60 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
61 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
62 import org.opendaylight.controller.md.sal.binding.api.DataObjectModification;
63 import org.opendaylight.controller.md.sal.binding.api.DataTreeIdentifier;
64 import org.opendaylight.controller.md.sal.binding.api.DataTreeModification;
65 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
66 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
67 import org.opendaylight.controller.md.sal.binding.test.AbstractConcurrentDataBrokerTest;
68 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
69 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
70 import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
71 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
72 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
73 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadTransaction;
74 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction;
75 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
76 import org.opendaylight.controller.md.sal.dom.api.DOMMountPoint;
77 import org.opendaylight.controller.md.sal.dom.api.DOMMountPointService;
78 import org.opendaylight.controller.md.sal.dom.api.DOMRpcException;
79 import org.opendaylight.controller.md.sal.dom.api.DOMRpcIdentifier;
80 import org.opendaylight.controller.md.sal.dom.api.DOMRpcImplementation;
81 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
82 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
83 import org.opendaylight.controller.md.sal.dom.api.DOMService;
84 import org.opendaylight.controller.md.sal.dom.broker.impl.DOMRpcRouter;
85 import org.opendaylight.controller.md.sal.dom.broker.impl.mount.DOMMountPointServiceImpl;
86 import org.opendaylight.controller.md.sal.dom.spi.DefaultDOMRpcResult;
87 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
88 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
89 import org.opendaylight.mdsal.binding.generator.impl.ModuleInfoBackedContext;
90 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
91 import org.opendaylight.mdsal.dom.api.DOMMountPointListener;
92 import org.opendaylight.mdsal.eos.dom.simple.SimpleDOMEntityOwnershipService;
93 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
94 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceRegistration;
95 import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
96 import org.opendaylight.mdsal.singleton.dom.impl.DOMClusterSingletonServiceProviderImpl;
97 import org.opendaylight.netconf.client.NetconfClientDispatcher;
98 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfSessionPreferences;
99 import org.opendaylight.netconf.topology.singleton.impl.utils.ClusteringRpcException;
100 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologySetup;
101 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologyUtils;
102 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host;
103 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
104 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
105 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
106 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.keystore.rev171017.Keystore;
107 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
108 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeBuilder;
109 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeConnectionStatus;
110 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.credentials.LoginPwUnencryptedBuilder;
111 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.credentials.login.pw.unencrypted.LoginPasswordUnencryptedBuilder;
112 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.network.topology.topology.topology.types.TopologyNetconf;
113 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.topology.singleton.config.rev170419.Config;
114 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.topology.singleton.config.rev170419.ConfigBuilder;
115 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.GetTopOutputBuilder;
116 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.PutTopInputBuilder;
117 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.Top;
118 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.two.level.list.TopLevelList;
119 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.two.level.list.TopLevelListBuilder;
120 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
121 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
122 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
123 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
124 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
125 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
126 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
127 import org.opendaylight.yangtools.yang.binding.YangModuleInfo;
128 import org.opendaylight.yangtools.yang.common.QName;
129 import org.opendaylight.yangtools.yang.common.RpcError;
130 import org.opendaylight.yangtools.yang.common.RpcError.ErrorType;
131 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
132 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
133 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
134 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
135 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
136 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
137 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
138 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
139 import org.opendaylight.yangtools.yang.model.api.Module;
140 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
141 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
142 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
143 import org.opendaylight.yangtools.yang.model.repo.api.RevisionSourceIdentifier;
144 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
145 import org.opendaylight.yangtools.yang.model.repo.spi.PotentialSchemaSource;
146 import org.slf4j.Logger;
147 import org.slf4j.LoggerFactory;
150 * Tests netconf mount points end-to-end.
152 * @author Thomas Pantelis
154 public class MountPointEndToEndTest {
155 private static Logger LOG = LoggerFactory.getLogger(MountPointEndToEndTest.class);
157 private static final String TOP_MODULE_NAME = "opendaylight-mdsal-list-test";
158 private static final String ACTOR_SYSTEM_NAME = "test";
159 private static final String TOPOLOGY_ID = TopologyNetconf.QNAME.getLocalName();
160 private static final NodeId NODE_ID = new NodeId("node-id");
161 private static final InstanceIdentifier<Node> NODE_INSTANCE_ID = NetconfTopologyUtils.createTopologyNodeListPath(
162 new NodeKey(NODE_ID), TOPOLOGY_ID);
164 @Mock private RpcProviderRegistry mockRpcProviderRegistry;
165 @Mock private NetconfClientDispatcher mockClientDispatcher;
166 @Mock private AAAEncryptionService mockEncryptionService;
167 @Mock private ThreadPool mockThreadPool;
168 @Mock private ScheduledThreadPool mockKeepaliveExecutor;
170 @Mock private ActorSystemProvider mockMasterActorSystemProvider;
171 @Mock private DOMMountPointListener masterMountPointListener;
172 private final DOMMountPointService masterMountPointService = new DOMMountPointServiceImpl();
173 private final DOMRpcRouter deviceRpcService = new DOMRpcRouter();
174 private DOMClusterSingletonServiceProviderImpl masterClusterSingletonServiceProvider;
175 private DataBroker masterDataBroker;
176 private DOMDataBroker deviceDOMDataBroker;
177 private ActorSystem masterSystem;
178 private NetconfTopologyManager masterNetconfTopologyManager;
179 private volatile SettableFuture<MasterSalFacade> masterSalFacadeFuture = SettableFuture.create();
181 @Mock private ActorSystemProvider mockSlaveActorSystemProvider;
182 @Mock private ClusterSingletonServiceProvider mockSlaveClusterSingletonServiceProvider;
183 @Mock private ClusterSingletonServiceRegistration mockSlaveClusterSingletonServiceReg;
184 @Mock private DOMMountPointListener slaveMountPointListener;
185 private final DOMMountPointService slaveMountPointService = new DOMMountPointServiceImpl();
186 private DataBroker slaveDataBroker;
187 private ActorSystem slaveSystem;
188 private NetconfTopologyManager slaveNetconfTopologyManager;
189 private final SettableFuture<NetconfTopologyContext> slaveNetconfTopologyContextFuture = SettableFuture.create();
190 private BindingTransactionChain slaveTxChain;
192 private final EventExecutor eventExecutor = GlobalEventExecutor.INSTANCE;
193 private final Config config = new ConfigBuilder().setWriteTransactionIdleTimeout(0).build();
194 private SchemaContext deviceSchemaContext;
195 private YangModuleInfo topModuleInfo;
196 private SchemaPath putTopRpcSchemaPath;
197 private SchemaPath getTopRpcSchemaPath;
198 private BindingNormalizedNodeSerializer bindingToNormalized;
199 private YangInstanceIdentifier yangNodeInstanceId;
200 private final TopDOMRpcImplementation topRpcImplementation = new TopDOMRpcImplementation();
202 @SuppressWarnings({ "unchecked", "rawtypes" })
204 public void setUp() throws Exception {
209 topModuleInfo = BindingReflections.getModuleInfo(Top.class);
211 final ModuleInfoBackedContext moduleContext = ModuleInfoBackedContext.create();
212 moduleContext.addModuleInfos(Arrays.asList(topModuleInfo));
213 deviceSchemaContext = moduleContext.tryToCreateSchemaContext().get();
215 deviceRpcService.onGlobalContextUpdated(deviceSchemaContext);
217 putTopRpcSchemaPath = findRpcDefinition("put-top").getPath();
218 getTopRpcSchemaPath = findRpcDefinition("get-top").getPath();
220 deviceRpcService.registerRpcImplementation(topRpcImplementation,
221 DOMRpcIdentifier.create(putTopRpcSchemaPath), DOMRpcIdentifier.create(getTopRpcSchemaPath));
227 yangNodeInstanceId = bindingToNormalized.toYangInstanceIdentifier(NODE_INSTANCE_ID);
229 doReturn(new SucceededFuture(GlobalEventExecutor.INSTANCE, null)).when(mockClientDispatcher)
230 .createReconnectingClient(any());
232 LOG.info("****** Setup complete");
235 private static void deleteCacheDir() {
236 FileUtils.deleteQuietly(new File(NetconfTopologyUtils.CACHE_DIRECTORY));
240 public void tearDown() throws Exception {
242 TestKit.shutdownActorSystem(slaveSystem, true);
243 TestKit.shutdownActorSystem(masterSystem, true);
246 private void setupMaster() throws Exception {
247 AbstractConcurrentDataBrokerTest dataBrokerTest = newDataBrokerTest();
248 masterDataBroker = dataBrokerTest.getDataBroker();
249 deviceDOMDataBroker = dataBrokerTest.getDomBroker();
250 bindingToNormalized = dataBrokerTest.getDataBrokerTestCustomizer().getBindingToNormalized();
252 masterSystem = ActorSystem.create(ACTOR_SYSTEM_NAME, ConfigFactory.load().getConfig("Master"));
254 masterClusterSingletonServiceProvider = new DOMClusterSingletonServiceProviderImpl(
255 new SimpleDOMEntityOwnershipService());
256 masterClusterSingletonServiceProvider.initializeProvider();
258 doReturn(masterSystem).when(mockMasterActorSystemProvider).getActorSystem();
260 doReturn(MoreExecutors.newDirectExecutorService()).when(mockThreadPool).getExecutor();
262 NetconfTopologyUtils.DEFAULT_SCHEMA_REPOSITORY.registerSchemaSource(
263 id -> Futures.immediateFuture(YangTextSchemaSource.delegateForByteSource(id,
264 topModuleInfo.getYangTextByteSource())),
265 PotentialSchemaSource.create(RevisionSourceIdentifier.create(TOP_MODULE_NAME,
266 topModuleInfo.getName().getRevision()), YangTextSchemaSource.class, 1));
268 masterNetconfTopologyManager = new NetconfTopologyManager(masterDataBroker, mockRpcProviderRegistry,
269 masterClusterSingletonServiceProvider, mockKeepaliveExecutor, mockThreadPool,
270 mockMasterActorSystemProvider, eventExecutor, mockClientDispatcher, TOPOLOGY_ID, config,
271 masterMountPointService, mockEncryptionService) {
273 protected NetconfTopologyContext newNetconfTopologyContext(final NetconfTopologySetup setup,
274 final ServiceGroupIdentifier serviceGroupIdent, final Timeout actorResponseWaitTime) {
275 NetconfTopologyContext context =
276 super.newNetconfTopologyContext(setup, serviceGroupIdent, actorResponseWaitTime);
277 NetconfTopologyContext spiedContext = spy(context);
278 doAnswer(invocation -> {
279 final MasterSalFacade spiedFacade = (MasterSalFacade) spy(invocation.callRealMethod());
280 doReturn(deviceDOMDataBroker).when(spiedFacade).newDeviceDataBroker();
281 masterSalFacadeFuture.set(spiedFacade);
283 }).when(spiedContext).newMasterSalFacade();
289 masterNetconfTopologyManager.init();
291 verifyTopologyNodesCreated(masterDataBroker);
294 private void setupSlave() throws Exception {
295 AbstractConcurrentDataBrokerTest dataBrokerTest = newDataBrokerTest();
296 slaveDataBroker = dataBrokerTest.getDataBroker();
298 slaveSystem = ActorSystem.create(ACTOR_SYSTEM_NAME, ConfigFactory.load().getConfig("Slave"));
300 doReturn(slaveSystem).when(mockSlaveActorSystemProvider).getActorSystem();
302 doReturn(mockSlaveClusterSingletonServiceReg).when(mockSlaveClusterSingletonServiceProvider)
303 .registerClusterSingletonService(any());
305 slaveNetconfTopologyManager = new NetconfTopologyManager(slaveDataBroker, mockRpcProviderRegistry,
306 mockSlaveClusterSingletonServiceProvider, mockKeepaliveExecutor, mockThreadPool,
307 mockSlaveActorSystemProvider, eventExecutor, mockClientDispatcher, TOPOLOGY_ID, config,
308 slaveMountPointService, mockEncryptionService) {
310 protected NetconfTopologyContext newNetconfTopologyContext(final NetconfTopologySetup setup,
311 final ServiceGroupIdentifier serviceGroupIdent, final Timeout actorResponseWaitTime) {
312 NetconfTopologyContext spiedContext =
313 spy(super.newNetconfTopologyContext(setup, serviceGroupIdent, actorResponseWaitTime));
314 slaveNetconfTopologyContextFuture.set(spiedContext);
319 slaveNetconfTopologyManager.init();
321 verifyTopologyNodesCreated(slaveDataBroker);
323 slaveTxChain = slaveDataBroker.createTransactionChain(new TransactionChainListener() {
325 public void onTransactionChainSuccessful(final TransactionChain<?, ?> chain) {
329 public void onTransactionChainFailed(final TransactionChain<?, ?> chain,
330 final AsyncTransaction<?, ?> transaction, final Throwable cause) {
331 LOG.error("Slave transaction chain failed", cause);
337 public void test() throws Exception {
342 final MasterSalFacade masterSalFacade = testMasterNodeUpdated();
344 testMasterDisconnected(masterSalFacade);
349 private MasterSalFacade testMaster() throws InterruptedException, ExecutionException, TimeoutException {
350 LOG.info("****** Testing master");
352 writeNetconfNode(NetconfTopologyUtils.DEFAULT_CACHE_DIRECTORY, masterDataBroker);
354 final MasterSalFacade masterSalFacade = masterSalFacadeFuture.get(5, TimeUnit.SECONDS);
356 masterSalFacade.onDeviceConnected(deviceSchemaContext,
357 NetconfSessionPreferences.fromStrings(Collections.emptyList()), deviceRpcService);
359 DOMMountPoint masterMountPoint = awaitMountPoint(masterMountPointService);
361 LOG.info("****** Testing master DOMDataBroker operations");
363 testDOMDataBrokerOperations(getDOMDataBroker(masterMountPoint));
365 LOG.info("****** Testing master DOMRpcService");
367 testDOMRpcService(getDOMRpcService(masterMountPoint));
368 return masterSalFacade;
371 private void testSlave() throws InterruptedException, ExecutionException, TimeoutException {
372 LOG.info("****** Testing slave");
374 writeNetconfNode("slave", slaveDataBroker);
376 verify(mockSlaveClusterSingletonServiceProvider, timeout(5000)).registerClusterSingletonService(any());
378 // Since the master and slave use separate DataBrokers we need to copy the master's oper node to the slave.
379 // This is essentially what happens in a clustered environment but we'll use a DTCL here.
381 masterDataBroker.registerDataTreeChangeListener(
382 new DataTreeIdentifier<>(LogicalDatastoreType.OPERATIONAL, NODE_INSTANCE_ID), changes -> {
383 final WriteTransaction slaveTx = slaveTxChain.newWriteOnlyTransaction();
384 for (DataTreeModification<Node> dataTreeModification : changes) {
385 DataObjectModification<Node> rootNode = dataTreeModification.getRootNode();
386 InstanceIdentifier<Node> path = dataTreeModification.getRootPath().getRootIdentifier();
387 switch (rootNode.getModificationType()) {
389 case SUBTREE_MODIFIED:
390 slaveTx.merge(LogicalDatastoreType.OPERATIONAL, path, rootNode.getDataAfter());
393 slaveTx.delete(LogicalDatastoreType.OPERATIONAL, path);
403 DOMMountPoint slaveMountPoint = awaitMountPoint(slaveMountPointService);
405 final NetconfTopologyContext slaveNetconfTopologyContext =
406 slaveNetconfTopologyContextFuture.get(5, TimeUnit.SECONDS);
407 verify(slaveNetconfTopologyContext, never()).newMasterSalFacade();
409 LOG.info("****** Testing slave DOMDataBroker operations");
411 testDOMDataBrokerOperations(getDOMDataBroker(slaveMountPoint));
413 LOG.info("****** Testing slave DOMRpcService");
415 testDOMRpcService(getDOMRpcService(slaveMountPoint));
418 private MasterSalFacade testMasterNodeUpdated() throws InterruptedException, ExecutionException, TimeoutException {
419 LOG.info("****** Testing update master node");
421 masterMountPointService.registerProvisionListener(masterMountPointListener);
422 slaveMountPointService.registerProvisionListener(slaveMountPointListener);
424 masterSalFacadeFuture = SettableFuture.create();
425 writeNetconfNode(NetconfTopologyUtils.DEFAULT_CACHE_DIRECTORY, masterDataBroker);
427 verify(masterMountPointListener, timeout(5000)).onMountPointRemoved(yangNodeInstanceId);
429 MasterSalFacade masterSalFacade = masterSalFacadeFuture.get(5, TimeUnit.SECONDS);
431 masterSalFacade.onDeviceConnected(deviceSchemaContext,
432 NetconfSessionPreferences.fromStrings(Collections.emptyList()), deviceRpcService);
434 verify(masterMountPointListener, timeout(5000)).onMountPointCreated(yangNodeInstanceId);
436 verify(slaveMountPointListener, timeout(5000)).onMountPointRemoved(yangNodeInstanceId);
437 verify(slaveMountPointListener, timeout(5000)).onMountPointCreated(yangNodeInstanceId);
439 return masterSalFacade;
442 private void testMasterDisconnected(final MasterSalFacade masterSalFacade)
443 throws InterruptedException, ExecutionException, TimeoutException {
444 LOG.info("****** Testing master disconnected");
446 masterSalFacade.onDeviceDisconnected();
448 awaitMountPointNotPresent(masterMountPointService);
450 await().atMost(5, TimeUnit.SECONDS).until(() -> {
451 try (ReadOnlyTransaction readTx = masterDataBroker.newReadOnlyTransaction()) {
452 Optional<Node> node = readTx.read(LogicalDatastoreType.OPERATIONAL,
453 NODE_INSTANCE_ID).get(5, TimeUnit.SECONDS);
454 assertTrue(node.isPresent());
455 final NetconfNode netconfNode = node.get().augmentation(NetconfNode.class);
456 return netconfNode.getConnectionStatus() != NetconfNodeConnectionStatus.ConnectionStatus.Connected;
460 awaitMountPointNotPresent(slaveMountPointService);
463 private void testCleanup() throws Exception {
464 LOG.info("****** Testing cleanup");
466 slaveNetconfTopologyManager.close();
467 verify(mockSlaveClusterSingletonServiceReg).close();
470 private void testDOMRpcService(final DOMRpcService domRpcService)
471 throws InterruptedException, ExecutionException, TimeoutException {
472 testPutTopRpc(domRpcService, new DefaultDOMRpcResult((NormalizedNode<?, ?>)null));
473 testPutTopRpc(domRpcService, null);
474 testPutTopRpc(domRpcService, new DefaultDOMRpcResult(ImmutableList.of(
475 RpcResultBuilder.newError(ErrorType.APPLICATION, "tag1", "error1"),
476 RpcResultBuilder.newError(ErrorType.APPLICATION, "tag2", "error2"))));
478 testGetTopRpc(domRpcService, new DefaultDOMRpcResult(bindingToNormalized.toNormalizedNodeRpcData(
479 new GetTopOutputBuilder().setTopLevelList(Arrays.asList(new TopLevelListBuilder().setName("one")
480 .build())).build())));
482 testFailedRpc(domRpcService, getTopRpcSchemaPath, null);
485 private void testPutTopRpc(final DOMRpcService domRpcService, final DOMRpcResult result)
486 throws InterruptedException, ExecutionException, TimeoutException {
487 ContainerNode putTopInput = bindingToNormalized.toNormalizedNodeRpcData(
488 new PutTopInputBuilder().setTopLevelList(Arrays.asList(new TopLevelListBuilder().setName("one")
490 testRpc(domRpcService, putTopRpcSchemaPath, putTopInput, result);
493 private void testGetTopRpc(final DOMRpcService domRpcService, final DOMRpcResult result)
494 throws InterruptedException, ExecutionException, TimeoutException {
495 testRpc(domRpcService, getTopRpcSchemaPath, null, result);
498 private void testRpc(final DOMRpcService domRpcService, final SchemaPath schemaPath,
499 final NormalizedNode<?, ?> input, final DOMRpcResult result) throws InterruptedException,
500 ExecutionException, TimeoutException {
501 final DOMRpcResult actual = invokeRpc(domRpcService, schemaPath, input, Futures.immediateCheckedFuture(result));
502 if (result == null) {
507 assertNotNull(actual);
508 assertEquals(result.getResult(), actual.getResult());
510 assertEquals(result.getErrors().size(), actual.getErrors().size());
511 Iterator<RpcError> iter1 = result.getErrors().iterator();
512 Iterator<RpcError> iter2 = actual.getErrors().iterator();
513 while (iter1.hasNext() && iter2.hasNext()) {
514 RpcError err1 = iter1.next();
515 RpcError err2 = iter2.next();
516 assertEquals(err1.getErrorType(), err2.getErrorType());
517 assertEquals(err1.getTag(), err2.getTag());
518 assertEquals(err1.getMessage(), err2.getMessage());
519 assertEquals(err1.getSeverity(), err2.getSeverity());
520 assertEquals(err1.getApplicationTag(), err2.getApplicationTag());
521 assertEquals(err1.getInfo(), err2.getInfo());
525 private void testFailedRpc(final DOMRpcService domRpcService, final SchemaPath schemaPath,
526 final NormalizedNode<?, ?> input) throws InterruptedException, TimeoutException {
528 invokeRpc(domRpcService, schemaPath, input, Futures.immediateFailedCheckedFuture(
529 new ClusteringRpcException("mock")));
530 fail("Expected exception");
531 } catch (ExecutionException e) {
532 assertTrue(e.getCause() instanceof ClusteringRpcException);
533 assertEquals("mock", e.getCause().getMessage());
537 private DOMRpcResult invokeRpc(final DOMRpcService domRpcService, final SchemaPath schemaPath,
538 final NormalizedNode<?, ?> input, final CheckedFuture<DOMRpcResult, DOMRpcException> returnFuture)
539 throws InterruptedException, ExecutionException, TimeoutException {
540 topRpcImplementation.init(returnFuture);
541 final ListenableFuture<DOMRpcResult> resultFuture = domRpcService.invokeRpc(schemaPath, input);
543 topRpcImplementation.verify(DOMRpcIdentifier.create(schemaPath), input);
545 return resultFuture.get(5, TimeUnit.SECONDS);
548 private static void testDOMDataBrokerOperations(final DOMDataBroker dataBroker)
549 throws InterruptedException, ExecutionException, TimeoutException {
551 DOMDataWriteTransaction writeTx = dataBroker.newWriteOnlyTransaction();
553 final ContainerNode topNode = Builders.containerBuilder()
554 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(Top.QNAME)).build();
555 final YangInstanceIdentifier topPath = YangInstanceIdentifier.of(Top.QNAME);
556 writeTx.put(LogicalDatastoreType.CONFIGURATION, topPath, topNode);
558 final QName name = QName.create(TopLevelList.QNAME, "name");
559 final YangInstanceIdentifier listPath = YangInstanceIdentifier.builder(topPath)
560 .node(TopLevelList.QNAME).build();
561 final MapEntryNode listEntryNode = ImmutableNodes.mapEntry(TopLevelList.QNAME, name, "one");
562 final MapNode listNode = ImmutableNodes.mapNodeBuilder(TopLevelList.QNAME).addChild(listEntryNode).build();
563 writeTx.merge(LogicalDatastoreType.CONFIGURATION, listPath, listNode);
564 writeTx.commit().get(5, TimeUnit.SECONDS);
566 verifyDataInStore(dataBroker.newReadWriteTransaction(), YangInstanceIdentifier.builder(listPath)
567 .nodeWithKey(TopLevelList.QNAME, name, "one").build(), listEntryNode);
569 writeTx = dataBroker.newWriteOnlyTransaction();
570 writeTx.delete(LogicalDatastoreType.CONFIGURATION, topPath);
571 writeTx.commit().get(5, TimeUnit.SECONDS);
573 DOMDataReadWriteTransaction readTx = dataBroker.newReadWriteTransaction();
574 assertFalse(readTx.exists(LogicalDatastoreType.CONFIGURATION, topPath).get(5, TimeUnit.SECONDS));
575 assertTrue(readTx.cancel());
578 private static void writeNetconfNode(final String cacheDir, final DataBroker databroker)
579 throws InterruptedException, ExecutionException, TimeoutException {
580 final NetconfNode netconfNode = new NetconfNodeBuilder()
581 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
582 .setPort(new PortNumber(1234))
583 .setActorResponseWaitTime(10)
584 .setTcpOnly(Boolean.TRUE)
585 .setSchemaless(Boolean.FALSE)
586 .setKeepaliveDelay(0L)
587 .setConnectionTimeoutMillis(5000L)
588 .setDefaultRequestTimeoutMillis(5000L)
589 .setMaxConnectionAttempts(1L)
590 .setCredentials(new LoginPwUnencryptedBuilder().setLoginPasswordUnencrypted(
591 new LoginPasswordUnencryptedBuilder().setUsername("user").setPassword("pass").build()).build())
592 .setSchemaCacheDirectory(cacheDir)
594 final Node node = new NodeBuilder().setNodeId(NODE_ID).addAugmentation(NetconfNode.class, netconfNode).build();
596 final WriteTransaction writeTx = databroker.newWriteOnlyTransaction();
597 writeTx.put(LogicalDatastoreType.CONFIGURATION, NODE_INSTANCE_ID, node);
598 writeTx.commit().get(5, TimeUnit.SECONDS);
601 private static void verifyDataInStore(final DOMDataReadTransaction readTx, final YangInstanceIdentifier path,
602 final NormalizedNode<?, ?> expNode) throws InterruptedException, ExecutionException, TimeoutException {
603 final Optional<NormalizedNode<?, ?>> read = readTx.read(LogicalDatastoreType.CONFIGURATION, path)
604 .get(5, TimeUnit.SECONDS);
605 assertTrue(read.isPresent());
606 assertEquals(expNode, read.get());
608 final Boolean exists = readTx.exists(LogicalDatastoreType.CONFIGURATION, path).get(5, TimeUnit.SECONDS);
612 private static void verifyTopologyNodesCreated(final DataBroker dataBroker) {
613 await().atMost(5, TimeUnit.SECONDS).until(() -> {
614 try (ReadOnlyTransaction readTx = dataBroker.newReadOnlyTransaction()) {
615 Optional<Topology> configTopology = readTx.read(LogicalDatastoreType.CONFIGURATION,
616 NetconfTopologyUtils.createTopologyListPath(TOPOLOGY_ID)).get(3, TimeUnit.SECONDS);
617 Optional<Topology> operTopology = readTx.read(LogicalDatastoreType.OPERATIONAL,
618 NetconfTopologyUtils.createTopologyListPath(TOPOLOGY_ID)).get(3, TimeUnit.SECONDS);
619 return configTopology.isPresent() && operTopology.isPresent();
624 private AbstractConcurrentDataBrokerTest newDataBrokerTest() throws Exception {
625 AbstractConcurrentDataBrokerTest dataBrokerTest = new AbstractConcurrentDataBrokerTest(true) {
627 protected Set<YangModuleInfo> getModuleInfos() throws Exception {
628 return ImmutableSet.of(BindingReflections.getModuleInfo(NetconfNode.class),
629 BindingReflections.getModuleInfo(NetworkTopology.class),
630 BindingReflections.getModuleInfo(Topology.class),
631 BindingReflections.getModuleInfo(Keystore.class),
636 dataBrokerTest.setup();
637 return dataBrokerTest;
640 private void awaitMountPointNotPresent(final DOMMountPointService mountPointService) {
641 await().atMost(5, TimeUnit.SECONDS).until(
642 () -> !mountPointService.getMountPoint(yangNodeInstanceId).isPresent());
645 private static DOMDataBroker getDOMDataBroker(final DOMMountPoint mountPoint) {
646 return getMountPointService(mountPoint, DOMDataBroker.class);
649 private static DOMRpcService getDOMRpcService(final DOMMountPoint mountPoint) {
650 return getMountPointService(mountPoint, DOMRpcService.class);
653 private static <T extends DOMService> T getMountPointService(final DOMMountPoint mountPoint,
654 final Class<T> serviceClass) {
655 final Optional<T> maybeService = mountPoint.getService(serviceClass);
656 assertTrue(maybeService.isPresent());
657 return maybeService.get();
660 private DOMMountPoint awaitMountPoint(final DOMMountPointService mountPointService) {
661 await().atMost(5, TimeUnit.SECONDS).until(() -> {
662 return mountPointService.getMountPoint(yangNodeInstanceId).isPresent();
665 return mountPointService.getMountPoint(yangNodeInstanceId).get();
668 private RpcDefinition findRpcDefinition(final String rpc) {
669 Module topModule = deviceSchemaContext.findModule(TOP_MODULE_NAME, topModuleInfo.getName().getRevision()).get();
670 RpcDefinition rpcDefinition = null;
671 for (RpcDefinition def: topModule.getRpcs()) {
672 if (def.getQName().getLocalName().equals(rpc)) {
678 assertNotNull(rpc + " rpc not found in " + topModule.getRpcs(), rpcDefinition);
679 return rpcDefinition;
682 private static class TopDOMRpcImplementation implements DOMRpcImplementation {
683 private volatile SettableFuture<Entry<DOMRpcIdentifier, NormalizedNode<?, ?>>> rpcInvokedFuture;
684 private volatile CheckedFuture<DOMRpcResult, DOMRpcException> returnFuture;
687 public CheckedFuture<DOMRpcResult, DOMRpcException> invokeRpc(final DOMRpcIdentifier rpc,
688 final NormalizedNode<?, ?> input) {
689 rpcInvokedFuture.set(new SimpleEntry<>(rpc, input));
693 void init(final CheckedFuture<DOMRpcResult, DOMRpcException> retFuture) {
694 this.returnFuture = retFuture;
695 rpcInvokedFuture = SettableFuture.create();
698 void verify(final DOMRpcIdentifier expRpc, final NormalizedNode<?, ?> expInput)
699 throws InterruptedException, ExecutionException, TimeoutException {
700 final Entry<DOMRpcIdentifier, NormalizedNode<?, ?>> actual = rpcInvokedFuture.get(5, TimeUnit.SECONDS);
701 assertEquals(expRpc, actual.getKey());
702 assertEquals(expInput, actual.getValue());