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