pl.wkr.fluentrule.api

Class FluentExpectedException

java.lang.Object

pl.wkr.fluentrule.api.FluentExpectedException

All Implemented Interfaces:

TestRule

public class FluentExpectedException
extends Object

Implements junit's expected exception rule in fluent way, returning AssertJ ThrowableAssert.

Usage in tests:

  @Rule
  public FluentExpectedException thrown = FluentExpectedException.none();

  @Test
  public void fluent_rule_any_exception() {
      thrown.expect().hasMessage("exc").hasNoCause();
      throw new IllegalStateException("exc");
  }
 

Author:

Wojciech Krak

See Also:

Project site - more examples

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FluentExpectedException() Create new instance of FluentExpectedException rule.
protected	FluentExpectedException(ProxiesFactory proxiesFactory) Create new instance of FluentExpectedException rule.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addCheck(Check check) Add assertion callback to callback list.
Statement	apply(Statement base, Description description) Method required by junit from rules implementations.
ThrowableAssert	expect() Starts expecting of any exception.
ThrowableAssert	expect(Class<? extends Throwable> type) Starts expecting of exception of specified type.
ThrowableAssert	expectCause() Start expecting of exception with any cause.
ThrowableAssert	expectCause(Class<? extends Throwable> type) Starts expecting of exception with cause of specified type.
<A extends AbstractThrowableAssert<A,T>,T extends Throwable> A	expectCauseWith(Class<A> assertClass)
ThrowableAssert	expectRootCause() Starts expecting of exception with any root cause.
ThrowableAssert	expectRootCause(Class<? extends Throwable> type) Starts expecting of exception with root cause of specified type.
<A extends AbstractThrowableAssert<A,T>,T extends Throwable> A	expectRootCauseWith(Class<A> assertClass)
<A extends AbstractThrowableAssert<A,T>,T extends Throwable> A	expectWith(Class<A> assertClass) Starts expecting exception and return custom throwable assert to specify expectations on exception.
protected void	failBecauseExceptionWasNotThrown() Throws AssertionError with info that exception was expected but not thrown.
S	handleAssertionErrors() Starts handling of assertion errors.
S	handleAssumptionViolatedExceptions() Starts handling of AssumptionViolatedException.
protected void	handleException(Throwable e) Handles thrown exception.
boolean	isExceptionExpected() Returns if rule is expecting any exception.
protected S	myself()
static FluentExpectedException	none() Creates and returns new instance of FluentExpectedException rule.

Methods inherited from class java.lang.Object

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

Constructor Detail

FluentExpectedException

protected FluentExpectedException()

Create new instance of FluentExpectedException rule. Standard constructor for extending.

FluentExpectedException

protected FluentExpectedException(ProxiesFactory proxiesFactory)

Create new instance of FluentExpectedException rule.

Parameters:

proxiesFactory -

Method Detail

none

public static FluentExpectedException none()

Creates and returns new instance of FluentExpectedException rule.

Returns:

new instance

expect

public ThrowableAssert expect()

Starts expecting of any exception.

Returns:

ThrowableAssert to specify more expectations

expect

public ThrowableAssert expect(Class<? extends Throwable> type)

Starts expecting of exception of specified type.

Parameters:

type - expected type of exception

Returns:

ThrowableAssert to specify more expectations

expectWith

public <A extends AbstractThrowableAssert<A,T>,T extends Throwable> A expectWith(Class<A> assertClass)

Starts expecting exception and return custom throwable assert to specify expectations on exception. Method take class of any custom implementation of AbstractThrowableAssert and returns proxy of it, to allow specify expectations on thrown exception.

Type Parameters:

A - class of custom throwable assert

T - class of throwables supported by custom throwable assert

Parameters:

assertClass - class of custom throwable assert, subclass of AbstractThrowableAssert

Returns:

instance of custom throwable assert to specify more expectations on exception

expectCause

public ThrowableAssert expectCause()

Start expecting of exception with any cause.

Returns:

ThrowableAssert to specify more expectations on exception's cause

expectCause

public ThrowableAssert expectCause(Class<? extends Throwable> type)

Starts expecting of exception with cause of specified type.

Parameters:

type - expected type of exception's cause

Returns:

ThrowableAssert to specify more expectations on exception's cause

expectCauseWith

public <A extends AbstractThrowableAssert<A,T>,T extends Throwable> A expectCauseWith(Class<A> assertClass)

expectRootCause

public ThrowableAssert expectRootCause()

Starts expecting of exception with any root cause.

Returns:

ThrowableAssert to specify more expectations on exception's root cause

expectRootCause

public ThrowableAssert expectRootCause(Class<? extends Throwable> type)

Starts expecting of exception with root cause of specified type.

Parameters:

type - expected type of exception's root cause

Returns:

ThrowableAssert to specify more expectations on exception's root cause

expectRootCauseWith

public <A extends AbstractThrowableAssert<A,T>,T extends Throwable> A expectRootCauseWith(Class<A> assertClass)

addCheck

protected void addCheck(Check check)

Add assertion callback to callback list.

Parameters:

check - callback to assert thrown exception

isExceptionExpected

public boolean isExceptionExpected()

Returns if rule is expecting any exception.

Returns:

true if any exception is expected

handleException

protected void handleException(Throwable e)

Handles thrown exception.

Parameters:

e - thrown exception

failBecauseExceptionWasNotThrown

protected void failBecauseExceptionWasNotThrown()

Throws AssertionError with info that exception was expected but not thrown.

myself

protected S myself()

handleAssertionErrors

public final S handleAssertionErrors()

Starts handling of assertion errors.

Returns:

this to allow chaining

handleAssumptionViolatedExceptions

public final S handleAssumptionViolatedExceptions()

Starts handling of AssumptionViolatedException.

Returns:

this to allow chaining

apply

public final Statement apply(Statement base,
              Description description)

Method required by junit from rules implementations.

Specified by:

apply in interface TestRule