restconf/restconf-nb-rfc8040/src/test/java/org/opendaylight/restconf/nb/rfc8040/jersey/providers/test/AbstractBodyReaderTest.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. 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.rfc8040.jersey.providers.test;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.junit.Assert.assertNotNull;
  12 import static org.junit.Assert.assertThrows;
  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.when;
  17
  18 import java.util.List;
  19 import java.util.Optional;
  20 import javax.ws.rs.core.MediaType;
  21 import javax.ws.rs.core.MultivaluedHashMap;
  22 import javax.ws.rs.core.MultivaluedMap;
  23 import javax.ws.rs.core.Request;
  24 import javax.ws.rs.core.Response.Status;
  25 import javax.ws.rs.core.UriInfo;
  26 import org.junit.function.ThrowingRunnable;
  27 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
  28 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
  29 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
  30 import org.opendaylight.mdsal.dom.spi.FixedDOMSchemaService;
  31 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  32 import org.opendaylight.restconf.common.errors.RestconfError;
  33 import org.opendaylight.restconf.common.patch.PatchContext;
  34 import org.opendaylight.restconf.nb.rfc8040.TestRestconfUtils;
  35 import org.opendaylight.restconf.nb.rfc8040.TestUtils;
  36 import org.opendaylight.restconf.nb.rfc8040.handlers.SchemaContextHandler;
  37 import org.opendaylight.restconf.nb.rfc8040.jersey.providers.spi.AbstractIdentifierAwareJaxRsProvider;
  38 import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload;
  39 import org.opendaylight.yangtools.yang.common.ErrorTag;
  40 import org.opendaylight.yangtools.yang.common.ErrorType;
  41 import org.opendaylight.yangtools.yang.common.QName;
  42 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  43 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  44
  45 public abstract class AbstractBodyReaderTest {
  46     protected static final QName CONT_AUG_QNAME = QName.create("test-ns-aug", "container-aug").intern();
  47     protected static final QName LEAF_AUG_QNAME = QName.create("test-ns-aug", "leaf-aug").intern();
  48
  49     protected final MediaType mediaType;
  50     protected final SchemaContextHandler schemaContextHandler;
  51     protected final DOMMountPointService mountPointService;
  52
  53     protected AbstractBodyReaderTest(final EffectiveModelContext schemaContext) throws NoSuchFieldException,
  54             IllegalAccessException {
  55         mediaType = getMediaType();
  56
  57         schemaContextHandler = TestUtils.newSchemaContextHandler(schemaContext);
  58
  59         mountPointService = mock(DOMMountPointService.class);
  60         final var mountPoint = mock(DOMMountPoint.class);
  61         doReturn(Optional.of(mountPoint)).when(mountPointService).getMountPoint(any(YangInstanceIdentifier.class));
  62         doReturn(Optional.of(FixedDOMSchemaService.of(schemaContext))).when(mountPoint)
  63             .getService(DOMSchemaService.class);
  64     }
  65
  66     protected abstract MediaType getMediaType();
  67
  68     protected static EffectiveModelContext schemaContextLoader(final String yangPath,
  69             final EffectiveModelContext schemaContext) {
  70         return TestRestconfUtils.loadSchemaContext(yangPath, schemaContext);
  71     }
  72
  73     protected static <T extends AbstractIdentifierAwareJaxRsProvider<?>> void mockBodyReader(
  74             final String identifier, final T normalizedNodeProvider, final boolean isPost) {
  75         final UriInfo uriInfoMock = mock(UriInfo.class);
  76         final MultivaluedMap<String, String> pathParm = new MultivaluedHashMap<>(1);
  77
  78         if (!identifier.isEmpty()) {
  79             pathParm.put("identifier", List.of(identifier));
  80         }
  81
  82         when(uriInfoMock.getPathParameters()).thenReturn(pathParm);
  83         when(uriInfoMock.getPathParameters(false)).thenReturn(pathParm);
  84         when(uriInfoMock.getPathParameters(true)).thenReturn(pathParm);
  85         normalizedNodeProvider.setUriInfo(uriInfoMock);
  86
  87         final Request request = mock(Request.class);
  88         if (isPost) {
  89             when(request.getMethod()).thenReturn("POST");
  90         } else {
  91             when(request.getMethod()).thenReturn("PUT");
  92         }
  93
  94         normalizedNodeProvider.setRequest(request);
  95     }
  96
  97     protected static void checkMountPointNormalizedNodePayload(final NormalizedNodePayload nnContext) {
  98         checkNormalizedNodePayload(nnContext);
  99         assertNotNull(nnContext.getInstanceIdentifierContext().getMountPoint());
 100     }
 101
 102     protected static void checkNormalizedNodePayload(final NormalizedNodePayload nnContext) {
 103         assertNotNull(nnContext.getData());
 104         assertNotNull(nnContext.getInstanceIdentifierContext()
 105                 .getInstanceIdentifier());
 106         assertNotNull(nnContext.getInstanceIdentifierContext()
 107                 .getSchemaContext());
 108         assertNotNull(nnContext.getInstanceIdentifierContext().getSchemaNode());
 109     }
 110
 111     protected static void checkPatchContext(final PatchContext patchContext) {
 112         assertNotNull(patchContext.getData());
 113         assertNotNull(patchContext.getInstanceIdentifierContext().getInstanceIdentifier());
 114         assertNotNull(patchContext.getInstanceIdentifierContext().getSchemaContext());
 115         assertNotNull(patchContext.getInstanceIdentifierContext().getSchemaNode());
 116     }
 117
 118     protected static void checkPatchContextMountPoint(final PatchContext patchContext) {
 119         checkPatchContext(patchContext);
 120         assertNotNull(patchContext.getInstanceIdentifierContext().getMountPoint());
 121     }
 122
 123     protected static EffectiveModelContext modelContext(final DOMMountPoint mountPoint) {
 124         return mountPoint.getService(DOMSchemaService.class)
 125             .flatMap(svc -> Optional.ofNullable(svc.getGlobalContext()))
 126             .orElse(null);
 127     }
 128
 129     protected static void assertRangeViolation(final ThrowingRunnable runnable) {
 130         final RestconfDocumentedException ex = assertThrows(RestconfDocumentedException.class, runnable);
 131         assertEquals(Status.BAD_REQUEST, ex.getResponse().getStatusInfo());
 132
 133         final List<RestconfError> errors = ex.getErrors();
 134         assertEquals(1, errors.size());
 135
 136         final RestconfError error = errors.get(0);
 137         assertEquals(ErrorType.APPLICATION, error.getErrorType());
 138         assertEquals(ErrorTag.INVALID_VALUE, error.getErrorTag());
 139         assertEquals("bar error app tag", error.getErrorAppTag());
 140         assertEquals("bar error message", error.getErrorMessage());
 141     }
 142 }