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