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.md.sal.dom.api.DOMRpcException;
43 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
44 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
45 import org.opendaylight.controller.sal.core.api.Broker.ConsumerSession;
46 import org.opendaylight.controller.sal.restconf.impl.BrokerFacade;
47 import org.opendaylight.controller.sal.restconf.impl.ControllerContext;
48 import org.opendaylight.controller.sal.restconf.impl.RestconfDocumentedException;
49 import org.opendaylight.controller.sal.restconf.impl.RestconfError;
50 import org.opendaylight.controller.sal.streams.listeners.ListenerAdapter;
51 import org.opendaylight.controller.sal.streams.listeners.Notificator;
52 import org.opendaylight.yangtools.concepts.ListenerRegistration;
53 import org.opendaylight.yangtools.yang.common.QName;
54 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
55 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
56 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
57 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
58 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
59 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
62 * Unit tests for BrokerFacade.
64 * @author Thomas Pantelis
66 public class BrokerFacadeTest {
69 DOMDataBroker domDataBroker;
72 ConsumerSession context;
75 DOMRpcService mockRpcService;
78 DOMMountPoint mockMountInstance;
80 BrokerFacade brokerFacade = BrokerFacade.getInstance();
82 NormalizedNode<?, ?> dummyNode = createDummyNode("test:module", "2014-01-09", "interfaces");
83 CheckedFuture<Optional<NormalizedNode<?, ?>>,ReadFailedException> dummyNodeInFuture = wrapDummyNode(dummyNode);
85 QName qname = TestUtils.buildQName("interfaces","test:module", "2014-01-09");
87 SchemaPath type = SchemaPath.create(true, qname);
89 YangInstanceIdentifier instanceID = YangInstanceIdentifier.builder().node(qname).build();
92 DOMDataReadOnlyTransaction rTransaction;
95 DOMDataWriteTransaction wTransaction;
98 DOMDataReadWriteTransaction rwTransaction;
101 public void setUp() throws Exception {
102 MockitoAnnotations.initMocks(this);
103 // TODO it is started before every test method
104 brokerFacade.setDomDataBroker(domDataBroker);
105 brokerFacade.setRpcService(mockRpcService);
106 brokerFacade.setContext(context);
107 when(domDataBroker.newReadOnlyTransaction()).thenReturn(rTransaction);
108 when(domDataBroker.newWriteOnlyTransaction()).thenReturn(wTransaction);
109 when(domDataBroker.newReadWriteTransaction()).thenReturn(rwTransaction);
111 ControllerContext.getInstance().setSchemas(TestUtils.loadSchemaContext("/full-versions/test-module"));
115 private CheckedFuture<Optional<NormalizedNode<?, ?>>,ReadFailedException> wrapDummyNode(final NormalizedNode<?, ?> dummyNode) {
116 return Futures.immediateCheckedFuture(Optional.<NormalizedNode<?, ?>> of(dummyNode));
119 private CheckedFuture<Boolean,ReadFailedException> wrapExistence(final Boolean exists) {
120 return Futures.immediateCheckedFuture(exists);
125 * Value of this node shouldn't be important for testing purposes
127 private NormalizedNode<?, ?> createDummyNode(final String namespace, final String date, final String localName) {
128 return Builders.containerBuilder()
129 .withNodeIdentifier(new NodeIdentifier(QName.create(namespace, date, localName))).build();
133 public void testReadConfigurationData() {
134 when(rTransaction.read(any(LogicalDatastoreType.class), any(YangInstanceIdentifier.class))).thenReturn(
137 final NormalizedNode<?, ?> actualNode = brokerFacade.readConfigurationData(instanceID);
139 assertSame("readConfigurationData", dummyNode, actualNode);
143 public void testReadOperationalData() {
144 when(rTransaction.read(any(LogicalDatastoreType.class), any(YangInstanceIdentifier.class))).thenReturn(
147 final NormalizedNode<?, ?> actualNode = brokerFacade.readOperationalData(instanceID);
149 assertSame("readOperationalData", dummyNode, actualNode);
152 @Test(expected = RestconfDocumentedException.class)
153 public void testReadOperationalDataWithNoDataBroker() {
154 brokerFacade.setDomDataBroker(null);
156 brokerFacade.readOperationalData(instanceID);
160 public void testInvokeRpc() throws Exception {
161 final DOMRpcResult expResult = mock(DOMRpcResult.class);
162 final CheckedFuture<DOMRpcResult, DOMRpcException> future = Futures.immediateCheckedFuture(expResult);
163 when(mockRpcService.invokeRpc(type, dummyNode)).thenReturn(future);
165 final CheckedFuture<DOMRpcResult, DOMRpcException> actualFuture = brokerFacade.invokeRpc(type, dummyNode);
166 assertNotNull("Future is null", actualFuture);
167 final DOMRpcResult actualResult = actualFuture.get();
168 assertSame("invokeRpc", expResult, actualResult);
171 @Test(expected = RestconfDocumentedException.class)
172 public void testInvokeRpcWithNoConsumerSession() {
173 brokerFacade.setContext(null);
174 brokerFacade.invokeRpc(type, dummyNode);
179 public void testCommitConfigurationDataPut() {
180 @SuppressWarnings("unchecked")
181 final CheckedFuture<Void, TransactionCommitFailedException> expFuture = mock(CheckedFuture.class);
183 when(wTransaction.submit()).thenReturn(expFuture);
185 final Future<Void> actualFuture = brokerFacade.commitConfigurationDataPut((SchemaContext)null, instanceID, dummyNode);
187 assertSame("commitConfigurationDataPut", expFuture, actualFuture);
189 final InOrder inOrder = inOrder(domDataBroker, wTransaction);
190 inOrder.verify(domDataBroker).newWriteOnlyTransaction();
191 inOrder.verify(wTransaction).put(LogicalDatastoreType.CONFIGURATION, instanceID, dummyNode);
192 inOrder.verify(wTransaction).submit();
196 public void testCommitConfigurationDataPost() {
197 @SuppressWarnings("unchecked")
198 final CheckedFuture<Void, TransactionCommitFailedException> expFuture = mock(CheckedFuture.class);
200 final NormalizedNode<?, ?> dummyNode2 = createDummyNode("dummy:namespace2", "2014-07-01", "dummy local name2");
202 when(rwTransaction.read(eq(LogicalDatastoreType.CONFIGURATION), any(YangInstanceIdentifier.class))).thenReturn(
203 wrapDummyNode(dummyNode2));
205 when(rwTransaction.exists(eq(LogicalDatastoreType.CONFIGURATION), any(YangInstanceIdentifier.class))).thenReturn(
206 wrapExistence(true));
209 when(rwTransaction.submit()).thenReturn(expFuture);
211 final CheckedFuture<Void, TransactionCommitFailedException> actualFuture = brokerFacade.commitConfigurationDataPost(
212 (SchemaContext)null, YangInstanceIdentifier.builder().build(), dummyNode);
214 assertSame("commitConfigurationDataPost", expFuture, actualFuture);
216 final InOrder inOrder = inOrder(domDataBroker, rwTransaction);
217 inOrder.verify(domDataBroker).newReadWriteTransaction();
218 inOrder.verify(rwTransaction).merge(LogicalDatastoreType.CONFIGURATION, instanceID, dummyNode);
219 inOrder.verify(rwTransaction).submit();
222 @Test(expected = RestconfDocumentedException.class)
223 public void testCommitConfigurationDataPostAlreadyExists() {
224 when(rwTransaction.read(eq(LogicalDatastoreType.CONFIGURATION), any(YangInstanceIdentifier.class))).thenReturn(
227 // Schema context is only necessary for ensuring parent structure
228 brokerFacade.commitConfigurationDataPost((SchemaContext)null, instanceID, dummyNode);
229 } catch (final RestconfDocumentedException e) {
230 assertEquals("getErrorTag", RestconfError.ErrorTag.DATA_EXISTS, e.getErrors().get(0).getErrorTag());
236 public void testCommitConfigurationDataDelete() {
237 @SuppressWarnings("unchecked")
238 final CheckedFuture<Void, TransactionCommitFailedException> expFuture = mock(CheckedFuture.class);
240 when(wTransaction.submit()).thenReturn(expFuture);
242 final CheckedFuture<Void, TransactionCommitFailedException> actualFuture = brokerFacade
243 .commitConfigurationDataDelete(instanceID);
245 assertSame("commitConfigurationDataDelete", expFuture, actualFuture);
247 final InOrder inOrder = inOrder(domDataBroker, wTransaction);
248 inOrder.verify(domDataBroker).newWriteOnlyTransaction();
249 inOrder.verify(wTransaction).delete(eq(LogicalDatastoreType.CONFIGURATION), any(YangInstanceIdentifier.class));
250 inOrder.verify(wTransaction).submit();
253 @SuppressWarnings("unchecked")
255 public void testRegisterToListenDataChanges() {
256 final ListenerAdapter listener = Notificator.createListener(instanceID, "stream");
258 final ListenerRegistration<DOMDataChangeListener> mockRegistration = mock(ListenerRegistration.class);
261 domDataBroker.registerDataChangeListener(any(LogicalDatastoreType.class), eq(instanceID), eq(listener),
262 eq(DataChangeScope.BASE))).thenReturn(mockRegistration);
264 brokerFacade.registerToListenDataChanges(LogicalDatastoreType.CONFIGURATION, DataChangeScope.BASE, listener);
266 verify(domDataBroker).registerDataChangeListener(LogicalDatastoreType.CONFIGURATION, instanceID, listener,
267 DataChangeScope.BASE);
269 assertEquals("isListening", true, listener.isListening());
271 brokerFacade.registerToListenDataChanges(LogicalDatastoreType.CONFIGURATION, DataChangeScope.BASE, listener);
272 verifyNoMoreInteractions(domDataBroker);