Polish "Support @Name with JavaBean-based configuration properties"

See gh-39452
This commit is contained in:
Andy Wilkinson
2024-07-22 15:40:14 +01:00
parent a305e2d1bd
commit 23b344691d
11 changed files with 181 additions and 71 deletions

View File

@@ -1,41 +0,0 @@
/*
* Copyright 2012-2023 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.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.boot.configurationprocessor;
import org.junit.jupiter.api.Test;
import org.springframework.boot.configurationprocessor.metadata.ConfigurationMetadata;
import org.springframework.boot.configurationprocessor.metadata.Metadata;
import org.springframework.boot.configurationsample.immutable.ImmutableNameAnnotationProperties;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Metadata generation tests for immutable properties using {@code @Name}.
*
* @author Phillip Webb
*/
class ImmutableNameAnnotationPropertiesTests extends AbstractMetadataGenerationTests {
@Test
void immutableNameAnnotationProperties() {
ConfigurationMetadata metadata = compile(ImmutableNameAnnotationProperties.class);
assertThat(metadata).has(Metadata.withProperty("named.import", String.class)
.fromSource(ImmutableNameAnnotationProperties.class));
}
}

View File

@@ -0,0 +1,57 @@
/*
* Copyright 2012-2024 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.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.boot.configurationprocessor;
import org.junit.jupiter.api.Test;
import org.springframework.boot.configurationprocessor.metadata.ConfigurationMetadata;
import org.springframework.boot.configurationprocessor.metadata.Metadata;
import org.springframework.boot.configurationsample.immutable.ConstructorParameterNameAnnotationProperties;
import org.springframework.boot.configurationsample.immutable.JavaBeanNameAnnotationProperties;
import org.springframework.boot.configurationsample.immutable.RecordComponentNameAnnotationProperties;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Metadata generation tests for using {@code @Name}.
*
* @author Phillip Webb
*/
class NameAnnotationPropertiesTests extends AbstractMetadataGenerationTests {
@Test
void constructorParameterNameAnnotationProperties() {
ConfigurationMetadata metadata = compile(ConstructorParameterNameAnnotationProperties.class);
assertThat(metadata).has(Metadata.withProperty("named.import", String.class)
.fromSource(ConstructorParameterNameAnnotationProperties.class));
}
@Test
void recordComponentNameAnnotationProperties() {
ConfigurationMetadata metadata = compile(RecordComponentNameAnnotationProperties.class);
assertThat(metadata).has(Metadata.withProperty("named.import", String.class)
.fromSource(RecordComponentNameAnnotationProperties.class));
}
@Test
void javaBeanNameAnnotationProperties() {
ConfigurationMetadata metadata = compile(JavaBeanNameAnnotationProperties.class);
assertThat(metadata).has(
Metadata.withProperty("named.import", String.class).fromSource(JavaBeanNameAnnotationProperties.class));
}
}

View File

@@ -31,11 +31,13 @@ import org.junit.jupiter.api.Test;
import org.springframework.boot.configurationprocessor.metadata.ItemMetadata;
import org.springframework.boot.configurationprocessor.test.RoundEnvironmentTester;
import org.springframework.boot.configurationprocessor.test.TestableAnnotationProcessor;
import org.springframework.boot.configurationsample.immutable.ConstructorParameterNameAnnotationProperties;
import org.springframework.boot.configurationsample.immutable.ImmutableClassConstructorBindingProperties;
import org.springframework.boot.configurationsample.immutable.ImmutableDeducedConstructorBindingProperties;
import org.springframework.boot.configurationsample.immutable.ImmutableMultiConstructorProperties;
import org.springframework.boot.configurationsample.immutable.ImmutableNameAnnotationProperties;
import org.springframework.boot.configurationsample.immutable.ImmutableSimpleProperties;
import org.springframework.boot.configurationsample.immutable.JavaBeanNameAnnotationProperties;
import org.springframework.boot.configurationsample.immutable.RecordComponentNameAnnotationProperties;
import org.springframework.boot.configurationsample.lombok.LombokExplicitProperties;
import org.springframework.boot.configurationsample.lombok.LombokSimpleDataProperties;
import org.springframework.boot.configurationsample.lombok.LombokSimpleProperties;
@@ -155,8 +157,20 @@ class PropertyDescriptorResolverTests {
}
@Test
void propertiesWithNameAnnotationParameter() {
process(ImmutableNameAnnotationProperties.class,
void contructorParameterPropertyWithNameAnnotationParameter() {
process(ConstructorParameterNameAnnotationProperties.class,
propertyNames((stream) -> assertThat(stream).containsExactly("import")));
}
@Test
void recordComponentPropertyWithNameAnnotationParameter() {
process(RecordComponentNameAnnotationProperties.class,
propertyNames((stream) -> assertThat(stream).containsExactly("import")));
}
@Test
void javaBeanPropertyWithNameAnnotationParameter() {
process(JavaBeanNameAnnotationProperties.class,
propertyNames((stream) -> assertThat(stream).containsExactly("import")));
}

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2020 the original author or authors.
* Copyright 2012-2024 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.
@@ -28,7 +28,7 @@ import java.lang.annotation.Target;
*
* @author Phillip Webb
*/
@Target(ElementType.PARAMETER)
@Target({ ElementType.PARAMETER, ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Name {

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2022 the original author or authors.
* Copyright 2012-2024 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.
@@ -20,16 +20,16 @@ import org.springframework.boot.configurationsample.ConfigurationProperties;
import org.springframework.boot.configurationsample.Name;
/**
* Immutable properties making use of {@code @Name}.
* Immutable class properties making use of {@code @Name}.
*
* @author Phillip Webb
*/
@ConfigurationProperties("named")
public class ImmutableNameAnnotationProperties {
public class ConstructorParameterNameAnnotationProperties {
private final String imports;
public ImmutableNameAnnotationProperties(@Name("import") String imports) {
public ConstructorParameterNameAnnotationProperties(@Name("import") String imports) {
this.imports = imports;
}

View File

@@ -0,0 +1,41 @@
/*
* Copyright 2012-2024 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.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.boot.configurationsample.immutable;
import org.springframework.boot.configurationsample.ConfigurationProperties;
import org.springframework.boot.configurationsample.Name;
/**
* Java bean properties making use of {@code @Name}.
*
* @author Andy Wilkinson
*/
@ConfigurationProperties("named")
public class JavaBeanNameAnnotationProperties {
@Name("import")
private String imports;
public String getImports() {
return this.imports;
}
public void setImports(String imports) {
this.imports = imports;
}
}

View File

@@ -0,0 +1,30 @@
/*
* Copyright 2012-2024 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.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.boot.configurationsample.immutable;
import org.springframework.boot.configurationsample.ConfigurationProperties;
import org.springframework.boot.configurationsample.Name;
/**
* Immutable record properties making use of {@code @Name}.
*
* @author Andy Wilkinson
*/
@ConfigurationProperties("named")
public record RecordComponentNameAnnotationProperties(@Name("import") String imports) {
}