2 * Copyright (c) ${year} Brocade Communications 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.controller.sal.restconf.impl.test;
11 import com.google.common.base.Optional;
12 import com.google.common.util.concurrent.CheckedFuture;
13 import com.google.common.util.concurrent.Futures;
14 import org.junit.Before;
15 import org.junit.Ignore;
16 import org.junit.Test;
17 import org.mockito.InOrder;
18 import org.mockito.Mock;
19 import org.mockito.MockitoAnnotations;
20 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
21 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
22 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
23 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
24 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
25 import org.opendaylight.controller.md.sal.dom.api.DOMDataChangeListener;
26 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadOnlyTransaction;
27 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction;
28 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
29 import org.opendaylight.controller.md.sal.dom.api.DOMMountPoint;
30 import org.opendaylight.controller.sal.core.api.Broker.ConsumerSession;
31 import org.opendaylight.controller.sal.restconf.impl.BrokerFacade;
32 import org.opendaylight.controller.sal.restconf.impl.ControllerContext;
33 import org.opendaylight.controller.sal.restconf.impl.RestconfDocumentedException;
34 import org.opendaylight.controller.sal.restconf.impl.RestconfError;
35 import org.opendaylight.controller.sal.streams.listeners.ListenerAdapter;
36 import org.opendaylight.controller.sal.streams.listeners.Notificator;
37 import org.opendaylight.yangtools.concepts.ListenerRegistration;
38 import org.opendaylight.yangtools.yang.common.QName;
39 import org.opendaylight.yangtools.yang.common.RpcResult;
40 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
41 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
42 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
43 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
44 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
46 import java.util.concurrent.Future;
48 import static org.junit.Assert.assertEquals;
49 import static org.junit.Assert.assertNotNull;
50 import static org.junit.Assert.assertSame;
51 import static org.mockito.Matchers.any;
52 import static org.mockito.Matchers.eq;
53 import static org.mockito.Mockito.inOrder;
54 import static org.mockito.Mockito.mock;
55 import static org.mockito.Mockito.verify;
56 import static org.mockito.Mockito.verifyNoMoreInteractions;
57 import static org.mockito.Mockito.when;
60 * Unit tests for BrokerFacade.
62 * @author Thomas Pantelis
64 public class BrokerFacadeTest {
67 DOMDataBroker domDataBroker;
70 ConsumerSession mockConsumerSession;
73 DOMMountPoint mockMountInstance;
75 BrokerFacade brokerFacade = BrokerFacade.getInstance();
77 CompositeNode dataNode;
79 NormalizedNode<?, ?> dummyNode = createDummyNode("test:module", "2014-01-09", "interfaces");
80 CheckedFuture<Optional<NormalizedNode<?, ?>>,ReadFailedException> dummyNodeInFuture = wrapDummyNode(dummyNode);
82 QName qname = TestUtils.buildQName("interfaces","test:module", "2014-01-09");
84 YangInstanceIdentifier instanceID = YangInstanceIdentifier.builder().node(qname).toInstance();
87 DOMDataReadOnlyTransaction rTransaction;
90 DOMDataWriteTransaction wTransaction;
93 DOMDataReadWriteTransaction rwTransaction;
96 public void setUp() throws Exception {
97 MockitoAnnotations.initMocks(this);
98 // TODO it is started before every test method
99 brokerFacade.setDomDataBroker(domDataBroker);
100 brokerFacade.setContext(mockConsumerSession);
101 when(domDataBroker.newReadOnlyTransaction()).thenReturn(rTransaction);
102 when(domDataBroker.newWriteOnlyTransaction()).thenReturn(wTransaction);
103 when(domDataBroker.newReadWriteTransaction()).thenReturn(rwTransaction);
105 dataNode = TestUtils.prepareCompositeNodeWithIetfInterfacesInterfacesData();
107 ControllerContext.getInstance().setSchemas(TestUtils.loadSchemaContext("/full-versions/test-module"));
111 private CheckedFuture<Optional<NormalizedNode<?, ?>>,ReadFailedException> wrapDummyNode(final NormalizedNode<?, ?> dummyNode) {
112 return Futures.immediateCheckedFuture(Optional.<NormalizedNode<?, ?>> of(dummyNode));
115 private CheckedFuture<Boolean,ReadFailedException> wrapExistence(Boolean exists) {
116 return Futures.immediateCheckedFuture(exists);
121 * Value of this node shouldn't be important for testing purposes
123 private NormalizedNode<?, ?> createDummyNode(final String namespace, final String date, final String localName) {
124 return Builders.containerBuilder()
125 .withNodeIdentifier(new NodeIdentifier(QName.create(namespace, date, localName))).build();
129 public void testReadConfigurationData() {
130 when(rTransaction.read(any(LogicalDatastoreType.class), any(YangInstanceIdentifier.class))).thenReturn(
133 NormalizedNode<?, ?> actualNode = brokerFacade.readConfigurationData(instanceID);
135 assertSame("readConfigurationData", dummyNode, actualNode);
139 public void testReadOperationalData() {
140 when(rTransaction.read(any(LogicalDatastoreType.class), any(YangInstanceIdentifier.class))).thenReturn(
143 NormalizedNode<?, ?> actualNode = brokerFacade.readOperationalData(instanceID);
145 assertSame("readOperationalData", dummyNode, actualNode);
148 @Test(expected = RestconfDocumentedException.class)
149 public void testReadOperationalDataWithNoDataBroker() {
150 brokerFacade.setDomDataBroker(null);
152 brokerFacade.readOperationalData(instanceID);
155 @SuppressWarnings("unchecked")
157 public void testInvokeRpc() throws Exception {
158 RpcResult<CompositeNode> expResult = mock(RpcResult.class);
159 Future<RpcResult<CompositeNode>> future = Futures.immediateFuture(expResult);
160 when(mockConsumerSession.rpc(qname, dataNode)).thenReturn(future);
162 Future<RpcResult<CompositeNode>> actualFuture = brokerFacade.invokeRpc(qname, dataNode);
163 assertNotNull("Future is null", actualFuture);
164 RpcResult<CompositeNode> actualResult = actualFuture.get();
166 assertSame("invokeRpc", expResult, actualResult);
169 @Test(expected = RestconfDocumentedException.class)
170 public void testInvokeRpcWithNoConsumerSession() {
171 brokerFacade.setContext(null);
173 brokerFacade.invokeRpc(qname, dataNode);
178 public void testCommitConfigurationDataPut() {
179 CheckedFuture<Void, TransactionCommitFailedException> expFuture = mock(CheckedFuture.class);
181 when(wTransaction.submit()).thenReturn(expFuture);
183 Future<Void> actualFuture = brokerFacade.commitConfigurationDataPut(instanceID, dummyNode);
185 assertSame("commitConfigurationDataPut", expFuture, actualFuture);
187 InOrder inOrder = inOrder(domDataBroker, wTransaction);
188 inOrder.verify(domDataBroker).newWriteOnlyTransaction();
189 inOrder.verify(wTransaction).put(LogicalDatastoreType.CONFIGURATION, instanceID, dummyNode);
190 inOrder.verify(wTransaction).submit();
194 public void testCommitConfigurationDataPost() {
195 CheckedFuture<Void, TransactionCommitFailedException> expFuture = mock(CheckedFuture.class);
197 NormalizedNode<?, ?> dummyNode2 = createDummyNode("dummy:namespace2", "2014-07-01", "dummy local name2");
199 when(rwTransaction.read(eq(LogicalDatastoreType.CONFIGURATION), any(YangInstanceIdentifier.class))).thenReturn(
200 wrapDummyNode(dummyNode2));
202 when(rwTransaction.exists(eq(LogicalDatastoreType.CONFIGURATION), any(YangInstanceIdentifier.class))).thenReturn(
203 wrapExistence(true));
206 when(rwTransaction.submit()).thenReturn(expFuture);
208 CheckedFuture<Void, TransactionCommitFailedException> actualFuture = brokerFacade.commitConfigurationDataPost(
209 instanceID, dummyNode);
211 assertSame("commitConfigurationDataPost", expFuture, actualFuture);
213 InOrder inOrder = inOrder(domDataBroker, rwTransaction);
214 inOrder.verify(domDataBroker).newReadWriteTransaction();
215 inOrder.verify(rwTransaction).merge(LogicalDatastoreType.CONFIGURATION, instanceID, dummyNode);
216 inOrder.verify(rwTransaction).submit();
219 @Test(expected = RestconfDocumentedException.class)
220 public void testCommitConfigurationDataPostAlreadyExists() {
221 when(rwTransaction.read(eq(LogicalDatastoreType.CONFIGURATION), any(YangInstanceIdentifier.class))).thenReturn(
224 brokerFacade.commitConfigurationDataPost(instanceID, dummyNode);
225 } catch (RestconfDocumentedException e) {
226 assertEquals("getErrorTag", RestconfError.ErrorTag.DATA_EXISTS, e.getErrors().get(0).getErrorTag());
232 public void testCommitConfigurationDataDelete() {
233 CheckedFuture<Void, TransactionCommitFailedException> expFuture = mock(CheckedFuture.class);
235 when(wTransaction.submit()).thenReturn(expFuture);
237 CheckedFuture<Void, TransactionCommitFailedException> actualFuture = brokerFacade
238 .commitConfigurationDataDelete(instanceID);
240 assertSame("commitConfigurationDataDelete", expFuture, actualFuture);
242 InOrder inOrder = inOrder(domDataBroker, wTransaction);
243 inOrder.verify(domDataBroker).newWriteOnlyTransaction();
244 inOrder.verify(wTransaction).delete(eq(LogicalDatastoreType.CONFIGURATION), any(YangInstanceIdentifier.class));
245 inOrder.verify(wTransaction).submit();
248 @SuppressWarnings("unchecked")
250 public void testRegisterToListenDataChanges() {
251 ListenerAdapter listener = Notificator.createListener(instanceID, "stream");
253 ListenerRegistration<DOMDataChangeListener> mockRegistration = mock(ListenerRegistration.class);
256 domDataBroker.registerDataChangeListener(any(LogicalDatastoreType.class), eq(instanceID), eq(listener),
257 eq(DataChangeScope.BASE))).thenReturn(mockRegistration);
259 brokerFacade.registerToListenDataChanges(LogicalDatastoreType.CONFIGURATION, DataChangeScope.BASE, listener);
261 verify(domDataBroker).registerDataChangeListener(LogicalDatastoreType.CONFIGURATION, instanceID, listener,
262 DataChangeScope.BASE);
264 assertEquals("isListening", true, listener.isListening());
266 brokerFacade.registerToListenDataChanges(LogicalDatastoreType.CONFIGURATION, DataChangeScope.BASE, listener);
267 verifyNoMoreInteractions(domDataBroker);