Package reactor.test

Interface StepVerifier.LastStep

All Known Subinterfaces:

StepVerifier.FirstStep<T>, StepVerifier.Step<T>

Enclosing interface:

StepVerifier

public static interface StepVerifier.LastStep

Define a builder for terminal states.

Method Summary

Modifier and Type	Method	Description
StepVerifier	consumeErrorWith(Consumer<Throwable> consumer)	Expect an error and consume with the given consumer.
StepVerifier	expectComplete()	Expect the completion signal.
StepVerifier	expectError()	Expect an unspecified error.
StepVerifier	expectError(Class<? extends Throwable> clazz)	Expect an error of the specified type.
StepVerifier	expectErrorMatches(Predicate<Throwable> predicate)	Expect an error and evaluate with the given predicate.
StepVerifier	expectErrorMessage(String errorMessage)	Expect an error with the specified message.
StepVerifier	expectErrorSatisfies(Consumer<Throwable> assertionConsumer)	Expect an error and assert it via assertion(s) provided as a Consumer.
StepVerifier	expectTimeout(Duration duration)	Verify that the Publisher under test doesn't terminate but rather times out after the provided Duration (a timeout implying a cancellation of the source).
StepVerifier	thenCancel()	Cancel the underlying subscription.
Duration	verifyComplete()	Trigger the verification, expecting a completion signal as terminal event.
Duration	verifyError()	Trigger the verification, expecting an unspecified error as terminal event.
Duration	verifyError(Class<? extends Throwable> clazz)	Trigger the verification, expecting an error of the specified type as terminal event.
Duration	verifyErrorMatches(Predicate<Throwable> predicate)	Trigger the verification, expecting an error that matches the given predicate as terminal event.
Duration	verifyErrorMessage(String errorMessage)	Trigger the verification, expecting an error with the specified message as terminal event.
Duration	verifyErrorSatisfies(Consumer<Throwable> assertionConsumer)	Trigger the verification, expecting an error as terminal event which gets asserted via assertion(s) provided as a Consumer.
default Duration	verifyTimeout(Duration duration)	Trigger the verification, expecting that the Publisher under test doesn't terminate but rather times out after the provided Duration.

Method Details

consumeErrorWith

StepVerifier consumeErrorWith(Consumer<Throwable> consumer)

Expect an error and consume with the given consumer. Any AssertionErrors thrown by the consumer will be rethrown during verification.

Parameters:

consumer - the consumer for the exception

Returns:

the built verification

expectError

StepVerifier expectError()

Expect an unspecified error.

Returns:

the built verification scenario, ready to be verified

See Also:

• Subscriber.onError(Throwable)

expectError

StepVerifier expectError(Class<? extends Throwable> clazz)

Expect an error of the specified type.

Parameters:

clazz - the expected error type

Returns:

the built verification scenario, ready to be verified

See Also:

• Subscriber.onError(Throwable)

expectErrorMessage

StepVerifier expectErrorMessage(String errorMessage)

Expect an error with the specified message.

Parameters:

errorMessage - the expected error message

Returns:

the built verification scenario, ready to be verified

See Also:

• Subscriber.onError(Throwable)

expectErrorMatches

StepVerifier expectErrorMatches(Predicate<Throwable> predicate)

Expect an error and evaluate with the given predicate.

Parameters:

predicate - the predicate to test on the next received error

Returns:

the built verification scenario, ready to be verified

See Also:

• Subscriber.onError(Throwable)

expectErrorSatisfies

StepVerifier expectErrorSatisfies(Consumer<Throwable> assertionConsumer)

Expect an error and assert it via assertion(s) provided as a Consumer. Any AssertionError thrown by the consumer has its message propagated through a new StepVerifier-specific AssertionError.

Parameters:

assertionConsumer - the consumer that applies assertion(s) on the next received error

Returns:

the built verification scenario, ready to be verified

See Also:

• Subscriber.onError(Throwable)

expectTimeout

StepVerifier expectTimeout(Duration duration)

Verify that the Publisher under test doesn't terminate but rather times out after the provided Duration (a timeout implying a cancellation of the source).

This is equivalent to appending the timeout operator to the publisher and expecting a TimeoutException onError signal, while also triggering a wait to ensure unexpected signals are detected.

Parameters:

duration - the Duration for which no new event is expected

Returns:

the built verification scenario, ready to be verified

expectComplete

StepVerifier expectComplete()

Expect the completion signal.

Returns:

the built verification scenario, ready to be verified

See Also:

• Subscriber.onComplete()

thenCancel

StepVerifier thenCancel()

Cancel the underlying subscription. This happens sequentially after the previous step.

Note that time-manipulating operators like StepVerifier.Step.expectNoEvent(Duration) are detected and waited for before cancellation occurs.

Returns:

the built verification scenario, ready to be verified

See Also:

• Subscription.cancel()

verifyError

Duration verifyError()

Trigger the verification, expecting an unspecified error as terminal event.

This is a convenience method that calls StepVerifier.verify() in addition to the expectation. Explicitly use the expect method and verification method separately if you need something more specific (like activating logging or changing the default timeout).

Returns:

the actual Duration the verification took.

See Also:

• expectError()
• StepVerifier.verify()
• Subscriber.onError(Throwable)

verifyError

Duration verifyError(Class<? extends Throwable> clazz)

Trigger the verification, expecting an error of the specified type as terminal event.

This is a convenience method that calls StepVerifier.verify() in addition to the expectation. Explicitly use the expect method and verification method separately if you need something more specific (like activating logging or changing the default timeout).

Parameters:

clazz - the expected error type

Returns:

the actual Duration the verification took.

See Also:

• expectError(Class)
• StepVerifier.verify()
• Subscriber.onError(Throwable)

verifyErrorMessage

Duration verifyErrorMessage(String errorMessage)

Trigger the verification, expecting an error with the specified message as terminal event.

This is a convenience method that calls StepVerifier.verify() in addition to the expectation. Explicitly use the expect method and verification method separately if you need something more specific (like activating logging or changing the default timeout).

Parameters:

errorMessage - the expected error message

Returns:

the actual Duration the verification took.

See Also:

• expectErrorMessage(String)
• StepVerifier.verify()
• Subscriber.onError(Throwable)

verifyErrorMatches

Duration verifyErrorMatches(Predicate<Throwable> predicate)

Trigger the verification, expecting an error that matches the given predicate as terminal event.

This is a convenience method that calls StepVerifier.verify() in addition to the expectation. Explicitly use the expect method and verification method separately if you need something more specific (like activating logging or changing the default timeout).

Parameters:

predicate - the predicate to test on the next received error

Returns:

the actual Duration the verification took.

See Also:

• expectErrorMatches(Predicate)
• StepVerifier.verify()
• Subscriber.onError(Throwable)

verifyTimeout

default Duration verifyTimeout(Duration duration)

Trigger the verification, expecting that the Publisher under test doesn't terminate but rather times out after the provided Duration. A timeout implies a cancellation of the source.

This is a convenience method that calls StepVerifier.verify() in addition to expectTimeout(Duration). The later is equivalent to appending the timeout operator to the publisher and expecting a TimeoutException onError signal, while also triggering a wait to ensure unexpected signals are detected.

Parameters:

duration - the Duration for which no new event is expected

Returns:

the actual Duration the verification took.

See Also:

• expectTimeout(Duration)
• StepVerifier.verify()

verifyErrorSatisfies

Duration verifyErrorSatisfies(Consumer<Throwable> assertionConsumer)

Trigger the verification, expecting an error as terminal event which gets asserted via assertion(s) provided as a Consumer. Any AssertionError thrown by the consumer has its message propagated through a new StepVerifier-specific AssertionError.

This is a convenience method that calls StepVerifier.verify() in addition to the expectation. Explicitly use the expect method and verification method separately if you need something more specific (like activating logging or changing the default timeout).

Parameters:

assertionConsumer - the consumer that applies assertion(s) on the next received error

Returns:

the actual Duration the verification took.

See Also:

• expectErrorSatisfies(Consumer)
• StepVerifier.verify()
• Subscriber.onError(Throwable)

verifyComplete

Duration verifyComplete()

Trigger the verification, expecting a completion signal as terminal event.

This is a convenience method that calls StepVerifier.verify() in addition to the expectation. Explicitly use the expect method and verification method separately if you need something more specific (like activating logging or changing the default timeout).

Returns:

the actual Duration the verification took.

See Also:

• expectComplete()
• StepVerifier.verify()
• Subscriber.onComplete()