org.evosuite.testcase.statements

Class FunctionalMockStatement

java.lang.Object

org.evosuite.testcase.statements.AbstractStatement

org.evosuite.testcase.statements.EntityWithParametersStatement

org.evosuite.testcase.statements.FunctionalMockStatement

All Implemented Interfaces:

Serializable, Statement

public class FunctionalMockStatement
extends EntityWithParametersStatement

Statement representing the creation and setup of a functional mock. Recall: a functional mock is different from an environment one (eg for file IO and CPU time). A functional mock instantiation can look like:

EvoInvocationListener listener = new EvoInvocationListener();
Foo foo = mock(Foo.class, withSettings().invocationListeners(listener));
when(foo.aMethod(any() ...)).thenReturn( v0, v1, ...);
when(foo.anotherMethod(...)).thenReturn( k0, k1, ...);
...
listener.activate();

All these statements will be represented with a single one, where the return value is the instantiated mock "foo", and the input parameters are all the input parameters of all mocked methods (eg v0, k0), in order.

Calls to "listener" are essential during the search (eg when the statement is executed), but will not be part of the final generated JUnit tests (ie not part of toCode())

Initially, a functional mock will have 0 input parameters, and no "when" call. After a test is executed, the input parameter lists will be updated based on what "listener" does report. The number of input parameters might vary several times throughout the lifespan of a test during the search (can both increase and decrease).

This statement cannot be used to mock the SUT, as it would make no sense whatsoever. However, there might be special cases: eg SUT being an abstract class with no concrete implementation. That would need to be handled specially.

Created by Andrea Arcuri on 01/08/15.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.evosuite.testcase.statements.AbstractStatement

AbstractStatement.Executer

Field Summary

Fields inherited from class org.evosuite.testcase.statements.EntityWithParametersStatement

annotations, parameterAnnotations, parameters

Fields inherited from class org.evosuite.testcase.statements.AbstractStatement

assertions, comment, retval, tc

Constructor Summary

Constructors

Constructor and Description
FunctionalMockStatement(TestCase tc, Type retvalType, Class<?> targetClass)
FunctionalMockStatement(TestCase tc, VariableReference retval, Class<?> targetClass)

Method Summary

Modifier and Type	Method and Description
void	addAssertion(Assertion assertion) Add a new assertion to statement
void	addMissingInputs(List<VariableReference> inputs)
static boolean	canBeFunctionalMocked(Type type)
void	changeClassLoader(ClassLoader loader) Class instances are bound to a class loader - if we want to reexecute a test on a different classloader we need to be able to change the class of the reflection object
Statement	copy(TestCase newTestCase, int offset) copy
boolean	doesNeedToUpdateInputs() Check if the last execution of the test case has led a change in the usage of the mock.
Throwable	execute(Scope scope, PrintStream out) This method executes the statement under the given scope.
void	fillWithNullRefs()
GenericAccessibleObject<?>	getAccessibleObject() Returns the accessibleObject which is used to generate this kind of statement E.g.
String	getDeclaringClassName()
String	getDescriptor()
String	getMethodName()
List<MethodDescriptor>	getMockedMethods()
List<VariableReference>	getParameters(String id)
Class<?>	getTargetClass()
boolean	isAssignmentStatement() Returns true if this statement should be handled as an AssignmentStatement.
boolean	same(Statement s) Allows the comparing of Statements between TestCases.
String	toString()
List<Type>	updateMockedMethods() Based on most recent test execution, update the mocking configuration.

Methods inherited from class org.evosuite.testcase.statements.EntityWithParametersStatement

getConstraints, getNumParameters, getNumParametersOfType, getParameterReferences, getUniqueVariableReferences, getVariableReferences, isBounded, mutateParameter, replace, replaceParameterReference

Methods inherited from class org.evosuite.testcase.statements.AbstractStatement

addComment, clone, clone, copyAssertions, exceptionHandler, getAssertionCode, getAssertionReferences, getAssertions, getCode, getCode, getComment, getDeclaredExceptions, getExceptionClass, getPosition, getReturnClass, getReturnType, getReturnValue, getTestCase, hasAssertions, isAccessible, isDeclaredException, isReflectionStatement, isValid, mutate, negate, references, removeAssertion, removeAssertions, setAssertions, setRetval

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.evosuite.testcase.statements.Statement

equals, hashCode

Constructor Detail

FunctionalMockStatement

public FunctionalMockStatement(TestCase tc,
                               VariableReference retval,
                               Class<?> targetClass)
                        throws IllegalArgumentException

Throws:

IllegalArgumentException

FunctionalMockStatement

public FunctionalMockStatement(TestCase tc,
                               Type retvalType,
                               Class<?> targetClass)
                        throws IllegalArgumentException

Throws:

IllegalArgumentException

Method Detail

changeClassLoader

public void changeClassLoader(ClassLoader loader)

Description copied from class: AbstractStatement

Class instances are bound to a class loader - if we want to reexecute a test on a different classloader we need to be able to change the class of the reflection object

Specified by:

changeClassLoader in interface Statement

Overrides:

changeClassLoader in class AbstractStatement

Parameters:

loader - a ClassLoader object.

canBeFunctionalMocked

public static boolean canBeFunctionalMocked(Type type)

getTargetClass

public Class<?> getTargetClass()

getMockedMethods

public List<MethodDescriptor> getMockedMethods()

getParameters

public List<VariableReference> getParameters(String id)
                                      throws IllegalArgumentException

Throws:

IllegalArgumentException

doesNeedToUpdateInputs

public boolean doesNeedToUpdateInputs()

Check if the last execution of the test case has led a change in the usage of the mock. This will result in adding/removing variable references

Returns:

updateMockedMethods

public List<Type> updateMockedMethods()
                               throws ConstructionFailedException

Based on most recent test execution, update the mocking configuration. After calling this method, it is necessary to provide the missing VariableReferences, if any, using addMissingInputs.

Returns:

a ordered, non-null list of types of missing new inputs that will need to be provided

Throws:

ConstructionFailedException

addMissingInputs

public void addMissingInputs(List<VariableReference> inputs)
                      throws IllegalArgumentException

Throws:

IllegalArgumentException

fillWithNullRefs

public void fillWithNullRefs()

addAssertion

public void addAssertion(Assertion assertion)

Description copied from class: AbstractStatement

Add a new assertion to statement

Specified by:

addAssertion in interface Statement

Overrides:

addAssertion in class AbstractStatement

Parameters:

assertion - Assertion to be added

copy

public Statement copy(TestCase newTestCase,
                      int offset)

Description copied from interface: Statement

copy

Parameters:

newTestCase - the testcase in which this statement will be inserted

offset - a int.

Returns:

a Statement object.

execute

public Throwable execute(Scope scope,
                         PrintStream out)
                  throws InvocationTargetException,
                         IllegalArgumentException,
                         IllegalAccessException,
                         InstantiationException

Description copied from interface: Statement

This method executes the statement under the given scope. If execution of the statement is aborted abnormally (i.e. an exception is thrown.) The exception is returned. Otherwise the return value is null.

Parameters:

scope - the scope under which the statement is executed

out - a PrintStream object.

Returns:

if an exception was thrown during execution this is the exception

Throws:

InvocationTargetException - if any.

IllegalArgumentException - if any.

IllegalAccessException - if any.

InstantiationException - if any.

getAccessibleObject

public GenericAccessibleObject<?> getAccessibleObject()

Description copied from interface: Statement

Returns the accessibleObject which is used to generate this kind of statement E.g. the Field of a FieldStatement, the Method of a MethodStatement and so on MAY return NULL (for example for NullStatements)

Returns:

a AccessibleObject object.

isAssignmentStatement

public boolean isAssignmentStatement()

Description copied from interface: Statement

Returns true if this statement should be handled as an AssignmentStatement. This method was added to allow the wrapping of AssignmentStatements (in which case "a instanceof AssignmentStatement" is no longer working)

Returns:

a boolean.

same

public boolean same(Statement s)

Description copied from interface: Statement

Allows the comparing of Statements between TestCases. I.e. this is a more semantic comparison than the one done by equals. E.g. two Variable are equal if they are at the same position and they reference to objects of the same type.

Parameters:

s - a Statement object.

Returns:

a boolean.

toString

public String toString()

Overrides:

toString in class Object

getDescriptor

public String getDescriptor()

Specified by:

getDescriptor in class EntityWithParametersStatement

getDeclaringClassName

public String getDeclaringClassName()

Specified by:

getDeclaringClassName in class EntityWithParametersStatement

getMethodName

public String getMethodName()

Specified by:

getMethodName in class EntityWithParametersStatement