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 static org.junit.Assert.assertEquals;
12 import static org.junit.Assert.assertNotNull;
13 import static org.junit.Assert.assertSame;
14 import static org.mockito.Matchers.any;
15 import static org.mockito.Matchers.eq;
16 import static org.mockito.Mockito.inOrder;
17 import static org.mockito.Mockito.mock;
18 import static org.mockito.Mockito.verify;
19 import static org.mockito.Mockito.verifyNoMoreInteractions;
20 import static org.mockito.Mockito.when;
22 import com.google.common.base.Optional;
23 import com.google.common.util.concurrent.CheckedFuture;
24 import com.google.common.util.concurrent.Futures;
25 import java.util.concurrent.Future;
26 import org.junit.Before;
27 import org.junit.Ignore;
28 import org.junit.Test;
29 import org.mockito.InOrder;
30 import org.mockito.Mock;
31 import org.mockito.MockitoAnnotations;
32 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
33 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
34 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
35 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
36 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
37 import org.opendaylight.controller.md.sal.dom.api.DOMDataChangeListener;
38 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadOnlyTransaction;
39 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction;
40 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
41 import org.opendaylight.controller.md.sal.dom.api.DOMMountPoint;
42 import org.opendaylight.controller.sal.core.api.Broker.ConsumerSession;
43 import org.opendaylight.controller.sal.restconf.impl.BrokerFacade;
44 import org.opendaylight.controller.sal.restconf.impl.ControllerContext;
45 import org.opendaylight.controller.sal.restconf.impl.RestconfDocumentedException;
46 import org.opendaylight.controller.sal.restconf.impl.RestconfError;
47 import org.opendaylight.controller.sal.streams.listeners.ListenerAdapter;
48 import org.opendaylight.controller.sal.streams.listeners.Notificator;
49 import org.opendaylight.yangtools.concepts.ListenerRegistration;
50 import org.opendaylight.yangtools.yang.common.QName;
51 import org.opendaylight.yangtools.yang.common.RpcResult;
52 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
53 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
54 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
55 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
56 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
59 * Unit tests for BrokerFacade.
61 * @author Thomas Pantelis
63 public class BrokerFacadeTest {
66 DOMDataBroker domDataBroker;
69 ConsumerSession mockConsumerSession;
72 DOMMountPoint mockMountInstance;
74 BrokerFacade brokerFacade = BrokerFacade.getInstance();
76 CompositeNode dataNode;
78 NormalizedNode<?, ?> dummyNode = createDummyNode("test:module", "2014-01-09", "interfaces");
79 CheckedFuture<Optional<NormalizedNode<?, ?>>,ReadFailedException> dummyNodeInFuture = wrapDummyNode(dummyNode);
81 QName qname = TestUtils.buildQName("interfaces","test:module", "2014-01-09");
83 YangInstanceIdentifier instanceID = YangInstanceIdentifier.builder().node(qname).toInstance();
86 DOMDataReadOnlyTransaction rTransaction;
89 DOMDataWriteTransaction wTransaction;
92 DOMDataReadWriteTransaction rwTransaction;
95 public void setUp() throws Exception {
96 MockitoAnnotations.initMocks(this);
97 // TODO it is started before every test method
98 brokerFacade.setDomDataBroker(domDataBroker);
99 brokerFacade.setContext(mockConsumerSession);
100 when(domDataBroker.newReadOnlyTransaction()).thenReturn(rTransaction);
101 when(domDataBroker.newWriteOnlyTransaction()).thenReturn(wTransaction);
102 when(domDataBroker.newReadWriteTransaction()).thenReturn(rwTransaction);
104 dataNode = TestUtils.prepareCompositeNodeWithIetfInterfacesInterfacesData();
106 ControllerContext.getInstance().setSchemas(TestUtils.loadSchemaContext("/full-versions/test-module"));
110 private CheckedFuture<Optional<NormalizedNode<?, ?>>,ReadFailedException> wrapDummyNode(final NormalizedNode<?, ?> dummyNode) {
111 return Futures.immediateCheckedFuture(Optional.<NormalizedNode<?, ?>> of(dummyNode));
114 private CheckedFuture<Boolean,ReadFailedException> wrapExistence(Boolean exists) {
115 return Futures.immediateCheckedFuture(exists);
120 * Value of this node shouldn't be important for testing purposes
122 private NormalizedNode<?, ?> createDummyNode(final String namespace, final String date, final String localName) {
123 return Builders.containerBuilder()
124 .withNodeIdentifier(new NodeIdentifier(QName.create(namespace, date, localName))).build();
128 public void testReadConfigurationData() {
129 when(rTransaction.read(any(LogicalDatastoreType.class), any(YangInstanceIdentifier.class))).thenReturn(
132 NormalizedNode<?, ?> actualNode = brokerFacade.readConfigurationData(instanceID);
134 assertSame("readConfigurationData", dummyNode, actualNode);
138 public void testReadOperationalData() {
139 when(rTransaction.read(any(LogicalDatastoreType.class), any(YangInstanceIdentifier.class))).thenReturn(
142 NormalizedNode<?, ?> actualNode = brokerFacade.readOperationalData(instanceID);
144 assertSame("readOperationalData", dummyNode, actualNode);
147 @Test(expected = RestconfDocumentedException.class)
148 public void testReadOperationalDataWithNoDataBroker() {
149 brokerFacade.setDomDataBroker(null);
151 brokerFacade.readOperationalData(instanceID);
154 @SuppressWarnings("unchecked")
156 public void testInvokeRpc() throws Exception {
157 RpcResult<CompositeNode> expResult = mock(RpcResult.class);
158 Future<RpcResult<CompositeNode>> future = Futures.immediateFuture(expResult);
159 when(mockConsumerSession.rpc(qname, dataNode)).thenReturn(future);
161 Future<RpcResult<CompositeNode>> actualFuture = brokerFacade.invokeRpc(qname, dataNode);
162 assertNotNull("Future is null", actualFuture);
163 RpcResult<CompositeNode> actualResult = actualFuture.get();
165 assertSame("invokeRpc", expResult, actualResult);
168 @Test(expected = RestconfDocumentedException.class)
169 public void testInvokeRpcWithNoConsumerSession() {
170 brokerFacade.setContext(null);
172 brokerFacade.invokeRpc(qname, dataNode);
177 public void testCommitConfigurationDataPut() {
178 CheckedFuture<Void, TransactionCommitFailedException> expFuture = mock(CheckedFuture.class);
180 when(wTransaction.submit()).thenReturn(expFuture);
182 Future<Void> actualFuture = brokerFacade.commitConfigurationDataPut(instanceID, dummyNode);
184 assertSame("commitConfigurationDataPut", expFuture, actualFuture);
186 InOrder inOrder = inOrder(domDataBroker, wTransaction);
187 inOrder.verify(domDataBroker).newWriteOnlyTransaction();
188 inOrder.verify(wTransaction).put(LogicalDatastoreType.CONFIGURATION, instanceID, dummyNode);
189 inOrder.verify(wTransaction).submit();
193 public void testCommitConfigurationDataPost() {
194 CheckedFuture<Void, TransactionCommitFailedException> expFuture = mock(CheckedFuture.class);
196 NormalizedNode<?, ?> dummyNode2 = createDummyNode("dummy:namespace2", "2014-07-01", "dummy local name2");
198 when(rwTransaction.read(eq(LogicalDatastoreType.CONFIGURATION), any(YangInstanceIdentifier.class))).thenReturn(
199 wrapDummyNode(dummyNode2));
201 when(rwTransaction.exists(eq(LogicalDatastoreType.CONFIGURATION), any(YangInstanceIdentifier.class))).thenReturn(
202 wrapExistence(true));
205 when(rwTransaction.submit()).thenReturn(expFuture);
207 CheckedFuture<Void, TransactionCommitFailedException> actualFuture = brokerFacade.commitConfigurationDataPost(
208 instanceID, dummyNode);
210 assertSame("commitConfigurationDataPost", expFuture, actualFuture);
212 InOrder inOrder = inOrder(domDataBroker, rwTransaction);
213 inOrder.verify(domDataBroker).newReadWriteTransaction();
214 inOrder.verify(rwTransaction).merge(LogicalDatastoreType.CONFIGURATION, instanceID, dummyNode);
215 inOrder.verify(rwTransaction).submit();
218 @Test(expected = RestconfDocumentedException.class)
219 public void testCommitConfigurationDataPostAlreadyExists() {
220 when(rwTransaction.read(eq(LogicalDatastoreType.CONFIGURATION), any(YangInstanceIdentifier.class))).thenReturn(
223 brokerFacade.commitConfigurationDataPost(instanceID, dummyNode);
224 } catch (RestconfDocumentedException e) {
225 assertEquals("getErrorTag", RestconfError.ErrorTag.DATA_EXISTS, e.getErrors().get(0).getErrorTag());
231 public void testCommitConfigurationDataDelete() {
232 CheckedFuture<Void, TransactionCommitFailedException> expFuture = mock(CheckedFuture.class);
234 when(wTransaction.submit()).thenReturn(expFuture);
236 NormalizedNode<?, ?> dummyNode2 = createDummyNode("dummy:namespace2", "2014-07-01", "dummy local name2");
239 CheckedFuture<Void, TransactionCommitFailedException> actualFuture = brokerFacade
240 .commitConfigurationDataDelete(instanceID);
242 assertSame("commitConfigurationDataDelete", expFuture, actualFuture);
244 InOrder inOrder = inOrder(domDataBroker, wTransaction);
245 inOrder.verify(domDataBroker).newWriteOnlyTransaction();
246 inOrder.verify(wTransaction).delete(eq(LogicalDatastoreType.CONFIGURATION), any(YangInstanceIdentifier.class));
247 inOrder.verify(wTransaction).submit();
250 @SuppressWarnings("unchecked")
252 public void testRegisterToListenDataChanges() {
253 ListenerAdapter listener = Notificator.createListener(instanceID, "stream");
255 ListenerRegistration<DOMDataChangeListener> mockRegistration = mock(ListenerRegistration.class);
258 domDataBroker.registerDataChangeListener(any(LogicalDatastoreType.class), eq(instanceID), eq(listener),
259 eq(DataChangeScope.BASE))).thenReturn(mockRegistration);
261 brokerFacade.registerToListenDataChanges(LogicalDatastoreType.CONFIGURATION, DataChangeScope.BASE, listener);
263 verify(domDataBroker).registerDataChangeListener(LogicalDatastoreType.CONFIGURATION, instanceID, listener,
264 DataChangeScope.BASE);
266 assertEquals("isListening", true, listener.isListening());
268 brokerFacade.registerToListenDataChanges(LogicalDatastoreType.CONFIGURATION, DataChangeScope.BASE, listener);
269 verifyNoMoreInteractions(domDataBroker);