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