Custom Annotations for Spring Boot Tests

Question

Is it possible to overwrite the parameter values of an annotation used in a custom annotation?

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@SpringBootTest(classes = [HOW_TO_CHANGE_THESE])
@ComponentScan(basePackages = {[HOW_TO_CHANGE_THESE]})
@ActiveProfiles("testing")
public @interface IntegrationTest {
}

My intention was to reduce the number of annotations in my tests, while setting default values to all tests of this type. I would like to use it like this:

@IntegrationTest(classes="...", basePackages="...")
class AbcTest {
}

Thanks in advance!

VadymVL · Accepted Answer · 2021-11-25 22:26:12Z

6

Yes, it is possible if you are using the Spring framework. It has a special @AliasFor annotation for this purpose:

@AliasFor is an annotation that is used to declare aliases for annotation attributes.

You can find more examples of its usage in the official documentation here or in this tutorial.

Also, there are details of how to use meta-annotations in the Spring Test Context in the official documentation here.

Your example with the usage of this annotation will look like this:

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@SpringBootTest
@ComponentScan
@ActiveProfiles("testing")
public @interface IntegrationTest {

    @AliasFor(annotation = ComponentScan.class, attribute = "basePackages")
    String[] basePackages() default {};

    @AliasFor(annotation = SpringBootTest.class, attribute = "classes")
    Class<?>[] classes() default {};
}

edited Nov 25, 2021 at 22:26

answered Nov 25, 2021 at 21:28

VadymVL

5,5863 gold badges30 silver badges43 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Custom Annotations for Spring Boot Tests

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related