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