restconf/sal-rest-connector/src/test/java/org/opendaylight/controller/sal/restconf/impl/test/BrokerFacadeTest.java

   1 /*
   2  * Copyright (c) 2014, 2015 Brocade Communications 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.controller.sal.restconf.impl.test;
  10
  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.times;
  19 import static org.mockito.Mockito.verify;
  20 import static org.mockito.Mockito.verifyNoMoreInteractions;
  21 import static org.mockito.Mockito.when;
  22
  23 import com.google.common.base.Optional;
  24 import com.google.common.collect.Lists;
  25 import com.google.common.util.concurrent.CheckedFuture;
  26 import com.google.common.util.concurrent.Futures;
  27 import java.util.concurrent.Future;
  28 import org.junit.Before;
  29 import org.junit.Ignore;
  30 import org.junit.Test;
  31 import org.mockito.InOrder;
  32 import org.mockito.Mock;
  33 import org.mockito.MockitoAnnotations;
  34 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
  35 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  36 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  37 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  38 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
  39 import org.opendaylight.controller.md.sal.dom.api.DOMDataChangeListener;
  40 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadOnlyTransaction;
  41 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction;
  42 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  43 import org.opendaylight.controller.md.sal.dom.api.DOMMountPoint;
  44 import org.opendaylight.controller.md.sal.dom.api.DOMNotificationService;
  45 import org.opendaylight.controller.md.sal.dom.api.DOMRpcException;
  46 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
  47 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
  48 import org.opendaylight.controller.sal.core.api.Broker.ConsumerSession;
  49 import org.opendaylight.netconf.sal.restconf.impl.BrokerFacade;
  50 import org.opendaylight.netconf.sal.restconf.impl.ControllerContext;
  51 import org.opendaylight.netconf.sal.restconf.impl.RestconfDocumentedException;
  52 import org.opendaylight.netconf.sal.restconf.impl.RestconfError;
  53 import org.opendaylight.netconf.sal.streams.listeners.ListenerAdapter;
  54 import org.opendaylight.netconf.sal.streams.listeners.NotificationListenerAdapter;
  55 import org.opendaylight.netconf.sal.streams.listeners.Notificator;
  56 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  57 import org.opendaylight.yangtools.yang.common.QName;
  58 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  59 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  60 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  61 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  62 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  63 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  64
  65 /**
  66  * Unit tests for BrokerFacade.
  67  *
  68  * @author Thomas Pantelis
  69  */
  70 public class BrokerFacadeTest {
  71
  72     @Mock
  73     DOMDataBroker domDataBroker;
  74
  75     @Mock
  76     DOMNotificationService domNotification;
  77
  78     @Mock
  79     ConsumerSession context;
  80
  81     @Mock
  82     DOMRpcService mockRpcService;
  83
  84     @Mock
  85     DOMMountPoint mockMountInstance;
  86
  87     BrokerFacade brokerFacade = BrokerFacade.getInstance();
  88
  89     NormalizedNode<?, ?> dummyNode = createDummyNode("test:module", "2014-01-09", "interfaces");
  90     CheckedFuture<Optional<NormalizedNode<?, ?>>,ReadFailedException> dummyNodeInFuture = wrapDummyNode(dummyNode);
  91
  92     QName qname = TestUtils.buildQName("interfaces","test:module", "2014-01-09");
  93
  94     SchemaPath type = SchemaPath.create(true, qname);
  95
  96     YangInstanceIdentifier instanceID = YangInstanceIdentifier.builder().node(qname).build();
  97
  98     @Mock
  99     DOMDataReadOnlyTransaction rTransaction;
 100
 101     @Mock
 102     DOMDataWriteTransaction wTransaction;
 103
 104     @Mock
 105     DOMDataReadWriteTransaction rwTransaction;
 106
 107     @Before
 108     public void setUp() throws Exception {
 109         MockitoAnnotations.initMocks(this);
 110         // TODO it is started before every test method
 111         brokerFacade.setDomDataBroker(domDataBroker);
 112         brokerFacade.setDomNotificationService(domNotification);
 113         brokerFacade.setRpcService(mockRpcService);
 114         brokerFacade.setContext(context);
 115         when(domDataBroker.newReadOnlyTransaction()).thenReturn(rTransaction);
 116         when(domDataBroker.newWriteOnlyTransaction()).thenReturn(wTransaction);
 117         when(domDataBroker.newReadWriteTransaction()).thenReturn(rwTransaction);
 118
 119         ControllerContext.getInstance().setSchemas(TestUtils.loadSchemaContext("/full-versions/test-module"));
 120     }
 121
 122     private CheckedFuture<Optional<NormalizedNode<?, ?>>,ReadFailedException> wrapDummyNode(final NormalizedNode<?, ?> dummyNode) {
 123         return  Futures.immediateCheckedFuture(Optional.<NormalizedNode<?, ?>> of(dummyNode));
 124     }
 125
 126     private CheckedFuture<Boolean,ReadFailedException> wrapExistence(final Boolean exists) {
 127         return  Futures.immediateCheckedFuture(exists);
 128     }
 129
 130
 131     /**
 132      * Value of this node shouldn't be important for testing purposes
 133      */
 134     private NormalizedNode<?, ?> createDummyNode(final String namespace, final String date, final String localName) {
 135         return Builders.containerBuilder()
 136                 .withNodeIdentifier(new NodeIdentifier(QName.create(namespace, date, localName))).build();
 137     }
 138
 139     @Test
 140     public void testReadConfigurationData() {
 141         when(rTransaction.read(any(LogicalDatastoreType.class), any(YangInstanceIdentifier.class))).thenReturn(
 142                 dummyNodeInFuture);
 143
 144         final NormalizedNode<?, ?> actualNode = brokerFacade.readConfigurationData(instanceID);
 145
 146         assertSame("readConfigurationData", dummyNode, actualNode);
 147     }
 148
 149     @Test
 150     public void testReadOperationalData() {
 151         when(rTransaction.read(any(LogicalDatastoreType.class), any(YangInstanceIdentifier.class))).thenReturn(
 152                 dummyNodeInFuture);
 153
 154         final NormalizedNode<?, ?> actualNode = brokerFacade.readOperationalData(instanceID);
 155
 156         assertSame("readOperationalData", dummyNode, actualNode);
 157     }
 158
 159     @Test(expected = RestconfDocumentedException.class)
 160     public void testReadOperationalDataWithNoDataBroker() {
 161         brokerFacade.setDomDataBroker(null);
 162
 163         brokerFacade.readOperationalData(instanceID);
 164     }
 165
 166     @Test
 167     public void testInvokeRpc() throws Exception {
 168         final DOMRpcResult expResult = mock(DOMRpcResult.class);
 169         final CheckedFuture<DOMRpcResult, DOMRpcException> future = Futures.immediateCheckedFuture(expResult);
 170         when(mockRpcService.invokeRpc(type, dummyNode)).thenReturn(future);
 171
 172         final CheckedFuture<DOMRpcResult, DOMRpcException> actualFuture = brokerFacade.invokeRpc(type, dummyNode);
 173         assertNotNull("Future is null", actualFuture);
 174         final DOMRpcResult actualResult = actualFuture.get();
 175         assertSame("invokeRpc", expResult, actualResult);
 176     }
 177
 178     @Test(expected = RestconfDocumentedException.class)
 179     public void testInvokeRpcWithNoConsumerSession() {
 180         brokerFacade.setContext(null);
 181         brokerFacade.invokeRpc(type, dummyNode);
 182     }
 183
 184     @Ignore
 185     @Test
 186     public void testCommitConfigurationDataPut() {
 187         @SuppressWarnings("unchecked")
 188         final CheckedFuture<Void, TransactionCommitFailedException> expFuture = mock(CheckedFuture.class);
 189
 190         when(wTransaction.submit()).thenReturn(expFuture);
 191
 192         final Future<Void> actualFuture = brokerFacade.commitConfigurationDataPut((SchemaContext)null, instanceID, dummyNode);
 193
 194         assertSame("commitConfigurationDataPut", expFuture, actualFuture);
 195
 196         final InOrder inOrder = inOrder(domDataBroker, wTransaction);
 197         inOrder.verify(domDataBroker).newWriteOnlyTransaction();
 198         inOrder.verify(wTransaction).put(LogicalDatastoreType.CONFIGURATION, instanceID, dummyNode);
 199         inOrder.verify(wTransaction).submit();
 200     }
 201
 202     @Test
 203     public void testCommitConfigurationDataPost() {
 204         @SuppressWarnings("unchecked")
 205         final CheckedFuture<Void, TransactionCommitFailedException> expFuture = mock(CheckedFuture.class);
 206
 207         when(rwTransaction.exists(eq(LogicalDatastoreType.CONFIGURATION), any(YangInstanceIdentifier.class))).thenReturn(
 208             wrapExistence(false));
 209
 210
 211         when(rwTransaction.submit()).thenReturn(expFuture);
 212
 213         final CheckedFuture<Void, TransactionCommitFailedException> actualFuture = brokerFacade.commitConfigurationDataPost(
 214                 (SchemaContext)null, instanceID, dummyNode);
 215
 216         assertSame("commitConfigurationDataPost", expFuture, actualFuture);
 217
 218         final InOrder inOrder = inOrder(domDataBroker, rwTransaction);
 219         inOrder.verify(domDataBroker).newReadWriteTransaction();
 220         inOrder.verify(rwTransaction).exists(LogicalDatastoreType.CONFIGURATION, instanceID);
 221         inOrder.verify(rwTransaction).put(LogicalDatastoreType.CONFIGURATION, instanceID, dummyNode);
 222         inOrder.verify(rwTransaction).submit();
 223     }
 224
 225     @Test(expected = RestconfDocumentedException.class)
 226     public void testCommitConfigurationDataPostAlreadyExists() {
 227         final CheckedFuture<Boolean, ReadFailedException> successFuture = Futures.immediateCheckedFuture(Boolean.TRUE);
 228         when(rwTransaction.exists(eq(LogicalDatastoreType.CONFIGURATION), any(YangInstanceIdentifier.class))).thenReturn(
 229                 successFuture);
 230         try {
 231             // Schema context is only necessary for ensuring parent structure
 232             brokerFacade.commitConfigurationDataPost((SchemaContext)null, instanceID, dummyNode);
 233         } catch (final RestconfDocumentedException e) {
 234             assertEquals("getErrorTag", RestconfError.ErrorTag.DATA_EXISTS, e.getErrors().get(0).getErrorTag());
 235             throw e;
 236         }
 237     }
 238
 239     @Test
 240     public void testCommitConfigurationDataDelete() {
 241         @SuppressWarnings("unchecked")
 242         final CheckedFuture<Void, TransactionCommitFailedException> expFuture = mock(CheckedFuture.class);
 243
 244         when(wTransaction.submit()).thenReturn(expFuture);
 245
 246         final CheckedFuture<Void, TransactionCommitFailedException> actualFuture = brokerFacade
 247                 .commitConfigurationDataDelete(instanceID);
 248
 249         assertSame("commitConfigurationDataDelete", expFuture, actualFuture);
 250
 251         final InOrder inOrder = inOrder(domDataBroker, wTransaction);
 252         inOrder.verify(domDataBroker).newWriteOnlyTransaction();
 253         inOrder.verify(wTransaction).delete(eq(LogicalDatastoreType.CONFIGURATION), any(YangInstanceIdentifier.class));
 254         inOrder.verify(wTransaction).submit();
 255     }
 256
 257     @SuppressWarnings("unchecked")
 258     @Test
 259     public void testRegisterToListenDataChanges() {
 260         final ListenerAdapter listener = Notificator.createListener(instanceID, "stream");
 261
 262         final ListenerRegistration<DOMDataChangeListener> mockRegistration = mock(ListenerRegistration.class);
 263
 264         when(
 265                 domDataBroker.registerDataChangeListener(any(LogicalDatastoreType.class), eq(instanceID), eq(listener),
 266                         eq(DataChangeScope.BASE))).thenReturn(mockRegistration);
 267
 268         brokerFacade.registerToListenDataChanges(LogicalDatastoreType.CONFIGURATION, DataChangeScope.BASE, listener);
 269
 270         verify(domDataBroker).registerDataChangeListener(LogicalDatastoreType.CONFIGURATION, instanceID, listener,
 271                 DataChangeScope.BASE);
 272
 273         assertEquals("isListening", true, listener.isListening());
 274
 275         brokerFacade.registerToListenDataChanges(LogicalDatastoreType.CONFIGURATION, DataChangeScope.BASE, listener);
 276         verifyNoMoreInteractions(domDataBroker);
 277     }
 278
 279     /**
 280      * Create, register, close and remove notification listener.
 281      */
 282     @Test
 283     public void testRegisterToListenNotificationChanges() {
 284         // create test notification listener
 285         final String identifier = "create-notification-stream/toaster:toastDone";
 286         final SchemaPath path = SchemaPath.create(true,
 287                 QName.create("http://netconfcentral.org/ns/toaster", "2009-11-20", "toastDone"));
 288         Notificator.createNotificationListener(Lists.newArrayList(path), identifier, "XML");
 289         final NotificationListenerAdapter listener = Notificator.getNotificationListenerFor(identifier).get(0);
 290
 291         // mock registration
 292         final ListenerRegistration<NotificationListenerAdapter> registration = mock(ListenerRegistration.class);
 293         when(domNotification.registerNotificationListener(listener, listener.getSchemaPath()))
 294                 .thenReturn(registration);
 295
 296         // test to register listener for the first time
 297         brokerFacade.registerToListenNotification(listener);
 298         assertEquals("Registration was not successful", true, listener.isListening());
 299
 300         // try to register for the second time
 301         brokerFacade.registerToListenNotification(listener);
 302         assertEquals("Registration was not successful", true, listener.isListening());
 303
 304         // registrations should be invoked only once
 305         verify(domNotification, times(1)).registerNotificationListener(listener, listener.getSchemaPath());
 306
 307         // close and remove test notification listener
 308         listener.close();
 309         Notificator.removeNotificationListenerIfNoSubscriberExists(listener);
 310     }
 311 }