restconf/restconf-nb-rfc8040/src/test/java/org/opendaylight/restconf/nb/rfc8040/rests/services/impl/RestconfInvokeOperationsServiceImplTest.java

   1 /*
   2  * Copyright (c) 2016 Cisco 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 package org.opendaylight.restconf.nb.rfc8040.rests.services.impl;
   9
  10 import static org.hamcrest.CoreMatchers.instanceOf;
  11 import static org.hamcrest.MatcherAssert.assertThat;
  12 import static org.junit.Assert.assertEquals;
  13 import static org.junit.Assert.assertNull;
  14 import static org.junit.Assert.assertSame;
  15 import static org.junit.Assert.assertThrows;
  16 import static org.junit.Assert.assertTrue;
  17 import static org.mockito.Mockito.doReturn;
  18 import static org.mockito.Mockito.mock;
  19 import static org.mockito.Mockito.verify;
  20 import static org.mockito.Mockito.when;
  21 import static org.opendaylight.yangtools.util.concurrent.FluentFutures.immediateFailedFluentFuture;
  22 import static org.opendaylight.yangtools.util.concurrent.FluentFutures.immediateFluentFuture;
  23
  24 import java.util.Collection;
  25 import java.util.List;
  26 import java.util.Optional;
  27 import java.util.concurrent.ExecutionException;
  28 import javax.ws.rs.WebApplicationException;
  29 import javax.ws.rs.container.AsyncResponse;
  30 import javax.ws.rs.core.Response.Status;
  31 import javax.ws.rs.core.UriInfo;
  32 import org.junit.Before;
  33 import org.junit.Test;
  34 import org.junit.runner.RunWith;
  35 import org.mockito.ArgumentCaptor;
  36 import org.mockito.Mock;
  37 import org.mockito.junit.MockitoJUnitRunner;
  38 import org.opendaylight.mdsal.common.api.CommitInfo;
  39 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  40 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
  41 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
  42 import org.opendaylight.mdsal.dom.api.DOMRpcException;
  43 import org.opendaylight.mdsal.dom.api.DOMRpcImplementationNotAvailableException;
  44 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
  45 import org.opendaylight.mdsal.dom.api.DOMRpcService;
  46 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
  47 import org.opendaylight.mdsal.dom.spi.DefaultDOMRpcResult;
  48 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
  49 import org.opendaylight.restconf.common.context.NormalizedNodeContext;
  50 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  51 import org.opendaylight.restconf.nb.rfc8040.TestRestconfUtils;
  52 import org.opendaylight.restconf.nb.rfc8040.handlers.SchemaContextHandler;
  53 import org.opendaylight.yangtools.yang.common.QName;
  54 import org.opendaylight.yangtools.yang.common.RpcError;
  55 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  56 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  57 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  58 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  59 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  60 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  61 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  62 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
  63
  64 @RunWith(MockitoJUnitRunner.StrictStubs.class)
  65 public class RestconfInvokeOperationsServiceImplTest {
  66     private static final String PATH_FOR_NEW_SCHEMA_CONTEXT = "/invoke-rpc";
  67
  68     private static final QName RPC = QName.create("ns", "2015-02-28", "test-rpc");
  69     private static final ContainerNode INPUT = Builders.containerBuilder()
  70         .withNodeIdentifier(new NodeIdentifier(QName.create(RPC, "input")))
  71         .withChild(ImmutableNodes.leafNode(QName.create(RPC, "content"), "test"))
  72         .build();
  73     private static final ContainerNode OUTPUT = Builders.containerBuilder()
  74         .withNodeIdentifier(new NodeIdentifier(QName.create(RPC, "output")))
  75         .withChild(ImmutableNodes.leafNode(QName.create(RPC, "content"), "operation result"))
  76         .build();
  77
  78     @Mock
  79     private DOMRpcService rpcService;
  80     @Mock
  81     private DOMMountPoint mountPoint;
  82     private RestconfInvokeOperationsServiceImpl invokeOperationsService;
  83
  84     @Before
  85     public void setup() throws Exception {
  86         final EffectiveModelContext contextRef =
  87                 YangParserTestUtils.parseYangFiles(TestRestconfUtils.loadFiles(PATH_FOR_NEW_SCHEMA_CONTEXT));
  88         final DOMDataBroker dataBroker = mock(DOMDataBroker.class);
  89         final DOMDataTreeWriteTransaction wTx = mock(DOMDataTreeWriteTransaction.class);
  90         when(dataBroker.newWriteOnlyTransaction()).thenReturn(wTx);
  91         doReturn(CommitInfo.emptyFluentFuture()).when(wTx).commit();
  92         final SchemaContextHandler schemaContextHandler = new SchemaContextHandler(dataBroker,
  93             mock(DOMSchemaService.class));
  94         schemaContextHandler.onModelContextUpdated(contextRef);
  95         this.invokeOperationsService =
  96                 new RestconfInvokeOperationsServiceImpl(this.rpcService, schemaContextHandler);
  97     }
  98
  99     @Test
 100     public void testInvokeRpcWithNonEmptyOutput() {
 101         final ContainerNode result = mock(ContainerNode.class);
 102         doReturn(false).when(result).isEmpty();
 103
 104         final AsyncResponse ar = mock(AsyncResponse.class);
 105         final ArgumentCaptor<NormalizedNodeContext> response = ArgumentCaptor.forClass(NormalizedNodeContext.class);
 106         invokeOperationsService.invokeRpc("invoke-rpc-module:rpcTest", prepNNC(result), mock(UriInfo.class), ar);
 107         verify(ar).resume(response.capture());
 108
 109         assertSame(result, response.getValue().getData());
 110     }
 111
 112     @Test
 113     public void testInvokeRpcWithEmptyOutput() {
 114         final ContainerNode result = mock(ContainerNode.class);
 115         doReturn(true).when(result).isEmpty();
 116
 117         final AsyncResponse ar = mock(AsyncResponse.class);
 118         final ArgumentCaptor<Throwable> response = ArgumentCaptor.forClass(Throwable.class);
 119         invokeOperationsService.invokeRpc("invoke-rpc-module:rpcTest", prepNNC(result), mock(UriInfo.class), ar);
 120         verify(ar).resume(response.capture());
 121
 122         final Throwable failure = response.getValue();
 123         assertThat(failure, instanceOf(WebApplicationException.class));
 124         assertEquals(Status.NO_CONTENT.getStatusCode(), ((WebApplicationException) failure).getResponse().getStatus());
 125     }
 126
 127     @Test
 128     public void invokeRpcTest() throws InterruptedException, ExecutionException {
 129         final DOMRpcResult mockResult = new DefaultDOMRpcResult(OUTPUT, List.of());
 130         doReturn(immediateFluentFuture(mockResult)).when(rpcService).invokeRpc(RPC, INPUT);
 131         final DOMRpcResult rpcResult = RestconfInvokeOperationsServiceImpl.invokeRpc(INPUT, RPC, rpcService).get();
 132         assertTrue(rpcResult.getErrors().isEmpty());
 133         assertEquals(OUTPUT, rpcResult.getResult());
 134     }
 135
 136     @Test
 137     public void invokeRpcErrorsAndCheckTestTest() throws InterruptedException, ExecutionException {
 138         final QName errorRpc = QName.create(RPC, "error-rpc");
 139         final DOMRpcException exception = new DOMRpcImplementationNotAvailableException(
 140                 "No implementation of RPC " + errorRpc + " available.");
 141         doReturn(immediateFailedFluentFuture(exception)).when(rpcService).invokeRpc(errorRpc, INPUT);
 142         final DOMRpcResult rpcResult = RestconfInvokeOperationsServiceImpl.invokeRpc(INPUT, errorRpc, rpcService).get();
 143         assertNull(rpcResult.getResult());
 144         final Collection<? extends RpcError> errorList = rpcResult.getErrors();
 145         assertEquals(1, errorList.size());
 146         final RpcError actual = errorList.iterator().next();
 147         assertEquals("No implementation of RPC " + errorRpc + " available.", actual.getMessage());
 148         assertEquals("operation-failed", actual.getTag());
 149         assertEquals(RpcError.ErrorType.RPC, actual.getErrorType());
 150     }
 151
 152     @Test
 153     public void invokeRpcViaMountPointTest() throws InterruptedException, ExecutionException {
 154         doReturn(Optional.ofNullable(rpcService)).when(mountPoint).getService(DOMRpcService.class);
 155         final DOMRpcResult mockResult = new DefaultDOMRpcResult(OUTPUT, List.of());
 156         doReturn(immediateFluentFuture(mockResult)).when(rpcService).invokeRpc(RPC, INPUT);
 157         final DOMRpcResult rpcResult = RestconfInvokeOperationsServiceImpl.invokeRpc(INPUT, RPC, mountPoint).get();
 158         assertTrue(rpcResult.getErrors().isEmpty());
 159         assertEquals(OUTPUT, rpcResult.getResult());
 160     }
 161
 162     @Test
 163     public void invokeRpcMissingMountPointServiceTest() {
 164         doReturn(Optional.empty()).when(mountPoint).getService(DOMRpcService.class);
 165         assertThrows(RestconfDocumentedException.class,
 166             () -> RestconfInvokeOperationsServiceImpl.invokeRpc(INPUT, RPC, mountPoint));
 167     }
 168
 169     @Test
 170     public void checkResponseTest() throws InterruptedException, ExecutionException {
 171         doReturn(immediateFluentFuture(new DefaultDOMRpcResult(OUTPUT, List.of())))
 172             .when(rpcService).invokeRpc(RPC, INPUT);
 173         final DOMRpcResult rpcResult = RestconfInvokeOperationsServiceImpl.invokeRpc(INPUT, RPC, rpcService).get();
 174         assertTrue(rpcResult.getErrors().isEmpty());
 175         assertEquals(OUTPUT, rpcResult.getResult());
 176     }
 177
 178     private NormalizedNodeContext prepNNC(final NormalizedNode result) {
 179         final InstanceIdentifierContext<?> context = mock(InstanceIdentifierContext.class);
 180         final RpcDefinition schemaNode = mock(RpcDefinition.class);
 181         final QName qname = QName.create("invoke:rpc:module", "2013-12-03", "rpcTest");
 182         when(schemaNode.getQName()).thenReturn(qname);
 183         doReturn(schemaNode).when(context).getSchemaNode();
 184         final NormalizedNode data = mock(NormalizedNode.class);
 185         final DOMRpcResult domRpcResult = mock(DOMRpcResult.class);
 186         doReturn(immediateFluentFuture(domRpcResult)).when(rpcService).invokeRpc(qname, data);
 187         doReturn(result).when(domRpcResult).getResult();
 188         return new NormalizedNodeContext(context, data);
 189     }
 190 }