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

Update @TestPropertySource Javadoc regarding "local" semantics

Browse Source 
See gh-23320
This commit is contained in:
Sam Brannen
2019-07-28 12:12:28 +02:00
parent 690694df33
commit 1954861844
1 changed files with 36 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
spring-test/src/main/java/org/springframework/test/context/TestPropertySource.java
View File

@@ -172,9 +172,24 @@ public @interface TestPropertySource {
* @ContextConfiguration
* public class ExtendedTest extends BaseTest {
* // ...
* }
* </pre>
*
* }</pre>
* <p>If {@code @TestPropertySource} is used as a <em>{@linkplain Repeatable
* repeatable}</em> annotation, the following special rules apply.
* <ol>
* <li>All {@code @TestPropertySource} annotations at a given level in the
* test class hierarchy (i.e., directly present or meta-present on a test
* class) are considered to be <em>local</em> annotations, in contrast to
* {@code @TestPropertySource} annotations that are inherited from a
* superclass.</li>
* <li>All local {@code @TestPropertySource} annotations must declare the
* same value for the {@code inheritLocations} flag.</li>
* <li>The {@code inheritLocations} flag is not taken into account between
* local {@code @TestPropertySource} annotations. Specifically, the property
* source locations for one local annotation will be appended to the list of
* property source locations defined by previous local annotations. This
* allows a local annotation to extend the list of test property source
* locations, potentially overriding individual properties.</li>
* </ol>
* @see #locations
*/
boolean inheritLocations() default true;
@@ -232,8 +247,24 @@ public @interface TestPropertySource {
* &#064;ContextConfiguration
* public class ExtendedTest extends BaseTest {
* // ...
* }
* </pre>
* }</pre>
* <p>If {@code @TestPropertySource} is used as a <em>{@linkplain Repeatable
* repeatable}</em> annotation, the following special rules apply.
* <ol>
* <li>All {@code @TestPropertySource} annotations at a given level in the
* test class hierarchy (i.e., directly present or meta-present on a test
* class) are considered to be <em>local</em> annotations, in contrast to
* {@code @TestPropertySource} annotations that are inherited from a
* superclass.</li>
* <li>All local {@code @TestPropertySource} annotations must declare the
* same value for the {@code inheritProperties} flag.</li>
* <li>The {@code inheritProperties} flag is not taken into account between
* local {@code @TestPropertySource} annotations. Specifically, inlined
* properties for one local annotation will be appended to the list of
* inlined properties defined by previous local annotations. This allows a
* local annotation to extend the list of inlined properties, potentially
* overriding individual properties.</li>
* </ol>
* @see #properties
*/
boolean inheritProperties() default true;