restconf/restconf-nb/src/test/java/org/opendaylight/restconf/nb/jaxrs/AbstractRestconfTest.java

   1 /*
   2  * Copyright (c) 2023 PANTHEON.tech, s.r.o. 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.jaxrs;
   9
  10 import static org.junit.jupiter.api.Assertions.assertEquals;
  11 import static org.junit.jupiter.api.Assertions.assertInstanceOf;
  12 import static org.junit.jupiter.api.Assertions.assertNotNull;
  13 import static org.mockito.ArgumentMatchers.any;
  14 import static org.mockito.Mockito.doReturn;
  15 import static org.mockito.Mockito.mock;
  16 import static org.mockito.Mockito.verify;
  17
  18 import java.io.ByteArrayOutputStream;
  19 import java.io.IOException;
  20 import java.nio.charset.StandardCharsets;
  21 import java.text.ParseException;
  22 import java.util.List;
  23 import java.util.function.Consumer;
  24 import javax.ws.rs.container.AsyncResponse;
  25 import javax.ws.rs.core.Response;
  26 import javax.ws.rs.core.UriInfo;
  27 import org.eclipse.jdt.annotation.NonNull;
  28 import org.eclipse.jdt.annotation.NonNullByDefault;
  29 import org.junit.jupiter.api.BeforeEach;
  30 import org.junit.jupiter.api.extension.ExtendWith;
  31 import org.mockito.ArgumentCaptor;
  32 import org.mockito.Mock;
  33 import org.mockito.junit.jupiter.MockitoExtension;
  34 import org.opendaylight.mdsal.dom.api.DOMActionService;
  35 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  36 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
  37 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
  38 import org.opendaylight.mdsal.dom.api.DOMRpcService;
  39 import org.opendaylight.mdsal.dom.spi.FixedDOMSchemaService;
  40 import org.opendaylight.restconf.api.ApiPath;
  41 import org.opendaylight.restconf.api.FormattableBody;
  42 import org.opendaylight.restconf.api.query.PrettyPrintParam;
  43 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  44 import org.opendaylight.restconf.common.errors.RestconfError;
  45 import org.opendaylight.restconf.nb.rfc8040.AbstractJukeboxTest;
  46 import org.opendaylight.restconf.nb.rfc8040.ErrorTagMapping;
  47 import org.opendaylight.restconf.server.mdsal.MdsalDatabindProvider;
  48 import org.opendaylight.restconf.server.mdsal.MdsalRestconfServer;
  49 import org.opendaylight.restconf.server.spi.NormalizedFormattableBody;
  50 import org.opendaylight.restconf.server.spi.OperationOutputBody;
  51 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  52 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  53 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  54
  55 @ExtendWith(MockitoExtension.class)
  56 abstract class AbstractRestconfTest extends AbstractJukeboxTest {
  57     static final ApiPath JUKEBOX_API_PATH = apiPath("example-jukebox:jukebox");
  58
  59     @Mock
  60     UriInfo uriInfo;
  61     @Mock
  62     DOMDataBroker dataBroker;
  63     @Mock
  64     DOMActionService actionService;
  65     @Mock
  66     DOMRpcService rpcService;
  67     @Mock
  68     DOMMountPointService mountPointService;
  69     @Mock
  70     DOMMountPoint mountPoint;
  71
  72     JaxRsRestconf restconf;
  73
  74     @BeforeEach
  75     final void setupRestconf() {
  76         restconf = new JaxRsRestconf(
  77             new MdsalRestconfServer(new MdsalDatabindProvider(new FixedDOMSchemaService(modelContext())),
  78                 dataBroker, rpcService, actionService, mountPointService),
  79             ErrorTagMapping.RFC8040, PrettyPrintParam.FALSE);
  80     }
  81
  82     EffectiveModelContext modelContext() {
  83         return JUKEBOX_SCHEMA;
  84     }
  85
  86     static final void assertJson(final String expectedJson, final OperationOutputBody payload) {
  87         final var baos = new ByteArrayOutputStream();
  88         try {
  89             payload.formatToJSON(PrettyPrintParam.FALSE, baos);
  90         } catch (IOException e) {
  91             throw new AssertionError(e);
  92         }
  93         assertEquals(expectedJson, baos.toString(StandardCharsets.UTF_8));
  94     }
  95
  96     static final void assertXml(final String expectedXml, final OperationOutputBody payload) {
  97         final var baos = new ByteArrayOutputStream();
  98         try {
  99             payload.formatToXML(PrettyPrintParam.FALSE, baos);
 100         } catch (IOException e) {
 101             throw new AssertionError(e);
 102         }
 103         assertEquals(expectedXml, baos.toString(StandardCharsets.UTF_8));
 104     }
 105
 106     @NonNullByDefault
 107     static final <N extends NormalizedNode> NormalizedFormattableBody<N> assertNormalizedBody(final int status,
 108             final Consumer<AsyncResponse> invocation) {
 109         return assertInstanceOf(NormalizedFormattableBody.class, assertFormattableBody(status, invocation));
 110     }
 111
 112     static final FormattableBody assertFormattableBody(final int status, final Consumer<AsyncResponse> invocation) {
 113         return assertEntity(JaxRsFormattableBody.class, status, invocation).body();
 114     }
 115
 116     static final ContainerNode assertOperationOutput(final int status, final Consumer<AsyncResponse> invocation) {
 117         return assertOperationOutputBody(status, invocation).output();
 118     }
 119
 120     static final OperationOutputBody assertOperationOutputBody(final int status,
 121             final Consumer<AsyncResponse> invocation) {
 122         return assertEntity(OperationOutputBody.class, status, invocation);
 123     }
 124
 125     static final <T> T assertEntity(final Class<T> expectedType, final int expectedStatus,
 126             final Consumer<AsyncResponse> invocation) {
 127         return assertInstanceOf(expectedType, assertEntity(expectedStatus, invocation));
 128     }
 129
 130     static final Object assertEntity(final int expectedStatus, final Consumer<AsyncResponse> invocation) {
 131         return assertResponse(expectedStatus, invocation).getEntity();
 132     }
 133
 134     static final RestconfError assertError(final Consumer<AsyncResponse> invocation) {
 135         final var errors = assertErrors(invocation);
 136         assertEquals(1, errors.size());
 137         final var error = errors.get(0);
 138         assertNotNull(error);
 139         return error;
 140     }
 141
 142     static final List<RestconfError> assertErrors(final Consumer<AsyncResponse> invocation) {
 143         final var ar = mock(AsyncResponse.class);
 144         doReturn(true).when(ar).resume(any(RestconfDocumentedException.class));
 145
 146         invocation.accept(ar);
 147
 148         final var captor = ArgumentCaptor.forClass(RestconfDocumentedException.class);
 149         verify(ar).resume(captor.capture());
 150         return captor.getValue().getErrors();
 151     }
 152
 153     static final Response assertResponse(final int expectedStatus, final Consumer<AsyncResponse> invocation) {
 154         final var ar = mock(AsyncResponse.class);
 155         doReturn(true).when(ar).resume(any(Response.class));
 156
 157         invocation.accept(ar);
 158
 159         final var captor = ArgumentCaptor.forClass(Response.class);
 160         verify(ar).resume(captor.capture());
 161         final var response = captor.getValue();
 162         assertEquals(expectedStatus, response.getStatus());
 163         return response;
 164     }
 165
 166     static final @NonNull ApiPath apiPath(final String str) {
 167         try {
 168             return ApiPath.parse(str);
 169         } catch (ParseException e) {
 170             throw new AssertionError(e);
 171         }
 172     }
 173 }