netconf/sal-netconf-connector/src/test/java/org/opendaylight/netconf/sal/connect/netconf/sal/tx/NetconfDeviceWriteOnlyTxTest.java

   1 /*
   2  * Copyright (c) 2014, 2015 Cisco Systems, Inc. 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.sal.connect.netconf.sal.tx;
   9
  10 import static org.junit.Assert.fail;
  11 import static org.mockito.ArgumentMatchers.any;
  12 import static org.mockito.ArgumentMatchers.eq;
  13 import static org.mockito.ArgumentMatchers.isNull;
  14 import static org.mockito.Mockito.atMost;
  15 import static org.mockito.Mockito.doReturn;
  16 import static org.mockito.Mockito.inOrder;
  17 import static org.mockito.Mockito.mock;
  18 import static org.mockito.Mockito.never;
  19 import static org.mockito.Mockito.verify;
  20 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_CANDIDATE_QNAME;
  21 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_FILTER_QNAME;
  22 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_RUNNING_QNAME;
  23
  24 import com.google.common.util.concurrent.Futures;
  25 import com.google.common.util.concurrent.ListenableFuture;
  26 import java.net.InetSocketAddress;
  27 import java.util.concurrent.ExecutionException;
  28 import org.junit.Assert;
  29 import org.junit.Before;
  30 import org.junit.Test;
  31 import org.junit.runner.RunWith;
  32 import org.mockito.ArgumentCaptor;
  33 import org.mockito.InOrder;
  34 import org.mockito.Mock;
  35 import org.mockito.junit.MockitoJUnitRunner;
  36 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  37 import org.opendaylight.mdsal.dom.api.DOMRpcService;
  38 import org.opendaylight.mdsal.dom.spi.DefaultDOMRpcResult;
  39 import org.opendaylight.netconf.sal.connect.netconf.AbstractBaseSchemasTest;
  40 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfBaseOps;
  41 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
  42 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.NetconfState;
  44 import org.opendaylight.yangtools.rfc8528.data.api.MountPointContext;
  45 import org.opendaylight.yangtools.util.concurrent.FluentFutures;
  46 import org.opendaylight.yangtools.yang.common.ErrorTag;
  47 import org.opendaylight.yangtools.yang.common.ErrorType;
  48 import org.opendaylight.yangtools.yang.common.QName;
  49 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  50 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  51 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  52 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  53 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  54 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  55
  56 @RunWith(MockitoJUnitRunner.StrictStubs.class)
  57 public class NetconfDeviceWriteOnlyTxTest extends AbstractBaseSchemasTest {
  58
  59     private final RemoteDeviceId id = new RemoteDeviceId("test-mount", new InetSocketAddress(99));
  60
  61     @Mock
  62     private DOMRpcService rpc;
  63     private YangInstanceIdentifier yangIId;
  64
  65     @Before
  66     public void setUp() {
  67         final ListenableFuture<DefaultDOMRpcResult> successFuture =
  68                 Futures.immediateFuture(new DefaultDOMRpcResult((NormalizedNode) null));
  69
  70         doReturn(successFuture)
  71                 .doReturn(Futures.immediateFailedFuture(new IllegalStateException("Failed tx")))
  72                 .doReturn(successFuture)
  73                 .when(rpc).invokeRpc(any(QName.class), any(ContainerNode.class));
  74
  75         yangIId = YangInstanceIdentifier.builder().node(NetconfState.QNAME).build();
  76     }
  77
  78     @Test
  79     public void testIgnoreNonVisibleData() {
  80         final WriteCandidateTx tx = new WriteCandidateTx(id, new NetconfBaseOps(rpc, mock(MountPointContext.class)),
  81                 false);
  82         final MapNode emptyList = ImmutableNodes.mapNodeBuilder(NETCONF_FILTER_QNAME).build();
  83         tx.merge(LogicalDatastoreType.CONFIGURATION, YangInstanceIdentifier
  84                 .create(new YangInstanceIdentifier.NodeIdentifier(NETCONF_FILTER_QNAME)), emptyList);
  85         tx.put(LogicalDatastoreType.CONFIGURATION, YangInstanceIdentifier
  86                 .create(new YangInstanceIdentifier.NodeIdentifier(NETCONF_FILTER_QNAME)), emptyList);
  87
  88         verify(rpc, atMost(1)).invokeRpc(any(QName.class), any(ContainerNode.class));
  89     }
  90
  91     @Test
  92     public void testDiscardChanges() throws InterruptedException {
  93         doReturn(FluentFutures.immediateFluentFuture(new DefaultDOMRpcResult((NormalizedNode) null)))
  94                 .when(rpc).invokeRpc(any(QName.class), isNull());
  95
  96         final WriteCandidateTx tx = new WriteCandidateTx(id, new NetconfBaseOps(rpc, mock(MountPointContext.class)),
  97                 false);
  98         try {
  99             tx.commit().get();
 100         } catch (final ExecutionException e) {
 101             // verify discard changes was sent
 102             final InOrder inOrder = inOrder(rpc);
 103             inOrder.verify(rpc).invokeRpc(NetconfMessageTransformUtil.NETCONF_LOCK_QNAME,
 104                     NetconfBaseOps.getLockContent(NETCONF_CANDIDATE_QNAME));
 105             inOrder.verify(rpc).invokeRpc(NetconfMessageTransformUtil.NETCONF_COMMIT_QNAME,
 106                     NetconfMessageTransformUtil.COMMIT_RPC_CONTENT);
 107             inOrder.verify(rpc).invokeRpc(eq(NetconfMessageTransformUtil.NETCONF_DISCARD_CHANGES_QNAME),
 108                     isNull());
 109             inOrder.verify(rpc).invokeRpc(NetconfMessageTransformUtil.NETCONF_UNLOCK_QNAME,
 110                     NetconfBaseOps.getUnLockContent(NETCONF_CANDIDATE_QNAME));
 111             return;
 112         }
 113
 114         fail("Submit should fail");
 115     }
 116
 117     @Test
 118     public void testFailedCommit() throws Exception {
 119         doReturn(Futures.immediateFuture(new DefaultDOMRpcResult((NormalizedNode) null)))
 120             .doReturn(Futures.immediateFuture(new DefaultDOMRpcResult(RpcResultBuilder.newError(ErrorType.APPLICATION,
 121                 new ErrorTag("a"), "m")))).when(rpc).invokeRpc(any(QName.class), any(ContainerNode.class));
 122
 123         final WriteCandidateTx tx = new WriteCandidateTx(id, new NetconfBaseOps(rpc, mock(MountPointContext.class)),
 124                 false);
 125
 126         try {
 127             tx.commit().get();
 128             fail("Submit should fail");
 129         } catch (final ExecutionException e) {
 130             // Intended
 131         }
 132     }
 133
 134     @Test
 135     public void testDiscardChangesNotSentWithoutCandidate() {
 136         doReturn(FluentFutures.immediateFluentFuture(new DefaultDOMRpcResult((NormalizedNode) null)))
 137                 .doReturn(FluentFutures.immediateFailedFluentFuture(new IllegalStateException("Failed tx")))
 138                 .when(rpc).invokeRpc(any(QName.class), any(ContainerNode.class));
 139
 140         final WriteRunningTx tx = new WriteRunningTx(id,
 141             new NetconfBaseOps(rpc, BASE_SCHEMAS.getBaseSchemaWithNotifications().getMountPointContext()), false);
 142
 143         tx.delete(LogicalDatastoreType.CONFIGURATION, yangIId);
 144         tx.commit();
 145         // verify discard changes was sent
 146         final InOrder inOrder = inOrder(rpc);
 147         inOrder.verify(rpc).invokeRpc(NetconfMessageTransformUtil.NETCONF_LOCK_QNAME,
 148                 NetconfBaseOps.getLockContent(NETCONF_RUNNING_QNAME));
 149         inOrder.verify(rpc).invokeRpc(eq(NetconfMessageTransformUtil.NETCONF_EDIT_CONFIG_QNAME),
 150                 any(ContainerNode.class));
 151         inOrder.verify(rpc).invokeRpc(NetconfMessageTransformUtil.NETCONF_UNLOCK_QNAME,
 152                 NetconfBaseOps.getUnLockContent(NETCONF_RUNNING_QNAME));
 153     }
 154
 155     @Test
 156     public void testListenerSuccess() throws Exception {
 157         doReturn(FluentFutures.immediateFluentFuture(new DefaultDOMRpcResult((NormalizedNode) null)))
 158                 .when(rpc).invokeRpc(any(QName.class), any(ContainerNode.class));
 159         final WriteCandidateTx tx = new WriteCandidateTx(
 160                 id, new NetconfBaseOps(rpc, BASE_SCHEMAS.getBaseSchema().getMountPointContext()), false);
 161         final TxListener listener = mock(TxListener.class);
 162         tx.addListener(listener);
 163         tx.delete(LogicalDatastoreType.CONFIGURATION, yangIId);
 164         tx.commit();
 165         verify(listener).onTransactionSubmitted(tx);
 166         verify(listener).onTransactionSuccessful(tx);
 167         verify(listener, never()).onTransactionFailed(eq(tx), any());
 168         verify(listener, never()).onTransactionCancelled(tx);
 169     }
 170
 171     @Test
 172     public void testListenerCancellation() throws Exception {
 173         doReturn(FluentFutures.immediateFluentFuture(new DefaultDOMRpcResult((NormalizedNode) null)))
 174                 .when(rpc).invokeRpc(any(QName.class), isNull());
 175         final WriteCandidateTx tx = new WriteCandidateTx(
 176                 id, new NetconfBaseOps(rpc, BASE_SCHEMAS.getBaseSchema().getMountPointContext()), false);
 177         final TxListener listener = mock(TxListener.class);
 178         tx.addListener(listener);
 179         tx.delete(LogicalDatastoreType.CONFIGURATION, yangIId);
 180         tx.cancel();
 181         verify(listener).onTransactionCancelled(tx);
 182         verify(listener, never()).onTransactionSubmitted(tx);
 183         verify(listener, never()).onTransactionSuccessful(tx);
 184         verify(listener, never()).onTransactionFailed(eq(tx), any());
 185     }
 186
 187     @Test
 188     public void testListenerFailure() throws Exception {
 189         final IllegalStateException cause = new IllegalStateException("Failed tx");
 190         doReturn(FluentFutures.immediateFailedFluentFuture(cause))
 191                 .when(rpc).invokeRpc(any(QName.class), any(ContainerNode.class));
 192         final WriteCandidateTx tx = new WriteCandidateTx(
 193                 id, new NetconfBaseOps(rpc, BASE_SCHEMAS.getBaseSchema().getMountPointContext()), false);
 194         final TxListener listener = mock(TxListener.class);
 195         tx.addListener(listener);
 196         tx.delete(LogicalDatastoreType.CONFIGURATION, yangIId);
 197         tx.commit();
 198         final ArgumentCaptor<Exception> excCaptor = ArgumentCaptor.forClass(Exception.class);
 199         verify(listener).onTransactionSubmitted(tx);
 200         verify(listener).onTransactionFailed(eq(tx), excCaptor.capture());
 201         Assert.assertEquals(cause, excCaptor.getValue().getCause().getCause());
 202         verify(listener, never()).onTransactionSuccessful(tx);
 203         verify(listener, never()).onTransactionCancelled(tx);
 204     }
 205 }