Motivation: There currently exists http.HttpUtil, http2.HttpUtil, and http.HttpHeaderUtil. Having 2 HttpUtil methods can be confusing and the utilty methods in the http package could be consolidated. Modifications: - Rename http2.HttpUtil to http2.HttpConversionUtil - Move http.HttpHeaderUtil methods into http.HttpUtil Result: Consolidated utilities whose names don't overlap. Fixes https://github.com/netty/netty/issues/4120
417 lines
18 KiB
Java
417 lines
18 KiB
Java
/*
|
|
* Copyright 2012 The Netty Project
|
|
*
|
|
* The Netty Project 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.
|
|
*/
|
|
package io.netty.handler.codec.http;
|
|
|
|
import io.netty.buffer.ByteBuf;
|
|
import io.netty.buffer.CompositeByteBuf;
|
|
import io.netty.buffer.Unpooled;
|
|
import io.netty.channel.ChannelHandlerContext;
|
|
import io.netty.channel.embedded.EmbeddedChannel;
|
|
import io.netty.handler.codec.DecoderResultProvider;
|
|
import io.netty.handler.codec.TooLongFrameException;
|
|
import io.netty.util.CharsetUtil;
|
|
import org.easymock.EasyMock;
|
|
import org.junit.Test;
|
|
|
|
import java.nio.channels.ClosedChannelException;
|
|
import java.util.List;
|
|
|
|
import static io.netty.util.ReferenceCountUtil.releaseLater;
|
|
import static org.hamcrest.CoreMatchers.instanceOf;
|
|
import static org.hamcrest.CoreMatchers.is;
|
|
import static org.junit.Assert.assertEquals;
|
|
import static org.junit.Assert.assertFalse;
|
|
import static org.junit.Assert.assertNotNull;
|
|
import static org.junit.Assert.assertNull;
|
|
import static org.junit.Assert.assertThat;
|
|
import static org.junit.Assert.assertTrue;
|
|
import static org.junit.Assert.fail;
|
|
|
|
public class HttpObjectAggregatorTest {
|
|
|
|
@Test
|
|
public void testAggregate() {
|
|
HttpObjectAggregator aggr = new HttpObjectAggregator(1024 * 1024);
|
|
EmbeddedChannel embedder = new EmbeddedChannel(aggr);
|
|
|
|
HttpRequest message = new DefaultHttpRequest(HttpVersion.HTTP_1_1, HttpMethod.GET, "http://localhost");
|
|
message.headers().set("X-Test", true);
|
|
HttpContent chunk1 = new DefaultHttpContent(Unpooled.copiedBuffer("test", CharsetUtil.US_ASCII));
|
|
HttpContent chunk2 = new DefaultHttpContent(Unpooled.copiedBuffer("test2", CharsetUtil.US_ASCII));
|
|
HttpContent chunk3 = new DefaultLastHttpContent(Unpooled.EMPTY_BUFFER);
|
|
assertFalse(embedder.writeInbound(message));
|
|
assertFalse(embedder.writeInbound(chunk1));
|
|
assertFalse(embedder.writeInbound(chunk2));
|
|
|
|
// this should trigger a channelRead event so return true
|
|
assertTrue(embedder.writeInbound(chunk3));
|
|
assertTrue(embedder.finish());
|
|
FullHttpRequest aggratedMessage = embedder.readInbound();
|
|
assertNotNull(aggratedMessage);
|
|
|
|
assertEquals(chunk1.content().readableBytes() + chunk2.content().readableBytes(),
|
|
HttpUtil.getContentLength(aggratedMessage));
|
|
assertEquals(aggratedMessage.headers().get("X-Test"), Boolean.TRUE.toString());
|
|
checkContentBuffer(aggratedMessage);
|
|
assertNull(embedder.readInbound());
|
|
}
|
|
|
|
private static void checkContentBuffer(FullHttpRequest aggregatedMessage) {
|
|
CompositeByteBuf buffer = (CompositeByteBuf) aggregatedMessage.content();
|
|
assertEquals(2, buffer.numComponents());
|
|
List<ByteBuf> buffers = buffer.decompose(0, buffer.capacity());
|
|
assertEquals(2, buffers.size());
|
|
for (ByteBuf buf: buffers) {
|
|
// This should be false as we decompose the buffer before to not have deep hierarchy
|
|
assertFalse(buf instanceof CompositeByteBuf);
|
|
}
|
|
aggregatedMessage.release();
|
|
}
|
|
|
|
@Test
|
|
public void testAggregateWithTrailer() {
|
|
HttpObjectAggregator aggr = new HttpObjectAggregator(1024 * 1024);
|
|
EmbeddedChannel embedder = new EmbeddedChannel(aggr);
|
|
HttpRequest message = new DefaultHttpRequest(HttpVersion.HTTP_1_1, HttpMethod.GET, "http://localhost");
|
|
message.headers().set("X-Test", true);
|
|
HttpUtil.setTransferEncodingChunked(message, true);
|
|
HttpContent chunk1 = new DefaultHttpContent(Unpooled.copiedBuffer("test", CharsetUtil.US_ASCII));
|
|
HttpContent chunk2 = new DefaultHttpContent(Unpooled.copiedBuffer("test2", CharsetUtil.US_ASCII));
|
|
LastHttpContent trailer = new DefaultLastHttpContent();
|
|
trailer.trailingHeaders().set("X-Trailer", true);
|
|
|
|
assertFalse(embedder.writeInbound(message));
|
|
assertFalse(embedder.writeInbound(chunk1));
|
|
assertFalse(embedder.writeInbound(chunk2));
|
|
|
|
// this should trigger a channelRead event so return true
|
|
assertTrue(embedder.writeInbound(trailer));
|
|
assertTrue(embedder.finish());
|
|
FullHttpRequest aggratedMessage = embedder.readInbound();
|
|
assertNotNull(aggratedMessage);
|
|
|
|
assertEquals(chunk1.content().readableBytes() + chunk2.content().readableBytes(),
|
|
HttpUtil.getContentLength(aggratedMessage));
|
|
assertEquals(aggratedMessage.headers().get("X-Test"), Boolean.TRUE.toString());
|
|
assertEquals(aggratedMessage.trailingHeaders().get("X-Trailer"), Boolean.TRUE.toString());
|
|
checkContentBuffer(aggratedMessage);
|
|
assertNull(embedder.readInbound());
|
|
}
|
|
|
|
@Test
|
|
public void testOversizedRequest() {
|
|
EmbeddedChannel embedder = new EmbeddedChannel(new HttpObjectAggregator(4));
|
|
HttpRequest message = new DefaultHttpRequest(HttpVersion.HTTP_1_1, HttpMethod.PUT, "http://localhost");
|
|
HttpContent chunk1 = new DefaultHttpContent(Unpooled.copiedBuffer("test", CharsetUtil.US_ASCII));
|
|
HttpContent chunk2 = new DefaultHttpContent(Unpooled.copiedBuffer("test2", CharsetUtil.US_ASCII));
|
|
HttpContent chunk3 = LastHttpContent.EMPTY_LAST_CONTENT;
|
|
|
|
assertFalse(embedder.writeInbound(message));
|
|
assertFalse(embedder.writeInbound(chunk1));
|
|
assertFalse(embedder.writeInbound(chunk2));
|
|
|
|
FullHttpResponse response = embedder.readOutbound();
|
|
assertEquals(HttpResponseStatus.REQUEST_ENTITY_TOO_LARGE, response.status());
|
|
assertEquals("0", response.headers().get(HttpHeaderNames.CONTENT_LENGTH));
|
|
assertFalse(embedder.isOpen());
|
|
|
|
try {
|
|
assertFalse(embedder.writeInbound(chunk3));
|
|
fail();
|
|
} catch (Exception e) {
|
|
assertTrue(e instanceof ClosedChannelException);
|
|
}
|
|
|
|
assertFalse(embedder.finish());
|
|
}
|
|
|
|
@Test
|
|
public void testOversizedRequestWithoutKeepAlive() {
|
|
// send a HTTP/1.0 request with no keep-alive header
|
|
HttpRequest message = new DefaultHttpRequest(HttpVersion.HTTP_1_0, HttpMethod.PUT, "http://localhost");
|
|
HttpUtil.setContentLength(message, 5);
|
|
checkOversizedRequest(message);
|
|
}
|
|
|
|
@Test
|
|
public void testOversizedRequestWithContentLength() {
|
|
HttpRequest message = new DefaultHttpRequest(HttpVersion.HTTP_1_1, HttpMethod.PUT, "http://localhost");
|
|
HttpUtil.setContentLength(message, 5);
|
|
checkOversizedRequest(message);
|
|
}
|
|
|
|
private static void checkOversizedRequest(HttpRequest message) {
|
|
EmbeddedChannel embedder = new EmbeddedChannel(new HttpObjectAggregator(4));
|
|
|
|
assertFalse(embedder.writeInbound(message));
|
|
HttpResponse response = embedder.readOutbound();
|
|
assertEquals(HttpResponseStatus.REQUEST_ENTITY_TOO_LARGE, response.status());
|
|
assertEquals("0", response.headers().get(HttpHeaderNames.CONTENT_LENGTH));
|
|
|
|
if (serverShouldCloseConnection(message)) {
|
|
assertFalse(embedder.isOpen());
|
|
assertFalse(embedder.finish());
|
|
} else {
|
|
assertTrue(embedder.isOpen());
|
|
}
|
|
}
|
|
|
|
private static boolean serverShouldCloseConnection(HttpRequest message) {
|
|
// The connection should only be kept open if Expect: 100-continue is set,
|
|
// or if keep-alive is on.
|
|
if (HttpUtil.is100ContinueExpected(message)) {
|
|
return false;
|
|
}
|
|
if (HttpUtil.isKeepAlive(message)) {
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
@Test
|
|
public void testOversizedResponse() {
|
|
EmbeddedChannel embedder = new EmbeddedChannel(new HttpObjectAggregator(4));
|
|
HttpResponse message = new DefaultHttpResponse(HttpVersion.HTTP_1_1, HttpResponseStatus.OK);
|
|
HttpContent chunk1 = new DefaultHttpContent(Unpooled.copiedBuffer("test", CharsetUtil.US_ASCII));
|
|
HttpContent chunk2 = new DefaultHttpContent(Unpooled.copiedBuffer("test2", CharsetUtil.US_ASCII));
|
|
|
|
assertFalse(embedder.writeInbound(message));
|
|
assertFalse(embedder.writeInbound(chunk1));
|
|
|
|
try {
|
|
embedder.writeInbound(chunk2);
|
|
fail();
|
|
} catch (TooLongFrameException expected) {
|
|
// Expected
|
|
}
|
|
|
|
assertFalse(embedder.isOpen());
|
|
assertFalse(embedder.finish());
|
|
}
|
|
|
|
@Test(expected = IllegalArgumentException.class)
|
|
public void testInvalidConstructorUsage() {
|
|
new HttpObjectAggregator(-1);
|
|
}
|
|
|
|
@Test(expected = IllegalArgumentException.class)
|
|
public void testInvalidMaxCumulationBufferComponents() {
|
|
HttpObjectAggregator aggr = new HttpObjectAggregator(Integer.MAX_VALUE);
|
|
aggr.setMaxCumulationBufferComponents(1);
|
|
}
|
|
|
|
@Test(expected = IllegalStateException.class)
|
|
public void testSetMaxCumulationBufferComponentsAfterInit() throws Exception {
|
|
HttpObjectAggregator aggr = new HttpObjectAggregator(Integer.MAX_VALUE);
|
|
ChannelHandlerContext ctx = EasyMock.createMock(ChannelHandlerContext.class);
|
|
EasyMock.replay(ctx);
|
|
aggr.handlerAdded(ctx);
|
|
aggr.setMaxCumulationBufferComponents(10);
|
|
}
|
|
|
|
@Test
|
|
public void testAggregateTransferEncodingChunked() {
|
|
HttpObjectAggregator aggr = new HttpObjectAggregator(1024 * 1024);
|
|
EmbeddedChannel embedder = new EmbeddedChannel(aggr);
|
|
|
|
HttpRequest message = new DefaultHttpRequest(HttpVersion.HTTP_1_1, HttpMethod.PUT, "http://localhost");
|
|
message.headers().set("X-Test", true);
|
|
message.headers().set("Transfer-Encoding", "Chunked");
|
|
HttpContent chunk1 = new DefaultHttpContent(Unpooled.copiedBuffer("test", CharsetUtil.US_ASCII));
|
|
HttpContent chunk2 = new DefaultHttpContent(Unpooled.copiedBuffer("test2", CharsetUtil.US_ASCII));
|
|
HttpContent chunk3 = LastHttpContent.EMPTY_LAST_CONTENT;
|
|
assertFalse(embedder.writeInbound(message));
|
|
assertFalse(embedder.writeInbound(chunk1));
|
|
assertFalse(embedder.writeInbound(chunk2));
|
|
|
|
// this should trigger a channelRead event so return true
|
|
assertTrue(embedder.writeInbound(chunk3));
|
|
assertTrue(embedder.finish());
|
|
FullHttpRequest aggratedMessage = embedder.readInbound();
|
|
assertNotNull(aggratedMessage);
|
|
|
|
assertEquals(chunk1.content().readableBytes() + chunk2.content().readableBytes(),
|
|
HttpUtil.getContentLength(aggratedMessage));
|
|
assertEquals(aggratedMessage.headers().get("X-Test"), Boolean.TRUE.toString());
|
|
checkContentBuffer(aggratedMessage);
|
|
assertNull(embedder.readInbound());
|
|
}
|
|
|
|
@Test
|
|
public void testBadRequest() {
|
|
EmbeddedChannel ch = new EmbeddedChannel(new HttpRequestDecoder(), new HttpObjectAggregator(1024 * 1024));
|
|
ch.writeInbound(Unpooled.copiedBuffer("GET / HTTP/1.0 with extra\r\n", CharsetUtil.UTF_8));
|
|
Object inbound = ch.readInbound();
|
|
assertThat(inbound, is(instanceOf(FullHttpRequest.class)));
|
|
assertTrue(((DecoderResultProvider) inbound).decoderResult().isFailure());
|
|
assertNull(ch.readInbound());
|
|
ch.finish();
|
|
}
|
|
|
|
@Test
|
|
public void testBadResponse() throws Exception {
|
|
EmbeddedChannel ch = new EmbeddedChannel(new HttpResponseDecoder(), new HttpObjectAggregator(1024 * 1024));
|
|
ch.writeInbound(Unpooled.copiedBuffer("HTTP/1.0 BAD_CODE Bad Server\r\n", CharsetUtil.UTF_8));
|
|
Object inbound = ch.readInbound();
|
|
assertThat(inbound, is(instanceOf(FullHttpResponse.class)));
|
|
assertTrue(((DecoderResultProvider) inbound).decoderResult().isFailure());
|
|
assertNull(ch.readInbound());
|
|
ch.finish();
|
|
}
|
|
|
|
@Test
|
|
public void testOversizedRequestWith100Continue() {
|
|
EmbeddedChannel embedder = new EmbeddedChannel(new HttpObjectAggregator(8));
|
|
|
|
// Send an oversized request with 100 continue.
|
|
HttpRequest message = new DefaultHttpRequest(HttpVersion.HTTP_1_1, HttpMethod.PUT, "http://localhost");
|
|
HttpUtil.set100ContinueExpected(message, true);
|
|
HttpUtil.setContentLength(message, 16);
|
|
|
|
HttpContent chunk1 = releaseLater(new DefaultHttpContent(Unpooled.copiedBuffer("some", CharsetUtil.US_ASCII)));
|
|
HttpContent chunk2 = releaseLater(new DefaultHttpContent(Unpooled.copiedBuffer("test", CharsetUtil.US_ASCII)));
|
|
HttpContent chunk3 = LastHttpContent.EMPTY_LAST_CONTENT;
|
|
|
|
// Send a request with 100-continue + large Content-Length header value.
|
|
assertFalse(embedder.writeInbound(message));
|
|
|
|
// The aggregator should respond with '417.'
|
|
FullHttpResponse response = (FullHttpResponse) embedder.readOutbound();
|
|
assertEquals(HttpResponseStatus.EXPECTATION_FAILED, response.status());
|
|
assertEquals("0", response.headers().get(HttpHeaderNames.CONTENT_LENGTH));
|
|
|
|
// An ill-behaving client could continue to send data without a respect, and such data should be discarded.
|
|
assertFalse(embedder.writeInbound(chunk1));
|
|
|
|
// The aggregator should not close the connection because keep-alive is on.
|
|
assertTrue(embedder.isOpen());
|
|
|
|
// Now send a valid request.
|
|
HttpRequest message2 = new DefaultHttpRequest(HttpVersion.HTTP_1_1, HttpMethod.PUT, "http://localhost");
|
|
|
|
assertFalse(embedder.writeInbound(message2));
|
|
assertFalse(embedder.writeInbound(chunk2));
|
|
assertTrue(embedder.writeInbound(chunk3));
|
|
|
|
FullHttpRequest fullMsg = (FullHttpRequest) embedder.readInbound();
|
|
assertNotNull(fullMsg);
|
|
|
|
assertEquals(
|
|
chunk2.content().readableBytes() + chunk3.content().readableBytes(),
|
|
HttpUtil.getContentLength(fullMsg));
|
|
|
|
assertEquals(HttpUtil.getContentLength(fullMsg), fullMsg.content().readableBytes());
|
|
|
|
fullMsg.release();
|
|
assertFalse(embedder.finish());
|
|
}
|
|
|
|
@Test
|
|
public void testOversizedRequestWith100ContinueAndDecoder() {
|
|
EmbeddedChannel embedder = new EmbeddedChannel(new HttpRequestDecoder(), new HttpObjectAggregator(4));
|
|
embedder.writeInbound(Unpooled.copiedBuffer(
|
|
"PUT /upload HTTP/1.1\r\n" +
|
|
"Expect: 100-continue\r\n" +
|
|
"Content-Length: 100\r\n\r\n", CharsetUtil.US_ASCII));
|
|
|
|
assertNull(embedder.readInbound());
|
|
|
|
FullHttpResponse response = (FullHttpResponse) embedder.readOutbound();
|
|
assertEquals(HttpResponseStatus.EXPECTATION_FAILED, response.status());
|
|
assertEquals("0", response.headers().get(HttpHeaderNames.CONTENT_LENGTH));
|
|
|
|
// Keep-alive is on by default in HTTP/1.1, so the connection should be still alive.
|
|
assertTrue(embedder.isOpen());
|
|
|
|
// The decoder should be reset by the aggregator at this point and be able to decode the next request.
|
|
embedder.writeInbound(Unpooled.copiedBuffer("GET /max-upload-size HTTP/1.1\r\n\r\n", CharsetUtil.US_ASCII));
|
|
|
|
FullHttpRequest request = (FullHttpRequest) embedder.readInbound();
|
|
assertThat(request.method(), is(HttpMethod.GET));
|
|
assertThat(request.uri(), is("/max-upload-size"));
|
|
assertThat(request.content().readableBytes(), is(0));
|
|
request.release();
|
|
|
|
assertFalse(embedder.finish());
|
|
}
|
|
|
|
@Test
|
|
public void testOversizedRequestWith100ContinueAndDecoderCloseConnection() {
|
|
EmbeddedChannel embedder = new EmbeddedChannel(new HttpRequestDecoder(), new HttpObjectAggregator(4, true));
|
|
embedder.writeInbound(Unpooled.copiedBuffer(
|
|
"PUT /upload HTTP/1.1\r\n" +
|
|
"Expect: 100-continue\r\n" +
|
|
"Content-Length: 100\r\n\r\n", CharsetUtil.US_ASCII));
|
|
|
|
assertNull(embedder.readInbound());
|
|
|
|
FullHttpResponse response = (FullHttpResponse) embedder.readOutbound();
|
|
assertEquals(HttpResponseStatus.EXPECTATION_FAILED, response.status());
|
|
assertEquals("0", response.headers().get(HttpHeaderNames.CONTENT_LENGTH));
|
|
|
|
// We are forcing the connection closed if an expectation is exceeded.
|
|
assertFalse(embedder.isOpen());
|
|
assertFalse(embedder.finish());
|
|
}
|
|
|
|
@Test
|
|
public void testRequestAfterOversized100ContinueAndDecoder() {
|
|
EmbeddedChannel embedder = new EmbeddedChannel(new HttpRequestDecoder(), new HttpObjectAggregator(15));
|
|
|
|
// Write first request with Expect: 100-continue.
|
|
HttpRequest message = new DefaultHttpRequest(HttpVersion.HTTP_1_1, HttpMethod.PUT, "http://localhost");
|
|
HttpUtil.set100ContinueExpected(message, true);
|
|
HttpUtil.setContentLength(message, 16);
|
|
|
|
HttpContent chunk1 = releaseLater(new DefaultHttpContent(Unpooled.copiedBuffer("some", CharsetUtil.US_ASCII)));
|
|
HttpContent chunk2 = releaseLater(new DefaultHttpContent(Unpooled.copiedBuffer("test", CharsetUtil.US_ASCII)));
|
|
HttpContent chunk3 = LastHttpContent.EMPTY_LAST_CONTENT;
|
|
|
|
// Send a request with 100-continue + large Content-Length header value.
|
|
assertFalse(embedder.writeInbound(message));
|
|
|
|
// The aggregator should respond with '417'.
|
|
FullHttpResponse response = (FullHttpResponse) embedder.readOutbound();
|
|
assertEquals(HttpResponseStatus.EXPECTATION_FAILED, response.status());
|
|
assertEquals("0", response.headers().get(HttpHeaderNames.CONTENT_LENGTH));
|
|
|
|
// An ill-behaving client could continue to send data without a respect, and such data should be discarded.
|
|
assertFalse(embedder.writeInbound(chunk1));
|
|
|
|
// The aggregator should not close the connection because keep-alive is on.
|
|
assertTrue(embedder.isOpen());
|
|
|
|
// Now send a valid request.
|
|
HttpRequest message2 = new DefaultHttpRequest(HttpVersion.HTTP_1_1, HttpMethod.PUT, "http://localhost");
|
|
|
|
assertFalse(embedder.writeInbound(message2));
|
|
assertFalse(embedder.writeInbound(chunk2));
|
|
assertTrue(embedder.writeInbound(chunk3));
|
|
|
|
FullHttpRequest fullMsg = (FullHttpRequest) embedder.readInbound();
|
|
assertNotNull(fullMsg);
|
|
|
|
assertEquals(
|
|
chunk2.content().readableBytes() + chunk3.content().readableBytes(),
|
|
HttpUtil.getContentLength(fullMsg));
|
|
|
|
assertEquals(HttpUtil.getContentLength(fullMsg), fullMsg.content().readableBytes());
|
|
|
|
fullMsg.release();
|
|
assertFalse(embedder.finish());
|
|
}
|
|
}
|