Skip to content

Commit 30938e3

Browse files
committed
Rename annotations used by tests of the configuration processor
This commit renames the annotations and other signals that the annotation processor uses to process configuration metadata. By adding a `Test` prefix, this prevents the confusion with the real annotation. Closes gh-47468
1 parent bee968e commit 30938e3

File tree

122 files changed

+369
-369
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

122 files changed

+369
-369
lines changed

spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/ConfigurationMetadataAnnotationProcessorTests.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -484,7 +484,7 @@ void recursivePropertiesDoNotCauseAStackOverflow() {
484484
@Test
485485
void recordProperties() {
486486
String source = """
487-
@org.springframework.boot.configurationsample.ConfigurationProperties("implicit")
487+
@org.springframework.boot.configurationsample.TestConfigurationProperties("implicit")
488488
public record ExampleRecord(String someString, Integer someInteger) {
489489
}
490490
""";
@@ -496,10 +496,10 @@ public record ExampleRecord(String someString, Integer someInteger) {
496496
@Test
497497
void recordPropertiesWithDefaultValues() {
498498
String source = """
499-
@org.springframework.boot.configurationsample.ConfigurationProperties("record.defaults")
499+
@org.springframework.boot.configurationsample.TestConfigurationProperties("record.defaults")
500500
public record ExampleRecord(
501-
@org.springframework.boot.configurationsample.DefaultValue("An1s9n") String someString,
502-
@org.springframework.boot.configurationsample.DefaultValue("594") Integer someInteger) {
501+
@org.springframework.boot.configurationsample.TestDefaultValue("An1s9n") String someString,
502+
@org.springframework.boot.configurationsample.TestDefaultValue("594") Integer someInteger) {
503503
}
504504
""";
505505
ConfigurationMetadata metadata = compile(source);
@@ -512,9 +512,9 @@ public record ExampleRecord(
512512
@Test
513513
void multiConstructorRecordProperties() {
514514
String source = """
515-
@org.springframework.boot.configurationsample.ConfigurationProperties("multi")
515+
@org.springframework.boot.configurationsample.TestConfigurationProperties("multi")
516516
public record ExampleRecord(String someString, Integer someInteger) {
517-
@org.springframework.boot.configurationsample.ConstructorBinding
517+
@org.springframework.boot.configurationsample.TestConstructorBinding
518518
public ExampleRecord(String someString) {
519519
this(someString, 42);
520520
}

spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/EndpointMetadataGenerationTests.java

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
import org.springframework.boot.configurationprocessor.metadata.ConfigurationMetadata;
2525
import org.springframework.boot.configurationprocessor.metadata.Metadata;
26-
import org.springframework.boot.configurationsample.Access;
26+
import org.springframework.boot.configurationsample.TestAccess;
2727
import org.springframework.boot.configurationsample.endpoint.CamelCaseEndpoint;
2828
import org.springframework.boot.configurationsample.endpoint.CustomPropertiesEndpoint;
2929
import org.springframework.boot.configurationsample.endpoint.DisabledEndpoint;
@@ -54,7 +54,7 @@ void simpleEndpoint() {
5454
ConfigurationMetadata metadata = compile(SimpleEndpoint.class);
5555
assertThat(metadata).has(Metadata.withGroup("management.endpoint.simple").fromSource(SimpleEndpoint.class));
5656
assertThat(metadata).has(enabledFlag("simple", true));
57-
assertThat(metadata).has(access("simple", Access.UNRESTRICTED));
57+
assertThat(metadata).has(access("simple", TestAccess.UNRESTRICTED));
5858
assertThat(metadata).has(cacheTtl("simple"));
5959
assertThat(metadata.getItems()).hasSize(4);
6060
}
@@ -64,7 +64,7 @@ void disabledEndpoint() {
6464
ConfigurationMetadata metadata = compile(DisabledEndpoint.class);
6565
assertThat(metadata).has(Metadata.withGroup("management.endpoint.disabled").fromSource(DisabledEndpoint.class));
6666
assertThat(metadata).has(enabledFlag("disabled", false));
67-
assertThat(metadata).has(access("disabled", Access.NONE));
67+
assertThat(metadata).has(access("disabled", TestAccess.NONE));
6868
assertThat(metadata.getItems()).hasSize(3);
6969
}
7070

@@ -73,7 +73,7 @@ void enabledEndpoint() {
7373
ConfigurationMetadata metadata = compile(EnabledEndpoint.class);
7474
assertThat(metadata).has(Metadata.withGroup("management.endpoint.enabled").fromSource(EnabledEndpoint.class));
7575
assertThat(metadata).has(enabledFlag("enabled", true));
76-
assertThat(metadata).has(access("enabled", Access.UNRESTRICTED));
76+
assertThat(metadata).has(access("enabled", TestAccess.UNRESTRICTED));
7777
assertThat(metadata.getItems()).hasSize(3);
7878
}
7979

@@ -82,7 +82,7 @@ void noAccessEndpoint() {
8282
ConfigurationMetadata metadata = compile(NoAccessEndpoint.class);
8383
assertThat(metadata).has(Metadata.withGroup("management.endpoint.noaccess").fromSource(NoAccessEndpoint.class));
8484
assertThat(metadata).has(enabledFlag("noaccess", false));
85-
assertThat(metadata).has(access("noaccess", Access.NONE));
85+
assertThat(metadata).has(access("noaccess", TestAccess.NONE));
8686
assertThat(metadata.getItems()).hasSize(3);
8787
}
8888

@@ -92,7 +92,7 @@ void readOnlyAccessEndpoint() {
9292
assertThat(metadata)
9393
.has(Metadata.withGroup("management.endpoint.readonlyaccess").fromSource(ReadOnlyAccessEndpoint.class));
9494
assertThat(metadata).has(enabledFlag("readonlyaccess", true));
95-
assertThat(metadata).has(access("readonlyaccess", Access.READ_ONLY));
95+
assertThat(metadata).has(access("readonlyaccess", TestAccess.READ_ONLY));
9696
assertThat(metadata.getItems()).hasSize(3);
9797
}
9898

@@ -102,7 +102,7 @@ void unrestrictedAccessEndpoint() {
102102
assertThat(metadata).has(Metadata.withGroup("management.endpoint.unrestrictedaccess")
103103
.fromSource(UnrestrictedAccessEndpoint.class));
104104
assertThat(metadata).has(enabledFlag("unrestrictedaccess", true));
105-
assertThat(metadata).has(access("unrestrictedaccess", Access.UNRESTRICTED));
105+
assertThat(metadata).has(access("unrestrictedaccess", TestAccess.UNRESTRICTED));
106106
assertThat(metadata.getItems()).hasSize(3);
107107
}
108108

@@ -115,7 +115,7 @@ void customPropertiesEndpoint() {
115115
.ofType(String.class)
116116
.withDefaultValue("test"));
117117
assertThat(metadata).has(enabledFlag("customprops", true));
118-
assertThat(metadata).has(access("customprops", Access.UNRESTRICTED));
118+
assertThat(metadata).has(access("customprops", TestAccess.UNRESTRICTED));
119119
assertThat(metadata).has(cacheTtl("customprops"));
120120
assertThat(metadata.getItems()).hasSize(5);
121121
}
@@ -125,7 +125,7 @@ void specificEndpoint() {
125125
ConfigurationMetadata metadata = compile(SpecificEndpoint.class);
126126
assertThat(metadata).has(Metadata.withGroup("management.endpoint.specific").fromSource(SpecificEndpoint.class));
127127
assertThat(metadata).has(enabledFlag("specific", true));
128-
assertThat(metadata).has(access("specific", Access.UNRESTRICTED));
128+
assertThat(metadata).has(access("specific", TestAccess.UNRESTRICTED));
129129
assertThat(metadata).has(cacheTtl("specific"));
130130
assertThat(metadata.getItems()).hasSize(4);
131131
}
@@ -136,7 +136,7 @@ void camelCaseEndpoint() {
136136
assertThat(metadata)
137137
.has(Metadata.withGroup("management.endpoint.pascal-case").fromSource(CamelCaseEndpoint.class));
138138
assertThat(metadata).has(enabledFlag("PascalCase", "pascal-case", true));
139-
assertThat(metadata).has(defaultAccess("PascalCase", "pascal-case", Access.UNRESTRICTED));
139+
assertThat(metadata).has(defaultAccess("PascalCase", "pascal-case", TestAccess.UNRESTRICTED));
140140
assertThat(metadata.getItems()).hasSize(3);
141141
}
142142

@@ -147,7 +147,7 @@ void incrementalEndpointBuildChangeGeneralEnabledFlag() {
147147
assertThat(metadata)
148148
.has(Metadata.withGroup("management.endpoint.incremental").fromSource(IncrementalEndpoint.class));
149149
assertThat(metadata).has(enabledFlag("incremental", true));
150-
assertThat(metadata).has(access("incremental", Access.UNRESTRICTED));
150+
assertThat(metadata).has(access("incremental", TestAccess.UNRESTRICTED));
151151
assertThat(metadata).has(cacheTtl("incremental"));
152152
assertThat(metadata.getItems()).hasSize(4);
153153
project.replaceText(IncrementalEndpoint.class, "id = \"incremental\"",
@@ -156,7 +156,7 @@ void incrementalEndpointBuildChangeGeneralEnabledFlag() {
156156
assertThat(metadata)
157157
.has(Metadata.withGroup("management.endpoint.incremental").fromSource(IncrementalEndpoint.class));
158158
assertThat(metadata).has(enabledFlag("incremental", false));
159-
assertThat(metadata).has(access("incremental", Access.NONE));
159+
assertThat(metadata).has(access("incremental", TestAccess.NONE));
160160
assertThat(metadata).has(cacheTtl("incremental"));
161161
assertThat(metadata.getItems()).hasSize(4);
162162
}
@@ -168,15 +168,15 @@ void incrementalEndpointBuildChangeCacheFlag() {
168168
assertThat(metadata)
169169
.has(Metadata.withGroup("management.endpoint.incremental").fromSource(IncrementalEndpoint.class));
170170
assertThat(metadata).has(enabledFlag("incremental", true));
171-
assertThat(metadata).has(access("incremental", Access.UNRESTRICTED));
171+
assertThat(metadata).has(access("incremental", TestAccess.UNRESTRICTED));
172172
assertThat(metadata).has(cacheTtl("incremental"));
173173
assertThat(metadata.getItems()).hasSize(4);
174174
project.replaceText(IncrementalEndpoint.class, "@Nullable String param", "String param");
175175
metadata = project.compile();
176176
assertThat(metadata)
177177
.has(Metadata.withGroup("management.endpoint.incremental").fromSource(IncrementalEndpoint.class));
178178
assertThat(metadata).has(enabledFlag("incremental", true));
179-
assertThat(metadata).has(access("incremental", Access.UNRESTRICTED));
179+
assertThat(metadata).has(access("incremental", TestAccess.UNRESTRICTED));
180180
assertThat(metadata.getItems()).hasSize(3);
181181
}
182182

@@ -186,14 +186,14 @@ void incrementalEndpointBuildEnableSpecificEndpoint() {
186186
ConfigurationMetadata metadata = project.compile();
187187
assertThat(metadata).has(Metadata.withGroup("management.endpoint.specific").fromSource(SpecificEndpoint.class));
188188
assertThat(metadata).has(enabledFlag("specific", true));
189-
assertThat(metadata).has(access("specific", Access.UNRESTRICTED));
189+
assertThat(metadata).has(access("specific", TestAccess.UNRESTRICTED));
190190
assertThat(metadata).has(cacheTtl("specific"));
191191
assertThat(metadata.getItems()).hasSize(4);
192192
project.replaceText(SpecificEndpoint.class, "enableByDefault = true", "enableByDefault = false");
193193
metadata = project.compile();
194194
assertThat(metadata).has(Metadata.withGroup("management.endpoint.specific").fromSource(SpecificEndpoint.class));
195195
assertThat(metadata).has(enabledFlag("specific", false));
196-
assertThat(metadata).has(access("specific", Access.NONE));
196+
assertThat(metadata).has(access("specific", TestAccess.NONE));
197197
assertThat(metadata).has(cacheTtl("specific"));
198198
assertThat(metadata.getItems()).hasSize(4);
199199
}
@@ -203,7 +203,7 @@ void shouldTolerateEndpointWithSameId() {
203203
ConfigurationMetadata metadata = compile(SimpleEndpoint.class, SimpleEndpoint2.class);
204204
assertThat(metadata).has(Metadata.withGroup("management.endpoint.simple").fromSource(SimpleEndpoint.class));
205205
assertThat(metadata).has(enabledFlag("simple", "simple", true));
206-
assertThat(metadata).has(defaultAccess("simple", "simple", Access.UNRESTRICTED));
206+
assertThat(metadata).has(defaultAccess("simple", "simple", TestAccess.UNRESTRICTED));
207207
assertThat(metadata).has(cacheTtl("simple"));
208208
assertThat(metadata.getItems()).hasSize(4);
209209
}
@@ -228,12 +228,12 @@ private Metadata.MetadataItemCondition enabledFlag(String endpointId, String end
228228
.withDeprecation(null, "management.endpoint.%s.access".formatted(endpointSuffix), "3.4.0");
229229
}
230230

231-
private Metadata.MetadataItemCondition access(String endpointId, Access defaultValue) {
231+
private Metadata.MetadataItemCondition access(String endpointId, TestAccess defaultValue) {
232232
return defaultAccess(endpointId, endpointId, defaultValue);
233233
}
234234

235235
private Metadata.MetadataItemCondition defaultAccess(String endpointId, String endpointSuffix,
236-
Access defaultValue) {
236+
TestAccess defaultValue) {
237237
return Metadata.withAccess("management.endpoint." + endpointSuffix + ".access")
238238
.withDefaultValue(defaultValue.name().toLowerCase(Locale.ENGLISH))
239239
.withDescription("Permitted level of access for the %s endpoint.".formatted(endpointId));

spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/IncrementalBuildMetadataGenerationTests.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,8 @@ void incrementalBuildAnnotationRemoved() {
6666
ConfigurationMetadata metadata = project.compile();
6767
assertThat(metadata).has(Metadata.withProperty("foo.counter").withDefaultValue(0));
6868
assertThat(metadata).has(Metadata.withProperty("bar.counter").withDefaultValue(0));
69-
project.replaceText(BarProperties.class, "@ConfigurationProperties", "//@ConfigurationProperties");
70-
project.replaceText(FooProperties.class, "@ConfigurationProperties", "//@ConfigurationProperties");
69+
project.replaceText(BarProperties.class, "@TestConfigurationProperties", "//@TestConfigurationProperties");
70+
project.replaceText(FooProperties.class, "@TestConfigurationProperties", "//@TestConfigurationProperties");
7171
metadata = project.compile();
7272
assertThat(metadata).isNull();
7373
}

spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/TestProject.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@
2929
import org.springframework.boot.configurationprocessor.metadata.JsonMarshaller;
3030
import org.springframework.boot.configurationprocessor.test.CompiledMetadataReader;
3131
import org.springframework.boot.configurationprocessor.test.TestConfigurationMetadataAnnotationProcessor;
32-
import org.springframework.boot.configurationsample.ConfigurationProperties;
33-
import org.springframework.boot.configurationsample.NestedConfigurationProperty;
32+
import org.springframework.boot.configurationsample.TestConfigurationProperties;
33+
import org.springframework.boot.configurationsample.TestNestedConfigurationProperty;
3434
import org.springframework.core.test.tools.ResourceFile;
3535
import org.springframework.core.test.tools.SourceFile;
3636
import org.springframework.core.test.tools.SourceFiles;
@@ -50,8 +50,8 @@
5050
*/
5151
public class TestProject {
5252

53-
private static final Class<?>[] ALWAYS_INCLUDE = { ConfigurationProperties.class,
54-
NestedConfigurationProperty.class };
53+
private static final Class<?>[] ALWAYS_INCLUDE = { TestConfigurationProperties.class,
54+
TestNestedConfigurationProperty.class };
5555

5656
private SourceFiles sources;
5757

spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/fieldvalues/AbstractFieldValuesProcessorTests.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ void getFieldValues() {
116116
assertThat(values.get("memberSelectInt")).isNull();
117117
}
118118

119-
@SupportedAnnotationTypes({ "org.springframework.boot.configurationsample.ConfigurationProperties" })
119+
@SupportedAnnotationTypes({ "org.springframework.boot.configurationsample.TestConfigurationProperties" })
120120
@SupportedSourceVersion(SourceVersion.RELEASE_6)
121121
private final class TestProcessor extends AbstractProcessor {
122122

spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/metadata/Metadata.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
import org.hamcrest.collection.IsMapContaining;
2626

2727
import org.springframework.boot.configurationprocessor.metadata.ItemMetadata.ItemType;
28-
import org.springframework.boot.configurationsample.Access;
28+
import org.springframework.boot.configurationsample.TestAccess;
2929
import org.springframework.util.ObjectUtils;
3030

3131
/**
@@ -68,7 +68,7 @@ public static Metadata.MetadataItemCondition withEnabledFlag(String key) {
6868
}
6969

7070
public static Metadata.MetadataItemCondition withAccess(String key) {
71-
return withProperty(key).ofType(Access.class);
71+
return withProperty(key).ofType(TestAccess.class);
7272
}
7373

7474
public static MetadataHintCondition withHint(String name) {

spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/test/TestConfigurationMetadataAnnotationProcessor.java

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -46,35 +46,35 @@
4646
@SupportedSourceVersion(SourceVersion.RELEASE_6)
4747
public class TestConfigurationMetadataAnnotationProcessor extends ConfigurationMetadataAnnotationProcessor {
4848

49-
public static final String CONFIGURATION_PROPERTIES_ANNOTATION = "org.springframework.boot.configurationsample.ConfigurationProperties";
49+
public static final String CONFIGURATION_PROPERTIES_ANNOTATION = "org.springframework.boot.configurationsample.TestConfigurationProperties";
5050

51-
public static final String NESTED_CONFIGURATION_PROPERTY_ANNOTATION = "org.springframework.boot.configurationsample.NestedConfigurationProperty";
51+
public static final String NESTED_CONFIGURATION_PROPERTY_ANNOTATION = "org.springframework.boot.configurationsample.TestNestedConfigurationProperty";
5252

53-
public static final String DEPRECATED_CONFIGURATION_PROPERTY_ANNOTATION = "org.springframework.boot.configurationsample.DeprecatedConfigurationProperty";
53+
public static final String DEPRECATED_CONFIGURATION_PROPERTY_ANNOTATION = "org.springframework.boot.configurationsample.TestDeprecatedConfigurationProperty";
5454

55-
public static final String CONSTRUCTOR_BINDING_ANNOTATION = "org.springframework.boot.configurationsample.ConstructorBinding";
55+
public static final String CONSTRUCTOR_BINDING_ANNOTATION = "org.springframework.boot.configurationsample.TestConstructorBinding";
5656

57-
public static final String AUTOWIRED_ANNOTATION = "org.springframework.boot.configurationsample.Autowired";
57+
public static final String AUTOWIRED_ANNOTATION = "org.springframework.boot.configurationsample.TestAutowired";
5858

59-
public static final String DEFAULT_VALUE_ANNOTATION = "org.springframework.boot.configurationsample.DefaultValue";
59+
public static final String DEFAULT_VALUE_ANNOTATION = "org.springframework.boot.configurationsample.TestDefaultValue";
6060

61-
public static final String CONTROLLER_ENDPOINT_ANNOTATION = "org.springframework.boot.configurationsample.ControllerEndpoint";
61+
public static final String CONTROLLER_ENDPOINT_ANNOTATION = "org.springframework.boot.configurationsample.TestControllerEndpoint";
6262

63-
public static final String ENDPOINT_ANNOTATION = "org.springframework.boot.configurationsample.Endpoint";
63+
public static final String ENDPOINT_ANNOTATION = "org.springframework.boot.configurationsample.TestEndpoint";
6464

65-
public static final String JMX_ENDPOINT_ANNOTATION = "org.springframework.boot.configurationsample.JmxEndpoint";
65+
public static final String JMX_ENDPOINT_ANNOTATION = "org.springframework.boot.configurationsample.TestJmxEndpoint";
6666

67-
public static final String REST_CONTROLLER_ENDPOINT_ANNOTATION = "org.springframework.boot.configurationsample.RestControllerEndpoint";
67+
public static final String REST_CONTROLLER_ENDPOINT_ANNOTATION = "org.springframework.boot.configurationsample.TestRestControllerEndpoint";
6868

69-
public static final String SERVLET_ENDPOINT_ANNOTATION = "org.springframework.boot.configurationsample.ServletEndpoint";
69+
public static final String SERVLET_ENDPOINT_ANNOTATION = "org.springframework.boot.configurationsample.TestServletEndpoint";
7070

71-
public static final String WEB_ENDPOINT_ANNOTATION = "org.springframework.boot.configurationsample.WebEndpoint";
71+
public static final String WEB_ENDPOINT_ANNOTATION = "org.springframework.boot.configurationsample.TestWebEndpoint";
7272

73-
public static final String READ_OPERATION_ANNOTATION = "org.springframework.boot.configurationsample.ReadOperation";
73+
public static final String READ_OPERATION_ANNOTATION = "org.springframework.boot.configurationsample.TestReadOperation";
7474

75-
public static final String NAME_ANNOTATION = "org.springframework.boot.configurationsample.Name";
75+
public static final String NAME_ANNOTATION = "org.springframework.boot.configurationsample.TestName";
7676

77-
public static final String ENDPOINT_ACCESS_ENUM = "org.springframework.boot.configurationsample.Access";
77+
public static final String ENDPOINT_ACCESS_ENUM = "org.springframework.boot.configurationsample.TestAccess";
7878

7979
public TestConfigurationMetadataAnnotationProcessor() {
8080
}
Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,12 @@
1717
package org.springframework.boot.configurationsample;
1818

1919
/**
20-
* Permitted level of access to an endpoint.
20+
* Alternative to Spring Boot's {@code @Access} for testing (removes the need for a
21+
* dependency on the real annotation).
2122
*
2223
* @author Andy Wilkinson
2324
*/
24-
public enum Access {
25+
public enum TestAccess {
2526

2627
NONE,
2728

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,6 @@
3131
@Target({ ElementType.TYPE, ElementType.CONSTRUCTOR })
3232
@Retention(RetentionPolicy.RUNTIME)
3333
@Documented
34-
public @interface Autowired {
34+
public @interface TestAutowired {
3535

3636
}
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
@Target({ ElementType.TYPE, ElementType.METHOD })
3333
@Retention(RetentionPolicy.RUNTIME)
3434
@Documented
35-
public @interface ConfigurationProperties {
35+
public @interface TestConfigurationProperties {
3636

3737
String value() default "";
3838

0 commit comments

Comments
 (0)