Skip to content

Allow overriding DateTimeProvider via Bean Definition #3385

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
+77 −6
Closed

Allow overriding DateTimeProvider via Bean Definition #3385

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 3 additions & 6 deletions ...java/org/springframework/data/auditing/config/AuditingBeanDefinitionRegistrarSupport.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,13 @@

import org.springframework.aop.framework.ProxyFactoryBean;
import org.springframework.aop.target.LazyInitTargetSource;
import org.springframework.beans.factory.config.AutowireCapableBeanFactory;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.support.AbstractBeanDefinition;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
import org.springframework.core.type.AnnotationMetadata;
import org.springframework.data.auditing.AuditingHandler;
import org.springframework.data.auditing.CurrentDateTimeProvider;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;

Expand All @@ -42,6 +40,7 @@
* @author Thomas Darimont
* @author Oliver Gierke
* @author Francisco Soler
* @author Jaeyeon Kim
*/
public abstract class AuditingBeanDefinitionRegistrarSupport implements ImportBeanDefinitionRegistrar {

Expand Down Expand Up @@ -117,20 +116,18 @@ protected BeanDefinitionBuilder getAuditHandlerBeanDefinitionBuilder(AuditingCon
protected BeanDefinitionBuilder configureDefaultAuditHandlerAttributes(AuditingConfiguration configuration,
BeanDefinitionBuilder builder) {

builder.setAutowireMode(AbstractBeanDefinition.AUTOWIRE_BY_TYPE);

if (StringUtils.hasText(configuration.getAuditorAwareRef())) {
builder.addPropertyValue(AUDITOR_AWARE,
createLazyInitTargetSourceBeanDefinition(configuration.getAuditorAwareRef()));
} else {
builder.setAutowireMode(AutowireCapableBeanFactory.AUTOWIRE_BY_TYPE);
}

builder.addPropertyValue(SET_DATES, configuration.isSetDates());
builder.addPropertyValue(MODIFY_ON_CREATE, configuration.isModifyOnCreate());

if (StringUtils.hasText(configuration.getDateTimeProviderRef())) {
builder.addPropertyReference(DATE_TIME_PROVIDER, configuration.getDateTimeProviderRef());
} else {
builder.addPropertyValue(DATE_TIME_PROVIDER, CurrentDateTimeProvider.INSTANCE);
}

builder.setRole(AbstractBeanDefinition.ROLE_INFRASTRUCTURE);
Expand Down
74 changes: 74 additions & 0 deletions ...springframework/data/auditing/config/AuditingBeanDefinitionRegistrarSupportUnitTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,11 @@
import org.mockito.junit.jupiter.MockitoExtension;

import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.support.AbstractBeanDefinition;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.core.type.AnnotationMetadata;
import org.springframework.data.auditing.AuditingHandler;
import org.springframework.data.auditing.EnableAuditing;

/**
Expand All @@ -38,6 +41,7 @@
* @author Thomas Darimont
* @author Oliver Gierke
* @author Francisco Soler
* @author Jaeyeon Kim
*/
@ExtendWith(MockitoExtension.class)
class AuditingBeanDefinitionRegistrarSupportUnitTests {
Expand Down Expand Up @@ -73,6 +77,76 @@ void rejectsNullRegistry() {
.isThrownBy(() -> registrar.registerBeanDefinitions(metadata, null));
}

@Test // DATACMNS-3177
void setsAuditorAwareAndDateTimeProviderIfConfigured() {

AuditingConfiguration configuration = new AuditingConfiguration() {
@Override
public String getAuditorAwareRef() {
return "auditorAwareBean";
}

@Override
public boolean isSetDates() {
return true;
}

@Override
public String getDateTimeProviderRef() {
return "dateTimeProviderBean";
}

@Override
public boolean isModifyOnCreate() {
return true;
}
};

BeanDefinitionBuilder builder = BeanDefinitionBuilder.rootBeanDefinition(AuditingHandler.class);
DummyAuditingBeanDefinitionRegistrarSupport registrar = new DummyAuditingBeanDefinitionRegistrarSupport();

BeanDefinitionBuilder result = registrar.configureDefaultAuditHandlerAttributes(configuration, builder);
AbstractBeanDefinition beanDefinition = result.getBeanDefinition();

assertThat(beanDefinition.getAutowireMode()).isEqualTo(AbstractBeanDefinition.AUTOWIRE_BY_TYPE);
assertThat(beanDefinition.getPropertyValues().contains("auditorAware")).isTrue();
assertThat(beanDefinition.getPropertyValues().contains("dateTimeProvider")).isTrue();
}

@Test // DATACMNS-3177
void doesNotSetAuditorAwareAndDateTimeProviderIfNotConfigured() {

AuditingConfiguration configuration = new AuditingConfiguration() {
@Override
public String getAuditorAwareRef() {
return "";
}

@Override
public boolean isSetDates() {
return true;
}

@Override
public String getDateTimeProviderRef() {
return "";
}

@Override
public boolean isModifyOnCreate() { return true; }
};

BeanDefinitionBuilder builder = BeanDefinitionBuilder.rootBeanDefinition(AuditingHandler.class);
DummyAuditingBeanDefinitionRegistrarSupport registrar = new DummyAuditingBeanDefinitionRegistrarSupport();

BeanDefinitionBuilder result = registrar.configureDefaultAuditHandlerAttributes(configuration, builder);
AbstractBeanDefinition beanDefinition = result.getBeanDefinition();

assertThat(beanDefinition.getAutowireMode()).isEqualTo(AbstractBeanDefinition.AUTOWIRE_BY_TYPE);
assertThat(beanDefinition.getPropertyValues().contains("auditorAware")).isFalse();
assertThat(beanDefinition.getPropertyValues().contains("dateTimeProvider")).isFalse();
}

static class SampleConfig {}

static class DummyAuditingBeanDefinitionRegistrarSupport extends AuditingBeanDefinitionRegistrarSupport {
Expand Down