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
   9 package org.opendaylight.netconf.sal.connect.netconf.sal.tx;
  10
  11 import static org.junit.Assert.fail;
  12 import static org.mockito.Matchers.any;
  13 import static org.mockito.Matchers.eq;
  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 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.toPath;
  24
  25 import com.google.common.util.concurrent.CheckedFuture;
  26 import com.google.common.util.concurrent.Futures;
  27 import java.net.InetSocketAddress;
  28 import org.junit.Assert;
  29 import org.junit.Before;
  30 import org.junit.Test;
  31 import org.mockito.ArgumentCaptor;
  32 import org.mockito.InOrder;
  33 import org.mockito.Mock;
  34 import org.mockito.MockitoAnnotations;
  35 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  36 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  37 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
  38 import org.opendaylight.controller.md.sal.dom.spi.DefaultDOMRpcResult;
  39 import org.opendaylight.netconf.sal.connect.netconf.schema.mapping.BaseSchema;
  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.yang.common.RpcError;
  45 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  46 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  47 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  48 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  49 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  50 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  51 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  52
  53 public class NetconfDeviceWriteOnlyTxTest {
  54
  55     private final RemoteDeviceId id = new RemoteDeviceId("test-mount", new InetSocketAddress(99));
  56
  57     @Mock
  58     private DOMRpcService rpc;
  59     private YangInstanceIdentifier yangIId;
  60
  61     @Before
  62     public void setUp() throws Exception {
  63         MockitoAnnotations.initMocks(this);
  64
  65         final CheckedFuture<DefaultDOMRpcResult, Exception> successFuture =
  66                 Futures.immediateCheckedFuture(new DefaultDOMRpcResult(((NormalizedNode<?, ?>) null)));
  67
  68         doReturn(successFuture)
  69                 .doReturn(Futures.immediateFailedCheckedFuture(new IllegalStateException("Failed tx")))
  70                 .doReturn(successFuture)
  71                 .when(rpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
  72
  73         yangIId = YangInstanceIdentifier.builder().node(NetconfState.QNAME).build();
  74     }
  75
  76     @Test
  77     public void testIgnoreNonVisibleData() {
  78         final WriteCandidateTx tx = new WriteCandidateTx(id, new NetconfBaseOps(rpc, mock(SchemaContext.class)),
  79                 false);
  80         final MapNode emptyList = ImmutableNodes.mapNodeBuilder(NETCONF_FILTER_QNAME).build();
  81         tx.merge(LogicalDatastoreType.CONFIGURATION, YangInstanceIdentifier
  82                 .create(new YangInstanceIdentifier.NodeIdentifier(NETCONF_FILTER_QNAME)), emptyList);
  83         tx.put(LogicalDatastoreType.CONFIGURATION, YangInstanceIdentifier
  84                 .create(new YangInstanceIdentifier.NodeIdentifier(NETCONF_FILTER_QNAME)), emptyList);
  85
  86         verify(rpc, atMost(1)).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
  87     }
  88
  89     @Test
  90     public void testDiscardChanges() {
  91         final WriteCandidateTx tx = new WriteCandidateTx(id, new NetconfBaseOps(rpc, mock(SchemaContext.class)),
  92                 false);
  93         final CheckedFuture<Void, TransactionCommitFailedException> submitFuture = tx.submit();
  94         try {
  95             submitFuture.checkedGet();
  96         } catch (final TransactionCommitFailedException e) {
  97             // verify discard changes was sent
  98             final InOrder inOrder = inOrder(rpc);
  99             inOrder.verify(rpc).invokeRpc(toPath(NetconfMessageTransformUtil.NETCONF_LOCK_QNAME),
 100                     NetconfBaseOps.getLockContent(NETCONF_CANDIDATE_QNAME));
 101             inOrder.verify(rpc).invokeRpc(toPath(NetconfMessageTransformUtil.NETCONF_COMMIT_QNAME),
 102                     NetconfMessageTransformUtil.COMMIT_RPC_CONTENT);
 103             inOrder.verify(rpc).invokeRpc(eq(toPath(NetconfMessageTransformUtil.NETCONF_DISCARD_CHANGES_QNAME)),
 104                     any(NormalizedNode.class));
 105             inOrder.verify(rpc).invokeRpc(toPath(NetconfMessageTransformUtil.NETCONF_UNLOCK_QNAME),
 106                     NetconfBaseOps.getUnLockContent(NETCONF_CANDIDATE_QNAME));
 107             return;
 108         }
 109
 110         fail("Submit should fail");
 111     }
 112
 113     @Test
 114     public void testFailedCommit() throws Exception {
 115         final CheckedFuture<DefaultDOMRpcResult, Exception> rpcErrorFuture = Futures.immediateCheckedFuture(
 116                 new DefaultDOMRpcResult(RpcResultBuilder.newError(RpcError.ErrorType.APPLICATION, "a", "m")));
 117
 118         doReturn(Futures.immediateCheckedFuture(new DefaultDOMRpcResult(((NormalizedNode<?, ?>) null))))
 119         .doReturn(rpcErrorFuture).when(rpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 120
 121         final WriteCandidateTx tx = new WriteCandidateTx(id, new NetconfBaseOps(rpc, mock(SchemaContext.class)),
 122                 false);
 123
 124         final CheckedFuture<Void, TransactionCommitFailedException> submitFuture = tx.submit();
 125         try {
 126             submitFuture.checkedGet();
 127         } catch (final TransactionCommitFailedException e) {
 128             return;
 129         }
 130
 131         fail("Submit should fail");
 132     }
 133
 134     @Test
 135     public void testDiscardChangesNotSentWithoutCandidate() {
 136         doReturn(Futures.immediateCheckedFuture(new DefaultDOMRpcResult((NormalizedNode<?, ?>) null)))
 137                 .doReturn(Futures.immediateFailedCheckedFuture(new IllegalStateException("Failed tx")))
 138                 .when(rpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 139
 140         final WriteRunningTx tx = new WriteRunningTx(
 141                 id, new NetconfBaseOps(rpc, BaseSchema.BASE_NETCONF_CTX_WITH_NOTIFICATIONS.getSchemaContext()), false);
 142
 143         tx.delete(LogicalDatastoreType.CONFIGURATION, yangIId);
 144         tx.submit();
 145         // verify discard changes was sent
 146         final InOrder inOrder = inOrder(rpc);
 147         inOrder.verify(rpc).invokeRpc(toPath(NetconfMessageTransformUtil.NETCONF_LOCK_QNAME),
 148                 NetconfBaseOps.getLockContent(NETCONF_RUNNING_QNAME));
 149         inOrder.verify(rpc).invokeRpc(eq(toPath(NetconfMessageTransformUtil.NETCONF_EDIT_CONFIG_QNAME)),
 150                 any(NormalizedNode.class));
 151         inOrder.verify(rpc).invokeRpc(toPath(NetconfMessageTransformUtil.NETCONF_UNLOCK_QNAME),
 152                 NetconfBaseOps.getUnLockContent(NETCONF_RUNNING_QNAME));
 153     }
 154
 155     @Test
 156     public void testListenerSuccess() throws Exception {
 157         doReturn(Futures.immediateCheckedFuture(new DefaultDOMRpcResult((NormalizedNode<?, ?>) null)))
 158                 .when(rpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 159         final WriteCandidateTx tx = new WriteCandidateTx(
 160                 id, new NetconfBaseOps(rpc, BaseSchema.BASE_NETCONF_CTX.getSchemaContext()), false);
 161         final TxListener listener = mock(TxListener.class);
 162         tx.addListener(listener);
 163         tx.delete(LogicalDatastoreType.CONFIGURATION, yangIId);
 164         tx.submit();
 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(Futures.immediateCheckedFuture(new DefaultDOMRpcResult((NormalizedNode<?, ?>) null)))
 174                 .when(rpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 175         final WriteCandidateTx tx = new WriteCandidateTx(
 176                 id, new NetconfBaseOps(rpc, BaseSchema.BASE_NETCONF_CTX.getSchemaContext()), 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(Futures.immediateFailedCheckedFuture(cause))
 191                 .when(rpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 192         final WriteCandidateTx tx = new WriteCandidateTx(
 193                 id, new NetconfBaseOps(rpc, BaseSchema.BASE_NETCONF_CTX.getSchemaContext()), false);
 194         final TxListener listener = mock(TxListener.class);
 195         tx.addListener(listener);
 196         tx.delete(LogicalDatastoreType.CONFIGURATION, yangIId);
 197         tx.submit();
 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 }