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.spy;
22 import static org.mockito.Mockito.timeout;
23 import static org.mockito.Mockito.verify;
25 import akka.actor.ActorSystem;
26 import akka.testkit.javadsl.TestKit;
27 import akka.util.Timeout;
28 import com.google.common.collect.ImmutableList;
29 import com.google.common.collect.ImmutableMap;
30 import com.google.common.util.concurrent.FluentFuture;
31 import com.google.common.util.concurrent.Futures;
32 import com.google.common.util.concurrent.ListenableFuture;
33 import com.google.common.util.concurrent.MoreExecutors;
34 import com.google.common.util.concurrent.SettableFuture;
35 import com.typesafe.config.ConfigFactory;
36 import io.netty.util.concurrent.EventExecutor;
37 import io.netty.util.concurrent.GlobalEventExecutor;
39 import java.util.Iterator;
40 import java.util.List;
42 import java.util.Map.Entry;
43 import java.util.Optional;
45 import java.util.concurrent.ExecutionException;
46 import java.util.concurrent.TimeUnit;
47 import java.util.concurrent.TimeoutException;
48 import org.apache.commons.io.FileUtils;
49 import org.eclipse.jdt.annotation.NonNull;
50 import org.junit.After;
51 import org.junit.Before;
52 import org.junit.Test;
53 import org.junit.runner.RunWith;
54 import org.mockito.Mock;
55 import org.mockito.junit.MockitoJUnitRunner;
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.mdsal.binding.api.DataBroker;
61 import org.opendaylight.mdsal.binding.api.DataObjectModification;
62 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
63 import org.opendaylight.mdsal.binding.api.DataTreeModification;
64 import org.opendaylight.mdsal.binding.api.ReadTransaction;
65 import org.opendaylight.mdsal.binding.api.RpcProviderService;
66 import org.opendaylight.mdsal.binding.api.Transaction;
67 import org.opendaylight.mdsal.binding.api.TransactionChain;
68 import org.opendaylight.mdsal.binding.api.TransactionChainListener;
69 import org.opendaylight.mdsal.binding.api.WriteTransaction;
70 import org.opendaylight.mdsal.binding.dom.adapter.test.AbstractConcurrentDataBrokerTest;
71 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
72 import org.opendaylight.mdsal.binding.runtime.spi.BindingRuntimeHelpers;
73 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
74 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
75 import org.opendaylight.mdsal.dom.api.DOMActionProviderService;
76 import org.opendaylight.mdsal.dom.api.DOMActionService;
77 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
78 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadOperations;
79 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadWriteTransaction;
80 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
81 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
82 import org.opendaylight.mdsal.dom.api.DOMMountPointListener;
83 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
84 import org.opendaylight.mdsal.dom.api.DOMRpcAvailabilityListener;
85 import org.opendaylight.mdsal.dom.api.DOMRpcIdentifier;
86 import org.opendaylight.mdsal.dom.api.DOMRpcImplementation;
87 import org.opendaylight.mdsal.dom.api.DOMRpcProviderService;
88 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
89 import org.opendaylight.mdsal.dom.api.DOMRpcService;
90 import org.opendaylight.mdsal.dom.api.DOMService;
91 import org.opendaylight.mdsal.dom.broker.DOMMountPointServiceImpl;
92 import org.opendaylight.mdsal.dom.broker.DOMRpcRouter;
93 import org.opendaylight.mdsal.dom.spi.DefaultDOMRpcResult;
94 import org.opendaylight.mdsal.dom.spi.FixedDOMSchemaService;
95 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
96 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceRegistration;
97 import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
98 import org.opendaylight.mdsal.singleton.dom.impl.DOMClusterSingletonServiceProviderImpl;
99 import org.opendaylight.netconf.api.CapabilityURN;
100 import org.opendaylight.netconf.client.NetconfClientDispatcher;
101 import org.opendaylight.netconf.client.mdsal.NetconfDeviceCapabilities;
102 import org.opendaylight.netconf.client.mdsal.NetconfDeviceSchema;
103 import org.opendaylight.netconf.client.mdsal.api.CredentialProvider;
104 import org.opendaylight.netconf.client.mdsal.api.DeviceActionFactory;
105 import org.opendaylight.netconf.client.mdsal.api.NetconfSessionPreferences;
106 import org.opendaylight.netconf.client.mdsal.api.RemoteDeviceId;
107 import org.opendaylight.netconf.client.mdsal.api.RemoteDeviceServices;
108 import org.opendaylight.netconf.client.mdsal.api.RemoteDeviceServices.Rpcs;
109 import org.opendaylight.netconf.client.mdsal.api.SchemaResourceManager;
110 import org.opendaylight.netconf.client.mdsal.api.SslHandlerFactoryProvider;
111 import org.opendaylight.netconf.client.mdsal.impl.DefaultSchemaResourceManager;
112 import org.opendaylight.netconf.nettyutil.ReconnectFuture;
113 import org.opendaylight.netconf.topology.singleton.impl.utils.ClusteringRpcException;
114 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologySetup;
115 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologyUtils;
116 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host;
117 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
118 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
119 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
120 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev230430.ConnectionOper.ConnectionStatus;
121 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev230430.credentials.credentials.LoginPwUnencryptedBuilder;
122 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev230430.credentials.credentials.login.pw.unencrypted.LoginPasswordUnencryptedBuilder;
123 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.keystore.rev171017.Keystore;
124 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev221225.NetconfNode;
125 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev221225.NetconfNodeBuilder;
126 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev221225.network.topology.topology.topology.types.TopologyNetconf;
127 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.topology.singleton.config.rev170419.Config;
128 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.topology.singleton.config.rev170419.ConfigBuilder;
129 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.GetTopInput;
130 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.GetTopOutputBuilder;
131 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.PutTopInputBuilder;
132 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.Top;
133 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.two.level.list.TopLevelList;
134 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.two.level.list.TopLevelListBuilder;
135 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.two.level.list.TopLevelListKey;
136 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
137 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
138 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyBuilder;
139 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
140 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
141 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
142 import org.opendaylight.yangtools.concepts.ListenerRegistration;
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.MountPointContext;
161 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
162 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
163 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
164 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
165 import org.opendaylight.yangtools.yang.model.api.Module;
166 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
167 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
168 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
169 import org.opendaylight.yangtools.yang.model.repo.spi.PotentialSchemaSource;
170 import org.opendaylight.yangtools.yang.parser.impl.DefaultYangParserFactory;
171 import org.slf4j.Logger;
172 import org.slf4j.LoggerFactory;
175 * Tests netconf mount points end-to-end.
177 * @author Thomas Pantelis
179 @RunWith(MockitoJUnitRunner.StrictStubs.class)
180 public class MountPointEndToEndTest extends AbstractBaseSchemasTest {
181 private static final Logger LOG = LoggerFactory.getLogger(MountPointEndToEndTest.class);
183 private static final String TOP_MODULE_NAME = "opendaylight-mdsal-list-test";
184 private static final String ACTOR_SYSTEM_NAME = "test";
185 private static final String TOPOLOGY_ID = TopologyNetconf.QNAME.getLocalName();
186 private static final @NonNull KeyedInstanceIdentifier<Node, NodeKey> NODE_INSTANCE_ID =
187 NetconfTopologyUtils.createTopologyNodeListPath(new NodeKey(new NodeId("node-id")), TOPOLOGY_ID);
189 private static final String TEST_ROOT_DIRECTORY = "test-cache-root";
190 private static final String TEST_DEFAULT_SUBDIR = "test-schema";
192 @Mock private DOMRpcProviderService mockRpcProviderRegistry;
193 @Mock private RpcProviderService mockRpcProviderService;
194 @Mock private DOMActionProviderService mockActionProviderRegistry;
195 @Mock private NetconfClientDispatcher mockClientDispatcher;
196 @Mock private AAAEncryptionService mockEncryptionService;
197 @Mock private ThreadPool mockThreadPool;
198 @Mock private ScheduledThreadPool mockKeepaliveExecutor;
199 @Mock private DeviceActionFactory deviceActionFactory;
200 @Mock private CredentialProvider credentialProvider;
201 @Mock private SslHandlerFactoryProvider sslHandlerFactoryProvider;
203 @Mock private ActorSystemProvider mockMasterActorSystemProvider;
204 @Mock private DOMMountPointListener masterMountPointListener;
205 private final DOMMountPointService masterMountPointService = new DOMMountPointServiceImpl();
206 private Rpcs.Normalized deviceRpcService;
208 private DOMClusterSingletonServiceProviderImpl masterClusterSingletonServiceProvider;
209 private DataBroker masterDataBroker;
210 private DOMDataBroker deviceDOMDataBroker;
211 private ActorSystem masterSystem;
212 private NetconfTopologyManager masterNetconfTopologyManager;
214 private volatile SettableFuture<MasterSalFacade> masterSalFacadeFuture = SettableFuture.create();
216 @Mock private ActorSystemProvider mockSlaveActorSystemProvider;
217 @Mock private ClusterSingletonServiceProvider mockSlaveClusterSingletonServiceProvider;
218 @Mock private ClusterSingletonServiceRegistration mockSlaveClusterSingletonServiceReg;
219 @Mock private DOMMountPointListener slaveMountPointListener;
220 private final DOMMountPointService slaveMountPointService = new DOMMountPointServiceImpl();
221 private DataBroker slaveDataBroker;
222 private ActorSystem slaveSystem;
223 private NetconfTopologyManager slaveNetconfTopologyManager;
224 private final SettableFuture<NetconfTopologyContext> slaveNetconfTopologyContextFuture = SettableFuture.create();
225 private TransactionChain slaveTxChain;
227 private final EventExecutor eventExecutor = GlobalEventExecutor.INSTANCE;
228 private final Config config = new ConfigBuilder().setWriteTransactionIdleTimeout(Uint16.ZERO).build();
229 private EffectiveModelContext deviceSchemaContext;
230 private YangModuleInfo topModuleInfo;
231 private QName putTopRpcSchemaPath;
232 private QName getTopRpcSchemaPath;
233 private BindingNormalizedNodeSerializer bindingToNormalized;
234 private YangInstanceIdentifier yangNodeInstanceId;
235 private final TopDOMRpcImplementation topRpcImplementation = new TopDOMRpcImplementation();
236 private final ContainerNode getTopInput = ImmutableNodes.containerNode(GetTopInput.QNAME);
238 private SchemaResourceManager resourceManager;
241 public void setUp() throws Exception {
244 resourceManager = new DefaultSchemaResourceManager(new DefaultYangParserFactory(), TEST_ROOT_DIRECTORY,
245 TEST_DEFAULT_SUBDIR);
247 topModuleInfo = BindingReflections.getModuleInfo(Top.class);
249 deviceSchemaContext = BindingRuntimeHelpers.createEffectiveModel(Top.class);
251 final var router = new DOMRpcRouter(FixedDOMSchemaService.of(deviceSchemaContext));
253 putTopRpcSchemaPath = findRpcDefinition("put-top").getQName();
254 getTopRpcSchemaPath = findRpcDefinition("get-top").getQName();
256 router.getRpcProviderService().registerRpcImplementation(topRpcImplementation,
257 DOMRpcIdentifier.create(putTopRpcSchemaPath), DOMRpcIdentifier.create(getTopRpcSchemaPath));
259 final var rpcService = router.getRpcService();
260 deviceRpcService = new Rpcs.Normalized() {
262 public ListenableFuture<? extends DOMRpcResult> invokeRpc(final QName type, final ContainerNode input) {
263 return rpcService.invokeRpc(type, input);
267 public <T extends DOMRpcAvailabilityListener> ListenerRegistration<T> registerRpcListener(
269 return rpcService.registerRpcListener(listener);
277 yangNodeInstanceId = bindingToNormalized.toYangInstanceIdentifier(NODE_INSTANCE_ID);
278 final var future = mock(ReconnectFuture.class);
279 doReturn(future).when(mockClientDispatcher).createReconnectingClient(any());
280 doReturn(future).when(future).firstSessionFuture();
282 LOG.info("****** Setup complete");
285 private static void deleteCacheDir() {
286 FileUtils.deleteQuietly(new File(TEST_ROOT_DIRECTORY));
290 public void tearDown() throws Exception {
292 TestKit.shutdownActorSystem(slaveSystem, true);
293 TestKit.shutdownActorSystem(masterSystem, true);
296 private void setupMaster() throws Exception {
297 final var dataBrokerTest = newDataBrokerTest();
298 masterDataBroker = dataBrokerTest.getDataBroker();
299 deviceDOMDataBroker = dataBrokerTest.getDomBroker();
300 bindingToNormalized = dataBrokerTest.getDataBrokerTestCustomizer().getAdapterContext().currentSerializer();
302 masterSystem = ActorSystem.create(ACTOR_SYSTEM_NAME, ConfigFactory.load().getConfig("Master"));
304 masterClusterSingletonServiceProvider = new DOMClusterSingletonServiceProviderImpl();
305 masterClusterSingletonServiceProvider.initializeProvider();
307 doReturn(masterSystem).when(mockMasterActorSystemProvider).getActorSystem();
309 doReturn(MoreExecutors.newDirectExecutorService()).when(mockThreadPool).getExecutor();
311 final var resources = resourceManager.getSchemaResources(TEST_DEFAULT_SUBDIR, "test");
312 resources.getSchemaRegistry().registerSchemaSource(
313 id -> Futures.immediateFuture(YangTextSchemaSource.delegateForCharSource(id,
314 topModuleInfo.getYangTextCharSource())),
315 PotentialSchemaSource.create(new SourceIdentifier(TOP_MODULE_NAME,
316 topModuleInfo.getName().getRevision().map(Revision::toString).orElse(null)),
317 YangTextSchemaSource.class, 1));
319 masterNetconfTopologyManager = new NetconfTopologyManager(BASE_SCHEMAS, masterDataBroker,
320 mockRpcProviderRegistry, mockActionProviderRegistry, masterClusterSingletonServiceProvider,
321 mockKeepaliveExecutor, mockThreadPool, mockMasterActorSystemProvider, eventExecutor,
322 mockClientDispatcher, TOPOLOGY_ID, config, masterMountPointService, mockEncryptionService,
323 mockRpcProviderService, deviceActionFactory, resourceManager, credentialProvider,
324 sslHandlerFactoryProvider) {
326 protected NetconfTopologyContext newNetconfTopologyContext(final NetconfTopologySetup setup,
327 final ServiceGroupIdentifier serviceGroupIdent, final Timeout actorResponseWaitTime,
328 final DeviceActionFactory deviceActionFact) {
329 final var context = super.newNetconfTopologyContext(setup, serviceGroupIdent, actorResponseWaitTime,
331 final var spiedContext = spy(context);
332 final var spiedSingleton = spy(context.getTopologySingleton());
333 doAnswer(invocation -> {
334 final var spiedFacade = (MasterSalFacade) spy(invocation.callRealMethod());
335 doReturn(deviceDOMDataBroker).when(spiedFacade)
336 .newDeviceDataBroker(any(MountPointContext.class), any(NetconfSessionPreferences.class));
337 masterSalFacadeFuture.set(spiedFacade);
339 }).when(spiedSingleton).createSalFacade(any(RemoteDeviceId.class), any(boolean.class));
340 doReturn(spiedSingleton).when(spiedContext).getTopologySingleton();
345 masterNetconfTopologyManager.init();
347 verifyTopologyNodesCreated(masterDataBroker);
350 private void setupSlave() throws Exception {
351 AbstractConcurrentDataBrokerTest dataBrokerTest = newDataBrokerTest();
352 slaveDataBroker = dataBrokerTest.getDataBroker();
354 slaveSystem = ActorSystem.create(ACTOR_SYSTEM_NAME, ConfigFactory.load().getConfig("Slave"));
356 doReturn(slaveSystem).when(mockSlaveActorSystemProvider).getActorSystem();
358 doReturn(mockSlaveClusterSingletonServiceReg).when(mockSlaveClusterSingletonServiceProvider)
359 .registerClusterSingletonService(any());
361 slaveNetconfTopologyManager = new NetconfTopologyManager(BASE_SCHEMAS, slaveDataBroker, mockRpcProviderRegistry,
362 mockActionProviderRegistry, mockSlaveClusterSingletonServiceProvider, mockKeepaliveExecutor, mockThreadPool,
363 mockSlaveActorSystemProvider, eventExecutor, mockClientDispatcher, TOPOLOGY_ID, config,
364 slaveMountPointService, mockEncryptionService, mockRpcProviderService, deviceActionFactory,
365 resourceManager, credentialProvider, sslHandlerFactoryProvider) {
367 protected NetconfTopologyContext newNetconfTopologyContext(final NetconfTopologySetup setup,
368 final ServiceGroupIdentifier serviceGroupIdent, final Timeout actorResponseWaitTime,
369 final DeviceActionFactory actionFactory) {
370 NetconfTopologyContext spiedContext = spy(super.newNetconfTopologyContext(setup, serviceGroupIdent,
371 actorResponseWaitTime, actionFactory));
373 slaveNetconfTopologyContextFuture.set(spiedContext);
378 slaveNetconfTopologyManager.init();
380 verifyTopologyNodesCreated(slaveDataBroker);
382 slaveTxChain = slaveDataBroker.createTransactionChain(new TransactionChainListener() {
384 public void onTransactionChainSuccessful(final TransactionChain chain) {
388 public void onTransactionChainFailed(final TransactionChain chain, final Transaction transaction,
389 final Throwable cause) {
390 LOG.error("Slave transaction chain failed", cause);
396 public void test() throws Exception {
401 final MasterSalFacade masterSalFacade = testMasterNodeUpdated();
403 testMasterDisconnected(masterSalFacade);
408 private MasterSalFacade testMaster() throws Exception {
409 LOG.info("****** Testing master");
411 writeNetconfNode(TEST_DEFAULT_SUBDIR, masterDataBroker);
413 final var masterSalFacade = masterSalFacadeFuture.get(5, TimeUnit.SECONDS);
414 masterSalFacade.onDeviceConnected(new NetconfDeviceSchema(NetconfDeviceCapabilities.empty(),
415 MountPointContext.of(deviceSchemaContext)),
416 NetconfSessionPreferences.fromStrings(List.of(CapabilityURN.CANDIDATE)),
417 new RemoteDeviceServices(deviceRpcService, null));
419 final var masterMountPoint = awaitMountPoint(masterMountPointService);
421 LOG.info("****** Testing master DOMDataBroker operations");
423 testDOMDataBrokerOperations(getDOMDataBroker(masterMountPoint));
425 LOG.info("****** Testing master DOMRpcService");
427 testDOMRpcService(getDOMRpcService(masterMountPoint));
428 return masterSalFacade;
431 private void testSlave() throws Exception {
432 LOG.info("****** Testing slave");
434 writeNetconfNode("slave", slaveDataBroker);
436 verify(mockSlaveClusterSingletonServiceProvider, timeout(5000)).registerClusterSingletonService(any());
438 // Since the master and slave use separate DataBrokers we need to copy the master's oper node to the slave.
439 // This is essentially what happens in a clustered environment but we'll use a DTCL here.
441 masterDataBroker.registerDataTreeChangeListener(
442 DataTreeIdentifier.create(LogicalDatastoreType.OPERATIONAL, NODE_INSTANCE_ID), changes -> {
443 final WriteTransaction slaveTx = slaveTxChain.newWriteOnlyTransaction();
444 for (DataTreeModification<Node> dataTreeModification : changes) {
445 DataObjectModification<Node> rootNode = dataTreeModification.getRootNode();
446 InstanceIdentifier<Node> path = dataTreeModification.getRootPath().getRootIdentifier();
447 switch (rootNode.getModificationType()) {
449 case SUBTREE_MODIFIED:
450 slaveTx.merge(LogicalDatastoreType.OPERATIONAL, path, rootNode.getDataAfter());
453 slaveTx.delete(LogicalDatastoreType.OPERATIONAL, path);
463 DOMMountPoint slaveMountPoint = awaitMountPoint(slaveMountPointService);
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(
487 new NetconfDeviceSchema(NetconfDeviceCapabilities.empty(), MountPointContext.of(deviceSchemaContext)),
488 NetconfSessionPreferences.fromStrings(List.of(CapabilityURN.CANDIDATE)),
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.orElseThrow().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 assertEquals(Optional.of(expNode), readTx.read(LogicalDatastoreType.CONFIGURATION, path)
671 .get(5, TimeUnit.SECONDS));
672 assertTrue(readTx.exists(LogicalDatastoreType.CONFIGURATION, path).get(5, TimeUnit.SECONDS));
675 private static void verifyTopologyNodesCreated(final DataBroker dataBroker) {
676 await().atMost(5, TimeUnit.SECONDS).until(() -> {
677 try (ReadTransaction readTx = dataBroker.newReadOnlyTransaction()) {
678 return readTx.exists(LogicalDatastoreType.OPERATIONAL,
679 NetconfTopologyUtils.createTopologyListPath(TOPOLOGY_ID)).get(3, TimeUnit.SECONDS);
684 private AbstractConcurrentDataBrokerTest newDataBrokerTest() throws Exception {
685 final var dataBrokerTest = new AbstractConcurrentDataBrokerTest(true) {
687 protected Set<YangModuleInfo> getModuleInfos() {
688 return Set.of(BindingReflections.getModuleInfo(NetconfNode.class),
689 BindingReflections.getModuleInfo(NetworkTopology.class),
690 BindingReflections.getModuleInfo(Keystore.class),
695 dataBrokerTest.setup();
697 final var path = NetconfTopologyUtils.createTopologyListPath(TOPOLOGY_ID);
698 putData(dataBrokerTest.getDataBroker(), path, new TopologyBuilder().withKey(path.getKey()).build());
699 return dataBrokerTest;
702 private void awaitMountPointNotPresent(final DOMMountPointService mountPointService) {
703 await().atMost(5, TimeUnit.SECONDS).until(
704 () -> mountPointService.getMountPoint(yangNodeInstanceId).isEmpty());
707 private static DOMDataBroker getDOMDataBroker(final DOMMountPoint mountPoint) {
708 return getMountPointService(mountPoint, DOMDataBroker.class);
711 private static DOMRpcService getDOMRpcService(final DOMMountPoint mountPoint) {
712 return getMountPointService(mountPoint, DOMRpcService.class);
715 private static DOMActionService getDomActionService(final DOMMountPoint mountPoint) {
716 return getMountPointService(mountPoint, DOMActionService.class);
719 private static <T extends DOMService> T getMountPointService(final DOMMountPoint mountPoint,
720 final Class<T> serviceClass) {
721 return mountPoint.getService(serviceClass).orElseThrow();
724 private DOMMountPoint awaitMountPoint(final DOMMountPointService mountPointService) {
725 await().atMost(5, TimeUnit.SECONDS).until(() ->
726 mountPointService.getMountPoint(yangNodeInstanceId).isPresent());
728 return mountPointService.getMountPoint(yangNodeInstanceId).orElseThrow();
731 private RpcDefinition findRpcDefinition(final String rpc) {
732 Module topModule = deviceSchemaContext.findModule(TOP_MODULE_NAME, topModuleInfo.getName().getRevision())
734 RpcDefinition rpcDefinition = null;
735 for (RpcDefinition def: topModule.getRpcs()) {
736 if (def.getQName().getLocalName().equals(rpc)) {
742 assertNotNull(rpc + " rpc not found in " + topModule.getRpcs(), rpcDefinition);
743 return rpcDefinition;
746 private static class TopDOMRpcImplementation implements DOMRpcImplementation {
747 private volatile SettableFuture<Entry<DOMRpcIdentifier, NormalizedNode>> rpcInvokedFuture;
748 private volatile ListenableFuture<DOMRpcResult> returnFuture;
751 public ListenableFuture<DOMRpcResult> invokeRpc(final DOMRpcIdentifier rpc, final ContainerNode input) {
752 rpcInvokedFuture.set(Map.entry(rpc, input));
756 void init(final ListenableFuture<DOMRpcResult> retFuture) {
757 returnFuture = retFuture;
758 rpcInvokedFuture = SettableFuture.create();
761 void verify(final DOMRpcIdentifier expRpc, final NormalizedNode expInput)
762 throws InterruptedException, ExecutionException, TimeoutException {
763 final Entry<DOMRpcIdentifier, NormalizedNode> actual = rpcInvokedFuture.get(5, TimeUnit.SECONDS);
764 assertEquals(expRpc, actual.getKey());
765 assertEquals(expInput, actual.getValue());