apps/netconf-topology-singleton/src/test/java/org/opendaylight/netconf/topology/singleton/impl/MountPointEndToEndTest.java

   1 /*
   2  * Copyright (c) 2018 Inocybe Technologies and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.netconf.topology.singleton.impl;
   9
  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;
  24
  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.Future;
  38 import io.netty.util.concurrent.GlobalEventExecutor;
  39 import java.io.File;
  40 import java.util.Iterator;
  41 import java.util.List;
  42 import java.util.Map;
  43 import java.util.Map.Entry;
  44 import java.util.Optional;
  45 import java.util.Set;
  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.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.topology.singleton.impl.utils.ClusteringRpcException;
 113 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologySetup;
 114 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologyUtils;
 115 import org.opendaylight.netconf.topology.spi.DefaultNetconfClientConfigurationBuilderFactory;
 116 import org.opendaylight.netconf.topology.spi.NetconfClientConfigurationBuilderFactory;
 117 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host;
 118 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
 119 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
 120 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
 121 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev230430.ConnectionOper.ConnectionStatus;
 122 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev230430.credentials.credentials.LoginPwUnencryptedBuilder;
 123 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev230430.credentials.credentials.login.pw.unencrypted.LoginPasswordUnencryptedBuilder;
 124 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.keystore.rev171017.Keystore;
 125 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev221225.NetconfNode;
 126 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev221225.NetconfNodeBuilder;
 127 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev221225.network.topology.topology.topology.types.TopologyNetconf;
 128 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.topology.singleton.config.rev170419.Config;
 129 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.topology.singleton.config.rev170419.ConfigBuilder;
 130 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.GetTopInput;
 131 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.GetTopOutputBuilder;
 132 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.PutTopInputBuilder;
 133 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.Top;
 134 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.two.level.list.TopLevelList;
 135 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.two.level.list.TopLevelListBuilder;
 136 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.two.level.list.TopLevelListKey;
 137 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
 138 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
 139 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyBuilder;
 140 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
 141 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
 142 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
 143 import org.opendaylight.yangtools.concepts.ListenerRegistration;
 144 import org.opendaylight.yangtools.util.concurrent.FluentFutures;
 145 import org.opendaylight.yangtools.yang.binding.DataObject;
 146 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 147 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
 148 import org.opendaylight.yangtools.yang.binding.YangModuleInfo;
 149 import org.opendaylight.yangtools.yang.common.ErrorTag;
 150 import org.opendaylight.yangtools.yang.common.ErrorType;
 151 import org.opendaylight.yangtools.yang.common.QName;
 152 import org.opendaylight.yangtools.yang.common.Revision;
 153 import org.opendaylight.yangtools.yang.common.RpcError;
 154 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
 155 import org.opendaylight.yangtools.yang.common.Uint16;
 156 import org.opendaylight.yangtools.yang.common.Uint32;
 157 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
 158 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
 159 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
 160 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
 161 import org.opendaylight.yangtools.yang.data.api.schema.MountPointContext;
 162 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
 163 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
 164 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
 165 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
 166 import org.opendaylight.yangtools.yang.model.api.Module;
 167 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
 168 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
 169 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
 170 import org.opendaylight.yangtools.yang.model.repo.spi.PotentialSchemaSource;
 171 import org.opendaylight.yangtools.yang.parser.impl.DefaultYangParserFactory;
 172 import org.slf4j.Logger;
 173 import org.slf4j.LoggerFactory;
 174
 175 /**
 176  * Tests netconf mount points end-to-end.
 177  *
 178  * @author Thomas Pantelis
 179  */
 180 @RunWith(MockitoJUnitRunner.StrictStubs.class)
 181 public class MountPointEndToEndTest extends AbstractBaseSchemasTest {
 182     private static final Logger LOG = LoggerFactory.getLogger(MountPointEndToEndTest.class);
 183
 184     private static final String TOP_MODULE_NAME = "opendaylight-mdsal-list-test";
 185     private static final String ACTOR_SYSTEM_NAME = "test";
 186     private static final String TOPOLOGY_ID = TopologyNetconf.QNAME.getLocalName();
 187     private static final @NonNull KeyedInstanceIdentifier<Node, NodeKey> NODE_INSTANCE_ID =
 188         NetconfTopologyUtils.createTopologyNodeListPath(new NodeKey(new NodeId("node-id")), TOPOLOGY_ID);
 189
 190     private static final String TEST_ROOT_DIRECTORY = "test-cache-root";
 191     private static final String TEST_DEFAULT_SUBDIR = "test-schema";
 192
 193     @Mock private DOMRpcProviderService mockRpcProviderRegistry;
 194     @Mock private RpcProviderService mockRpcProviderService;
 195     @Mock private DOMActionProviderService mockActionProviderRegistry;
 196     @Mock private NetconfClientDispatcher mockClientDispatcher;
 197     @Mock private AAAEncryptionService mockEncryptionService;
 198     @Mock private ThreadPool mockThreadPool;
 199     @Mock private ScheduledThreadPool mockKeepaliveExecutor;
 200     @Mock private DeviceActionFactory deviceActionFactory;
 201     @Mock private CredentialProvider credentialProvider;
 202     @Mock private SslHandlerFactoryProvider sslHandlerFactoryProvider;
 203
 204     @Mock private ActorSystemProvider mockMasterActorSystemProvider;
 205     @Mock private DOMMountPointListener masterMountPointListener;
 206     private final DOMMountPointService masterMountPointService = new DOMMountPointServiceImpl();
 207     private Rpcs.Normalized deviceRpcService;
 208
 209     private DOMClusterSingletonServiceProviderImpl masterClusterSingletonServiceProvider;
 210     private DataBroker masterDataBroker;
 211     private DOMDataBroker deviceDOMDataBroker;
 212     private ActorSystem masterSystem;
 213     private NetconfTopologyManager masterNetconfTopologyManager;
 214
 215     private volatile SettableFuture<MasterSalFacade> masterSalFacadeFuture = SettableFuture.create();
 216
 217     @Mock private ActorSystemProvider mockSlaveActorSystemProvider;
 218     @Mock private ClusterSingletonServiceProvider mockSlaveClusterSingletonServiceProvider;
 219     @Mock private ClusterSingletonServiceRegistration mockSlaveClusterSingletonServiceReg;
 220     @Mock private DOMMountPointListener slaveMountPointListener;
 221     private final DOMMountPointService slaveMountPointService = new DOMMountPointServiceImpl();
 222     private DataBroker slaveDataBroker;
 223     private ActorSystem slaveSystem;
 224     private NetconfTopologyManager slaveNetconfTopologyManager;
 225     private final SettableFuture<NetconfTopologyContext> slaveNetconfTopologyContextFuture = SettableFuture.create();
 226     private TransactionChain slaveTxChain;
 227
 228     private NetconfClientConfigurationBuilderFactory builderFactory;
 229     private final EventExecutor eventExecutor = GlobalEventExecutor.INSTANCE;
 230     private final Config config = new ConfigBuilder().setWriteTransactionIdleTimeout(Uint16.ZERO).build();
 231     private EffectiveModelContext deviceSchemaContext;
 232     private YangModuleInfo topModuleInfo;
 233     private QName putTopRpcSchemaPath;
 234     private QName getTopRpcSchemaPath;
 235     private BindingNormalizedNodeSerializer bindingToNormalized;
 236     private YangInstanceIdentifier yangNodeInstanceId;
 237     private final TopDOMRpcImplementation topRpcImplementation = new TopDOMRpcImplementation();
 238     private final ContainerNode getTopInput = ImmutableNodes.containerNode(GetTopInput.QNAME);
 239
 240     private SchemaResourceManager resourceManager;
 241
 242     @Before
 243     public void setUp() throws Exception {
 244         deleteCacheDir();
 245
 246         resourceManager = new DefaultSchemaResourceManager(new DefaultYangParserFactory(), TEST_ROOT_DIRECTORY,
 247             TEST_DEFAULT_SUBDIR);
 248
 249         topModuleInfo = BindingRuntimeHelpers.getYangModuleInfo(Top.class);
 250
 251         deviceSchemaContext = BindingRuntimeHelpers.createEffectiveModel(Top.class);
 252
 253         final var router = new DOMRpcRouter(FixedDOMSchemaService.of(deviceSchemaContext));
 254
 255         putTopRpcSchemaPath = findRpcDefinition("put-top").getQName();
 256         getTopRpcSchemaPath = findRpcDefinition("get-top").getQName();
 257
 258         router.getRpcProviderService().registerRpcImplementation(topRpcImplementation,
 259                 DOMRpcIdentifier.create(putTopRpcSchemaPath), DOMRpcIdentifier.create(getTopRpcSchemaPath));
 260
 261         final var rpcService = router.getRpcService();
 262         deviceRpcService = new Rpcs.Normalized() {
 263             @Override
 264             public ListenableFuture<? extends DOMRpcResult> invokeRpc(final QName type, final ContainerNode input) {
 265                 return rpcService.invokeRpc(type, input);
 266             }
 267
 268             @Override
 269             public <T extends DOMRpcAvailabilityListener> ListenerRegistration<T> registerRpcListener(
 270                     final T listener) {
 271                 return rpcService.registerRpcListener(listener);
 272             }
 273         };
 274
 275         builderFactory = new DefaultNetconfClientConfigurationBuilderFactory(mockEncryptionService, credentialProvider,
 276             sslHandlerFactoryProvider);
 277
 278         setupMaster();
 279
 280         setupSlave();
 281
 282         yangNodeInstanceId = bindingToNormalized.toYangInstanceIdentifier(NODE_INSTANCE_ID);
 283         doReturn(mock(Future.class)).when(mockClientDispatcher).createClient(any());
 284
 285         LOG.info("****** Setup complete");
 286     }
 287
 288     private static void deleteCacheDir() {
 289         FileUtils.deleteQuietly(new File(TEST_ROOT_DIRECTORY));
 290     }
 291
 292     @After
 293     public void tearDown() throws Exception {
 294         deleteCacheDir();
 295         TestKit.shutdownActorSystem(slaveSystem, true);
 296         TestKit.shutdownActorSystem(masterSystem, true);
 297     }
 298
 299     private void setupMaster() throws Exception {
 300         final var dataBrokerTest = newDataBrokerTest();
 301         masterDataBroker = dataBrokerTest.getDataBroker();
 302         deviceDOMDataBroker = dataBrokerTest.getDomBroker();
 303         bindingToNormalized = dataBrokerTest.getDataBrokerTestCustomizer().getAdapterContext().currentSerializer();
 304
 305         masterSystem = ActorSystem.create(ACTOR_SYSTEM_NAME, ConfigFactory.load().getConfig("Master"));
 306
 307         masterClusterSingletonServiceProvider = new DOMClusterSingletonServiceProviderImpl();
 308         masterClusterSingletonServiceProvider.initializeProvider();
 309
 310         doReturn(masterSystem).when(mockMasterActorSystemProvider).getActorSystem();
 311
 312         doReturn(MoreExecutors.newDirectExecutorService()).when(mockThreadPool).getExecutor();
 313
 314         final var resources =  resourceManager.getSchemaResources(TEST_DEFAULT_SUBDIR, "test");
 315         resources.getSchemaRegistry().registerSchemaSource(
 316             id -> Futures.immediateFuture(YangTextSchemaSource.delegateForCharSource(id,
 317                     topModuleInfo.getYangTextCharSource())),
 318             PotentialSchemaSource.create(new SourceIdentifier(TOP_MODULE_NAME,
 319                     topModuleInfo.getName().getRevision().map(Revision::toString).orElse(null)),
 320                 YangTextSchemaSource.class, 1));
 321
 322         masterNetconfTopologyManager = new NetconfTopologyManager(BASE_SCHEMAS, masterDataBroker,
 323                 mockRpcProviderRegistry, mockActionProviderRegistry, masterClusterSingletonServiceProvider,
 324                 mockKeepaliveExecutor, mockThreadPool, mockMasterActorSystemProvider, eventExecutor,
 325                 mockClientDispatcher, TOPOLOGY_ID, config, masterMountPointService, mockEncryptionService,
 326                 mockRpcProviderService, deviceActionFactory, resourceManager, builderFactory) {
 327             @Override
 328             protected NetconfTopologyContext newNetconfTopologyContext(final NetconfTopologySetup setup,
 329                     final ServiceGroupIdentifier serviceGroupIdent, final Timeout actorResponseWaitTime,
 330                     final DeviceActionFactory deviceActionFact) {
 331                 final var context = super.newNetconfTopologyContext(setup, serviceGroupIdent, actorResponseWaitTime,
 332                     deviceActionFact);
 333                 final var spiedContext = spy(context);
 334                 final var spiedSingleton = spy(context.getTopologySingleton());
 335                 doAnswer(invocation -> {
 336                     final var spiedFacade = (MasterSalFacade) spy(invocation.callRealMethod());
 337                     doReturn(deviceDOMDataBroker).when(spiedFacade)
 338                         .newDeviceDataBroker(any(MountPointContext.class), any(NetconfSessionPreferences.class));
 339                     masterSalFacadeFuture.set(spiedFacade);
 340                     return spiedFacade;
 341                 }).when(spiedSingleton).createSalFacade(any(RemoteDeviceId.class), any(boolean.class));
 342                 doReturn(spiedSingleton).when(spiedContext).getTopologySingleton();
 343                 return spiedContext;
 344             }
 345         };
 346
 347         masterNetconfTopologyManager.init();
 348
 349         verifyTopologyNodesCreated(masterDataBroker);
 350     }
 351
 352     private void setupSlave() throws Exception {
 353         AbstractConcurrentDataBrokerTest dataBrokerTest = newDataBrokerTest();
 354         slaveDataBroker = dataBrokerTest.getDataBroker();
 355
 356         slaveSystem = ActorSystem.create(ACTOR_SYSTEM_NAME, ConfigFactory.load().getConfig("Slave"));
 357
 358         doReturn(slaveSystem).when(mockSlaveActorSystemProvider).getActorSystem();
 359
 360         doReturn(mockSlaveClusterSingletonServiceReg).when(mockSlaveClusterSingletonServiceProvider)
 361                 .registerClusterSingletonService(any());
 362
 363         slaveNetconfTopologyManager = new NetconfTopologyManager(BASE_SCHEMAS, slaveDataBroker, mockRpcProviderRegistry,
 364             mockActionProviderRegistry, mockSlaveClusterSingletonServiceProvider, mockKeepaliveExecutor, mockThreadPool,
 365                 mockSlaveActorSystemProvider, eventExecutor, mockClientDispatcher, TOPOLOGY_ID, config,
 366                 slaveMountPointService, mockEncryptionService, mockRpcProviderService, deviceActionFactory,
 367                 resourceManager, builderFactory) {
 368             @Override
 369             protected NetconfTopologyContext newNetconfTopologyContext(final NetconfTopologySetup setup,
 370                 final ServiceGroupIdentifier serviceGroupIdent, final Timeout actorResponseWaitTime,
 371                 final DeviceActionFactory actionFactory) {
 372                 NetconfTopologyContext spiedContext = spy(super.newNetconfTopologyContext(setup, serviceGroupIdent,
 373                     actorResponseWaitTime, actionFactory));
 374
 375                 slaveNetconfTopologyContextFuture.set(spiedContext);
 376                 return spiedContext;
 377             }
 378         };
 379
 380         slaveNetconfTopologyManager.init();
 381
 382         verifyTopologyNodesCreated(slaveDataBroker);
 383
 384         slaveTxChain = slaveDataBroker.createTransactionChain(new TransactionChainListener() {
 385             @Override
 386             public void onTransactionChainSuccessful(final TransactionChain chain) {
 387             }
 388
 389             @Override
 390             public void onTransactionChainFailed(final TransactionChain chain, final Transaction transaction,
 391                     final Throwable cause) {
 392                 LOG.error("Slave transaction chain failed", cause);
 393             }
 394         });
 395     }
 396
 397     @Test
 398     public void test() throws Exception {
 399         testMaster();
 400
 401         testSlave();
 402
 403         final MasterSalFacade masterSalFacade = testMasterNodeUpdated();
 404
 405         testMasterDisconnected(masterSalFacade);
 406
 407         testCleanup();
 408     }
 409
 410     private MasterSalFacade testMaster() throws Exception {
 411         LOG.info("****** Testing master");
 412
 413         writeNetconfNode(TEST_DEFAULT_SUBDIR, masterDataBroker);
 414
 415         final var masterSalFacade = masterSalFacadeFuture.get(5, TimeUnit.SECONDS);
 416         masterSalFacade.onDeviceConnected(new NetconfDeviceSchema(NetconfDeviceCapabilities.empty(),
 417             MountPointContext.of(deviceSchemaContext)),
 418             NetconfSessionPreferences.fromStrings(List.of(CapabilityURN.CANDIDATE)),
 419             new RemoteDeviceServices(deviceRpcService, null));
 420
 421         final var masterMountPoint = awaitMountPoint(masterMountPointService);
 422
 423         LOG.info("****** Testing master DOMDataBroker operations");
 424
 425         testDOMDataBrokerOperations(getDOMDataBroker(masterMountPoint));
 426
 427         LOG.info("****** Testing master DOMRpcService");
 428
 429         testDOMRpcService(getDOMRpcService(masterMountPoint));
 430         return masterSalFacade;
 431     }
 432
 433     private void testSlave() throws Exception {
 434         LOG.info("****** Testing slave");
 435
 436         writeNetconfNode("slave", slaveDataBroker);
 437
 438         verify(mockSlaveClusterSingletonServiceProvider, timeout(5000)).registerClusterSingletonService(any());
 439
 440         // Since the master and slave use separate DataBrokers we need to copy the master's oper node to the slave.
 441         // This is essentially what happens in a clustered environment but we'll use a DTCL here.
 442
 443         masterDataBroker.registerDataTreeChangeListener(
 444             DataTreeIdentifier.create(LogicalDatastoreType.OPERATIONAL, NODE_INSTANCE_ID), changes -> {
 445                 final WriteTransaction slaveTx = slaveTxChain.newWriteOnlyTransaction();
 446                 for (DataTreeModification<Node> dataTreeModification : changes) {
 447                     DataObjectModification<Node> rootNode = dataTreeModification.getRootNode();
 448                     InstanceIdentifier<Node> path = dataTreeModification.getRootPath().getRootIdentifier();
 449                     switch (rootNode.getModificationType()) {
 450                         case WRITE:
 451                         case SUBTREE_MODIFIED:
 452                             slaveTx.merge(LogicalDatastoreType.OPERATIONAL, path, rootNode.getDataAfter());
 453                             break;
 454                         case DELETE:
 455                             slaveTx.delete(LogicalDatastoreType.OPERATIONAL, path);
 456                             break;
 457                         default:
 458                             break;
 459                     }
 460                 }
 461
 462                 slaveTx.commit();
 463             });
 464
 465         DOMMountPoint slaveMountPoint = awaitMountPoint(slaveMountPointService);
 466
 467         LOG.info("****** Testing slave DOMDataBroker operations");
 468
 469         testDOMDataBrokerOperations(getDOMDataBroker(slaveMountPoint));
 470
 471         LOG.info("****** Testing slave DOMRpcService");
 472
 473         testDOMRpcService(getDOMRpcService(slaveMountPoint));
 474     }
 475
 476     private MasterSalFacade testMasterNodeUpdated() throws Exception {
 477         LOG.info("****** Testing update master node");
 478
 479         masterMountPointService.registerProvisionListener(masterMountPointListener);
 480         slaveMountPointService.registerProvisionListener(slaveMountPointListener);
 481
 482         masterSalFacadeFuture = SettableFuture.create();
 483         writeNetconfNode(TEST_DEFAULT_SUBDIR, masterDataBroker);
 484
 485         verify(masterMountPointListener, timeout(5000)).onMountPointRemoved(yangNodeInstanceId);
 486
 487         final var masterSalFacade = masterSalFacadeFuture.get(5, TimeUnit.SECONDS);
 488         masterSalFacade.onDeviceConnected(
 489             new NetconfDeviceSchema(NetconfDeviceCapabilities.empty(), MountPointContext.of(deviceSchemaContext)),
 490             NetconfSessionPreferences.fromStrings(List.of(CapabilityURN.CANDIDATE)),
 491             new RemoteDeviceServices(deviceRpcService, null));
 492
 493         verify(masterMountPointListener, timeout(5000)).onMountPointCreated(yangNodeInstanceId);
 494
 495         verify(slaveMountPointListener, timeout(5000)).onMountPointRemoved(yangNodeInstanceId);
 496         verify(slaveMountPointListener, timeout(5000)).onMountPointCreated(yangNodeInstanceId);
 497
 498         return masterSalFacade;
 499     }
 500
 501     private void testMasterDisconnected(final MasterSalFacade masterSalFacade) throws Exception {
 502         LOG.info("****** Testing master disconnected");
 503
 504         masterSalFacade.onDeviceDisconnected();
 505
 506         awaitMountPointNotPresent(masterMountPointService);
 507
 508         await().atMost(5, TimeUnit.SECONDS).until(() -> {
 509             try (ReadTransaction readTx = masterDataBroker.newReadOnlyTransaction()) {
 510                 Optional<Node> node = readTx.read(LogicalDatastoreType.OPERATIONAL,
 511                         NODE_INSTANCE_ID).get(5, TimeUnit.SECONDS);
 512                 assertTrue(node.isPresent());
 513                 final NetconfNode netconfNode = node.orElseThrow().augmentation(NetconfNode.class);
 514                 return netconfNode.getConnectionStatus() != ConnectionStatus.Connected;
 515             }
 516         });
 517
 518         awaitMountPointNotPresent(slaveMountPointService);
 519     }
 520
 521     private void testCleanup() throws Exception {
 522         LOG.info("****** Testing cleanup");
 523
 524         slaveNetconfTopologyManager.close();
 525         verify(mockSlaveClusterSingletonServiceReg).close();
 526     }
 527
 528     private void testDOMRpcService(final DOMRpcService domRpcService)
 529             throws InterruptedException, ExecutionException, TimeoutException {
 530         testPutTopRpc(domRpcService, new DefaultDOMRpcResult((ContainerNode)null));
 531         testPutTopRpc(domRpcService, null);
 532         testPutTopRpc(domRpcService, new DefaultDOMRpcResult(ImmutableList.of(
 533                 RpcResultBuilder.newError(ErrorType.APPLICATION, new ErrorTag("tag1"), "error1"),
 534                 RpcResultBuilder.newError(ErrorType.APPLICATION, new ErrorTag("tag2"), "error2"))));
 535
 536         testGetTopRpc(domRpcService, new DefaultDOMRpcResult(bindingToNormalized.toNormalizedNodeRpcData(
 537                 new GetTopOutputBuilder().setTopLevelList(oneTopLevelList()).build())));
 538
 539         testFailedRpc(domRpcService, getTopRpcSchemaPath, getTopInput);
 540     }
 541
 542     private void testPutTopRpc(final DOMRpcService domRpcService, final DOMRpcResult result)
 543             throws InterruptedException, ExecutionException, TimeoutException {
 544         ContainerNode putTopInput = bindingToNormalized.toNormalizedNodeRpcData(
 545                 new PutTopInputBuilder().setTopLevelList(oneTopLevelList()).build());
 546         testRpc(domRpcService, putTopRpcSchemaPath, putTopInput, result);
 547     }
 548
 549     private static Map<TopLevelListKey, TopLevelList> oneTopLevelList() {
 550         final TopLevelListKey key = new TopLevelListKey("one");
 551         return ImmutableMap.of(key, new TopLevelListBuilder().withKey(key).build());
 552     }
 553
 554     private void testGetTopRpc(final DOMRpcService domRpcService, final DOMRpcResult result)
 555             throws InterruptedException, ExecutionException, TimeoutException {
 556         testRpc(domRpcService, getTopRpcSchemaPath, getTopInput, result);
 557     }
 558
 559     private void testRpc(final DOMRpcService domRpcService, final QName qname, final ContainerNode input,
 560             final DOMRpcResult result) throws InterruptedException, ExecutionException, TimeoutException {
 561         final FluentFuture<DOMRpcResult> future = result == null ? FluentFutures.immediateNullFluentFuture()
 562                 : FluentFutures.immediateFluentFuture(result);
 563         final DOMRpcResult actual = invokeRpc(domRpcService, qname, input, future);
 564         if (result == null) {
 565             assertNull(actual);
 566             return;
 567         }
 568
 569         assertNotNull(actual);
 570         assertEquals(result.value(), actual.value());
 571
 572         assertEquals(result.errors().size(), actual.errors().size());
 573         Iterator<? extends RpcError> iter1 = result.errors().iterator();
 574         Iterator<? extends RpcError> iter2 = actual.errors().iterator();
 575         while (iter1.hasNext() && iter2.hasNext()) {
 576             RpcError err1 = iter1.next();
 577             RpcError err2 = iter2.next();
 578             assertEquals(err1.getErrorType(), err2.getErrorType());
 579             assertEquals(err1.getTag(), err2.getTag());
 580             assertEquals(err1.getMessage(), err2.getMessage());
 581             assertEquals(err1.getSeverity(), err2.getSeverity());
 582             assertEquals(err1.getApplicationTag(), err2.getApplicationTag());
 583             assertEquals(err1.getInfo(), err2.getInfo());
 584         }
 585     }
 586
 587     private void testFailedRpc(final DOMRpcService domRpcService, final QName qname, final ContainerNode input)
 588             throws InterruptedException, TimeoutException {
 589         try {
 590             invokeRpc(domRpcService, qname, input, Futures.immediateFailedFuture(new ClusteringRpcException("mock")));
 591             fail("Expected exception");
 592         } catch (ExecutionException e) {
 593             assertTrue(e.getCause() instanceof ClusteringRpcException);
 594             assertEquals("mock", e.getCause().getMessage());
 595         }
 596     }
 597
 598     private DOMRpcResult invokeRpc(final DOMRpcService domRpcService, final QName qname, final ContainerNode input,
 599             final ListenableFuture<DOMRpcResult> returnFuture)
 600                 throws InterruptedException, ExecutionException, TimeoutException {
 601         topRpcImplementation.init(returnFuture);
 602         final ListenableFuture<? extends DOMRpcResult> resultFuture = domRpcService.invokeRpc(qname, input);
 603
 604         topRpcImplementation.verify(DOMRpcIdentifier.create(qname), input);
 605
 606         return resultFuture.get(5, TimeUnit.SECONDS);
 607     }
 608
 609     private static void testDOMDataBrokerOperations(final DOMDataBroker dataBroker)
 610             throws InterruptedException, ExecutionException, TimeoutException {
 611
 612         DOMDataTreeWriteTransaction writeTx = dataBroker.newWriteOnlyTransaction();
 613
 614         final ContainerNode topNode = Builders.containerBuilder()
 615                 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(Top.QNAME)).build();
 616         final YangInstanceIdentifier topPath = YangInstanceIdentifier.of(Top.QNAME);
 617         writeTx.put(LogicalDatastoreType.CONFIGURATION, topPath, topNode);
 618
 619         final QName name = QName.create(TopLevelList.QNAME, "name");
 620         final YangInstanceIdentifier listPath = YangInstanceIdentifier.builder(topPath)
 621                 .node(TopLevelList.QNAME).build();
 622         final MapEntryNode listEntryNode = ImmutableNodes.mapEntry(TopLevelList.QNAME, name, "one");
 623         final MapNode listNode = ImmutableNodes.mapNodeBuilder(TopLevelList.QNAME).addChild(listEntryNode).build();
 624         writeTx.merge(LogicalDatastoreType.CONFIGURATION, listPath, listNode);
 625         writeTx.commit().get(5, TimeUnit.SECONDS);
 626
 627         verifyDataInStore(dataBroker.newReadWriteTransaction(), YangInstanceIdentifier.builder(listPath)
 628                 .nodeWithKey(TopLevelList.QNAME, name, "one").build(), listEntryNode);
 629
 630         writeTx = dataBroker.newWriteOnlyTransaction();
 631         writeTx.delete(LogicalDatastoreType.CONFIGURATION, topPath);
 632         writeTx.commit().get(5, TimeUnit.SECONDS);
 633
 634         DOMDataTreeReadWriteTransaction readTx = dataBroker.newReadWriteTransaction();
 635         assertFalse(readTx.exists(LogicalDatastoreType.CONFIGURATION, topPath).get(5, TimeUnit.SECONDS));
 636         assertTrue(readTx.cancel());
 637     }
 638
 639     private static void writeNetconfNode(final String cacheDir, final DataBroker dataBroker) throws Exception {
 640         putData(dataBroker, NODE_INSTANCE_ID, new NodeBuilder()
 641             .withKey(NODE_INSTANCE_ID.getKey())
 642             .addAugmentation(new NetconfNodeBuilder()
 643                 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
 644                 .setPort(new PortNumber(Uint16.valueOf(1234)))
 645                 .setActorResponseWaitTime(Uint16.valueOf(10))
 646                 .setTcpOnly(Boolean.TRUE)
 647                 .setSchemaless(Boolean.FALSE)
 648                 .setKeepaliveDelay(Uint32.ZERO)
 649                 .setConnectionTimeoutMillis(Uint32.valueOf(5000))
 650                 .setDefaultRequestTimeoutMillis(Uint32.valueOf(5000))
 651                 .setMaxConnectionAttempts(Uint32.ONE)
 652                 .setCredentials(new LoginPwUnencryptedBuilder()
 653                     .setLoginPasswordUnencrypted(new LoginPasswordUnencryptedBuilder()
 654                         .setUsername("user")
 655                         .setPassword("pass")
 656                         .build())
 657                     .build())
 658                 .setSchemaCacheDirectory(cacheDir)
 659                 .build())
 660             .build());
 661     }
 662
 663     private static <T extends DataObject> void putData(final DataBroker databroker, final InstanceIdentifier<T> path,
 664             final T data) throws Exception {
 665         final var writeTx = databroker.newWriteOnlyTransaction();
 666         writeTx.put(LogicalDatastoreType.CONFIGURATION, path, data);
 667         writeTx.commit().get(5, TimeUnit.SECONDS);
 668     }
 669
 670     private static void verifyDataInStore(final DOMDataTreeReadOperations readTx, final YangInstanceIdentifier path,
 671             final NormalizedNode expNode) throws InterruptedException, ExecutionException, TimeoutException {
 672         assertEquals(Optional.of(expNode), readTx.read(LogicalDatastoreType.CONFIGURATION, path)
 673             .get(5, TimeUnit.SECONDS));
 674         assertTrue(readTx.exists(LogicalDatastoreType.CONFIGURATION, path).get(5, TimeUnit.SECONDS));
 675     }
 676
 677     private static void verifyTopologyNodesCreated(final DataBroker dataBroker) {
 678         await().atMost(5, TimeUnit.SECONDS).until(() -> {
 679             try (ReadTransaction readTx = dataBroker.newReadOnlyTransaction()) {
 680                 return readTx.exists(LogicalDatastoreType.OPERATIONAL,
 681                     NetconfTopologyUtils.createTopologyListPath(TOPOLOGY_ID)).get(3, TimeUnit.SECONDS);
 682             }
 683         });
 684     }
 685
 686     private AbstractConcurrentDataBrokerTest newDataBrokerTest() throws Exception {
 687         final var dataBrokerTest = new AbstractConcurrentDataBrokerTest(true) {
 688             @Override
 689             protected Set<YangModuleInfo> getModuleInfos() {
 690                 return Set.of(
 691                     BindingRuntimeHelpers.getYangModuleInfo(NetconfNode.class),
 692                     BindingRuntimeHelpers.getYangModuleInfo(NetworkTopology.class),
 693                     BindingRuntimeHelpers.getYangModuleInfo(Keystore.class),
 694                     topModuleInfo);
 695             }
 696         };
 697
 698         dataBrokerTest.setup();
 699
 700         final var path = NetconfTopologyUtils.createTopologyListPath(TOPOLOGY_ID);
 701         putData(dataBrokerTest.getDataBroker(), path, new TopologyBuilder().withKey(path.getKey()).build());
 702         return dataBrokerTest;
 703     }
 704
 705     private void awaitMountPointNotPresent(final DOMMountPointService mountPointService) {
 706         await().atMost(5, TimeUnit.SECONDS).until(
 707             () -> mountPointService.getMountPoint(yangNodeInstanceId).isEmpty());
 708     }
 709
 710     private static DOMDataBroker getDOMDataBroker(final DOMMountPoint mountPoint) {
 711         return getMountPointService(mountPoint, DOMDataBroker.class);
 712     }
 713
 714     private static DOMRpcService getDOMRpcService(final DOMMountPoint mountPoint) {
 715         return getMountPointService(mountPoint, DOMRpcService.class);
 716     }
 717
 718     private static DOMActionService getDomActionService(final DOMMountPoint mountPoint) {
 719         return getMountPointService(mountPoint, DOMActionService.class);
 720     }
 721
 722     private static <T extends DOMService> T getMountPointService(final DOMMountPoint mountPoint,
 723             final Class<T> serviceClass) {
 724         return mountPoint.getService(serviceClass).orElseThrow();
 725     }
 726
 727     private DOMMountPoint awaitMountPoint(final DOMMountPointService mountPointService) {
 728         await().atMost(5, TimeUnit.SECONDS).until(() ->
 729                 mountPointService.getMountPoint(yangNodeInstanceId).isPresent());
 730
 731         return mountPointService.getMountPoint(yangNodeInstanceId).orElseThrow();
 732     }
 733
 734     private RpcDefinition findRpcDefinition(final String rpc) {
 735         Module topModule = deviceSchemaContext.findModule(TOP_MODULE_NAME, topModuleInfo.getName().getRevision())
 736             .orElseThrow();
 737         RpcDefinition rpcDefinition = null;
 738         for (RpcDefinition def: topModule.getRpcs()) {
 739             if (def.getQName().getLocalName().equals(rpc)) {
 740                 rpcDefinition = def;
 741                 break;
 742             }
 743         }
 744
 745         assertNotNull(rpc + " rpc not found in " + topModule.getRpcs(), rpcDefinition);
 746         return rpcDefinition;
 747     }
 748
 749     private static class TopDOMRpcImplementation implements DOMRpcImplementation {
 750         private volatile SettableFuture<Entry<DOMRpcIdentifier, NormalizedNode>> rpcInvokedFuture;
 751         private volatile ListenableFuture<DOMRpcResult> returnFuture;
 752
 753         @Override
 754         public ListenableFuture<DOMRpcResult> invokeRpc(final DOMRpcIdentifier rpc, final ContainerNode input) {
 755             rpcInvokedFuture.set(Map.entry(rpc, input));
 756             return returnFuture;
 757         }
 758
 759         void init(final ListenableFuture<DOMRpcResult> retFuture) {
 760             returnFuture = retFuture;
 761             rpcInvokedFuture = SettableFuture.create();
 762         }
 763
 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());
 769         }
 770     }
 771 }