org.easetech.easytest.annotation

Annotation Type Duration

@Target(value={FIELD,METHOD})
@Retention(value=RUNTIME)
public @interface Duration

Duration is similar to Intercept annotation in that it intercepts the call to the methods of the Class annotated with Duration annotation. But it has got extra attributes for the user to specify the maximum duration a method under test should take to execute. If the total time taken by the method exceeds the time specified (using the attribute timeInMillis), the test method will fail.
This annotation can be used both at the FIELD level as well as the METHOD level

Usage at Field Level:

class TestClass {
 
      @Duration(timeInMillis=100)
      private ItemService testSubject;
 }

OR , in case the user also needs to specify its custom MethodIntercepter :

class TestClass {
 
      @Duration(timeInMillis=100 , interceptor=MyCustomInterceptor.class)
      private ItemService testSubject;
 }

In both the above cases, EasyTest will measure the time taken by each method of ItemService. If the time taken by the method is more than the time specified, the test will fail with appropriate failure reason.

Usage at Test Method Level

  class TestClass {
 
      private ItemService testSubject;
      
      @Test
      @Duration(forClass=ItemService.class , timeInMillis=50)
      private Item testGetItem(@Param(name='itemId') String itemId) {
          return testSubject.getItem(itemId);
      }
 }

In this case, EasyTest will compare the time taken, by the method under test, with the time specified in the Duration annotation, only for this test method.

Special case : When the Duration annotation is specified both at the field level and at the method level

  class TestClass {
      @Duration(timeInMillis=100)
      private ItemService testSubject;
      
      @Test
      @Duration(forClass=ItemService.class , timeInMillis=50)
      private Item testGetItem(@Param(name='itemId') String itemId) {
          return testSubject.getItem(itemId);
      }
 }

In this case, EasyTest will override the timeInMillis value supplied at the field level, with the value supplied at the method level. Once the method is finished, it will revert back to the original value specified at the field level. Thus if you have second test method that does not have Duration annotation, then the measure of time taken by the method will be 100 milliseconds and not 50 ms.

Author:

Anuj Kumar

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
long	timeInMillis The time in milliseconds.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<?>	forClass The Class that should be proxied to provide the time comparison functionality.
Class<? extends MethodIntercepter>	interceptor The MethodInterceptor to use to intercept method calls.

Element Detail

timeInMillis

public abstract long timeInMillis

The time in milliseconds. This is the maximum time a method under test should take to execute

forClass

public abstract Class<?> forClass

The Class that should be proxied to provide the time comparison functionality. Only required in case the Duration annotation is specified at the test method level. Its value will be ignored in case it is specified when the annotation is used at the field level

Default:

org.easetech.easytest.interceptor.Empty.class

interceptor

public abstract Class<? extends MethodIntercepter> interceptor

The MethodInterceptor to use to intercept method calls.

Default:

org.easetech.easytest.interceptor.DefaultMethodIntercepter.class