org.evosuite.testcase

Interface TestCase

All Superinterfaces:

Cloneable, Iterable<Statement>, Listenable<Void>, Serializable

All Known Implementing Classes:

CarvedTestCase, DefaultTestCase, StructuredTestCase

public interface TestCase
extends Iterable<Statement>, Cloneable, Listenable<Void>

A test case is a list of statements

Author:

Gordon Fraser, Sebastian Steenbuck

Method Summary

Modifier and Type	Method and Description
void	accept(TestVisitor visitor) Handle test visitor
void	addAssertions(TestCase other) Copy all the assertions from other test case
void	addContractViolation(ContractViolation violation) Keep track of an additional test failure
void	addCoveredGoal(TestFitnessFunction goal) Keep track of an additional covered goal
VariableReference	addStatement(Statement statement) Append new statement at end of test case
VariableReference	addStatement(Statement statement, int position) Add new statement at position and fix following variable references
void	addStatements(List<? extends Statement> statements) addStatements
void	chop(int length) Remove all statements after a given position
void	clearCoveredGoals() Remove all covered goals
TestCase	clone() clone
boolean	contains(Statement statement)
Set<Class<?>>	getAccessedClasses() Determine the set of classes that are accessed by the test case
AccessedEnvironment	getAccessedEnvironment() Retrieve an object containing information about what environment components this test interacted with
List<Assertion>	getAssertions() Get all assertions that exist for this test case
Set<ContractViolation>	getContractViolations() Retrieve all violations observed during test execution
Set<TestFitnessFunction>	getCoveredGoals() Retrieve all coverage goals covered by this test
Set<Class<?>>	getDeclaredExceptions() getDeclaredExceptions
Set<VariableReference>	getDependencies(VariableReference var) Determine the set of variables that var depends on
int	getID() Get an unique id representing this test.
VariableReference	getLastObject(Type type) Get the last object of the defined type
VariableReference	getLastObject(Type type, int position) Get the last object of the defined type
Object	getObject(VariableReference reference, Scope scope) Get actual object represented by a variable for a given execution scope
List<VariableReference>	getObjects(int position) Get all objects up to position satisfying constraint
List<VariableReference>	getObjects(Type type, int position) Get all objects up to position satisfying constraint
VariableReference	getRandomNonNullNonPrimitiveObject(Type type, int position) Get a random object matching type
VariableReference	getRandomNonNullObject(Type type, int position) Get a random object matching type
VariableReference	getRandomObject() Get a random object matching type
VariableReference	getRandomObject(int position) Get a random object matching type
VariableReference	getRandomObject(Type type) Get a random object matching type
VariableReference	getRandomObject(Type type, int position) Get a random object matching type
Set<VariableReference>	getReferences(VariableReference var) Determine the set of variables that depend on var
VariableReference	getReturnValue(int position) Get return value (variable) of statement at position
Statement	getStatement(int position) Access statement by index
boolean	hasAssertions() Check if there are any assertions
boolean	hasCastableObject(Type type) hasCastableObject
boolean	hasObject(Type type, int position) Check if the test case has an object of a given class
boolean	hasReferences(VariableReference var) Check if var is referenced after its definition
boolean	hasStatement(int position) Check if there is a statement at the given position.
boolean	isAccessible() Check if all methods/fields accessed are accessible also for the current SUT
boolean	isEmpty() isEmpty
boolean	isFailing()
boolean	isGoalCovered(TestFitnessFunction goal) Check if the current test case does cover the given goal.
boolean	isPrefix(TestCase t) Check if this test case is a prefix of t
boolean	isUnstable() A test can be unstable if its assertions fail, eg due to non-determinism, non-properly handled static variables and side effects on environment, etc
boolean	isValid() Check if test case is valid (executable)
void	remove(int position) Remove statement at position and fix variable references
void	removeAssertion(Assertion assertion) Remove assertion from test case
void	removeAssertions() Remove all assertions from test case
void	replace(VariableReference var1, VariableReference var2) Replace a VariableReference with another one
void	setFailing()
VariableReference	setStatement(Statement statement, int position) Set new statement at position
void	setUnstable(boolean unstable) Define whether this test case is unstable or not
int	size() size
int	sizeWithAssertions() Get number of statements plus the number of assertions
int	sliceFor(VariableReference var)
String	toCode() Get Java code representation of the test case
String	toCode(Map<Integer,Throwable> exceptions) Get Java code representation of the test case

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface org.evosuite.utils.Listenable

addListener, deleteListener

Method Detail

getID

int getID()

Get an unique id representing this test. This is mainly useful for debugging.

Returns:

accept

void accept(TestVisitor visitor)

Handle test visitor

Parameters:

visitor - a TestVisitor object.

addAssertions

void addAssertions(TestCase other)

Copy all the assertions from other test case

Parameters:

other - The other test case

addCoveredGoal

void addCoveredGoal(TestFitnessFunction goal)

Keep track of an additional covered goal

Parameters:

goal - a TestFitnessFunction object.

addContractViolation

void addContractViolation(ContractViolation violation)

Keep track of an additional test failure

Parameters:

violation - a ContractViolation object.

addStatement

VariableReference addStatement(Statement statement)

Append new statement at end of test case

Parameters:

statement - New statement

Returns:

VariableReference of return value

addStatement

VariableReference addStatement(Statement statement,
                               int position)

Add new statement at position and fix following variable references

Parameters:

statement - New statement

position - Position at which to add

Returns:

Return value of statement. Notice that the test might choose to modify the statement you inserted. You should use the returned variable reference and not use references

addStatements

void addStatements(List<? extends Statement> statements)

addStatements

Parameters:

statements - a List object.

chop

void chop(int length)

Remove all statements after a given position

Parameters:

length - Length of the test case after chopping

sliceFor

int sliceFor(VariableReference var)

clearCoveredGoals

void clearCoveredGoals()

Remove all covered goals

contains

boolean contains(Statement statement)

clone

TestCase clone()

clone

Returns:

a TestCase object.

getAccessedClasses

Set<Class<?>> getAccessedClasses()

Determine the set of classes that are accessed by the test case

Returns:

Set of accessed classes

getAccessedEnvironment

AccessedEnvironment getAccessedEnvironment()

Retrieve an object containing information about what environment components this test interacted with

Returns:

a List object.

getAssertions

List<Assertion> getAssertions()

Get all assertions that exist for this test case

Returns:

List of assertions TODO: Also return ExceptionAssertion?

getContractViolations

Set<ContractViolation> getContractViolations()

Retrieve all violations observed during test execution

Returns:

getCoveredGoals

Set<TestFitnessFunction> getCoveredGoals()

Retrieve all coverage goals covered by this test

Returns:

a Set object.

getDeclaredExceptions

Set<Class<?>> getDeclaredExceptions()

getDeclaredExceptions

Returns:

a Set object.

getDependencies

Set<VariableReference> getDependencies(VariableReference var)

Determine the set of variables that var depends on

Parameters:

var - Variable to check for

Returns:

Set of dependency variables

getLastObject

VariableReference getLastObject(Type type)
                         throws ConstructionFailedException

Get the last object of the defined type

Parameters:

type -

Returns:

Throws:

ConstructionFailedException

getLastObject

VariableReference getLastObject(Type type,
                                int position)
                         throws ConstructionFailedException

Get the last object of the defined type

Parameters:

type -

Returns:

Throws:

ConstructionFailedException

getObject

Object getObject(VariableReference reference,
                 Scope scope)

Get actual object represented by a variable for a given execution scope

Parameters:

reference - Variable

scope - Excution scope

Returns:

Object in scope

getObjects

List<VariableReference> getObjects(int position)

Get all objects up to position satisfying constraint

Parameters:

position - a int.

Returns:

a List object.

getObjects

List<VariableReference> getObjects(Type type,
                                   int position)

Get all objects up to position satisfying constraint

Parameters:

type - a Type object.

position - a int.

Returns:

a List object.

getRandomNonNullNonPrimitiveObject

VariableReference getRandomNonNullNonPrimitiveObject(Type type,
                                                     int position)
                                              throws ConstructionFailedException

Get a random object matching type

Parameters:

type - a Type object.

position - Upper bound in test case up to which objects are considered

Returns:

a VariableReference object.

Throws:

ConstructionFailedException - if no such object exists

getRandomNonNullObject

VariableReference getRandomNonNullObject(Type type,
                                         int position)
                                  throws ConstructionFailedException

Get a random object matching type

Parameters:

type - a Type object.

position - Upper bound in test case up to which objects are considered

Returns:

a VariableReference object.

Throws:

ConstructionFailedException - if no such object exists

getRandomObject

VariableReference getRandomObject()

Get a random object matching type

Returns:

Random object

Throws:

ConstructionFailedException - if any.

getRandomObject

VariableReference getRandomObject(int position)

Get a random object matching type

Parameters:

position - Upper bound in test case up to which objects are considered

Returns:

a VariableReference object.

Throws:

ConstructionFailedException - if no such object exists

getRandomObject

VariableReference getRandomObject(Type type)
                           throws ConstructionFailedException

Get a random object matching type

Parameters:

type - Class we are looking for

Returns:

Random object

Throws:

ConstructionFailedException - if any.

getRandomObject

VariableReference getRandomObject(Type type,
                                  int position)
                           throws ConstructionFailedException

Get a random object matching type

Parameters:

type - a Type object.

position - Upper bound in test case up to which objects are considered

Returns:

a VariableReference object.

Throws:

ConstructionFailedException - if no such object exists

getReferences

Set<VariableReference> getReferences(VariableReference var)

Determine the set of variables that depend on var

Parameters:

var - Variable to check for

Returns:

Set of dependent variables

getReturnValue

VariableReference getReturnValue(int position)

Get return value (variable) of statement at position

Parameters:

position - a int.

Returns:

a VariableReference object.

getStatement

Statement getStatement(int position)

Access statement by index

Parameters:

position - Index of statement

Returns:

Statement at position

hasStatement

boolean hasStatement(int position)

Check if there is a statement at the given position.

Parameters:

position - Index of statement

Returns:

Whether or not there is a statement at the given position.

hasAssertions

boolean hasAssertions()

Check if there are any assertions

Returns:

True if there are assertions

hasCastableObject

boolean hasCastableObject(Type type)

hasCastableObject

Parameters:

type - a Type object.

Returns:

a boolean.

hasObject

boolean hasObject(Type type,
                  int position)

Check if the test case has an object of a given class

Parameters:

type - Type to look for

position - Upper bound up to which the test is checked

Returns:

True if there is something usable

hasReferences

boolean hasReferences(VariableReference var)

Check if var is referenced after its definition

Parameters:

var - Variable to check for

Returns:

True if there is a use of var

isAccessible

boolean isAccessible()

Check if all methods/fields accessed are accessible also for the current SUT

Returns:

isEmpty

boolean isEmpty()

isEmpty

Returns:

true if size()==0

isFailing

boolean isFailing()

setFailing

void setFailing()

isGoalCovered

boolean isGoalCovered(TestFitnessFunction goal)

Check if the current test case does cover the given goal.

Parameters:

goal -

Returns:

isPrefix

boolean isPrefix(TestCase t)

Check if this test case is a prefix of t

A test case A is a prefix of a test case B if and only if the first length(A) statements of B are equal to ones of A, in the same order. In other words, B can be seen as an extension of A.

Parameters:

t - Test case to check against

Returns:

True if this test is a prefix of t

isUnstable

boolean isUnstable()

A test can be unstable if its assertions fail, eg due to non-determinism, non-properly handled static variables and side effects on environment, etc

Returns:

isValid

boolean isValid()

Check if test case is valid (executable)

Returns:

a boolean.

remove

void remove(int position)

Remove statement at position and fix variable references

Parameters:

position - a int.

removeAssertion

void removeAssertion(Assertion assertion)

Remove assertion from test case

removeAssertions

void removeAssertions()

Remove all assertions from test case

replace

void replace(VariableReference var1,
             VariableReference var2)

Replace a VariableReference with another one

Parameters:

var1 - The old variable

var2 - The new variable

setStatement

VariableReference setStatement(Statement statement,
                               int position)

Set new statement at position

Parameters:

statement - New statement

position - Position at which to add

Returns:

Return value of statement. Notice that the test might choose to modify the statement you inserted. You should use the returned variable reference and not use references

setUnstable

void setUnstable(boolean unstable)

Define whether this test case is unstable or not

Parameters:

unstable -

size

int size()

size

Returns:

Number of statements

sizeWithAssertions

int sizeWithAssertions()

Get number of statements plus the number of assertions

Returns:

Number of statements plus number of assertions

toCode

String toCode()

Get Java code representation of the test case

Returns:

Code as string

toCode

String toCode(Map<Integer,Throwable> exceptions)

Get Java code representation of the test case

Parameters:

exceptions - a Map object.

Returns:

Code as string