org.powermock.api.easymock.annotation

Annotation Type Mock

@Target(value=FIELD)
 @Retention(value=RUNTIME)
 @Documented
public @interface Mock

This annotation can be placed on those fields in your test class that should be mocked. This eliminates the need to setup and tear-down mocks manually which minimizes repetitive test code and makes the test more readable. In order for PowerMock to control the life-cycle of the mocks you must supply the PowerMockListener annotation to the class-level of the test case. For example:

 ...
 @PowerMockListener(AnnotationEnabler.class)
 public class PersonServiceTest {
 
        @Mock
        private PersonDao personDaoMock;
 
        private PersonService classUnderTest;
 
        @Before
        public void setUp() {
                classUnderTest = new PersonService(personDaoMock);
        }
  ...
 }
 

Note that you can also create partial mocks by using the annotation. Let's say that the PersonService has a method called "getPerson" and another method called "savePerson" and these are the only two methods that you'd like to mock. Rewriting the previous example to accommodate this will give us the following test:

 ...
 @PowerMockListener(AnnotationEnabler.class)
 public class PersonServiceTest {
 
        @Mock({"getPerson", "savePerson"})
        private PersonDao personDaoMock;
 
        private PersonService classUnderTest;
 
        @Before
        public void setUp() {
                classUnderTest = new PersonService(personDaoMock);
        }
  ...
 }
 

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	fieldName Name of the test subject field to which this mock will be assigned.
String[]	value

Element Detail

value

public abstract String[] value

Default:

""

fieldName

public abstract String fieldName

Name of the test subject field to which this mock will be assigned. Use to disambiguate the case where a mock may be assigned to multiple fields of the same type. When set, this mock will be assigned to the given field name in any test subject with a matching field name. If not set, injection is to all type-compatible fields in all test subjects. A given field name may only be used once, and there must be a matching field in at least one test subject.

Returns:

name of the field to inject to

Default:

""