Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve documentation for @EnabledIf and @DisabledIf test support

Browse Source 
Closes gh-28157
This commit is contained in:
Sam Brannen
2022-03-10 19:27:41 +01:00
parent 1bbcd706be
commit af977c0891
3 changed files with 50 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
spring-test/src/main/java/org/springframework/test/context/junit/jupiter/DisabledIf.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2019 the original author or authors.
* Copyright 2002-2022 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -50,12 +50,23 @@ import org.springframework.core.annotation.AliasFor;
* public {@literal @}interface DisabledOnMac {}
* </pre>
*
* <p>Please note that {@code @DisabledOnMac} is meant only as an example of what
* is possible. If you have that exact use case, please use the built-in
* {@link org.junit.jupiter.api.condition.DisabledOnOs @DisabledOnOs(MAC)} support
* in JUnit Jupiter.
*
* <p>Since JUnit 5.7, JUnit Jupiter also has a condition annotation named
* {@link org.junit.jupiter.api.condition.DisabledIf @DisabledIf}. Thus, if you
* wish to use Spring's {@code @DisabledIf} support make sure you import the
* annotation type from the correct package.
*
* @author Sam Brannen
* @author Tadaya Tsuyukubo
* @since 5.0
* @see SpringExtension
* @see EnabledIf
* @see org.junit.jupiter.api.Disabled
* @see org.junit.jupiter.api.condition.DisabledIf
*/
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)

13
spring-test/src/main/java/org/springframework/test/context/junit/jupiter/EnabledIf.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2019 the original author or authors.
* Copyright 2002-2022 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -50,11 +50,22 @@ import org.springframework.core.annotation.AliasFor;
* public {@literal @}interface EnabledOnMac {}
* </pre>
*
* <p>Please note that {@code @EnabledOnMac} is meant only as an example of what
* is possible. If you have that exact use case, please use the built-in
* {@link org.junit.jupiter.api.condition.EnabledOnOs @EnabledOnOs(MAC)} support
* in JUnit Jupiter.
*
* <p>Since JUnit 5.7, JUnit Jupiter also has a condition annotation named
* {@link org.junit.jupiter.api.condition.EnabledIf @EnabledIf}. Thus, if you
* wish to use Spring's {@code @EnabledIf} support make sure you import the
* annotation type from the correct package.
*
* @author Sam Brannen
* @since 5.0
* @see SpringExtension
* @see DisabledIf
* @see org.junit.jupiter.api.Disabled
* @see org.junit.jupiter.api.condition.EnabledIf
*/
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)