forked from netty/netty
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Ensure HttpData#addContent/setContent releases the buffer before thro…
…wing IOException (netty#11621) Motivation: When the ByteBuf size exceeds the max limit/defined size, IOException is thrown. HttpData#addContent/setContent should release the buffer in such cases otherwise memory leak will happen. Modification: - Release the provided ByteBuf before throwing IOException - Add unit tests Result: Fixes netty#11618
- Loading branch information
Showing
7 changed files
with
210 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
135 changes: 135 additions & 0 deletions
135
codec-http/src/test/java/io/netty/handler/codec/http/multipart/HttpDataTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,135 @@ | ||
/* | ||
* Copyright 2021 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: | ||
* | ||
* https://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.multipart; | ||
|
||
import io.netty.buffer.ByteBuf; | ||
import io.netty.buffer.PooledByteBufAllocator; | ||
import io.netty.util.CharsetUtil; | ||
import org.assertj.core.api.ThrowableAssert; | ||
import org.junit.jupiter.api.BeforeAll; | ||
import org.junit.jupiter.api.Test; | ||
import org.junit.jupiter.params.ParameterizedTest; | ||
import org.junit.jupiter.params.provider.MethodSource; | ||
|
||
import java.io.IOException; | ||
import java.lang.annotation.ElementType; | ||
import java.lang.annotation.Retention; | ||
import java.lang.annotation.RetentionPolicy; | ||
import java.lang.annotation.Target; | ||
import java.util.Random; | ||
|
||
import static org.assertj.core.api.Assertions.assertThat; | ||
import static org.assertj.core.api.Assertions.assertThatExceptionOfType; | ||
|
||
class HttpDataTest { | ||
private static final byte[] BYTES = new byte[64]; | ||
|
||
@Retention(RetentionPolicy.RUNTIME) | ||
@Target(ElementType.METHOD) | ||
@ParameterizedTest(name = "{displayName}({0})") | ||
@MethodSource("data") | ||
@interface ParameterizedHttpDataTest { | ||
} | ||
|
||
static HttpData[] data() { | ||
return new HttpData[]{ | ||
new MemoryAttribute("test", 10), | ||
new MemoryFileUpload("test", "", "text/plain", null, CharsetUtil.UTF_8, 10), | ||
new MixedAttribute("test", 10, -1), | ||
new MixedFileUpload("test", "", "text/plain", null, CharsetUtil.UTF_8, 10, -1), | ||
new DiskAttribute("test", 10), | ||
new DiskFileUpload("test", "", "text/plain", null, CharsetUtil.UTF_8, 10) | ||
}; | ||
} | ||
|
||
@BeforeAll | ||
static void setUp() { | ||
Random rndm = new Random(); | ||
rndm.nextBytes(BYTES); | ||
} | ||
|
||
@ParameterizedHttpDataTest | ||
void testAddContentEmptyBuffer(HttpData httpData) throws IOException { | ||
ByteBuf content = PooledByteBufAllocator.DEFAULT.buffer(); | ||
httpData.addContent(content, false); | ||
assertThat(content.refCnt()).isEqualTo(0); | ||
} | ||
|
||
@Test | ||
void testAddContentExceedsDefinedSizeDiskFileUpload() { | ||
doTestAddContentExceedsSize( | ||
new DiskFileUpload("test", "", "application/json", null, CharsetUtil.UTF_8, 10), | ||
"Out of size: 64 > 10"); | ||
} | ||
|
||
@Test | ||
void testAddContentExceedsDefinedSizeMemoryFileUpload() { | ||
doTestAddContentExceedsSize( | ||
new MemoryFileUpload("test", "", "application/json", null, CharsetUtil.UTF_8, 10), | ||
"Out of size: 64 > 10"); | ||
} | ||
|
||
@ParameterizedHttpDataTest | ||
void testAddContentExceedsMaxSize(final HttpData httpData) { | ||
httpData.setMaxSize(10); | ||
doTestAddContentExceedsSize(httpData, "Size exceed allowed maximum capacity"); | ||
} | ||
|
||
@ParameterizedHttpDataTest | ||
void testSetContentExceedsDefinedSize(final HttpData httpData) { | ||
doTestSetContentExceedsSize(httpData, "Out of size: 64 > 10"); | ||
} | ||
|
||
@ParameterizedHttpDataTest | ||
void testSetContentExceedsMaxSize(final HttpData httpData) { | ||
httpData.setMaxSize(10); | ||
doTestSetContentExceedsSize(httpData, "Size exceed allowed maximum capacity"); | ||
} | ||
|
||
private static void doTestAddContentExceedsSize(final HttpData httpData, String expectedMessage) { | ||
final ByteBuf content = PooledByteBufAllocator.DEFAULT.buffer(); | ||
content.writeBytes(BYTES); | ||
|
||
assertThatExceptionOfType(IOException.class) | ||
.isThrownBy(new ThrowableAssert.ThrowingCallable() { | ||
|
||
@Override | ||
public void call() throws Throwable { | ||
httpData.addContent(content, false); | ||
} | ||
}) | ||
.withMessage(expectedMessage); | ||
|
||
assertThat(content.refCnt()).isEqualTo(0); | ||
} | ||
|
||
private static void doTestSetContentExceedsSize(final HttpData httpData, String expectedMessage) { | ||
final ByteBuf content = PooledByteBufAllocator.DEFAULT.buffer(); | ||
content.writeBytes(BYTES); | ||
|
||
assertThatExceptionOfType(IOException.class) | ||
.isThrownBy(new ThrowableAssert.ThrowingCallable() { | ||
|
||
@Override | ||
public void call() throws Throwable { | ||
httpData.setContent(content); | ||
} | ||
}) | ||
.withMessage(expectedMessage); | ||
|
||
assertThat(content.refCnt()).isEqualTo(0); | ||
} | ||
} |