Package io.github.imagineDevit.giwt.core

Class ATestCase<T,R,STATE extends ATestCaseState<T>,RESULT extends ATestCaseResult<R>>

java.lang.Object

io.github.imagineDevit.giwt.core.CloseableCase

io.github.imagineDevit.giwt.core.ATestCase<T,R,STATE,RESULT>

Type Parameters:

T -

R -

public abstract class ATestCase<T,R,STATE extends ATestCaseState<T>,RESULT extends ATestCaseResult<R>>
extends CloseableCase

Test case abstract class.

Since:

0.0.1

Author:

Henri Joel SEDJAME

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ATestCase.Result	Test case result that can be either success or failure

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<GivenFFn<T,STATE>>	andGivenFns
protected GivenSFn<T>	givenFn
protected final List<StmtMsg>	givenMsgs
protected GivenRFn	givenRFn
protected final String	name
protected final TestParameters.Parameter	parameters
protected final TestCaseReport.TestReport	report
protected RESULT	result
protected STATE	state
protected final List<ThenFn<R,RESULT>>	thenFns
protected final List<StmtMsg>	thenMsgs
protected WhenCFn<T>	whenCFn
protected WhenSFn<R>	whenFn
protected final List<Object>	whenFns
protected final List<StmtMsg>	whenMsgs
protected WhenRFn	whenRFn

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ATestCase(String name, TestCaseReport.TestReport report, TestParameters.Parameter parameters)	Constructor

Method Summary

Modifier and Type	Method	Description
protected void	andGiven(String message, GivenFFn<T,STATE> fn)	Adds another Given statement to the current test case with the provided message and function.
protected void	andThen(String message, ThenFn<R,RESULT> fn)	Adds a then statement to the current test case with the provided message and a consumer function.
protected String	getName()	Returns the name of the test case with its relevant parameters formatted.
<TC extends ATestCase<T, R, STATE, RESULT>> AGivenStmt<T,R,STATE,RESULT,TC>	given(String message, GivenRFn fn)	Creates a new Given statement with the provided message and (runnable) function.
<TC extends ATestCase<T, R, STATE, RESULT>> AGivenStmt<T,R,STATE,RESULT,TC>	given(String message, GivenSFn<T> fn)	Creates a new Given statement with the provided message and (supplier) function.
<TC extends ATestCase<T, R, STATE, RESULT>> AGivenStmt<T,R,STATE,RESULT,TC>	given(String message, T t)
protected abstract RESULT	resultOf(R value)
protected abstract RESULT	resultOfErr(Exception e)
protected void	run()
protected abstract STATE	stateOf(T value)
protected abstract RESULT	stateToResult(Function<T,R> mapper)
protected <TC extends ATestCase<T, R, STATE, RESULT>> AThenStmt<T,R,STATE,RESULT,TC>	then(String message, ThenFn<R,RESULT> fn)	Adds a Then statement to the current test case with the provided message and a consumer function.
protected <TC extends ATestCase<T, R, STATE, RESULT>> AWhenStmt<T,R,STATE,RESULT,TC>	when(String message, WhenFFn<T,R> fn)	Adds a When statement to the current test case with the provided message and a function.
<TC extends ATestCase<T, R, STATE, RESULT>> AWhenStmt<T,R,STATE,RESULT,TC>	when(String message, WhenRFn fn)	Adds a When statement to the current test case with the provided message and a runnable function
<TC extends ATestCase<T, R, STATE, RESULT>> AWhenStmt<T,R,STATE,RESULT,TC>	when(String message, WhenSFn<R> fn)	Adds a When statement to the current test case with the provided message and a supplier function.
protected <TC extends ATestCase<T, R, STATE, RESULT>> AWhenStmt<T,R,STATE,RESULT,TC>	whenc(String message, WhenCFn<T> fn)	Adds a When statement to the current test case with the provided message and a runnable function
protected <TC extends ATestCase<T, R, STATE, RESULT>> AWhenStmt<T,R,STATE,RESULT,TC>	whenr(String message, WhenRFn fn)	Adds a When statement to the current test case with the provided message and a function.

Methods inherited from class io.github.imagineDevit.giwt.core.CloseableCase

runIfOpen

Methods inherited from class java.lang.Object

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

Field Details

name

protected final String name

report

protected final TestCaseReport.TestReport report

parameters

protected final TestParameters.Parameter parameters

andGivenFns

protected final List<GivenFFn<T,STATE extends ATestCaseState<T>>> andGivenFns

whenFns

protected final List<Object> whenFns

thenFns

protected final List<ThenFn<R,RESULT extends ATestCaseResult<R>>> thenFns

givenMsgs

protected final List<StmtMsg> givenMsgs

whenMsgs

protected final List<StmtMsg> whenMsgs

thenMsgs

protected final List<StmtMsg> thenMsgs

state

protected STATE extends ATestCaseState<T> state

result

protected RESULT extends ATestCaseResult<R> result

givenFn

protected GivenSFn<T> givenFn

givenRFn

protected GivenRFn givenRFn

whenFn

protected WhenSFn<R> whenFn

whenRFn

protected WhenRFn whenRFn

whenCFn

protected WhenCFn<T> whenCFn

Constructor Details

ATestCase

protected ATestCase(String name,
 TestCaseReport.TestReport report,
 TestParameters.Parameter parameters)

Constructor

Parameters:

name - the testCase name

report - the test report

parameters - the test parameters

Method Details

given

public <TC extends ATestCase<T,
R,
STATE,
RESULT>>
AGivenStmt<T,R,STATE,RESULT,TC> given(String message,
 GivenSFn<T> fn)

Creates a new Given statement with the provided message and (supplier) function.

Parameters:

message - the description of the statement being given

fn - the function that executes the given statement

Returns:

the Given statement object

given

public <TC extends ATestCase<T,
R,
STATE,
RESULT>>
AGivenStmt<T,R,STATE,RESULT,TC> given(String message,
 T t)

given

public <TC extends ATestCase<T,
R,
STATE,
RESULT>>
AGivenStmt<T,R,STATE,RESULT,TC> given(String message,
 GivenRFn fn)

Creates a new Given statement with the provided message and (runnable) function.

Parameters:

message - the description of the statement being given

fn - the function that executes the given statement

Returns:

the Given statement object

when

public <TC extends ATestCase<T,
R,
STATE,
RESULT>>
AWhenStmt<T,R,STATE,RESULT,TC> when(String message,
 WhenSFn<R> fn)

Adds a When statement to the current test case with the provided message and a supplier function.

Parameters:

message - the description of the new When statement

fn - the function that executes the When statement

Returns:

a new instance of WhenStmt that is associated with this test case

when

public <TC extends ATestCase<T,
R,
STATE,
RESULT>>
AWhenStmt<T,R,STATE,RESULT,TC> when(String message,
 WhenRFn fn)

Adds a When statement to the current test case with the provided message and a runnable function

Parameters:

message - the description of the new When statement

fn - the function that executes the When statement

Returns:

a new instance of WhenStmt that is associated with this test case

andGiven

protected void andGiven(String message,
 GivenFFn<T,STATE> fn)

Adds another Given statement to the current test case with the provided message and function.

Parameters:

message - the description of the new Given statement

fn - the function that executes the given statement

when

protected <TC extends ATestCase<T,
R,
STATE,
RESULT>>
AWhenStmt<T,R,STATE,RESULT,TC> when(String message,
 WhenFFn<T,R> fn)

Adds a When statement to the current test case with the provided message and a function.

Parameters:

message - the description of the new When statement

fn - the function that executes the When statement and returns a result of type R

Returns:

a new instance of WhenStmt that is associated with this test case

whenc

protected <TC extends ATestCase<T,
R,
STATE,
RESULT>>
AWhenStmt<T,R,STATE,RESULT,TC> whenc(String message,
 WhenCFn<T> fn)

Adds a When statement to the current test case with the provided message and a runnable function

Parameters:

message - the description of the new When statement

fn - the function that executes the When statement

Returns:

a new instance of WhenStmt that is associated with this test case

whenr

protected <TC extends ATestCase<T,
R,
STATE,
RESULT>>
AWhenStmt<T,R,STATE,RESULT,TC> whenr(String message,
 WhenRFn fn)

Adds a When statement to the current test case with the provided message and a function.

Parameters:

message - the description of the new When statement

fn - the function that executes the When statement and returns a result of type R

Returns:

a new instance of WhenStmt that is associated with this test case

then

protected <TC extends ATestCase<T,
R,
STATE,
RESULT>>
AThenStmt<T,R,STATE,RESULT,TC> then(String message,
 ThenFn<R,RESULT> fn)

Adds a Then statement to the current test case with the provided message and a consumer function.

Parameters:

message - the description of the new Then statement

fn - the function that executes the Then statement

Returns:

a new instance of ThenStmt that is associated with this test case

andThen

protected void andThen(String message,
 ThenFn<R,RESULT> fn)

Adds a then statement to the current test case with the provided message and a consumer function. This method is used in conjunction with the initial ThenStmt method, allowing for multiple Then statements in a single test case.

Parameters:

message - the description of the new Then statement

fn - the function that executes the additional Then statement

run

protected void run()

getName

protected String getName()

Returns the name of the test case with its relevant parameters formatted. If the test case has parameters, it will format the name using the parameters. If not, it will return the name as is. Note: This method is protected, which means it can only be accessed by classes within the same package or subclasses.

Returns:

the formatted name of the test case.

stateOf

protected abstract STATE stateOf(T value)

stateToResult

protected abstract RESULT stateToResult(Function<T,R> mapper)

resultOf

protected abstract RESULT resultOf(R value)

resultOfErr

protected abstract RESULT resultOfErr(Exception e)