/* * Copyright (c) 2023 PANTHEON.tech, s.r.o. and others. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Public License v1.0 which accompanies this distribution, * and is available at http://www.eclipse.org/legal/epl-v10.html */ package org.opendaylight.restconf.nb.jaxrs; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertInstanceOf; import static org.junit.jupiter.api.Assertions.assertNotNull; import static org.mockito.ArgumentMatchers.any; import static org.mockito.Mockito.doReturn; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.verify; import java.io.ByteArrayOutputStream; import java.io.IOException; import java.nio.charset.StandardCharsets; import java.text.ParseException; import java.util.List; import java.util.function.Consumer; import javax.ws.rs.container.AsyncResponse; import javax.ws.rs.core.Response; import javax.ws.rs.core.UriInfo; import org.eclipse.jdt.annotation.NonNull; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.extension.ExtendWith; import org.mockito.ArgumentCaptor; import org.mockito.Mock; import org.mockito.junit.jupiter.MockitoExtension; import org.opendaylight.mdsal.dom.api.DOMActionService; import org.opendaylight.mdsal.dom.api.DOMDataBroker; import org.opendaylight.mdsal.dom.api.DOMMountPoint; import org.opendaylight.mdsal.dom.api.DOMMountPointService; import org.opendaylight.mdsal.dom.api.DOMRpcService; import org.opendaylight.mdsal.dom.spi.FixedDOMSchemaService; import org.opendaylight.restconf.api.ApiPath; import org.opendaylight.restconf.api.FormattableBody; import org.opendaylight.restconf.api.query.PrettyPrintParam; import org.opendaylight.restconf.common.errors.RestconfDocumentedException; import org.opendaylight.restconf.common.errors.RestconfError; import org.opendaylight.restconf.nb.rfc8040.AbstractJukeboxTest; import org.opendaylight.restconf.nb.rfc8040.ErrorTagMapping; import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload; import org.opendaylight.restconf.server.mdsal.MdsalDatabindProvider; import org.opendaylight.restconf.server.mdsal.MdsalRestconfServer; import org.opendaylight.restconf.server.spi.OperationOutputBody; import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode; import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext; @ExtendWith(MockitoExtension.class) abstract class AbstractRestconfTest extends AbstractJukeboxTest { static final ApiPath JUKEBOX_API_PATH = apiPath("example-jukebox:jukebox"); @Mock UriInfo uriInfo; @Mock DOMDataBroker dataBroker; @Mock DOMActionService actionService; @Mock DOMRpcService rpcService; @Mock DOMMountPointService mountPointService; @Mock DOMMountPoint mountPoint; JaxRsRestconf restconf; @BeforeEach final void setupRestconf() { restconf = new JaxRsRestconf( new MdsalRestconfServer(new MdsalDatabindProvider(new FixedDOMSchemaService(modelContext())), dataBroker, rpcService, actionService, mountPointService), ErrorTagMapping.RFC8040, PrettyPrintParam.FALSE); } EffectiveModelContext modelContext() { return JUKEBOX_SCHEMA; } static final void assertJson(final String expectedJson, final OperationOutputBody payload) { final var baos = new ByteArrayOutputStream(); try { payload.formatToJSON(PrettyPrintParam.FALSE, baos); } catch (IOException e) { throw new AssertionError(e); } assertEquals(expectedJson, baos.toString(StandardCharsets.UTF_8)); } static final void assertXml(final String expectedXml, final OperationOutputBody payload) { final var baos = new ByteArrayOutputStream(); try { payload.formatToXML(PrettyPrintParam.FALSE, baos); } catch (IOException e) { throw new AssertionError(e); } assertEquals(expectedXml, baos.toString(StandardCharsets.UTF_8)); } static final FormattableBody assertFormattableBody(final int status, final Consumer invocation) { return assertEntity(JaxRsFormattableBody.class, status, invocation).body(); } static final ContainerNode assertOperationOutput(final int status, final Consumer invocation) { return assertOperationOutputBody(status, invocation).output(); } static final OperationOutputBody assertOperationOutputBody(final int status, final Consumer invocation) { return assertEntity(OperationOutputBody.class, status, invocation); } static final NormalizedNode assertNormalizedNode(final int status, final Consumer invocation) { return assertNormalizedNodePayload(status, invocation).data(); } static final NormalizedNodePayload assertNormalizedNodePayload(final int status, final Consumer invocation) { return assertEntity(NormalizedNodePayload.class, status, invocation); } static final T assertEntity(final Class expectedType, final int expectedStatus, final Consumer invocation) { return assertInstanceOf(expectedType, assertEntity(expectedStatus, invocation)); } static final Object assertEntity(final int expectedStatus, final Consumer invocation) { return assertResponse(expectedStatus, invocation).getEntity(); } static final RestconfError assertError(final Consumer invocation) { final var errors = assertErrors(invocation); assertEquals(1, errors.size()); final var error = errors.get(0); assertNotNull(error); return error; } static final List assertErrors(final Consumer invocation) { final var ar = mock(AsyncResponse.class); doReturn(true).when(ar).resume(any(RestconfDocumentedException.class)); invocation.accept(ar); final var captor = ArgumentCaptor.forClass(RestconfDocumentedException.class); verify(ar).resume(captor.capture()); return captor.getValue().getErrors(); } static final Response assertResponse(final int expectedStatus, final Consumer invocation) { final var ar = mock(AsyncResponse.class); doReturn(true).when(ar).resume(any(Response.class)); invocation.accept(ar); final var captor = ArgumentCaptor.forClass(Response.class); verify(ar).resume(captor.capture()); final var response = captor.getValue(); assertEquals(expectedStatus, response.getStatus()); return response; } static final @NonNull ApiPath apiPath(final String str) { try { return ApiPath.parse(str); } catch (ParseException e) { throw new AssertionError(e); } } }