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