org.powermock.api.easymock.annotation.MockNice Maven / Gradle / Ivy
The newest version!
package org.powermock.api.easymock.annotation;
import org.powermock.core.classloader.annotations.PowerMockListener;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* This annotation can be placed on those fields in your test class that should
* be mocked in a nice manner (i.e. by default allows all method calls and
* returns appropriate empty values (0, {@code null} or {@code false}
* )). 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
* {@link PowerMockListener} annotation to the class-level of the test case. For
* example when using the EasyMock API:
*
*
* @PowerMockListener(EasyMockAnnotationEnabler.class)
* public class PersonServiceTest {
*
* @MockNice
* 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(EasyMockAnnotationEnabler.class)
* public class PersonServiceTest {
*
* @MockNice({"getPerson", "savePerson"})
* private PersonDao personDaoMock;
*
* private PersonService classUnderTest;
*
* @Before
* public void setUp() {
* classUnderTest = new PersonService(personDaoMock);
* }
* ...
* }
*
*
*
*/
@Target( { ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface MockNice {
String[] value() default "";
}