|
| |
|
| java.lang.Object
 net.sf.surrogate.core.SurrogateManager
All known Subclasses: net.sf.surrogate.core.MockMethod,
| SurrogateManager | | public class SurrogateManager (Code) | | The link between Mock/ Unit Test objects and AspectJ code.
The SurrogateManager is the common controller for Junit tests manipulating
MockObjects and mock methods.
Test Case View
The SurrogateManager provides utility methods for test cases to control which
Mock objects should be active for a particular test case run. These methods
are normally:
SurrogateManager.getInstance()SurrogateManager.reset()SurrogateManager.addMock(Object)SurrogateManager.addMockMethod(MockMethod)SurrogateManager.removeMock(Object)SurrogateManager.removeMockMethod(MockMethod)
Aspect View
Every time an aspect detects a "mock poincut", it will ask the
SurrogateManager if a mock object has been registered for the corresponding
joinpoint. If so, the mock executes instead of the "real" method. Otherwise,
the real object is allowed to execute. The methods used by the aspects are
normally:
SurrogateManager.getInstance()SurrogateManager.getMockExecutor(JoinPoint)
Test Case responsibility
A test case should normally always call the
SurrogateManager.reset method before
starting to use the SurrogateManager to avoid independence from other
testcases which might have been run earlier from within the same VM.
If the System property "surrogate.debug" is set to "true", e.g. with the java
-Dsurrogate.debug=true option, the SurrogateManager will report every
time it is asked to resolve a JoinPoint into a mock object or method. The
information is written to System.out. Each debug line is on
the following format:
surrogate:<joinpoint id>|added|removed=<mock id>
Example:
surrogate:added=public static native long java.lang.System.currentTimeMillis()
surrogate:added=net.sf.surrogate.example.MockFileWriter@38e059
surrogate:call(long java.lang.System.currentTimeMillis())=public static native long java.lang.System.currentTimeMillis()
surrogate:call(java.io.FileWriter(String))=net.sf.surrogate.example.MockFileWriter@38e059
surrogate:call(java.io.BufferedWriter(Writer))=null
I.e. the unit test has added mocks for currentTimeMillis and
the FileWriter. As expected, mocks were returned for the
currentTimeMillis and FileWriter
mockJoinPoint's but no mock was found for the BufferedWriter
joinpoint (null was returned).
See Also: SurrogateCalls
See Also: MockMethod
author:
Per S Hustad |
| Inner Class :public static interface MockExecutor | |
| addMock | | public Object addMock(Object o)(Code) | | Adds a Mock object to the manager for later lookup by Aspect code.
Note that for objects to be substituted with their mock implementation,
there must have been defined a pointcut intercepting the
method call or method execution. Otherwise, the mock object will never be
substituted, even if it has been registered. See
SurrogateCalls for pointcut definition details.
Surrogate uses the java.lang.Class.isAssignableFrom to see
whether the registered mock can subsitute a "real" object. It does this
by looking up the declared return type signature of the method or the
class signature of the constructor call.
Example usage:
SurrogateManager mm = SurrogateManager.getInstance();
mm.reset();
MockCustomerService mock = new MockCustomerService();
mm.addMock(mock);
mock.setGetCustomerReturnValue("MockCustomer");
...
Parameters:
o - the Mock object to add. Must be non-null. the Mock object given as argument
See Also: SurrogateManager.addMockMethod(MockMethod)
See Also: SurrogateManager.removeMock(Object)
See Also: SurrogateCalls |
| addMockMethod | | public MockMethod addMockMethod(MockMethod m)(Code) | | Adds a mock method to the manager for later lookup by Aspect code.
Note that for objects to be substituted with their mock implementation,
there must have been defined a pointcut intercepting the
method call or method execution. Otherwise, the mock object will never be
substituted, even if it has been registered. See
SurrogateCalls for pointcut definition details.
Example usage:
SurrogateManager mm = SurrogateManager.getInstance();
mm.reset();
MockMethod mockTime =
mm.addMockMethod(new MockMethod(System.class,"currentTimeMillis"));
mockTime.addReturnValue(1000L);
mockTime.addReturnValue(2000L);
mockTime.setExpectedCalls(2);
... Call object using System.currentTimeMillis
mockTime.verify();
...
Parameters:
m - the Mock object to add. Must be non-null. the MockMethod as given on input
See Also: SurrogateManager.addMock(Object)
See Also: SurrogateManager.removeMockMethod(MockMethod) |
| createInstance | | protected static SurrogateManager createInstance()(Code) | | Created an instance of the manager. Override this method if you want to
create a subclass of the manager
a new instance of the manager |
| getMockExecutor | | public MockExecutor getMockExecutor(JoinPoint p) throws IllegalArgumentException, NoSuchMethodException(Code) | | Gets the mock object or mock method for a joinpoint. This method should
normally only be called from the corresponding
SurrogateCalls advice but can also be called from other
advices which might want to check if a mock matches the joinpoint.
The rules are as follows
- If a
MockMethod matches the joinpoint, this method is
returned.
- Otherwise, if a Mock object matches the joinpoint, this object is
returned, wrapped behind a
MockExecutor
- Otherwise,
null is returned.
The advices should, if receiving a non-null MockExecutor
return value, call the MockExecutor.execute with the
same JoinPoint as used as arguments to
getMockExecutor. If the returned
MockExecutor is null, the advice should
return a sensible value, e.g. with return proceed();
Parameters:
p - the thisJoinPoint on the advice executing the corresponding mock executor or null if nomatch has been found with a registered mock object or mock method
throws:
IllegalArgumentException - if the joinpoint signature is not a "constructor" or "method"signature.
throws:
NoSuchMethodException - if the joinpoint is inconsistent. This should normally beconsidered as a bug.
See Also: SurrogateCalls
See Also: SurrogateManager.addMock(Object)
See Also: SurrogateManager.addMockMethod(MockMethod) |
| getMockMethod | | MockMethod getMockMethod(Method m)(Code) | | Gets a registered Mock method reference for a method. This
method should normally only be called from the aspect code.
Parameters:
m - the Method to check the registered Mock method reference or null if nosuch reference exists for the method
See Also: SurrogateManager.addMockMethod(MockMethod) |
| getMockObject | | Object getMockObject(Class myClassOrInterface)(Code) | | Locates and gets a Mock object for an interface or a class. This method
looks for a Mock object implementing the interface or the class
assignable from myClassOrInterface by searching in the
list of Mock objects for the first object which
myClassOrInterface is assignable from
Parameters:
myClassOrInterface - the interface/class to find a mock object for the Mock object for the interface/class or null ifno such mock object has been registered via theaddMock method.
See Also: SurrogateManager.addMock(Object)
See Also: Class.isAssignableFrom(java.lang.Class) |
| getReturnedClassMock | | protected Object getReturnedClassMock(JoinPoint p) throws IllegalArgumentException(Code) | | Checks if an AspectJ "mock" joinpoint has an assoicated mock object
registered by the manager.
Parameters:
p - the join point the corresponding mock object or null if no matchis found |
| removeMock | | public Object removeMock(Object o)(Code) | | Removes a mock from the manager. The object will hence no longer be
returned instead of a "real" object when the corresponding aspect advice
executes
Parameters:
o - the object to remove. the removed object or null if the object was notfound
See Also: SurrogateManager.addMock(Object) |
| removeMockMethod | | public MockMethod removeMockMethod(MockMethod m)(Code) | | Removes a mock method from the manager. The method will hence no longer
execute instead of the "real" method when the corresponding aspect advice
executes.
Parameters:
o - the object to remove. the removed method or null if the mock method wasnot found.
See Also: SurrogateManager.addMockMethod(MockMethod) |
| reset | | public void reset()(Code) | | Removes all Mock objects and methods from the list of active objects.
This method should be called by every TestCase method to ensure that
"old" Mocks created by other testcases are not hanging around in the
system ...
|
|
|
|