/* * SPDX-License-Identifier: Apache-2.0 * * The OpenSearch Contributors require contributions made to * this file be licensed under the Apache-2.0 license or a * compatible open source license. */ /* * Licensed to Elasticsearch under one or more contributor * license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright * ownership. Elasticsearch licenses this file to you under * the Apache License, Version 2.0 (the "License"); you may * not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. */ /* * Modifications Copyright OpenSearch Contributors. See * GitHub history for details. */ package org.opensearch.rest; import org.opensearch.OpenSearchParseException; import org.opensearch.common.CheckedConsumer; import org.opensearch.core.common.bytes.BytesArray; import org.opensearch.core.common.bytes.BytesReference; import org.opensearch.common.collect.MapBuilder; import org.opensearch.core.xcontent.NamedXContentRegistry; import org.opensearch.core.xcontent.XContentParser; import org.opensearch.common.xcontent.XContentType; import org.opensearch.http.HttpChannel; import org.opensearch.http.HttpRequest; import org.opensearch.test.OpenSearchTestCase; import org.opensearch.test.rest.FakeRestRequest; import java.io.IOException; import java.util.ArrayList; import java.util.Collections; import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.concurrent.atomic.AtomicReference; import static java.util.Collections.emptyMap; import static java.util.Collections.singletonMap; import static org.hamcrest.Matchers.equalTo; import static org.hamcrest.Matchers.instanceOf; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; public class RestRequestTests extends OpenSearchTestCase { public void testContentConsumesContent() { runConsumesContentTest(RestRequest::content, true); } public void testRequiredContentConsumesContent() { runConsumesContentTest(RestRequest::requiredContent, true); } public void testContentParserConsumesContent() { runConsumesContentTest(RestRequest::contentParser, true); } public void testContentOrSourceParamConsumesContent() { runConsumesContentTest(RestRequest::contentOrSourceParam, true); } public void testContentOrSourceParamsParserConsumesContent() { runConsumesContentTest(RestRequest::contentOrSourceParamParser, true); } public void testWithContentOrSourceParamParserOrNullConsumesContent() { @SuppressWarnings("unchecked") CheckedConsumer consumer = mock(CheckedConsumer.class); runConsumesContentTest(request -> request.withContentOrSourceParamParserOrNull(consumer), true); } public void testApplyContentParserConsumesContent() { @SuppressWarnings("unchecked") CheckedConsumer consumer = mock(CheckedConsumer.class); runConsumesContentTest(request -> request.applyContentParser(consumer), true); } public void testHasContentDoesNotConsumesContent() { runConsumesContentTest(RestRequest::hasContent, false); } private void runConsumesContentTest(final CheckedConsumer consumer, final boolean expected) { final HttpRequest httpRequest = mock(HttpRequest.class); when(httpRequest.uri()).thenReturn(""); when(httpRequest.content()).thenReturn(new BytesArray(new byte[1])); when(httpRequest.getHeaders()).thenReturn( Collections.singletonMap("Content-Type", Collections.singletonList(randomFrom("application/json", "application/x-ndjson"))) ); final RestRequest request = RestRequest.request(mock(NamedXContentRegistry.class), httpRequest, mock(HttpChannel.class)); assertFalse(request.isContentConsumed()); try { consumer.accept(request); } catch (final Exception e) { throw new RuntimeException(e); } assertThat(request.isContentConsumed(), equalTo(expected)); } public void testContentParser() throws IOException { Exception e = expectThrows(OpenSearchParseException.class, () -> contentRestRequest("", emptyMap()).contentParser()); assertEquals("request body is required", e.getMessage()); e = expectThrows(OpenSearchParseException.class, () -> contentRestRequest("", singletonMap("source", "{}")).contentParser()); assertEquals("request body is required", e.getMessage()); assertEquals(emptyMap(), contentRestRequest("{}", emptyMap()).contentParser().map()); e = expectThrows(OpenSearchParseException.class, () -> contentRestRequest("", emptyMap(), emptyMap()).contentParser()); assertEquals("request body is required", e.getMessage()); } public void testApplyContentParser() throws IOException { contentRestRequest("", emptyMap()).applyContentParser(p -> fail("Shouldn't have been called")); contentRestRequest("", singletonMap("source", "{}")).applyContentParser(p -> fail("Shouldn't have been called")); AtomicReference source = new AtomicReference<>(); contentRestRequest("{}", emptyMap()).applyContentParser(p -> source.set(p.map())); assertEquals(emptyMap(), source.get()); } public void testContentOrSourceParam() throws IOException { Exception e = expectThrows(OpenSearchParseException.class, () -> contentRestRequest("", emptyMap()).contentOrSourceParam()); assertEquals("request body or source parameter is required", e.getMessage()); assertEquals(new BytesArray("stuff"), contentRestRequest("stuff", emptyMap()).contentOrSourceParam().v2()); assertEquals( new BytesArray("stuff"), contentRestRequest( "stuff", MapBuilder.newMapBuilder() .put("source", "stuff2") .put("source_content_type", "application/json") .immutableMap() ).contentOrSourceParam().v2() ); assertEquals( new BytesArray("{\"foo\": \"stuff\"}"), contentRestRequest( "", MapBuilder.newMapBuilder() .put("source", "{\"foo\": \"stuff\"}") .put("source_content_type", "application/json") .immutableMap() ).contentOrSourceParam().v2() ); e = expectThrows( IllegalStateException.class, () -> contentRestRequest("", MapBuilder.newMapBuilder().put("source", "stuff2").immutableMap()) .contentOrSourceParam() ); assertEquals("source and source_content_type parameters are required", e.getMessage()); } public void testHasContentOrSourceParam() throws IOException { assertEquals(false, contentRestRequest("", emptyMap()).hasContentOrSourceParam()); assertEquals(true, contentRestRequest("stuff", emptyMap()).hasContentOrSourceParam()); assertEquals(true, contentRestRequest("stuff", singletonMap("source", "stuff2")).hasContentOrSourceParam()); assertEquals(true, contentRestRequest("", singletonMap("source", "stuff")).hasContentOrSourceParam()); } public void testContentOrSourceParamParser() throws IOException { Exception e = expectThrows(OpenSearchParseException.class, () -> contentRestRequest("", emptyMap()).contentOrSourceParamParser()); assertEquals("request body or source parameter is required", e.getMessage()); assertEquals(emptyMap(), contentRestRequest("{}", emptyMap()).contentOrSourceParamParser().map()); assertEquals(emptyMap(), contentRestRequest("{}", singletonMap("source", "stuff2")).contentOrSourceParamParser().map()); assertEquals( emptyMap(), contentRestRequest( "", MapBuilder.newMapBuilder().put("source", "{}").put("source_content_type", "application/json").immutableMap() ).contentOrSourceParamParser().map() ); } public void testWithContentOrSourceParamParserOrNull() throws IOException { contentRestRequest("", emptyMap()).withContentOrSourceParamParserOrNull(parser -> assertNull(parser)); contentRestRequest("{}", emptyMap()).withContentOrSourceParamParserOrNull(parser -> assertEquals(emptyMap(), parser.map())); contentRestRequest("{}", singletonMap("source", "stuff2")).withContentOrSourceParamParserOrNull( parser -> assertEquals(emptyMap(), parser.map()) ); contentRestRequest( "", MapBuilder.newMapBuilder().put("source_content_type", "application/json").put("source", "{}").immutableMap() ).withContentOrSourceParamParserOrNull(parser -> assertEquals(emptyMap(), parser.map())); } public void testContentTypeParsing() { for (XContentType xContentType : XContentType.values()) { Map> map = new HashMap<>(); map.put("Content-Type", Collections.singletonList(xContentType.mediaType())); RestRequest restRequest = contentRestRequest("", Collections.emptyMap(), map); assertEquals(xContentType, restRequest.getMediaType()); map = new HashMap<>(); map.put("Content-Type", Collections.singletonList(xContentType.mediaTypeWithoutParameters())); restRequest = contentRestRequest("", Collections.emptyMap(), map); assertEquals(xContentType, restRequest.getMediaType()); } } public void testPlainTextSupport() { RestRequest restRequest = contentRestRequest( randomAlphaOfLengthBetween(1, 30), Collections.emptyMap(), Collections.singletonMap( "Content-Type", Collections.singletonList(randomFrom("text/plain", "text/plain; charset=utf-8", "text/plain;charset=utf-8")) ) ); assertNull(restRequest.getMediaType()); } public void testMalformedContentTypeHeader() { final String type = randomFrom("text", "text/:ain; charset=utf-8", "text/plain\";charset=utf-8", ":", "/", "t:/plain"); final RestRequest.ContentTypeHeaderException e = expectThrows(RestRequest.ContentTypeHeaderException.class, () -> { final Map> headers = Collections.singletonMap("Content-Type", Collections.singletonList(type)); contentRestRequest("", Collections.emptyMap(), headers); }); assertNotNull(e.getCause()); assertThat(e.getCause(), instanceOf(IllegalArgumentException.class)); assertThat(e.getMessage(), equalTo("java.lang.IllegalArgumentException: invalid Content-Type header [" + type + "]")); } public void testNoContentTypeHeader() { RestRequest contentRestRequest = contentRestRequest("", Collections.emptyMap(), Collections.emptyMap()); assertNull(contentRestRequest.getMediaType()); } public void testMultipleContentTypeHeaders() { List headers = new ArrayList<>(randomUnique(() -> randomAlphaOfLengthBetween(1, 16), randomIntBetween(2, 10))); final RestRequest.ContentTypeHeaderException e = expectThrows( RestRequest.ContentTypeHeaderException.class, () -> contentRestRequest("", Collections.emptyMap(), Collections.singletonMap("Content-Type", headers)) ); assertNotNull(e.getCause()); assertThat(e.getCause(), instanceOf((IllegalArgumentException.class))); assertThat(e.getMessage(), equalTo("java.lang.IllegalArgumentException: only one Content-Type header should be provided")); } public void testRequiredContent() { Exception e = expectThrows(OpenSearchParseException.class, () -> contentRestRequest("", emptyMap()).requiredContent()); assertEquals("request body is required", e.getMessage()); assertEquals(new BytesArray("stuff"), contentRestRequest("stuff", emptyMap()).requiredContent()); assertEquals( new BytesArray("stuff"), contentRestRequest( "stuff", MapBuilder.newMapBuilder() .put("source", "stuff2") .put("source_content_type", "application/json") .immutableMap() ).requiredContent() ); e = expectThrows( OpenSearchParseException.class, () -> contentRestRequest( "", MapBuilder.newMapBuilder() .put("source", "{\"foo\": \"stuff\"}") .put("source_content_type", "application/json") .immutableMap() ).requiredContent() ); assertEquals("request body is required", e.getMessage()); e = expectThrows(IllegalStateException.class, () -> contentRestRequest("test", null, Collections.emptyMap()).requiredContent()); assertEquals("unknown content type", e.getMessage()); } private static RestRequest contentRestRequest(String content, Map params) { Map> headers = new HashMap<>(); headers.put("Content-Type", Collections.singletonList("application/json")); return contentRestRequest(content, params, headers); } private static RestRequest contentRestRequest(String content, Map params, Map> headers) { FakeRestRequest.Builder builder = new FakeRestRequest.Builder(NamedXContentRegistry.EMPTY); builder.withHeaders(headers); builder.withContent(new BytesArray(content), null); builder.withParams(params); return new ContentRestRequest(builder.build()); } private static final class ContentRestRequest extends RestRequest { private final RestRequest restRequest; private ContentRestRequest(RestRequest restRequest) { super( restRequest.getXContentRegistry(), restRequest.params(), restRequest.path(), restRequest.getHeaders(), restRequest.getHttpRequest(), restRequest.getHttpChannel() ); this.restRequest = restRequest; } @Override public Method method() { return restRequest.method(); } @Override public String uri() { return restRequest.uri(); } @Override public BytesReference content() { return restRequest.content(); } } }