2 * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.netconf.topology.singleton.impl.tx;
11 import static junit.framework.TestCase.assertNull;
12 import static org.junit.Assert.assertEquals;
13 import static org.junit.Assert.assertTrue;
14 import static org.mockito.Matchers.any;
15 import static org.mockito.Mockito.doNothing;
16 import static org.mockito.Mockito.doReturn;
17 import static org.mockito.Mockito.mock;
18 import static org.mockito.Mockito.times;
19 import static org.mockito.Mockito.verify;
20 import static org.mockito.MockitoAnnotations.initMocks;
21 import static org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologyUtils.DEFAULT_SCHEMA_REPOSITORY;
23 import akka.actor.ActorRef;
24 import akka.actor.ActorSystem;
25 import akka.actor.Props;
26 import akka.pattern.Patterns;
27 import akka.testkit.JavaTestKit;
28 import akka.testkit.TestActorRef;
29 import akka.util.Timeout;
30 import com.google.common.collect.Lists;
31 import com.google.common.util.concurrent.CheckedFuture;
32 import com.google.common.util.concurrent.Futures;
33 import java.net.InetAddress;
34 import java.net.InetSocketAddress;
35 import java.net.UnknownHostException;
36 import java.util.List;
37 import java.util.concurrent.TimeUnit;
38 import org.junit.After;
39 import org.junit.Before;
40 import org.junit.Rule;
41 import org.junit.Test;
42 import org.junit.rules.ExpectedException;
43 import org.mockito.Mock;
44 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
45 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
46 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
47 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadOnlyTransaction;
48 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
49 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
50 import org.opendaylight.netconf.topology.singleton.api.NetconfDOMTransaction;
51 import org.opendaylight.netconf.topology.singleton.impl.NetconfDOMDataBroker;
52 import org.opendaylight.netconf.topology.singleton.impl.actors.NetconfNodeActor;
53 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologySetup;
54 import org.opendaylight.netconf.topology.singleton.messages.CreateInitialMasterActorData;
55 import org.opendaylight.netconf.topology.singleton.messages.MasterActorDataInitialized;
56 import org.opendaylight.yangtools.yang.common.QName;
57 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
58 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
59 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
60 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
61 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
62 import scala.concurrent.Await;
63 import scala.concurrent.Future;
64 import scala.concurrent.duration.Duration;
66 public class WriteOnlyTransactionTest {
67 private static final Timeout TIMEOUT = new Timeout(Duration.create(5, "seconds"));
68 private static final int TIMEOUT_SEC = 5;
69 private static ActorSystem system;
72 public final ExpectedException exception = ExpectedException.none();
74 private ActorRef masterRef;
75 private NetconfDOMDataBroker slaveDataBroker;
76 private DOMDataBroker masterDataBroker;
77 private List<SourceIdentifier> sourceIdentifiers;
80 private DOMDataWriteTransaction writeTx;
83 public void setup() throws UnknownHostException {
86 system = ActorSystem.create();
88 final RemoteDeviceId remoteDeviceId = new RemoteDeviceId("netconf-topology",
89 new InetSocketAddress(InetAddress.getByName("127.0.0.1"), 9999));
91 final NetconfTopologySetup setup = mock(NetconfTopologySetup.class);
92 final Props props = NetconfNodeActor.props(setup, remoteDeviceId, DEFAULT_SCHEMA_REPOSITORY,
93 DEFAULT_SCHEMA_REPOSITORY);
95 masterRef = TestActorRef.create(system, props, "master_read");
97 sourceIdentifiers = Lists.newArrayList();
99 // Create master data broker
101 final DOMDataBroker delegateDataBroker = mock(DOMDataBroker.class);
102 writeTx = mock(DOMDataWriteTransaction.class);
103 final DOMDataReadOnlyTransaction readTx = mock(DOMDataReadOnlyTransaction.class);
105 doReturn(writeTx).when(delegateDataBroker).newWriteOnlyTransaction();
106 doReturn(readTx).when(delegateDataBroker).newReadOnlyTransaction();
108 final NetconfDOMTransaction masterDOMTransactions =
109 new NetconfMasterDOMTransaction(delegateDataBroker);
112 new NetconfDOMDataBroker(system, remoteDeviceId, masterDOMTransactions);
114 // Create slave data broker for testing proxy
116 final NetconfDOMTransaction proxyDOMTransactions =
117 new NetconfProxyDOMTransaction(system, masterRef);
119 slaveDataBroker = new NetconfDOMDataBroker(system, remoteDeviceId, proxyDOMTransactions);
125 public void teardown() {
126 JavaTestKit.shutdownActorSystem(system);
131 public void testPutMergeDeleteCalls() throws Exception {
133 /* Initialize data on master */
135 initializeDataTest();
137 final YangInstanceIdentifier instanceIdentifier = YangInstanceIdentifier.EMPTY;
138 final LogicalDatastoreType storeType = LogicalDatastoreType.CONFIGURATION;
139 final NormalizedNode<?, ?> testNode = ImmutableContainerNodeBuilder.create()
140 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(QName.create("TestQname")))
141 .withChild(ImmutableNodes.leafNode(QName.create("NodeQname"), "foo")).build();
143 // Test of invoking put on master through slave proxy
145 doNothing().when(writeTx).put(storeType, instanceIdentifier, testNode);
146 slaveDataBroker.newWriteOnlyTransaction().put(storeType, instanceIdentifier, testNode);
148 verify(writeTx, times(1)).put(storeType, instanceIdentifier, testNode);
150 // Test of invoking merge on master through slave proxy
152 doNothing().when(writeTx).merge(storeType, instanceIdentifier, testNode);
153 slaveDataBroker.newWriteOnlyTransaction().merge(storeType, instanceIdentifier, testNode);
155 verify(writeTx, times(1)).merge(storeType, instanceIdentifier, testNode);
157 // Test of invoking delete on master through slave proxy
159 doNothing().when(writeTx).delete(storeType, instanceIdentifier);
160 slaveDataBroker.newWriteOnlyTransaction().delete(storeType, instanceIdentifier);
162 verify(writeTx, times(1)).delete(storeType, instanceIdentifier);
167 public void testSubmit() throws Exception {
169 /* Initialize data on master */
171 initializeDataTest();
175 final CheckedFuture<Void,TransactionCommitFailedException> resultSubmit = Futures.immediateCheckedFuture(null);
176 doReturn(resultSubmit).when(writeTx).submit();
178 final CheckedFuture<Void, TransactionCommitFailedException> resultSubmitResponse =
179 slaveDataBroker.newWriteOnlyTransaction().submit();
181 final Object result= resultSubmitResponse.checkedGet(TIMEOUT_SEC, TimeUnit.SECONDS);
187 doNothing().when(writeTx).delete(any(), any());
188 slaveDataBroker.newWriteOnlyTransaction().delete(LogicalDatastoreType.CONFIGURATION,
189 YangInstanceIdentifier.EMPTY);
191 final CheckedFuture<Void,TransactionCommitFailedException> resultSubmitTx = Futures.immediateCheckedFuture(null);
192 doReturn(resultSubmitTx).when(writeTx).submit();
194 final CheckedFuture<Void, TransactionCommitFailedException> resultSubmitTxResponse =
195 slaveDataBroker.newWriteOnlyTransaction().submit();
197 final Object resultTx = resultSubmitTxResponse.checkedGet(TIMEOUT_SEC, TimeUnit.SECONDS);
199 assertNull(resultTx);
201 slaveDataBroker.newWriteOnlyTransaction().delete(LogicalDatastoreType.CONFIGURATION,
202 YangInstanceIdentifier.EMPTY);
204 final TransactionCommitFailedException throwable = new TransactionCommitFailedException("Fail", null);
205 final CheckedFuture<Void,TransactionCommitFailedException> resultThrowable =
206 Futures.immediateFailedCheckedFuture(throwable);
208 doReturn(resultThrowable).when(writeTx).submit();
210 final CheckedFuture<Void, TransactionCommitFailedException> resultThrowableResponse =
211 slaveDataBroker.newWriteOnlyTransaction().submit();
213 exception.expect(TransactionCommitFailedException.class);
214 resultThrowableResponse.checkedGet(TIMEOUT_SEC, TimeUnit.SECONDS);
218 public void testCancel() throws Exception {
220 /* Initialize data on master */
222 initializeDataTest();
226 final Boolean resultFalseNoTx = slaveDataBroker.newWriteOnlyTransaction().cancel();
227 assertEquals(false, resultFalseNoTx);
229 // With Tx, readWriteTx test
231 doNothing().when(writeTx).delete(any(), any());
232 slaveDataBroker.newReadWriteTransaction().delete(LogicalDatastoreType.CONFIGURATION,
233 YangInstanceIdentifier.EMPTY);
235 doReturn(true).when(writeTx).cancel();
237 final Boolean resultTrue = slaveDataBroker.newWriteOnlyTransaction().cancel();
238 assertEquals(true, resultTrue);
240 doReturn(false).when(writeTx).cancel();
242 final Boolean resultFalse = slaveDataBroker.newWriteOnlyTransaction().cancel();
243 assertEquals(false, resultFalse);
247 private void initializeDataTest() throws Exception {
248 final Future<Object> initialDataToActor =
249 Patterns.ask(masterRef, new CreateInitialMasterActorData(masterDataBroker, sourceIdentifiers),
252 final Object success = Await.result(initialDataToActor, TIMEOUT.duration());
254 assertTrue(success instanceof MasterActorDataInitialized);