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