io.reactivex.common

Class TestConsumer<T,U extends TestConsumer<T,U>>

java.lang.Object

io.reactivex.common.TestConsumer<T,U>

Type Parameters:

T - the value type consumed

U - the subclass of this BaseTestConsumer

All Implemented Interfaces:

Disposable

public abstract class TestConsumer<T,U extends TestConsumer<T,U>>
extends java.lang.Object
implements Disposable

Base class with shared infrastructure to support TestObserver and TestObserver.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TestConsumer.TestWaitStrategy Enumeration of default wait strategies when waiting for a specific number of items in awaitCount(int, Runnable).

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	checkSubscriptionOnce
protected long	completions The number of completions.
protected java.util.concurrent.CountDownLatch	done The latch that indicates an onError or onComplete has been called.
protected java.util.List<java.lang.Throwable>	errors The list of errors received.
protected int	establishedFusionMode
protected int	initialFusionMode
protected java.lang.Thread	lastThread The last thread seen by the observer.
protected java.lang.CharSequence	tag The optional tag associated with this test consumer.
protected boolean	timeout Indicates that one of the awaitX method has timed out.
protected java.util.List<T>	values The list of values received.

Constructor Summary

Constructors

Constructor and Description
TestConsumer()

Method Summary

Modifier and Type	Method and Description
U	assertComplete() Assert that this TestObserver/TestObserver received exactly one onComplete event.
U	assertEmpty() Assert that the TestObserver/TestObserver has received a Disposable but no other events.
U	assertError(java.lang.Class<? extends java.lang.Throwable> errorClass) Asserts that this TestObserver/TestObserver received exactly one onError event which is an instance of the specified errorClass class.
U	assertError(Predicate<java.lang.Throwable> errorPredicate) Asserts that this TestObserver/TestObserver received exactly one onError event for which the provided predicate returns true.
U	assertError(java.lang.Throwable error) Assert that this TestObserver/TestObserver received exactly the specified onError event value.
U	assertErrorMessage(java.lang.String message) Assert that there is a single error and it has the given message.
U	assertFailure(java.lang.Class<? extends java.lang.Throwable> error, T... values) Assert that the upstream signalled the specified values in order and then failed with a specific class or subclass of Throwable.
U	assertFailure(Predicate<java.lang.Throwable> errorPredicate, T... values) Assert that the upstream signalled the specified values in order and then failed with a Throwable for which the provided predicate returns true.
U	assertFailureAndMessage(java.lang.Class<? extends java.lang.Throwable> error, java.lang.String message, T... values) Assert that the upstream signalled the specified values in order, then failed with a specific class or subclass of Throwable and with the given exact error message.
U	assertNever(Predicate<? super T> valuePredicate) Asserts that this TestObserver/TestObserver did not receive any onNext value for which the provided predicate returns true.
U	assertNever(T value) Assert that this TestObserver/TestObserver did not receive an onNext value which is equal to the given value with respect to Objects.equals.
U	assertNoErrors() Assert that this TestObserver/TestObserver has not received any onError event.
U	assertNotComplete() Assert that this TestObserver/TestObserver has not received any onComplete event.
U	assertNoTimeout() Asserts that some awaitX method has not timed out.
abstract U	assertNotSubscribed() Assert that the onSubscribe method hasn't been called at all.
U	assertNotTerminated() Assert that the TestObserver/TestObserver has not terminated (i.e., the terminal latch is still non-zero).
U	assertNoValues() Assert that this TestObserver/TestObserver has not received any onNext events.
U	assertResult(T... values) Assert that the upstream signalled the specified values in order and completed normally.
abstract U	assertSubscribed() Assert that the onSubscribe method was called exactly once.
U	assertTerminated() Assert that the TestObserver/TestObserver terminated (i.e., the terminal latch reached zero).
U	assertTimeout() Asserts that some awaitX method has timed out.
U	assertValue(Predicate<T> valuePredicate) Asserts that this TestObserver/TestObserver received exactly one onNext value for which the provided predicate returns true.
U	assertValue(T value) Assert that this TestObserver/TestObserver received exactly one onNext value which is equal to the given value with respect to Objects.equals.
U	assertValueAt(int index, Predicate<T> valuePredicate) Asserts that this TestObserver/TestObserver received an onNext value at the given index for the provided predicate returns true.
U	assertValueCount(int count) Assert that this TestObserver/TestObserver received the specified number onNext events.
U	assertValues(T... values) Assert that the TestObserver/TestObserver received only the specified values in the specified order.
U	assertValueSequence(java.lang.Iterable<? extends T> sequence) Assert that the TestObserver/TestObserver received only the specified sequence of values in the same order.
U	assertValueSet(java.util.Collection<? extends T> expected) Assert that the TestObserver/TestObserver received only the specified values in any order.
U	await() Awaits until this TestObserver/TestObserver receives an onError or onComplete events.
boolean	await(long time, java.util.concurrent.TimeUnit unit) Awaits the specified amount of time or until this TestObserver/TestObserver receives an onError or onComplete events, whichever happens first.
U	awaitCount(int atLeast) Await until the TestObserver/TestObserver receives the given number of items or terminates by sleeping 10 milliseconds at a time up to 5000 milliseconds of timeout.
U	awaitCount(int atLeast, java.lang.Runnable waitStrategy) Await until the TestObserver/TestObserver receives the given number of items or terminates by waiting according to the wait strategy and up to 5000 milliseconds of timeout.
U	awaitCount(int atLeast, java.lang.Runnable waitStrategy, long timeoutMillis) Await until the TestObserver/TestObserver receives the given number of items or terminates.
U	awaitDone(long time, java.util.concurrent.TimeUnit unit) Awaits until the internal latch is counted down.
boolean	awaitTerminalEvent() Waits until the any terminal event has been received by this TestObserver/TestObserver or returns false if the wait has been interrupted.
boolean	awaitTerminalEvent(long duration, java.util.concurrent.TimeUnit unit) Awaits the specified amount of time or until this TestObserver/TestObserver receives an onError or onComplete events, whichever happens first.
U	clearTimeout() Clears the timeout flag set by the await methods when they timed out.
long	completions() Returns the number of times onComplete was called.
int	errorCount() Returns the number of onError exceptions received.
java.util.List<java.lang.Throwable>	errors() Returns a shared list of received onError exceptions.
protected java.lang.AssertionError	fail(java.lang.String message) Fail with the given message and add the sequence of errors as suppressed ones.
java.util.List<java.util.List<java.lang.Object>>	getEvents() Returns a list of 3 other lists: the first inner list contains the plain values received; the second list contains the potential errors and the final list contains the potential completions as Notifications.
boolean	isTerminated() Returns true if TestObserver/TestObserver received any onError or onComplete events.
boolean	isTimeout() History: 2.0.7 - experimental
java.lang.Thread	lastThread() Returns the last thread which called the onXXX methods of this TestObserver/TestObserver.
static java.lang.String	valueAndClass(java.lang.Object o) Appends the class name to a non-null value.
int	valueCount() Returns the number of onNext values received.
java.util.List<T>	values() Returns a shared list of received onNext values.
U	withTag(java.lang.CharSequence tag) Set the tag displayed along with an assertion failure's other state information.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.reactivex.common.Disposable

dispose, isDisposed

Field Detail

done

protected final java.util.concurrent.CountDownLatch done

The latch that indicates an onError or onComplete has been called.

values

protected final java.util.List<T> values

The list of values received.

errors

protected final java.util.List<java.lang.Throwable> errors

The list of errors received.

completions

protected long completions

The number of completions.

lastThread

protected java.lang.Thread lastThread

The last thread seen by the observer.

checkSubscriptionOnce

protected boolean checkSubscriptionOnce

initialFusionMode

protected int initialFusionMode

establishedFusionMode

protected int establishedFusionMode

tag

protected java.lang.CharSequence tag

The optional tag associated with this test consumer.

Since:

2.0.7

timeout

protected boolean timeout

Indicates that one of the awaitX method has timed out.

Since:

2.0.7

Constructor Detail

TestConsumer

public TestConsumer()

Method Detail

lastThread

public final java.lang.Thread lastThread()

Returns the last thread which called the onXXX methods of this TestObserver/TestObserver.

Returns:

the last thread which called the onXXX methods

values

public final java.util.List<T> values()

Returns a shared list of received onNext values.

Returns:

a list of received onNext values

errors

public final java.util.List<java.lang.Throwable> errors()

Returns a shared list of received onError exceptions.

Returns:

a list of received events onError exceptions

completions

public final long completions()

Returns the number of times onComplete was called.

Returns:

the number of times onComplete was called

isTerminated

public final boolean isTerminated()

Returns true if TestObserver/TestObserver received any onError or onComplete events.

Returns:

true if TestObserver/TestObserver received any onError or onComplete events

valueCount

public final int valueCount()

Returns the number of onNext values received.

Returns:

the number of onNext values received

errorCount

public final int errorCount()

Returns the number of onError exceptions received.

Returns:

the number of onError exceptions received

fail

protected final java.lang.AssertionError fail(java.lang.String message)

Fail with the given message and add the sequence of errors as suppressed ones.

Note this is deliberately the only fail method. Most of the times an assertion would fail but it is possible it was due to an exception somewhere. This construct will capture those potential errors and report it along with the original failure.

Parameters:

message - the message to use

Returns:

AssertionError the prepared AssertionError instance

await

public final U await()
              throws java.lang.InterruptedException

Awaits until this TestObserver/TestObserver receives an onError or onComplete events.

Returns:

this

Throws:

java.lang.InterruptedException - if the current thread is interrupted while waiting

See Also:

awaitTerminalEvent()

await

public final boolean await(long time,
                           java.util.concurrent.TimeUnit unit)
                    throws java.lang.InterruptedException

Awaits the specified amount of time or until this TestObserver/TestObserver receives an onError or onComplete events, whichever happens first.

Parameters:

time - the waiting time

unit - the time unit of the waiting time

Returns:

true if the TestObserver/TestObserver terminated, false if timeout happened

Throws:

java.lang.InterruptedException - if the current thread is interrupted while waiting

See Also:

awaitTerminalEvent(long, TimeUnit)

assertComplete

public final U assertComplete()

Assert that this TestObserver/TestObserver received exactly one onComplete event.

Returns:

this;

assertNotComplete

public final U assertNotComplete()

Assert that this TestObserver/TestObserver has not received any onComplete event.

Returns:

this;

assertNoErrors

public final U assertNoErrors()

Assert that this TestObserver/TestObserver has not received any onError event.

Returns:

this;

assertError

public final U assertError(java.lang.Throwable error)

Assert that this TestObserver/TestObserver received exactly the specified onError event value.

The comparison is performed via Objects.equals(); since most exceptions don't implement equals(), this assertion may fail. Use the assertError(Class) overload to test against the class of an error instead of an instance of an error or assertError(Predicate) to test with different condition.

Parameters:

error - the error to check

Returns:

this;

See Also:

assertError(Class), assertError(Predicate)

assertError

public final U assertError(java.lang.Class<? extends java.lang.Throwable> errorClass)

Asserts that this TestObserver/TestObserver received exactly one onError event which is an instance of the specified errorClass class.

Parameters:

errorClass - the error class to expect

Returns:

this;

assertError

public final U assertError(Predicate<java.lang.Throwable> errorPredicate)

Asserts that this TestObserver/TestObserver received exactly one onError event for which the provided predicate returns true.

Parameters:

errorPredicate - the predicate that receives the error Throwable and should return true for expected errors.

Returns:

this

assertValue

public final U assertValue(T value)

Assert that this TestObserver/TestObserver received exactly one onNext value which is equal to the given value with respect to Objects.equals.

Parameters:

value - the value to expect

Returns:

this;

assertNever

public final U assertNever(T value)

Assert that this TestObserver/TestObserver did not receive an onNext value which is equal to the given value with respect to Objects.equals.

History: 2.0.5 - experimental

Parameters:

value - the value to expect not being received

Returns:

this;

Since:

2.1

assertValue

public final U assertValue(Predicate<T> valuePredicate)

Asserts that this TestObserver/TestObserver received exactly one onNext value for which the provided predicate returns true.

Parameters:

valuePredicate - the predicate that receives the onNext value and should return true for the expected value.

Returns:

this

assertNever

public final U assertNever(Predicate<? super T> valuePredicate)

Asserts that this TestObserver/TestObserver did not receive any onNext value for which the provided predicate returns true.

History: 2.0.5 - experimental

Parameters:

valuePredicate - the predicate that receives the onNext value and should return true for the expected value.

Returns:

this

Since:

2.1

assertValueAt

public final U assertValueAt(int index,
                             Predicate<T> valuePredicate)

Asserts that this TestObserver/TestObserver received an onNext value at the given index for the provided predicate returns true.

Parameters:

index - the position to assert on

valuePredicate - the predicate that receives the onNext value and should return true for the expected value.

Returns:

this

valueAndClass

public static java.lang.String valueAndClass(java.lang.Object o)

Appends the class name to a non-null value.

Parameters:

o - the object

Returns:

the string representation

assertValueCount

public final U assertValueCount(int count)

Assert that this TestObserver/TestObserver received the specified number onNext events.

Parameters:

count - the expected number of onNext events

Returns:

this;

assertNoValues

public final U assertNoValues()

Assert that this TestObserver/TestObserver has not received any onNext events.

Returns:

this;

assertValues

public final U assertValues(T... values)

Assert that the TestObserver/TestObserver received only the specified values in the specified order.

Parameters:

values - the values expected

Returns:

this;

See Also:

assertValueSet(Collection)

assertValueSet

public final U assertValueSet(java.util.Collection<? extends T> expected)

Assert that the TestObserver/TestObserver received only the specified values in any order.

This helps asserting when the order of the values is not guaranteed, i.e., when merging asynchronous streams.

Parameters:

expected - the collection of values expected in any order

Returns:

this;

assertValueSequence

public final U assertValueSequence(java.lang.Iterable<? extends T> sequence)

Assert that the TestObserver/TestObserver received only the specified sequence of values in the same order.

Parameters:

sequence - the sequence of expected values in order

Returns:

this;

assertTerminated

public final U assertTerminated()

Assert that the TestObserver/TestObserver terminated (i.e., the terminal latch reached zero).

Returns:

this;

assertNotTerminated

public final U assertNotTerminated()

Assert that the TestObserver/TestObserver has not terminated (i.e., the terminal latch is still non-zero).

Returns:

this;

awaitTerminalEvent

public final boolean awaitTerminalEvent()

Waits until the any terminal event has been received by this TestObserver/TestObserver or returns false if the wait has been interrupted.

Returns:

true if the TestObserver/TestObserver terminated, false if the wait has been interrupted

awaitTerminalEvent

public final boolean awaitTerminalEvent(long duration,
                                        java.util.concurrent.TimeUnit unit)

Awaits the specified amount of time or until this TestObserver/TestObserver receives an onError or onComplete events, whichever happens first.

Parameters:

duration - the waiting time

unit - the time unit of the waiting time

Returns:

true if the TestObserver/TestObserver terminated, false if timeout or interrupt happened

assertErrorMessage

public final U assertErrorMessage(java.lang.String message)

Assert that there is a single error and it has the given message.

Parameters:

message - the message expected

Returns:

this

getEvents

public final java.util.List<java.util.List<java.lang.Object>> getEvents()

Returns a list of 3 other lists: the first inner list contains the plain values received; the second list contains the potential errors and the final list contains the potential completions as Notifications.

Returns:

a list of (values, errors, completion-notifications)

assertSubscribed

public abstract U assertSubscribed()

Assert that the onSubscribe method was called exactly once.

Returns:

this;

assertNotSubscribed

public abstract U assertNotSubscribed()

Assert that the onSubscribe method hasn't been called at all.

Returns:

this;

assertResult

public final U assertResult(T... values)

Assert that the upstream signalled the specified values in order and completed normally.

Parameters:

values - the expected values, asserted in order

Returns:

this

See Also:

assertFailure(Class, Object...), assertFailure(Predicate, Object...), assertFailureAndMessage(Class, String, Object...)

assertFailure

public final U assertFailure(java.lang.Class<? extends java.lang.Throwable> error,
                             T... values)

Assert that the upstream signalled the specified values in order and then failed with a specific class or subclass of Throwable.

Parameters:

error - the expected exception (parent) class

values - the expected values, asserted in order

Returns:

this

assertFailure

public final U assertFailure(Predicate<java.lang.Throwable> errorPredicate,
                             T... values)

Assert that the upstream signalled the specified values in order and then failed with a Throwable for which the provided predicate returns true.

Parameters:

errorPredicate - the predicate that receives the error Throwable and should return true for expected errors.

values - the expected values, asserted in order

Returns:

this

assertFailureAndMessage

public final U assertFailureAndMessage(java.lang.Class<? extends java.lang.Throwable> error,
                                       java.lang.String message,
                                       T... values)

Assert that the upstream signalled the specified values in order, then failed with a specific class or subclass of Throwable and with the given exact error message.

Parameters:

error - the expected exception (parent) class

message - the expected failure message

values - the expected values, asserted in order

Returns:

this

awaitDone

public final U awaitDone(long time,
                         java.util.concurrent.TimeUnit unit)

Awaits until the internal latch is counted down.

If the wait times out or gets interrupted, the TestObserver/TestObserver is cancelled.

Parameters:

time - the waiting time

unit - the time unit of the waiting time

Returns:

this

Throws:

java.lang.RuntimeException - wrapping an InterruptedException if the wait is interrupted

assertEmpty

public final U assertEmpty()

Assert that the TestObserver/TestObserver has received a Disposable but no other events.

Returns:

this

withTag

public final U withTag(java.lang.CharSequence tag)

Set the tag displayed along with an assertion failure's other state information.

History: 2.0.7 - experimental

Parameters:

tag - the string to display (null won't print any tag)

Returns:

this

Since:

2.1

awaitCount

public final U awaitCount(int atLeast)

Await until the TestObserver/TestObserver receives the given number of items or terminates by sleeping 10 milliseconds at a time up to 5000 milliseconds of timeout.

History: 2.0.7 - experimental

Parameters:

atLeast - the number of items expected at least

Returns:

this

Since:

2.1

See Also:

awaitCount(int, Runnable, long)

awaitCount

public final U awaitCount(int atLeast,
                          java.lang.Runnable waitStrategy)

Await until the TestObserver/TestObserver receives the given number of items or terminates by waiting according to the wait strategy and up to 5000 milliseconds of timeout.

History: 2.0.7 - experimental

Parameters:

atLeast - the number of items expected at least

waitStrategy - a Runnable called when the current received count hasn't reached the expected value and there was no terminal event either, see TestConsumer.TestWaitStrategy for examples

Returns:

this

Since:

2.1

See Also:

awaitCount(int, Runnable, long)

awaitCount

public final U awaitCount(int atLeast,
                          java.lang.Runnable waitStrategy,
                          long timeoutMillis)

Await until the TestObserver/TestObserver receives the given number of items or terminates.

History: 2.0.7 - experimental

Parameters:

atLeast - the number of items expected at least

waitStrategy - a Runnable called when the current received count hasn't reached the expected value and there was no terminal event either, see TestConsumer.TestWaitStrategy for examples

timeoutMillis - if positive, the await ends if the specified amount of time has passed no matter how many items were received

Returns:

this

Since:

2.1

isTimeout

public final boolean isTimeout()

History: 2.0.7 - experimental

Returns:

true if one of the timeout-based await methods has timed out.

Since:

2.1

See Also:

clearTimeout(), assertTimeout(), assertNoTimeout()

clearTimeout

public final U clearTimeout()

Clears the timeout flag set by the await methods when they timed out.

History: 2.0.7 - experimental

Returns:

this

Since:

2.1

See Also:

isTimeout()

assertTimeout

public final U assertTimeout()

Asserts that some awaitX method has timed out.

History: 2.0.7 - experimental

Returns:

this

Since:

2.1

assertNoTimeout

public final U assertNoTimeout()

Asserts that some awaitX method has not timed out.

History: 2.0.7 - experimental

Returns:

this

Since:

2.1