de.tobiasroeser.lambdatest.generic

Class FreeSpecBase

java.lang.Object

de.tobiasroeser.lambdatest.generic.FreeSpecBase

All Implemented Interfaces:

LambdaTest

Direct Known Subclasses:

FreeSpec, FreeSpec

public abstract class FreeSpecBase
extends Object
implements LambdaTest

Common base class containing framework agnostic implementation of FreeSpec-like classes.

See Also:

FreeSpec, FreeSpec

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FreeSpecBase.F0WithException<R>

Constructor Summary

Constructors

Constructor and Description
FreeSpecBase()

Method Summary

Modifier and Type	Method and Description
Optional<Section>	getCurrentSection()
static Reporter	getDefaultReporter()
boolean	getExpectFailFast()
Reporter	getReporter() Gets the currently used reporter.
boolean	getRunInParallel()
String	getSuiteName()
List<DefaultTestCase>	getTestCases()
<T extends Throwable> T	intercept(Class<T> exceptionType, RunnableWithException throwing) Intercept exceptions of type <code>exceptionType</code> and fail if no such exception or an exception with an incompatible type was thrown.
<T extends Throwable> T	intercept(Class<T> exceptionType, String messageRegex, RunnableWithException throwing) Intercept exceptions of type <code>exceptionType</code> and fail if no such exception or an exception with an incompatible type was thrown or it the message does not match a given pattern.
void	pending() Marks the test as pending.
void	section(String section, Runnable code)
static void	setDefaultReporter(Reporter reporter) Set the default reporter.
void	setExpectFailFast(boolean failFast) If true, the first failed assertion will also fail the test.
void	setReporter(Reporter reporter) Set the Reporter to be used.
void	setRunInParallel(boolean runInParallel) If true tests in this suite can be run in parallel.
void	test(String name, RunnableWithException testCase) Adds a test to the test suite.
static <T> T	withDefaultReporter(Reporter reporter, FreeSpecBase.F0WithException<T> f) Executes a given function f with the default reporter set to reporter, and restored the previous default reporter afterwards.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.tobiasroeser.lambdatest.LambdaTest

pending

Constructor Detail

FreeSpecBase

public FreeSpecBase()

Method Detail

getDefaultReporter

public static Reporter getDefaultReporter()

setDefaultReporter

public static void setDefaultReporter(Reporter reporter)

Set the default reporter.

See Also:

withDefaultReporter(Reporter, F0WithException)

withDefaultReporter

public static <T> T withDefaultReporter(Reporter reporter,
                                        FreeSpecBase.F0WithException<T> f)
                                 throws Exception

Executes a given function f with the default reporter set to reporter, and restored the previous default reporter afterwards.

Parameters:

reporter - The default reporter to be used while executing f.

f - The function to apply.

Returns:

The return value of the function f.

Throws:

Exception - All expeceptions thrown by f.

getRunInParallel

public boolean getRunInParallel()

setRunInParallel

public void setRunInParallel(boolean runInParallel)

Description copied from interface: LambdaTest

If true tests in this suite can be run in parallel.

Specified by:

setRunInParallel in interface LambdaTest

Parameters:

runInParallel - If true, tests may execute in parallel.

getExpectFailFast

public boolean getExpectFailFast()

setExpectFailFast

public void setExpectFailFast(boolean failFast)

Description copied from interface: LambdaTest

If true, the first failed assertion will also fail the test. If false, the test runs as long as possible, potentially collection multipe failed assertions.

Specified by:

setExpectFailFast in interface LambdaTest

Parameters:

failFast - If true, to fail fast.

getSuiteName

public String getSuiteName()

getReporter

public Reporter getReporter()

Description copied from interface: LambdaTest

Gets the currently used reporter.

Specified by:

getReporter in interface LambdaTest

setReporter

public void setReporter(Reporter reporter)

Description copied from interface: LambdaTest

Set the Reporter to be used.

Specified by:

setReporter in interface LambdaTest

Parameters:

reporter - The Reporter to be used.

test

public void test(String name,
                 RunnableWithException testCase)

Adds a test to the test suite.

Parameters:

name - The name of the new test.

testCase - The test case. It should return when it is successful, else it should throw an exception. Depending on the underlying test framework/runner, there are different exceptions types, which are recognized and handled. See in the concrete implementation documentation for more details.

getTestCases

public List<DefaultTestCase> getTestCases()

intercept

public <T extends Throwable> T intercept(Class<T> exceptionType,
                                         RunnableWithException throwing)
                                  throws Exception

Intercept exceptions of type <code>exceptionType</code> and fail if no such exception or an exception with an incompatible type was thrown.

Specified by:

intercept in interface LambdaTest

Parameters:

exceptionType - The exception type to intercept.

throwing - The execution block which is expected to throw the exception.

Returns:

The intercepted exception.

Throws:

Exception - If no exception was thrown or an exception with an incompatible type was thrown.

intercept

public <T extends Throwable> T intercept(Class<T> exceptionType,
                                         String messageRegex,
                                         RunnableWithException throwing)
                                  throws Exception

Intercept exceptions of type <code>exceptionType</code> and fail if no such exception or an exception with an incompatible type was thrown or it the message does not match a given pattern.

Specified by:

intercept in interface LambdaTest

Parameters:

exceptionType - The exception type to intercept.

messageRegex - A regular expression pattern to match the expected message. See Pattern for details.

throwing - The execution block which is expected to throw the exception.

Returns:

The intercepted exception.

Throws:

Exception - If no exception was thrown or an exception with an incompatible type was thrown or if the message of the exception did not match the expected pattern.

section

public void section(String section,
                    Runnable code)

getCurrentSection

public Optional<Section> getCurrentSection()

pending

public void pending()

Description copied from interface: LambdaTest

Marks the test as pending. Instructions after pending() will not be executed.

Specified by:

pending in interface LambdaTest