Package io.smallrye.mutiny.helpers.test

Class UniAssertSubscriber<T>

java.lang.Object

io.smallrye.mutiny.helpers.test.UniAssertSubscriber<T>

Type Parameters:

T - the type of the items

All Implemented Interfaces:

UniSubscriber<T>

public class UniAssertSubscriber<T>
extends java.lang.Object
implements UniSubscriber<T>

A Uni UniSubscriber for testing purposes that comes with useful assertion helpers.

Constructor Summary

Constructors

Constructor	Description
UniAssertSubscriber()	Create a new UniAssertSubscriber with no upfront cancellation.
UniAssertSubscriber(boolean cancelled)	Create a new UniAssertSubscriber.

Method Summary

Modifier and Type	Method	Description
UniAssertSubscriber<T>	assertCompleted()	Assert that the Uni has completed.
UniAssertSubscriber<T>	assertFailed()	Assert that the Uni has failed.
UniAssertSubscriber<T>	assertFailedWith(java.lang.Class<? extends java.lang.Throwable> expectedTypeOfFailure, java.lang.String expectedMessage)	Assert that the Uni has failed.
UniAssertSubscriber<T>	assertItem(T expected)	Assert that the Uni has received an item.
UniAssertSubscriber<T>	assertNotSubscribed()	Assert that the Uni has not been subscribed.
UniAssertSubscriber<T>	assertNotTerminated()	Assert that the Uni has not terminated.
UniAssertSubscriber<T>	assertSignalsReceivedInOrder()	Assert that signals have been received in correct order.
UniAssertSubscriber<T>	assertSubscribed()	Assert that the Uni has been subscribed.
UniAssertSubscriber<T>	assertTerminated()	Assert that the Uni has terminated.
UniAssertSubscriber<T>	await()	Await for termination.
void	cancel()	Cancel the subscription.
static <T> UniAssertSubscriber<T>	create()	Create a new UniAssertSubscriber with no upfront cancellation.
java.lang.Throwable	getFailure()	Get the Uni failure, if any.
T	getItem()	Get the Uni item, if any.
java.lang.String	getOnFailureThreadName()	Get the name of the thread that called onFailure(Throwable), if any.
java.lang.String	getOnItemThreadName()	Get the name of the thread that called onItem(Object), if any.
java.lang.String	getOnSubscribeThreadName()	Get the name of the thread that called onSubscribe(UniSubscription), if any.
java.util.List<UniSignal>	getSignals()	Get the UniSignal audit trail for this subscriber.
void	onFailure(java.lang.Throwable failure)	Called if the computation of the item by the subscriber Uni failed.
void	onItem(T item)	Event handler called once the item has been computed by the subscribed Uni.
void	onSubscribe(UniSubscription subscription)	Event handler called once the subscribed Uni has taken into account the subscription.

Methods inherited from class java.lang.Object

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

Constructor Detail

UniAssertSubscriber

public UniAssertSubscriber(boolean cancelled)

Create a new UniAssertSubscriber.

Parameters:

cancelled - true when the subscription shall be cancelled upfront, false otherwise

UniAssertSubscriber

public UniAssertSubscriber()

Create a new UniAssertSubscriber with no upfront cancellation.

Method Detail

create

public static <T> UniAssertSubscriber<T> create()

Create a new UniAssertSubscriber with no upfront cancellation.

Type Parameters:

T - the type of the item

Returns:

a new subscriber

onSubscribe

public void onSubscribe(UniSubscription subscription)

Description copied from interface: UniSubscriber

Event handler called once the subscribed Uni has taken into account the subscription. The Uni have triggered the computation of the item. IMPORTANT: UniSubscriber.onItem(Object) and UniSubscriber.onFailure(Throwable) would not be called before the invocation of this method.

• Executor: Operate on no particular executor, except if Uni.runSubscriptionOn(Executor) has been called
• Exception: Throwing an exception cancels the subscription, UniSubscriber.onItem(Object) and UniSubscriber.onFailure(Throwable) won't be called

Specified by:

onSubscribe in interface UniSubscriber<T>

Parameters:

subscription - the subscription allowing to cancel the computation.

onItem

public void onItem(T item)

Description copied from interface: UniSubscriber

Event handler called once the item has been computed by the subscribed Uni. IMPORTANT: this method will be only called once per subscription. If UniSubscriber.onFailure(Throwable) is called, this method won't be called.

• Executor: Operate on no particular executor, except if Uni.emitOn(java.util.concurrent.Executor) has been called
• Exception: Throwing an exception cancels the subscription.

Specified by:

onItem in interface UniSubscriber<T>

Parameters:

item - the item, may be null.

onFailure

public void onFailure(java.lang.Throwable failure)

Description copied from interface: UniSubscriber

Called if the computation of the item by the subscriber Uni failed. IMPORTANT: this method will be only called once per subscription. If UniSubscriber.onItem(Object) is called, this method won't be called.

• Executor: Operate on no particular executor, except if Uni.emitOn(java.util.concurrent.Executor) has been called
• Exception: Throwing an exception cancels the subscription.

Specified by:

onFailure in interface UniSubscriber<T>

Parameters:

failure - the failure, cannot be null.

await

public UniAssertSubscriber<T> await()

Await for termination.

Returns:

this UniAssertSubscriber

assertCompleted

public UniAssertSubscriber<T> assertCompleted()

Assert that the Uni has completed.

Returns:

this UniAssertSubscriber

assertFailed

public UniAssertSubscriber<T> assertFailed()

Assert that the Uni has failed.

Returns:

this UniAssertSubscriber

getItem

public T getItem()

Get the Uni item, if any.

Returns:

the item or null

getFailure

public java.lang.Throwable getFailure()

Get the Uni failure, if any.

Returns:

the failure or null

assertItem

public UniAssertSubscriber<T> assertItem(T expected)

Assert that the Uni has received an item.

Parameters:

expected - the expected item

Returns:

this UniAssertSubscriber

assertFailedWith

public UniAssertSubscriber<T> assertFailedWith(java.lang.Class<? extends java.lang.Throwable> expectedTypeOfFailure,
                                               java.lang.String expectedMessage)

Assert that the Uni has failed.

Parameters:

expectedTypeOfFailure - the expected failure type

expectedMessage - a message that is expected to be contained in the failure message

Returns:

this UniAssertSubscriber

getOnItemThreadName

public java.lang.String getOnItemThreadName()

Get the name of the thread that called onItem(Object), if any.

Returns:

the thread name

getOnFailureThreadName

public java.lang.String getOnFailureThreadName()

Get the name of the thread that called onFailure(Throwable), if any.

Returns:

the thread name

getOnSubscribeThreadName

public java.lang.String getOnSubscribeThreadName()

Get the name of the thread that called onSubscribe(UniSubscription), if any.

Returns:

the thread name

cancel

public void cancel()

Cancel the subscription.

assertTerminated

public UniAssertSubscriber<T> assertTerminated()

Assert that the Uni has terminated.

Returns:

this UniAssertSubscriber

assertNotTerminated

public UniAssertSubscriber<T> assertNotTerminated()

Assert that the Uni has not terminated.

Returns:

this UniAssertSubscriber

assertSubscribed

public UniAssertSubscriber<T> assertSubscribed()

Assert that the Uni has been subscribed.

Returns:

this UniAssertSubscriber

assertNotSubscribed

public UniAssertSubscriber<T> assertNotSubscribed()

Assert that the Uni has not been subscribed.

Returns:

this UniAssertSubscriber

getSignals

public java.util.List<UniSignal> getSignals()

Get the UniSignal audit trail for this subscriber.

Returns:

the signals in receive order

assertSignalsReceivedInOrder

public UniAssertSubscriber<T> assertSignalsReceivedInOrder()

Assert that signals have been received in correct order.

An example of an legal sequence would be receiving onSubscribe -> onItem. An example of an illegal sequence would be receiving onItem -> onSubscribe.

Returns:

this UniAssertSubscriber