Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2012-2019 the original author or authors.
* Copyright 2012-2020 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.
Expand Down Expand Up @@ -30,7 +30,7 @@
* @author Phillip Webb
* @since 2.0.0
*/
@Target(ElementType.FIELD)
@Target({ ElementType.FIELD, ElementType.PARAMETER })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DurationFormat {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
* @author Edson Chávez
* @since 2.3.0
*/
@Target(ElementType.FIELD)
@Target({ ElementType.FIELD, ElementType.PARAMETER })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface PeriodFormat {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,11 @@
import org.springframework.boot.context.properties.bind.validation.BindValidationException;
import org.springframework.boot.context.properties.source.ConfigurationPropertyName;
import org.springframework.boot.convert.DataSizeUnit;
import org.springframework.boot.convert.DurationFormat;
import org.springframework.boot.convert.DurationStyle;
import org.springframework.boot.convert.DurationUnit;
import org.springframework.boot.convert.PeriodFormat;
import org.springframework.boot.convert.PeriodStyle;
import org.springframework.boot.convert.PeriodUnit;
import org.springframework.boot.testsupport.system.CapturedOutput;
import org.springframework.boot.testsupport.system.OutputCaptureExtension;
Expand Down Expand Up @@ -808,6 +812,53 @@ void loadWhenBindingToConstructorParametersWithDefaultDataUnitShouldBind() {
assertThat(bean.getPeriod()).isEqualTo(Period.ofYears(4));
}

@Test
void loadWhenBindingToConstructorParametersWithCustomDataFormatShouldBind() {
MutablePropertySources sources = this.context.getEnvironment().getPropertySources();
Map<String, Object> source = new HashMap<>();
source.put("test.duration", "12d");
source.put("test.period", "13y");
sources.addLast(new MapPropertySource("test", source));
load(ConstructorParameterWithFormatConfiguration.class);
ConstructorParameterWithFormatProperties bean = this.context
.getBean(ConstructorParameterWithFormatProperties.class);
assertThat(bean.getDuration()).isEqualTo(Duration.ofDays(12));
assertThat(bean.getPeriod()).isEqualTo(Period.ofYears(13));
}

@Test
void loadWhenBindingToConstructorParametersWithNotMatchingCustomDurationFormatShouldFail() {
MutablePropertySources sources = this.context.getEnvironment().getPropertySources();
Map<String, Object> source = new HashMap<>();
source.put("test.duration", "P12D");
sources.addLast(new MapPropertySource("test", source));
assertThatExceptionOfType(Exception.class)
.isThrownBy(() -> load(ConstructorParameterWithFormatConfiguration.class)).satisfies((ex) -> {
assertThat(ex).hasCauseInstanceOf(BindException.class);
});
}

@Test
void loadWhenBindingToConstructorParametersWithNotMatchingCustomPeriodFormatShouldFail() {
MutablePropertySources sources = this.context.getEnvironment().getPropertySources();
Map<String, Object> source = new HashMap<>();
source.put("test.period", "P12D");
sources.addLast(new MapPropertySource("test", source));
assertThatExceptionOfType(Exception.class)
.isThrownBy(() -> load(ConstructorParameterWithFormatConfiguration.class)).satisfies((ex) -> {
assertThat(ex).hasCauseInstanceOf(BindException.class);
});
}

@Test
void loadWhenBindingToConstructorParametersWithDefaultDataFormatShouldBind() {
load(ConstructorParameterWithFormatConfiguration.class);
ConstructorParameterWithFormatProperties bean = this.context
.getBean(ConstructorParameterWithFormatProperties.class);
assertThat(bean.getDuration()).isEqualTo(Duration.ofDays(2));
assertThat(bean.getPeriod()).isEqualTo(Period.ofYears(3));
}

@Test
void loadWhenBindingToConstructorParametersShouldValidate() {
assertThatExceptionOfType(Exception.class)
Expand Down Expand Up @@ -2007,6 +2058,31 @@ Period getPeriod() {

}

@ConstructorBinding
@ConfigurationProperties(prefix = "test")
static class ConstructorParameterWithFormatProperties {

private final Duration duration;

private final Period period;

ConstructorParameterWithFormatProperties(
@DefaultValue("2d") @DurationFormat(DurationStyle.SIMPLE) Duration duration,
@DefaultValue("3y") @PeriodFormat(PeriodStyle.SIMPLE) Period period) {
this.duration = duration;
this.period = period;
}

Duration getDuration() {
return this.duration;
}

Period getPeriod() {
return this.period;
}

}

@ConstructorBinding
@ConfigurationProperties(prefix = "test")
@Validated
Expand Down Expand Up @@ -2035,6 +2111,11 @@ static class ConstructorParameterWithUnitConfiguration {

}

@EnableConfigurationProperties(ConstructorParameterWithFormatProperties.class)
static class ConstructorParameterWithFormatConfiguration {

}

@EnableConfigurationProperties(ConstructorParameterValidatedProperties.class)
static class ConstructorParameterValidationConfiguration {

Expand Down