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.ArgumentMatchers.any;
18 import static org.mockito.Mockito.doAnswer;
19 import static org.mockito.Mockito.doReturn;
20 import static org.mockito.Mockito.mock;
21 import static org.mockito.Mockito.never;
22 import static org.mockito.Mockito.spy;
23 import static org.mockito.Mockito.timeout;
24 import static org.mockito.Mockito.verify;
26 import akka.actor.ActorSystem;
27 import akka.testkit.javadsl.TestKit;
28 import akka.util.Timeout;
29 import com.google.common.collect.ImmutableList;
30 import com.google.common.collect.ImmutableMap;
31 import com.google.common.util.concurrent.FluentFuture;
32 import com.google.common.util.concurrent.Futures;
33 import com.google.common.util.concurrent.ListenableFuture;
34 import com.google.common.util.concurrent.MoreExecutors;
35 import com.google.common.util.concurrent.SettableFuture;
36 import com.typesafe.config.ConfigFactory;
37 import io.netty.util.concurrent.EventExecutor;
38 import io.netty.util.concurrent.GlobalEventExecutor;
40 import java.util.Iterator;
41 import java.util.List;
43 import java.util.Map.Entry;
44 import java.util.Optional;
46 import java.util.concurrent.ExecutionException;
47 import java.util.concurrent.TimeUnit;
48 import java.util.concurrent.TimeoutException;
49 import org.apache.commons.io.FileUtils;
50 import org.eclipse.jdt.annotation.NonNull;
51 import org.junit.After;
52 import org.junit.Before;
53 import org.junit.Test;
54 import org.junit.runner.RunWith;
55 import org.mockito.Mock;
56 import org.mockito.junit.MockitoJUnitRunner;
57 import org.opendaylight.aaa.encrypt.AAAEncryptionService;
58 import org.opendaylight.controller.cluster.ActorSystemProvider;
59 import org.opendaylight.controller.config.threadpool.ScheduledThreadPool;
60 import org.opendaylight.controller.config.threadpool.ThreadPool;
61 import org.opendaylight.mdsal.binding.api.DataBroker;
62 import org.opendaylight.mdsal.binding.api.DataObjectModification;
63 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
64 import org.opendaylight.mdsal.binding.api.DataTreeModification;
65 import org.opendaylight.mdsal.binding.api.ReadTransaction;
66 import org.opendaylight.mdsal.binding.api.RpcProviderService;
67 import org.opendaylight.mdsal.binding.api.Transaction;
68 import org.opendaylight.mdsal.binding.api.TransactionChain;
69 import org.opendaylight.mdsal.binding.api.TransactionChainListener;
70 import org.opendaylight.mdsal.binding.api.WriteTransaction;
71 import org.opendaylight.mdsal.binding.dom.adapter.test.AbstractConcurrentDataBrokerTest;
72 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
73 import org.opendaylight.mdsal.binding.runtime.spi.BindingRuntimeHelpers;
74 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
75 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
76 import org.opendaylight.mdsal.dom.api.DOMActionProviderService;
77 import org.opendaylight.mdsal.dom.api.DOMActionService;
78 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
79 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadOperations;
80 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadWriteTransaction;
81 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
82 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
83 import org.opendaylight.mdsal.dom.api.DOMMountPointListener;
84 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
85 import org.opendaylight.mdsal.dom.api.DOMRpcAvailabilityListener;
86 import org.opendaylight.mdsal.dom.api.DOMRpcIdentifier;
87 import org.opendaylight.mdsal.dom.api.DOMRpcImplementation;
88 import org.opendaylight.mdsal.dom.api.DOMRpcProviderService;
89 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
90 import org.opendaylight.mdsal.dom.api.DOMRpcService;
91 import org.opendaylight.mdsal.dom.api.DOMService;
92 import org.opendaylight.mdsal.dom.broker.DOMMountPointServiceImpl;
93 import org.opendaylight.mdsal.dom.broker.DOMRpcRouter;
94 import org.opendaylight.mdsal.dom.spi.DefaultDOMRpcResult;
95 import org.opendaylight.mdsal.dom.spi.FixedDOMSchemaService;
96 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
97 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceRegistration;
98 import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
99 import org.opendaylight.mdsal.singleton.dom.impl.DOMClusterSingletonServiceProviderImpl;
100 import org.opendaylight.netconf.client.NetconfClientDispatcher;
101 import org.opendaylight.netconf.nettyutil.ReconnectFuture;
102 import org.opendaylight.netconf.sal.connect.api.DeviceActionFactory;
103 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceServices;
104 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceServices.Rpcs;
105 import org.opendaylight.netconf.sal.connect.api.SchemaResourceManager;
106 import org.opendaylight.netconf.sal.connect.impl.DefaultSchemaResourceManager;
107 import org.opendaylight.netconf.sal.connect.netconf.NetconfDeviceSchema;
108 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCapabilities;
109 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfSessionPreferences;
110 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
111 import org.opendaylight.netconf.topology.singleton.impl.utils.ClusteringRpcException;
112 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologySetup;
113 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologyUtils;
114 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host;
115 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
116 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
117 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
118 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev221225.ConnectionOper.ConnectionStatus;
119 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev221225.credentials.credentials.LoginPwUnencryptedBuilder;
120 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev221225.credentials.credentials.login.pw.unencrypted.LoginPasswordUnencryptedBuilder;
121 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.keystore.rev171017.Keystore;
122 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev221225.NetconfNode;
123 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev221225.NetconfNodeBuilder;
124 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev221225.network.topology.topology.topology.types.TopologyNetconf;
125 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.topology.singleton.config.rev170419.Config;
126 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.topology.singleton.config.rev170419.ConfigBuilder;
127 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.GetTopInput;
128 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.GetTopOutputBuilder;
129 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.PutTopInputBuilder;
130 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.Top;
131 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.two.level.list.TopLevelList;
132 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.two.level.list.TopLevelListBuilder;
133 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.two.level.list.TopLevelListKey;
134 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
135 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
136 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyBuilder;
137 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
138 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
139 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
140 import org.opendaylight.yangtools.concepts.ListenerRegistration;
141 import org.opendaylight.yangtools.rfc8528.data.api.MountPointContext;
142 import org.opendaylight.yangtools.rfc8528.data.util.EmptyMountPointContext;
143 import org.opendaylight.yangtools.util.concurrent.FluentFutures;
144 import org.opendaylight.yangtools.yang.binding.DataObject;
145 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
146 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
147 import org.opendaylight.yangtools.yang.binding.YangModuleInfo;
148 import org.opendaylight.yangtools.yang.common.ErrorTag;
149 import org.opendaylight.yangtools.yang.common.ErrorType;
150 import org.opendaylight.yangtools.yang.common.QName;
151 import org.opendaylight.yangtools.yang.common.Revision;
152 import org.opendaylight.yangtools.yang.common.RpcError;
153 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
154 import org.opendaylight.yangtools.yang.common.Uint16;
155 import org.opendaylight.yangtools.yang.common.Uint32;
156 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
157 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
158 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
159 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
160 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
161 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
162 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
163 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
164 import org.opendaylight.yangtools.yang.model.api.Module;
165 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
166 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
167 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
168 import org.opendaylight.yangtools.yang.model.repo.spi.PotentialSchemaSource;
169 import org.opendaylight.yangtools.yang.parser.impl.DefaultYangParserFactory;
170 import org.slf4j.Logger;
171 import org.slf4j.LoggerFactory;
174 * Tests netconf mount points end-to-end.
176 * @author Thomas Pantelis
178 @RunWith(MockitoJUnitRunner.StrictStubs.class)
179 public class MountPointEndToEndTest extends AbstractBaseSchemasTest {
180 private static final Logger LOG = LoggerFactory.getLogger(MountPointEndToEndTest.class);
182 private static final String TOP_MODULE_NAME = "opendaylight-mdsal-list-test";
183 private static final String ACTOR_SYSTEM_NAME = "test";
184 private static final String TOPOLOGY_ID = TopologyNetconf.QNAME.getLocalName();
185 private static final @NonNull KeyedInstanceIdentifier<Node, NodeKey> NODE_INSTANCE_ID =
186 NetconfTopologyUtils.createTopologyNodeListPath(new NodeKey(new NodeId("node-id")), TOPOLOGY_ID);
188 private static final String TEST_ROOT_DIRECTORY = "test-cache-root";
189 private static final String TEST_DEFAULT_SUBDIR = "test-schema";
191 @Mock private DOMRpcProviderService mockRpcProviderRegistry;
192 @Mock private RpcProviderService mockRpcProviderService;
193 @Mock private DOMActionProviderService mockActionProviderRegistry;
194 @Mock private NetconfClientDispatcher mockClientDispatcher;
195 @Mock private AAAEncryptionService mockEncryptionService;
196 @Mock private ThreadPool mockThreadPool;
197 @Mock private ScheduledThreadPool mockKeepaliveExecutor;
198 @Mock private DeviceActionFactory deviceActionFactory;
200 @Mock private ActorSystemProvider mockMasterActorSystemProvider;
201 @Mock private DOMMountPointListener masterMountPointListener;
202 private final DOMMountPointService masterMountPointService = new DOMMountPointServiceImpl();
203 private Rpcs.Normalized deviceRpcService;
205 private DOMClusterSingletonServiceProviderImpl masterClusterSingletonServiceProvider;
206 private DataBroker masterDataBroker;
207 private DOMDataBroker deviceDOMDataBroker;
208 private ActorSystem masterSystem;
209 private NetconfTopologyManager masterNetconfTopologyManager;
211 private volatile SettableFuture<MasterSalFacade> masterSalFacadeFuture = SettableFuture.create();
213 @Mock private ActorSystemProvider mockSlaveActorSystemProvider;
214 @Mock private ClusterSingletonServiceProvider mockSlaveClusterSingletonServiceProvider;
215 @Mock private ClusterSingletonServiceRegistration mockSlaveClusterSingletonServiceReg;
216 @Mock private DOMMountPointListener slaveMountPointListener;
217 private final DOMMountPointService slaveMountPointService = new DOMMountPointServiceImpl();
218 private DataBroker slaveDataBroker;
219 private ActorSystem slaveSystem;
220 private NetconfTopologyManager slaveNetconfTopologyManager;
221 private final SettableFuture<NetconfTopologyContext> slaveNetconfTopologyContextFuture = SettableFuture.create();
222 private TransactionChain slaveTxChain;
224 private final EventExecutor eventExecutor = GlobalEventExecutor.INSTANCE;
225 private final Config config = new ConfigBuilder().setWriteTransactionIdleTimeout(Uint16.ZERO).build();
226 private EffectiveModelContext deviceSchemaContext;
227 private YangModuleInfo topModuleInfo;
228 private QName putTopRpcSchemaPath;
229 private QName getTopRpcSchemaPath;
230 private BindingNormalizedNodeSerializer bindingToNormalized;
231 private YangInstanceIdentifier yangNodeInstanceId;
232 private final TopDOMRpcImplementation topRpcImplementation = new TopDOMRpcImplementation();
233 private final ContainerNode getTopInput = ImmutableNodes.containerNode(GetTopInput.QNAME);
235 private SchemaResourceManager resourceManager;
238 public void setUp() throws Exception {
241 resourceManager = new DefaultSchemaResourceManager(new DefaultYangParserFactory(), TEST_ROOT_DIRECTORY,
242 TEST_DEFAULT_SUBDIR);
244 topModuleInfo = BindingReflections.getModuleInfo(Top.class);
246 deviceSchemaContext = BindingRuntimeHelpers.createEffectiveModel(Top.class);
248 final var router = new DOMRpcRouter(FixedDOMSchemaService.of(deviceSchemaContext));
250 putTopRpcSchemaPath = findRpcDefinition("put-top").getQName();
251 getTopRpcSchemaPath = findRpcDefinition("get-top").getQName();
253 router.getRpcProviderService().registerRpcImplementation(topRpcImplementation,
254 DOMRpcIdentifier.create(putTopRpcSchemaPath), DOMRpcIdentifier.create(getTopRpcSchemaPath));
256 final var rpcService = router.getRpcService();
257 deviceRpcService = new Rpcs.Normalized() {
259 public ListenableFuture<? extends DOMRpcResult> invokeRpc(final QName type, final ContainerNode input) {
260 return rpcService.invokeRpc(type, input);
264 public <T extends DOMRpcAvailabilityListener> ListenerRegistration<T> registerRpcListener(
266 return rpcService.registerRpcListener(listener);
274 yangNodeInstanceId = bindingToNormalized.toYangInstanceIdentifier(NODE_INSTANCE_ID);
276 doReturn(mock(ReconnectFuture.class)).when(mockClientDispatcher).createReconnectingClient(any());
278 LOG.info("****** Setup complete");
281 private static void deleteCacheDir() {
282 FileUtils.deleteQuietly(new File(TEST_ROOT_DIRECTORY));
286 public void tearDown() throws Exception {
288 TestKit.shutdownActorSystem(slaveSystem, true);
289 TestKit.shutdownActorSystem(masterSystem, true);
292 private void setupMaster() throws Exception {
293 final var dataBrokerTest = newDataBrokerTest();
294 masterDataBroker = dataBrokerTest.getDataBroker();
295 deviceDOMDataBroker = dataBrokerTest.getDomBroker();
296 bindingToNormalized = dataBrokerTest.getDataBrokerTestCustomizer().getAdapterContext().currentSerializer();
298 masterSystem = ActorSystem.create(ACTOR_SYSTEM_NAME, ConfigFactory.load().getConfig("Master"));
300 masterClusterSingletonServiceProvider = new DOMClusterSingletonServiceProviderImpl();
301 masterClusterSingletonServiceProvider.initializeProvider();
303 doReturn(masterSystem).when(mockMasterActorSystemProvider).getActorSystem();
305 doReturn(MoreExecutors.newDirectExecutorService()).when(mockThreadPool).getExecutor();
307 final var resources = resourceManager.getSchemaResources(TEST_DEFAULT_SUBDIR, "test");
308 resources.getSchemaRegistry().registerSchemaSource(
309 id -> Futures.immediateFuture(YangTextSchemaSource.delegateForByteSource(id,
310 topModuleInfo.getYangTextByteSource())),
311 PotentialSchemaSource.create(new SourceIdentifier(TOP_MODULE_NAME,
312 topModuleInfo.getName().getRevision().map(Revision::toString).orElse(null)),
313 YangTextSchemaSource.class, 1));
315 masterNetconfTopologyManager = new NetconfTopologyManager(BASE_SCHEMAS, masterDataBroker,
316 mockRpcProviderRegistry, mockActionProviderRegistry, masterClusterSingletonServiceProvider,
317 mockKeepaliveExecutor, mockThreadPool, mockMasterActorSystemProvider, eventExecutor,
318 mockClientDispatcher, TOPOLOGY_ID, config, masterMountPointService, mockEncryptionService,
319 mockRpcProviderService, deviceActionFactory, resourceManager) {
321 protected NetconfTopologyContext newNetconfTopologyContext(final NetconfTopologySetup setup,
322 final ServiceGroupIdentifier serviceGroupIdent, final Timeout actorResponseWaitTime,
323 final DeviceActionFactory deviceActionFact) {
324 final var context = super.newNetconfTopologyContext(setup, serviceGroupIdent, actorResponseWaitTime,
327 final var spiedContext = spy(context);
328 doAnswer(invocation -> {
329 final var spiedFacade = (MasterSalFacade) spy(invocation.callRealMethod());
330 doReturn(deviceDOMDataBroker).when(spiedFacade)
331 .newDeviceDataBroker(any(MountPointContext.class), any(NetconfSessionPreferences.class));
332 masterSalFacadeFuture.set(spiedFacade);
334 }).when(spiedContext).newMasterSalFacade();
340 masterNetconfTopologyManager.init();
342 verifyTopologyNodesCreated(masterDataBroker);
345 private void setupSlave() throws Exception {
346 AbstractConcurrentDataBrokerTest dataBrokerTest = newDataBrokerTest();
347 slaveDataBroker = dataBrokerTest.getDataBroker();
349 slaveSystem = ActorSystem.create(ACTOR_SYSTEM_NAME, ConfigFactory.load().getConfig("Slave"));
351 doReturn(slaveSystem).when(mockSlaveActorSystemProvider).getActorSystem();
353 doReturn(mockSlaveClusterSingletonServiceReg).when(mockSlaveClusterSingletonServiceProvider)
354 .registerClusterSingletonService(any());
356 slaveNetconfTopologyManager = new NetconfTopologyManager(BASE_SCHEMAS, slaveDataBroker, mockRpcProviderRegistry,
357 mockActionProviderRegistry, mockSlaveClusterSingletonServiceProvider, mockKeepaliveExecutor, mockThreadPool,
358 mockSlaveActorSystemProvider, eventExecutor, mockClientDispatcher, TOPOLOGY_ID, config,
359 slaveMountPointService, mockEncryptionService, mockRpcProviderService, deviceActionFactory,
362 protected NetconfTopologyContext newNetconfTopologyContext(final NetconfTopologySetup setup,
363 final ServiceGroupIdentifier serviceGroupIdent, final Timeout actorResponseWaitTime,
364 final DeviceActionFactory actionFactory) {
365 NetconfTopologyContext spiedContext = spy(super.newNetconfTopologyContext(setup, serviceGroupIdent,
366 actorResponseWaitTime, actionFactory));
368 slaveNetconfTopologyContextFuture.set(spiedContext);
373 slaveNetconfTopologyManager.init();
375 verifyTopologyNodesCreated(slaveDataBroker);
377 slaveTxChain = slaveDataBroker.createTransactionChain(new TransactionChainListener() {
379 public void onTransactionChainSuccessful(final TransactionChain chain) {
383 public void onTransactionChainFailed(final TransactionChain chain, final Transaction transaction,
384 final Throwable cause) {
385 LOG.error("Slave transaction chain failed", cause);
391 public void test() throws Exception {
396 final MasterSalFacade masterSalFacade = testMasterNodeUpdated();
398 testMasterDisconnected(masterSalFacade);
403 private MasterSalFacade testMaster() throws Exception {
404 LOG.info("****** Testing master");
406 writeNetconfNode(TEST_DEFAULT_SUBDIR, masterDataBroker);
408 final var masterSalFacade = masterSalFacadeFuture.get(5, TimeUnit.SECONDS);
409 masterSalFacade.onDeviceConnected(new NetconfDeviceSchema(NetconfDeviceCapabilities.empty(),
410 new EmptyMountPointContext(deviceSchemaContext)),
411 NetconfSessionPreferences.fromStrings(
412 List.of(NetconfMessageTransformUtil.NETCONF_CANDIDATE_URI.toString())),
413 new RemoteDeviceServices(deviceRpcService, null));
415 final var masterMountPoint = awaitMountPoint(masterMountPointService);
417 LOG.info("****** Testing master DOMDataBroker operations");
419 testDOMDataBrokerOperations(getDOMDataBroker(masterMountPoint));
421 LOG.info("****** Testing master DOMRpcService");
423 testDOMRpcService(getDOMRpcService(masterMountPoint));
424 return masterSalFacade;
427 private void testSlave() throws Exception {
428 LOG.info("****** Testing slave");
430 writeNetconfNode("slave", slaveDataBroker);
432 verify(mockSlaveClusterSingletonServiceProvider, timeout(5000)).registerClusterSingletonService(any());
434 // Since the master and slave use separate DataBrokers we need to copy the master's oper node to the slave.
435 // This is essentially what happens in a clustered environment but we'll use a DTCL here.
437 masterDataBroker.registerDataTreeChangeListener(
438 DataTreeIdentifier.create(LogicalDatastoreType.OPERATIONAL, NODE_INSTANCE_ID), changes -> {
439 final WriteTransaction slaveTx = slaveTxChain.newWriteOnlyTransaction();
440 for (DataTreeModification<Node> dataTreeModification : changes) {
441 DataObjectModification<Node> rootNode = dataTreeModification.getRootNode();
442 InstanceIdentifier<Node> path = dataTreeModification.getRootPath().getRootIdentifier();
443 switch (rootNode.getModificationType()) {
445 case SUBTREE_MODIFIED:
446 slaveTx.merge(LogicalDatastoreType.OPERATIONAL, path, rootNode.getDataAfter());
449 slaveTx.delete(LogicalDatastoreType.OPERATIONAL, path);
459 DOMMountPoint slaveMountPoint = awaitMountPoint(slaveMountPointService);
461 final NetconfTopologyContext slaveNetconfTopologyContext =
462 slaveNetconfTopologyContextFuture.get(5, TimeUnit.SECONDS);
463 verify(slaveNetconfTopologyContext, never()).newMasterSalFacade();
465 LOG.info("****** Testing slave DOMDataBroker operations");
467 testDOMDataBrokerOperations(getDOMDataBroker(slaveMountPoint));
469 LOG.info("****** Testing slave DOMRpcService");
471 testDOMRpcService(getDOMRpcService(slaveMountPoint));
474 private MasterSalFacade testMasterNodeUpdated() throws Exception {
475 LOG.info("****** Testing update master node");
477 masterMountPointService.registerProvisionListener(masterMountPointListener);
478 slaveMountPointService.registerProvisionListener(slaveMountPointListener);
480 masterSalFacadeFuture = SettableFuture.create();
481 writeNetconfNode(TEST_DEFAULT_SUBDIR, masterDataBroker);
483 verify(masterMountPointListener, timeout(5000)).onMountPointRemoved(yangNodeInstanceId);
485 final var masterSalFacade = masterSalFacadeFuture.get(5, TimeUnit.SECONDS);
486 masterSalFacade.onDeviceConnected(new NetconfDeviceSchema(NetconfDeviceCapabilities.empty(),
487 new EmptyMountPointContext(deviceSchemaContext)), NetconfSessionPreferences.fromStrings(List.of(
488 NetconfMessageTransformUtil.NETCONF_CANDIDATE_URI.toString())),
489 new RemoteDeviceServices(deviceRpcService, null));
491 verify(masterMountPointListener, timeout(5000)).onMountPointCreated(yangNodeInstanceId);
493 verify(slaveMountPointListener, timeout(5000)).onMountPointRemoved(yangNodeInstanceId);
494 verify(slaveMountPointListener, timeout(5000)).onMountPointCreated(yangNodeInstanceId);
496 return masterSalFacade;
499 private void testMasterDisconnected(final MasterSalFacade masterSalFacade) throws Exception {
500 LOG.info("****** Testing master disconnected");
502 masterSalFacade.onDeviceDisconnected();
504 awaitMountPointNotPresent(masterMountPointService);
506 await().atMost(5, TimeUnit.SECONDS).until(() -> {
507 try (ReadTransaction readTx = masterDataBroker.newReadOnlyTransaction()) {
508 Optional<Node> node = readTx.read(LogicalDatastoreType.OPERATIONAL,
509 NODE_INSTANCE_ID).get(5, TimeUnit.SECONDS);
510 assertTrue(node.isPresent());
511 final NetconfNode netconfNode = node.get().augmentation(NetconfNode.class);
512 return netconfNode.getConnectionStatus() != ConnectionStatus.Connected;
516 awaitMountPointNotPresent(slaveMountPointService);
519 private void testCleanup() throws Exception {
520 LOG.info("****** Testing cleanup");
522 slaveNetconfTopologyManager.close();
523 verify(mockSlaveClusterSingletonServiceReg).close();
526 private void testDOMRpcService(final DOMRpcService domRpcService)
527 throws InterruptedException, ExecutionException, TimeoutException {
528 testPutTopRpc(domRpcService, new DefaultDOMRpcResult((ContainerNode)null));
529 testPutTopRpc(domRpcService, null);
530 testPutTopRpc(domRpcService, new DefaultDOMRpcResult(ImmutableList.of(
531 RpcResultBuilder.newError(ErrorType.APPLICATION, new ErrorTag("tag1"), "error1"),
532 RpcResultBuilder.newError(ErrorType.APPLICATION, new ErrorTag("tag2"), "error2"))));
534 testGetTopRpc(domRpcService, new DefaultDOMRpcResult(bindingToNormalized.toNormalizedNodeRpcData(
535 new GetTopOutputBuilder().setTopLevelList(oneTopLevelList()).build())));
537 testFailedRpc(domRpcService, getTopRpcSchemaPath, getTopInput);
540 private void testPutTopRpc(final DOMRpcService domRpcService, final DOMRpcResult result)
541 throws InterruptedException, ExecutionException, TimeoutException {
542 ContainerNode putTopInput = bindingToNormalized.toNormalizedNodeRpcData(
543 new PutTopInputBuilder().setTopLevelList(oneTopLevelList()).build());
544 testRpc(domRpcService, putTopRpcSchemaPath, putTopInput, result);
547 private static Map<TopLevelListKey, TopLevelList> oneTopLevelList() {
548 final TopLevelListKey key = new TopLevelListKey("one");
549 return ImmutableMap.of(key, new TopLevelListBuilder().withKey(key).build());
552 private void testGetTopRpc(final DOMRpcService domRpcService, final DOMRpcResult result)
553 throws InterruptedException, ExecutionException, TimeoutException {
554 testRpc(domRpcService, getTopRpcSchemaPath, getTopInput, result);
557 private void testRpc(final DOMRpcService domRpcService, final QName qname, final ContainerNode input,
558 final DOMRpcResult result) throws InterruptedException, ExecutionException, TimeoutException {
559 final FluentFuture<DOMRpcResult> future = result == null ? FluentFutures.immediateNullFluentFuture()
560 : FluentFutures.immediateFluentFuture(result);
561 final DOMRpcResult actual = invokeRpc(domRpcService, qname, input, future);
562 if (result == null) {
567 assertNotNull(actual);
568 assertEquals(result.value(), actual.value());
570 assertEquals(result.errors().size(), actual.errors().size());
571 Iterator<? extends RpcError> iter1 = result.errors().iterator();
572 Iterator<? extends RpcError> iter2 = actual.errors().iterator();
573 while (iter1.hasNext() && iter2.hasNext()) {
574 RpcError err1 = iter1.next();
575 RpcError err2 = iter2.next();
576 assertEquals(err1.getErrorType(), err2.getErrorType());
577 assertEquals(err1.getTag(), err2.getTag());
578 assertEquals(err1.getMessage(), err2.getMessage());
579 assertEquals(err1.getSeverity(), err2.getSeverity());
580 assertEquals(err1.getApplicationTag(), err2.getApplicationTag());
581 assertEquals(err1.getInfo(), err2.getInfo());
585 private void testFailedRpc(final DOMRpcService domRpcService, final QName qname, final ContainerNode input)
586 throws InterruptedException, TimeoutException {
588 invokeRpc(domRpcService, qname, input, Futures.immediateFailedFuture(new ClusteringRpcException("mock")));
589 fail("Expected exception");
590 } catch (ExecutionException e) {
591 assertTrue(e.getCause() instanceof ClusteringRpcException);
592 assertEquals("mock", e.getCause().getMessage());
596 private DOMRpcResult invokeRpc(final DOMRpcService domRpcService, final QName qname, final ContainerNode input,
597 final ListenableFuture<DOMRpcResult> returnFuture)
598 throws InterruptedException, ExecutionException, TimeoutException {
599 topRpcImplementation.init(returnFuture);
600 final ListenableFuture<? extends DOMRpcResult> resultFuture = domRpcService.invokeRpc(qname, input);
602 topRpcImplementation.verify(DOMRpcIdentifier.create(qname), input);
604 return resultFuture.get(5, TimeUnit.SECONDS);
607 private static void testDOMDataBrokerOperations(final DOMDataBroker dataBroker)
608 throws InterruptedException, ExecutionException, TimeoutException {
610 DOMDataTreeWriteTransaction writeTx = dataBroker.newWriteOnlyTransaction();
612 final ContainerNode topNode = Builders.containerBuilder()
613 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(Top.QNAME)).build();
614 final YangInstanceIdentifier topPath = YangInstanceIdentifier.of(Top.QNAME);
615 writeTx.put(LogicalDatastoreType.CONFIGURATION, topPath, topNode);
617 final QName name = QName.create(TopLevelList.QNAME, "name");
618 final YangInstanceIdentifier listPath = YangInstanceIdentifier.builder(topPath)
619 .node(TopLevelList.QNAME).build();
620 final MapEntryNode listEntryNode = ImmutableNodes.mapEntry(TopLevelList.QNAME, name, "one");
621 final MapNode listNode = ImmutableNodes.mapNodeBuilder(TopLevelList.QNAME).addChild(listEntryNode).build();
622 writeTx.merge(LogicalDatastoreType.CONFIGURATION, listPath, listNode);
623 writeTx.commit().get(5, TimeUnit.SECONDS);
625 verifyDataInStore(dataBroker.newReadWriteTransaction(), YangInstanceIdentifier.builder(listPath)
626 .nodeWithKey(TopLevelList.QNAME, name, "one").build(), listEntryNode);
628 writeTx = dataBroker.newWriteOnlyTransaction();
629 writeTx.delete(LogicalDatastoreType.CONFIGURATION, topPath);
630 writeTx.commit().get(5, TimeUnit.SECONDS);
632 DOMDataTreeReadWriteTransaction readTx = dataBroker.newReadWriteTransaction();
633 assertFalse(readTx.exists(LogicalDatastoreType.CONFIGURATION, topPath).get(5, TimeUnit.SECONDS));
634 assertTrue(readTx.cancel());
637 private static void writeNetconfNode(final String cacheDir, final DataBroker dataBroker) throws Exception {
638 putData(dataBroker, NODE_INSTANCE_ID, new NodeBuilder()
639 .withKey(NODE_INSTANCE_ID.getKey())
640 .addAugmentation(new NetconfNodeBuilder()
641 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
642 .setPort(new PortNumber(Uint16.valueOf(1234)))
643 .setActorResponseWaitTime(Uint16.valueOf(10))
644 .setTcpOnly(Boolean.TRUE)
645 .setSchemaless(Boolean.FALSE)
646 .setKeepaliveDelay(Uint32.ZERO)
647 .setConnectionTimeoutMillis(Uint32.valueOf(5000))
648 .setDefaultRequestTimeoutMillis(Uint32.valueOf(5000))
649 .setMaxConnectionAttempts(Uint32.ONE)
650 .setCredentials(new LoginPwUnencryptedBuilder()
651 .setLoginPasswordUnencrypted(new LoginPasswordUnencryptedBuilder()
656 .setSchemaCacheDirectory(cacheDir)
661 private static <T extends DataObject> void putData(final DataBroker databroker, final InstanceIdentifier<T> path,
662 final T data) throws Exception {
663 final var writeTx = databroker.newWriteOnlyTransaction();
664 writeTx.put(LogicalDatastoreType.CONFIGURATION, path, data);
665 writeTx.commit().get(5, TimeUnit.SECONDS);
668 private static void verifyDataInStore(final DOMDataTreeReadOperations readTx, final YangInstanceIdentifier path,
669 final NormalizedNode expNode) throws InterruptedException, ExecutionException, TimeoutException {
670 final Optional<NormalizedNode> read = readTx.read(LogicalDatastoreType.CONFIGURATION, path)
671 .get(5, TimeUnit.SECONDS);
672 assertTrue(read.isPresent());
673 assertEquals(expNode, read.get());
675 final Boolean exists = readTx.exists(LogicalDatastoreType.CONFIGURATION, path).get(5, TimeUnit.SECONDS);
679 private static void verifyTopologyNodesCreated(final DataBroker dataBroker) {
680 await().atMost(5, TimeUnit.SECONDS).until(() -> {
681 try (ReadTransaction readTx = dataBroker.newReadOnlyTransaction()) {
682 return readTx.exists(LogicalDatastoreType.OPERATIONAL,
683 NetconfTopologyUtils.createTopologyListPath(TOPOLOGY_ID)).get(3, TimeUnit.SECONDS);
688 private AbstractConcurrentDataBrokerTest newDataBrokerTest() throws Exception {
689 final var dataBrokerTest = new AbstractConcurrentDataBrokerTest(true) {
691 protected Set<YangModuleInfo> getModuleInfos() {
692 return Set.of(BindingReflections.getModuleInfo(NetconfNode.class),
693 BindingReflections.getModuleInfo(NetworkTopology.class),
694 BindingReflections.getModuleInfo(Keystore.class),
699 dataBrokerTest.setup();
701 final var path = NetconfTopologyUtils.createTopologyListPath(TOPOLOGY_ID);
702 putData(dataBrokerTest.getDataBroker(), path, new TopologyBuilder().withKey(path.getKey()).build());
703 return dataBrokerTest;
706 private void awaitMountPointNotPresent(final DOMMountPointService mountPointService) {
707 await().atMost(5, TimeUnit.SECONDS).until(
708 () -> mountPointService.getMountPoint(yangNodeInstanceId).isEmpty());
711 private static DOMDataBroker getDOMDataBroker(final DOMMountPoint mountPoint) {
712 return getMountPointService(mountPoint, DOMDataBroker.class);
715 private static DOMRpcService getDOMRpcService(final DOMMountPoint mountPoint) {
716 return getMountPointService(mountPoint, DOMRpcService.class);
719 private static DOMActionService getDomActionService(final DOMMountPoint mountPoint) {
720 return getMountPointService(mountPoint, DOMActionService.class);
723 private static <T extends DOMService> T getMountPointService(final DOMMountPoint mountPoint,
724 final Class<T> serviceClass) {
725 return mountPoint.getService(serviceClass).orElseThrow();
728 private DOMMountPoint awaitMountPoint(final DOMMountPointService mountPointService) {
729 await().atMost(5, TimeUnit.SECONDS).until(() ->
730 mountPointService.getMountPoint(yangNodeInstanceId).isPresent());
732 return mountPointService.getMountPoint(yangNodeInstanceId).orElseThrow();
735 private RpcDefinition findRpcDefinition(final String rpc) {
736 Module topModule = deviceSchemaContext.findModule(TOP_MODULE_NAME, topModuleInfo.getName().getRevision()).get();
737 RpcDefinition rpcDefinition = null;
738 for (RpcDefinition def: topModule.getRpcs()) {
739 if (def.getQName().getLocalName().equals(rpc)) {
745 assertNotNull(rpc + " rpc not found in " + topModule.getRpcs(), rpcDefinition);
746 return rpcDefinition;
749 private static class TopDOMRpcImplementation implements DOMRpcImplementation {
750 private volatile SettableFuture<Entry<DOMRpcIdentifier, NormalizedNode>> rpcInvokedFuture;
751 private volatile ListenableFuture<DOMRpcResult> returnFuture;
754 public ListenableFuture<DOMRpcResult> invokeRpc(final DOMRpcIdentifier rpc, final ContainerNode input) {
755 rpcInvokedFuture.set(Map.entry(rpc, input));
759 void init(final ListenableFuture<DOMRpcResult> retFuture) {
760 returnFuture = retFuture;
761 rpcInvokedFuture = SettableFuture.create();
764 void verify(final DOMRpcIdentifier expRpc, final NormalizedNode expInput)
765 throws InterruptedException, ExecutionException, TimeoutException {
766 final Entry<DOMRpcIdentifier, NormalizedNode> actual = rpcInvokedFuture.get(5, TimeUnit.SECONDS);
767 assertEquals(expRpc, actual.getKey());
768 assertEquals(expInput, actual.getValue());