Skip to content

Commit 2afaf1b

Browse files
DaveCTurnerDaveCTurner
committed
Improve test coverage
1 parent 483bee7 commit 2afaf1b

File tree

1 file changed

+162
-9
lines changed

1 file changed

+162
-9
lines changed

‎modules/transport-netty4/src/test/java/org/elasticsearch/http/netty4/Netty4HttpHeaderValidatorTests.java‎

Lines changed: 162 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,17 +23,20 @@
2323
import io.netty.handler.codec.http.HttpRequestDecoder;
2424
import io.netty.handler.codec.http.HttpVersion;
2525
import io.netty.handler.codec.http.LastHttpContent;
26-
import io.netty.handler.flow.FlowControlHandler;
2726

2827
import org.elasticsearch.action.ActionListener;
2928
import org.elasticsearch.common.ValidationException;
3029
import org.elasticsearch.common.settings.Settings;
3130
import org.elasticsearch.common.util.concurrent.ThreadContext;
3231
import org.elasticsearch.test.ESTestCase;
3332

33+
import java.util.ArrayDeque;
34+
import java.util.Objects;
3435
import java.util.concurrent.BlockingQueue;
3536
import java.util.concurrent.LinkedBlockingQueue;
3637

38+
import static org.hamcrest.Matchers.instanceOf;
39+
3740
public class Netty4HttpHeaderValidatorTests extends ESTestCase {
3841
private EmbeddedChannel channel;
3942
private BlockingQueue<ValidationRequest> validatorRequestQueue;
@@ -70,18 +73,49 @@ public void testValidatorReceiveHttpRequest() {
7073
}
7174

7275
public void testDecoderFailurePassThrough() {
73-
for (var i = 0; i < 1000; i++) {
74-
var httpRequest = newHttpRequest();
75-
httpRequest.setDecoderResult(DecoderResult.failure(new Exception("bad")));
76-
channel.writeInbound(httpRequest);
77-
assertEquals(httpRequest, channel.readInbound());
76+
// send a valid request so that the buffer is nonempty
77+
final var validRequest = newHttpRequest();
78+
channel.writeInbound(validRequest);
79+
channel.writeInbound(newLastHttpContent());
80+
81+
// follow it with an invalid request which should be buffered
82+
final var invalidHttpRequest1 = newHttpRequest();
83+
invalidHttpRequest1.setDecoderResult(DecoderResult.failure(new Exception("simulated decoder failure 1")));
84+
channel.writeInbound(invalidHttpRequest1);
85+
86+
// handle the first request
87+
if (randomBoolean()) {
88+
Objects.requireNonNull(validatorRequestQueue.poll()).listener().onResponse(null);
89+
channel.runPendingTasks();
90+
assertSame(validRequest, channel.readInbound());
91+
channel.read();
92+
asInstanceOf(LastHttpContent.class, channel.readInbound()).release();
93+
} else {
94+
Objects.requireNonNull(validatorRequestQueue.poll()).listener().onFailure(new Exception("simulated validation failure"));
95+
channel.runPendingTasks();
96+
assertSame(validRequest, channel.readInbound());
7897
}
98+
99+
// handle the second request, which is read from the buffer and passed on without validation
100+
assertNull(channel.readInbound());
101+
channel.read();
102+
assertSame(invalidHttpRequest1, channel.readInbound());
103+
104+
// send another invalid request which is passed straight through
105+
final var invalidHttpRequest2 = newHttpRequest();
106+
invalidHttpRequest2.setDecoderResult(DecoderResult.failure(new Exception("simulated decoder failure 2")));
107+
channel.writeInbound(invalidHttpRequest2);
108+
if (randomBoolean()) {
109+
channel.read(); // optional read
110+
}
111+
assertSame(invalidHttpRequest2, channel.readInbound());
79112
}
80113

81114
/**
82115
* Sends back-to-back http requests and randomly fail validation.
83116
* Ensures that invalid requests drop content and valid pass through.
84117
*/
118+
@AwaitsFix(bugUrl = "coverage TODO nocommit")
85119
public void testMixedValidationResults() {
86120
for (var i = 0; i < 1000; i++) {
87121
var shouldPassValidation = randomBoolean();
@@ -121,10 +155,8 @@ public void testMixedValidationResults() {
121155
}
122156

123157
public void testIgnoreReadWhenValidating() {
124-
channel.pipeline().addFirst(new FlowControlHandler()); // catch all inbound messages
125-
126158
channel.writeInbound(newHttpRequest());
127-
channel.writeInbound(newLastHttpContent()); // should hold by flow-control-handler
159+
channel.writeInbound(newLastHttpContent());
128160
assertNull("nothing should pass yet", channel.readInbound());
129161

130162
channel.read();
@@ -161,5 +193,126 @@ public void testWithAggregator() {
161193
asInstanceOf(FullHttpRequest.class, channel.readInbound()).release();
162194
}
163195

196+
public void testBufferPipelinedRequestsWhenValidating() {
197+
final var expectedChunks = new ArrayDeque<HttpContent>();
198+
expectedChunks.addLast(newHttpContent());
199+
200+
// write one full request and one incomplete request received all at once
201+
channel.writeInbound(newHttpRequest());
202+
channel.writeInbound(newLastHttpContent());
203+
channel.writeInbound(newHttpRequest());
204+
channel.writeInbound(expectedChunks.peekLast());
205+
assertNull("nothing should pass yet", channel.readInbound());
206+
207+
if (randomBoolean()) {
208+
channel.read();
209+
}
210+
var validationRequest = validatorRequestQueue.poll();
211+
assertNotNull(validationRequest);
212+
213+
channel.read();
214+
assertNull("should ignore read while validating", channel.readInbound());
215+
216+
validationRequest.listener().onResponse(null);
217+
channel.runPendingTasks();
218+
assertTrue("http request should pass", channel.readInbound() instanceof HttpRequest);
219+
assertNull("content should not pass yet, need explicit read", channel.readInbound());
220+
221+
channel.read();
222+
asInstanceOf(LastHttpContent.class, channel.readInbound()).release();
223+
224+
// should have started to validate the next request
225+
channel.read();
226+
assertNull("should ignore read while validating", channel.readInbound());
227+
Objects.requireNonNull(validatorRequestQueue.poll()).listener().onResponse(null);
228+
229+
channel.runPendingTasks();
230+
assertThat("next http request should pass", channel.readInbound(), instanceOf(HttpRequest.class));
231+
232+
// another chunk received and is buffered, nothing is sent downstream
233+
expectedChunks.addLast(newHttpContent());
234+
channel.writeInbound(expectedChunks.peekLast());
235+
assertNull(channel.readInbound());
236+
assertFalse(channel.hasPendingTasks());
237+
238+
// the first chunk is now emitted on request
239+
channel.read();
240+
var nextChunk = asInstanceOf(HttpContent.class, channel.readInbound());
241+
assertSame(nextChunk, expectedChunks.pollFirst());
242+
nextChunk.release();
243+
assertNull(channel.readInbound());
244+
assertFalse(channel.hasPendingTasks());
245+
246+
// and the second chunk
247+
channel.read();
248+
nextChunk = asInstanceOf(HttpContent.class, channel.readInbound());
249+
assertSame(nextChunk, expectedChunks.pollFirst());
250+
nextChunk.release();
251+
assertNull(channel.readInbound());
252+
assertFalse(channel.hasPendingTasks());
253+
254+
// buffer is now drained, no more chunks available
255+
if (randomBoolean()) {
256+
channel.read(); // optional read
257+
}
258+
assertNull(channel.readInbound());
259+
assertTrue(expectedChunks.isEmpty());
260+
assertFalse(channel.hasPendingTasks());
261+
262+
// subsequent chunks are passed straight through without another read()
263+
expectedChunks.addLast(newHttpContent());
264+
channel.writeInbound(expectedChunks.peekLast());
265+
nextChunk = asInstanceOf(HttpContent.class, channel.readInbound());
266+
assertSame(nextChunk, expectedChunks.pollFirst());
267+
nextChunk.release();
268+
assertNull(channel.readInbound());
269+
assertFalse(channel.hasPendingTasks());
270+
}
271+
272+
public void testDropChunksOnValidationFailure() {
273+
// write an incomplete request which will be marked as invalid
274+
channel.writeInbound(newHttpRequest());
275+
channel.writeInbound(newHttpContent());
276+
assertNull("nothing should pass yet", channel.readInbound());
277+
278+
var validationRequest = validatorRequestQueue.poll();
279+
assertNotNull(validationRequest);
280+
validationRequest.listener().onFailure(new Exception("simulated validation failure"));
281+
282+
// failed request is passed downstream
283+
channel.runPendingTasks();
284+
var inboundRequest = asInstanceOf(HttpRequest.class, channel.readInbound());
285+
assertTrue(inboundRequest.decoderResult().isFailure());
286+
assertEquals("simulated validation failure", inboundRequest.decoderResult().cause().getMessage());
287+
288+
// chunk is not emitted (the buffer is now drained)
289+
assertNull(channel.readInbound());
290+
if (randomBoolean()) {
291+
channel.read();
292+
assertNull(channel.readInbound());
293+
}
294+
295+
// next chunk is also not emitted (it is released on receipt, not buffered)
296+
channel.writeInbound(newLastHttpContent());
297+
assertNull(channel.readInbound());
298+
if (randomBoolean()) {
299+
channel.read();
300+
assertNull(channel.readInbound());
301+
}
302+
assertFalse(channel.hasPendingTasks());
303+
304+
// next request triggers validation again
305+
final var nextRequest = newHttpRequest();
306+
channel.writeInbound(nextRequest);
307+
Objects.requireNonNull(validatorRequestQueue.poll()).listener().onResponse(null);
308+
channel.runPendingTasks();
309+
310+
if (randomBoolean()) {
311+
channel.read(); // optional read
312+
}
313+
assertSame(nextRequest, channel.readInbound());
314+
assertFalse(channel.hasPendingTasks());
315+
}
316+
164317
record ValidationRequest(HttpRequest request, Channel channel, ActionListener<Void> listener) {}
165318
}

0 commit comments

Comments
 (0)