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.util.List;
  19 import java.util.function.Consumer;
  20 import javax.ws.rs.container.AsyncResponse;
  21 import javax.ws.rs.core.Response;
  22 import javax.ws.rs.core.UriInfo;
  23 import org.junit.jupiter.api.BeforeEach;
  24 import org.junit.jupiter.api.extension.ExtendWith;
  25 import org.mockito.ArgumentCaptor;
  26 import org.mockito.Mock;
  27 import org.mockito.junit.jupiter.MockitoExtension;
  28 import org.opendaylight.mdsal.dom.api.DOMActionService;
  29 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  30 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
  31 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
  32 import org.opendaylight.mdsal.dom.api.DOMRpcService;
  33 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  34 import org.opendaylight.restconf.common.errors.RestconfError;
  35 import org.opendaylight.restconf.nb.rfc8040.AbstractJukeboxTest;
  36 import org.opendaylight.restconf.nb.rfc8040.databind.DatabindContext;
  37 import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload;
  38 import org.opendaylight.restconf.server.mdsal.MdsalRestconfServer;
  39 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  40 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  41
  42 @ExtendWith(MockitoExtension.class)
  43 abstract class AbstractRestconfTest extends AbstractJukeboxTest {
  44     static final JaxRsApiPath JUKEBOX_API_PATH = new JaxRsApiPath("example-jukebox:jukebox");
  45
  46     @Mock
  47     UriInfo uriInfo;
  48     @Mock
  49     DOMDataBroker dataBroker;
  50     @Mock
  51     DOMActionService actionService;
  52     @Mock
  53     DOMRpcService rpcService;
  54     @Mock
  55     DOMMountPointService mountPointService;
  56     @Mock
  57     DOMMountPoint mountPoint;
  58
  59     JaxRsRestconf restconf;
  60
  61     @BeforeEach
  62     final void setupRestconf() {
  63         restconf = new JaxRsRestconf(new MdsalRestconfServer(() -> DatabindContext.ofModel(modelContext()), dataBroker,
  64             rpcService, actionService, mountPointService));
  65     }
  66
  67     EffectiveModelContext modelContext() {
  68         return JUKEBOX_SCHEMA;
  69     }
  70
  71     static final NormalizedNode assertNormalizedNode(final int status, final Consumer<AsyncResponse> invocation) {
  72         return assertEntity(NormalizedNodePayload.class, status, invocation).data();
  73     }
  74
  75     static final <T> T assertEntity(final Class<T> expectedType, final int expectedStatus,
  76             final Consumer<AsyncResponse> invocation) {
  77         return assertInstanceOf(expectedType, assertEntity(expectedStatus, invocation));
  78     }
  79
  80     static final Object assertEntity(final int expectedStatus, final Consumer<AsyncResponse> invocation) {
  81         return assertResponse(expectedStatus, invocation).getEntity();
  82     }
  83
  84     static final RestconfError assertError(final Consumer<AsyncResponse> invocation) {
  85         final var errors = assertErrors(invocation);
  86         assertEquals(1, errors.size());
  87         final var error = errors.get(0);
  88         assertNotNull(error);
  89         return error;
  90     }
  91
  92     static final List<RestconfError> assertErrors(final Consumer<AsyncResponse> invocation) {
  93         final var ar = mock(AsyncResponse.class);
  94         final var captor = ArgumentCaptor.forClass(RestconfDocumentedException.class);
  95         doReturn(true).when(ar).resume(captor.capture());
  96         invocation.accept(ar);
  97         verify(ar).resume(any(RestconfDocumentedException.class));
  98         return captor.getValue().getErrors();
  99     }
 100
 101     static final Response assertResponse(final int expectedStatus, final Consumer<AsyncResponse> invocation) {
 102         final var ar = mock(AsyncResponse.class);
 103         final var captor = ArgumentCaptor.forClass(Response.class);
 104         doReturn(true).when(ar).resume(captor.capture());
 105         invocation.accept(ar);
 106         verify(ar).resume(any(Response.class));
 107         final var response = captor.getValue();
 108         assertEquals(expectedStatus, response.getStatus());
 109         return response;
 110     }
 111 }