org.testcontainers.containers.output

Class WaitingConsumer

java.lang.Object

org.testcontainers.containers.output.WaitingConsumer

All Implemented Interfaces:

Consumer<OutputFrame>

public class WaitingConsumer
extends Object
implements Consumer<OutputFrame>

A consumer for container output that buffers lines in a BlockingDeque and enables tests to wait for a matching condition.

Constructor Summary

Constructors

Constructor and Description
WaitingConsumer()

Method Summary

Modifier and Type	Method and Description
void	accept(OutputFrame frame)
LinkedBlockingDeque<OutputFrame>	getFrames() Get access to the underlying frame buffer.
void	waitUntil(Predicate<OutputFrame> predicate) Wait until any frame (usually, line) of output matches the provided predicate.
void	waitUntil(Predicate<OutputFrame> predicate, int limit, TimeUnit limitUnit) Wait until any frame (usually, line) of output matches the provided predicate.
void	waitUntil(Predicate<OutputFrame> predicate, long limit, TimeUnit limitUnit, int times) Wait until any frame (usually, line) of output matches the provided predicate.
void	waitUntilEnd() Wait until Docker closes the stream of output.
void	waitUntilEnd(long limit, TimeUnit limitUnit) Wait until Docker closes the stream of output.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.function.Consumer

andThen

Constructor Detail

WaitingConsumer

public WaitingConsumer()

Method Detail

accept

public void accept(OutputFrame frame)

Specified by:

accept in interface Consumer<OutputFrame>

getFrames

public LinkedBlockingDeque<OutputFrame> getFrames()

Get access to the underlying frame buffer. Modifying the buffer contents is likely to cause problems if the waitUntil() methods are also being used, as they feed on the same data.

Returns:

the collection of frames

waitUntil

public void waitUntil(Predicate<OutputFrame> predicate)
               throws TimeoutException

Wait until any frame (usually, line) of output matches the provided predicate.

Note that lines will often have a trailing newline character, and this is not stripped off before the predicate is tested.

Parameters:

predicate - a predicate to test against each frame

Throws:

TimeoutException

waitUntil

public void waitUntil(Predicate<OutputFrame> predicate,
                      int limit,
                      TimeUnit limitUnit)
               throws TimeoutException

Wait until any frame (usually, line) of output matches the provided predicate.

Note that lines will often have a trailing newline character, and this is not stripped off before the predicate is tested.

Parameters:

predicate - a predicate to test against each frame

limit - maximum time to wait

limitUnit - maximum time to wait (units)

Throws:

TimeoutException

waitUntil

public void waitUntil(Predicate<OutputFrame> predicate,
                      long limit,
                      TimeUnit limitUnit,
                      int times)
               throws TimeoutException

Wait until any frame (usually, line) of output matches the provided predicate.

Note that lines will often have a trailing newline character, and this is not stripped off before the predicate is tested.

Parameters:

predicate - a predicate to test against each frame

limit - maximum time to wait

limitUnit - maximum time to wait (units)

times - number of times the predicate has to match

Throws:

TimeoutException

waitUntilEnd

public void waitUntilEnd()
                  throws TimeoutException

Wait until Docker closes the stream of output.

Throws:

TimeoutException

waitUntilEnd

public void waitUntilEnd(long limit,
                         TimeUnit limitUnit)
                  throws TimeoutException

Wait until Docker closes the stream of output.

Parameters:

limit - maximum time to wait

limitUnit - maximum time to wait (units)

Throws:

TimeoutException