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.opendaylight.yangtools.util.concurrent.FluentFutures.immediateFailedFluentFuture;
  21 import static org.opendaylight.yangtools.util.concurrent.FluentFutures.immediateFluentFuture;
  22
  23 import java.util.Collection;
  24 import java.util.List;
  25 import java.util.Optional;
  26 import java.util.concurrent.ExecutionException;
  27 import javax.ws.rs.WebApplicationException;
  28 import javax.ws.rs.container.AsyncResponse;
  29 import javax.ws.rs.core.Response.Status;
  30 import javax.ws.rs.core.UriInfo;
  31 import org.junit.Before;
  32 import org.junit.BeforeClass;
  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.spi.DefaultDOMRpcResult;
  47 import org.opendaylight.mdsal.dom.spi.FixedDOMSchemaService;
  48 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
  49 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  50 import org.opendaylight.restconf.nb.rfc8040.TestRestconfUtils;
  51 import org.opendaylight.restconf.nb.rfc8040.handlers.SchemaContextHandler;
  52 import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload;
  53 import org.opendaylight.yangtools.yang.common.ErrorTag;
  54 import org.opendaylight.yangtools.yang.common.ErrorType;
  55 import org.opendaylight.yangtools.yang.common.QName;
  56 import org.opendaylight.yangtools.yang.common.RpcError;
  57 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  58 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  59 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  60 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  61 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  62 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  63 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  64 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
  65
  66 @RunWith(MockitoJUnitRunner.StrictStubs.class)
  67 public class RestconfInvokeOperationsServiceImplTest {
  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     private static EffectiveModelContext CONTEXT;
  79
  80     @Mock
  81     private DOMRpcService rpcService;
  82     @Mock
  83     private DOMMountPoint mountPoint;
  84     private RestconfInvokeOperationsServiceImpl invokeOperationsService;
  85
  86     @BeforeClass
  87     public static void beforeClass() throws Exception {
  88         CONTEXT = YangParserTestUtils.parseYangFiles(TestRestconfUtils.loadFiles("/invoke-rpc"));
  89     }
  90
  91     @Before
  92     public void setup() {
  93         final DOMDataBroker dataBroker = mock(DOMDataBroker.class);
  94         final DOMDataTreeWriteTransaction wTx = mock(DOMDataTreeWriteTransaction.class);
  95         doReturn(wTx).when(dataBroker).newWriteOnlyTransaction();
  96         doReturn(CommitInfo.emptyFluentFuture()).when(wTx).commit();
  97         final SchemaContextHandler schemaContextHandler = new SchemaContextHandler(dataBroker,
  98             FixedDOMSchemaService.of(CONTEXT));
  99         schemaContextHandler.init();
 100         invokeOperationsService =
 101                 new RestconfInvokeOperationsServiceImpl(rpcService, schemaContextHandler);
 102     }
 103
 104     @Test
 105     public void testInvokeRpcWithNonEmptyOutput() {
 106         final ContainerNode result = mock(ContainerNode.class);
 107         doReturn(false).when(result).isEmpty();
 108
 109         final AsyncResponse ar = mock(AsyncResponse.class);
 110         final ArgumentCaptor<NormalizedNodePayload> response = ArgumentCaptor.forClass(NormalizedNodePayload.class);
 111         invokeOperationsService.invokeRpc("invoke-rpc-module:rpcTest", prepNNC(result), mock(UriInfo.class), ar);
 112         verify(ar).resume(response.capture());
 113
 114         assertSame(result, response.getValue().getData());
 115     }
 116
 117     @Test
 118     public void testInvokeRpcWithEmptyOutput() {
 119         final ContainerNode result = mock(ContainerNode.class);
 120         doReturn(true).when(result).isEmpty();
 121
 122         final AsyncResponse ar = mock(AsyncResponse.class);
 123         final ArgumentCaptor<Throwable> response = ArgumentCaptor.forClass(Throwable.class);
 124         invokeOperationsService.invokeRpc("invoke-rpc-module:rpcTest", prepNNC(result), mock(UriInfo.class), ar);
 125         verify(ar).resume(response.capture());
 126
 127         final Throwable failure = response.getValue();
 128         assertThat(failure, instanceOf(WebApplicationException.class));
 129         assertEquals(Status.NO_CONTENT.getStatusCode(), ((WebApplicationException) failure).getResponse().getStatus());
 130     }
 131
 132     @Test
 133     public void invokeRpcTest() throws InterruptedException, ExecutionException {
 134         final DOMRpcResult mockResult = new DefaultDOMRpcResult(OUTPUT, List.of());
 135         doReturn(immediateFluentFuture(mockResult)).when(rpcService).invokeRpc(RPC, INPUT);
 136         final DOMRpcResult rpcResult = RestconfInvokeOperationsServiceImpl.invokeRpc(INPUT, RPC, rpcService).get();
 137         assertTrue(rpcResult.getErrors().isEmpty());
 138         assertEquals(OUTPUT, rpcResult.getResult());
 139     }
 140
 141     @Test
 142     public void invokeRpcErrorsAndCheckTestTest() throws InterruptedException, ExecutionException {
 143         final QName errorRpc = QName.create(RPC, "error-rpc");
 144         final DOMRpcException exception = new DOMRpcImplementationNotAvailableException(
 145                 "No implementation of RPC " + errorRpc + " available.");
 146         doReturn(immediateFailedFluentFuture(exception)).when(rpcService).invokeRpc(errorRpc, INPUT);
 147         final DOMRpcResult rpcResult = RestconfInvokeOperationsServiceImpl.invokeRpc(INPUT, errorRpc, rpcService).get();
 148         assertNull(rpcResult.getResult());
 149         final Collection<? extends RpcError> errorList = rpcResult.getErrors();
 150         assertEquals(1, errorList.size());
 151         final RpcError actual = errorList.iterator().next();
 152         assertEquals("No implementation of RPC " + errorRpc + " available.", actual.getMessage());
 153         assertEquals(ErrorTag.OPERATION_FAILED, actual.getTag());
 154         assertEquals(ErrorType.RPC, actual.getErrorType());
 155     }
 156
 157     @Test
 158     public void invokeRpcViaMountPointTest() throws InterruptedException, ExecutionException {
 159         doReturn(Optional.ofNullable(rpcService)).when(mountPoint).getService(DOMRpcService.class);
 160         final DOMRpcResult mockResult = new DefaultDOMRpcResult(OUTPUT, List.of());
 161         doReturn(immediateFluentFuture(mockResult)).when(rpcService).invokeRpc(RPC, INPUT);
 162         final DOMRpcResult rpcResult = RestconfInvokeOperationsServiceImpl.invokeRpc(INPUT, RPC, mountPoint).get();
 163         assertTrue(rpcResult.getErrors().isEmpty());
 164         assertEquals(OUTPUT, rpcResult.getResult());
 165     }
 166
 167     @Test
 168     public void invokeRpcMissingMountPointServiceTest() {
 169         doReturn(Optional.empty()).when(mountPoint).getService(DOMRpcService.class);
 170         assertThrows(RestconfDocumentedException.class,
 171             () -> RestconfInvokeOperationsServiceImpl.invokeRpc(INPUT, RPC, mountPoint));
 172     }
 173
 174     @Test
 175     public void checkResponseTest() throws InterruptedException, ExecutionException {
 176         doReturn(immediateFluentFuture(new DefaultDOMRpcResult(OUTPUT, List.of())))
 177             .when(rpcService).invokeRpc(RPC, INPUT);
 178         final DOMRpcResult rpcResult = RestconfInvokeOperationsServiceImpl.invokeRpc(INPUT, RPC, rpcService).get();
 179         assertTrue(rpcResult.getErrors().isEmpty());
 180         assertEquals(OUTPUT, rpcResult.getResult());
 181     }
 182
 183     private NormalizedNodePayload prepNNC(final NormalizedNode result) {
 184         final QName qname = QName.create("invoke:rpc:module", "2013-12-03", "rpc-test");
 185         final RpcDefinition schemaNode = CONTEXT.getOperations().stream().filter(rpc -> rpc.getQName().equals(qname))
 186             .findFirst()
 187             .orElseThrow();
 188
 189         final NormalizedNode data = mock(NormalizedNode.class);
 190         final DOMRpcResult domRpcResult = mock(DOMRpcResult.class);
 191         doReturn(immediateFluentFuture(domRpcResult)).when(rpcService).invokeRpc(qname, data);
 192         doReturn(result).when(domRpcResult).getResult();
 193         return NormalizedNodePayload.of(
 194             InstanceIdentifierContext.ofRpcInput(CONTEXT, schemaNode, null), data);
 195     }
 196 }