Search code examples
spring-bootspring-boot-test

How to use user defined database proxy in @DataJpaTest


We need to track database metrics so we are using datasource-proxy to track this to integrate the same in spring boot project we have created custom datasource as below

@Component
@Slf4j
@ConfigurationProperties(prefix = "spring.datasource")
public class DataSourceBeanConfig
{

    public DataSource actualDataSource()
    {
        EmbeddedDatabaseBuilder databaseBuilder = new EmbeddedDatabaseBuilder();
        return databaseBuilder.setType(EmbeddedDatabaseType.H2).build();
    }

    @Bean
    @Primary
    public DataSource dataSource() {
        // use pretty formatted query with multiline enabled
        PrettyQueryEntryCreator creator = new PrettyQueryEntryCreator();
        creator.setMultiline(true);
        
        log.info("Inside Proxy Creation");
        
        SystemOutQueryLoggingListener listener = new SystemOutQueryLoggingListener();
        listener.setQueryLogEntryCreator(creator);

        return ProxyDataSourceBuilder
                .create(actualDataSource())
                .countQuery()
                .name("MyDS")
                .listener(listener)
                .build();
    }
}

When we run main application datasource-proxy is picked up but when we use @DataJpaTest it is not picking up. How to enable datasource-proxy in JUNIT test cases?

Edit::

Using Spring BeanPostProcessor to configure Proxy DataSource

@Slf4j
@Configuration
public class DataSourceBeanConfig implements BeanPostProcessor
{
    public Object postProcessAfterInitialization(Object bean, String beanName)
            throws BeansException
    {

        if (bean instanceof DataSource)
        {
            System.out.println("AfterInitialization : " + beanName);
            
            // use pretty formatted query with multiline enabled
            PrettyQueryEntryCreator creator = new PrettyQueryEntryCreator();
            creator.setMultiline(true);

            log.info("Inside Proxy Creation");

            SystemOutQueryLoggingListener listener = new SystemOutQueryLoggingListener();
            listener.setQueryLogEntryCreator(creator);

            return ProxyDataSourceBuilder.create((DataSource) bean).countQuery()
                    .name("MyDS").listener(listener).build();

        }
        return bean; // you can return any other object as well
    }
}

Solution

  • Here is the solution we need to create TestConfiguration to use in @DataJpaTest

    @RunWith(SpringRunner.class)
    @DataJpaTest
    public class DataTestJPA
    {
    
        @TestConfiguration
        static class ProxyDataSourceConfig implements BeanPostProcessor
        {
            public Object postProcessAfterInitialization(Object bean, String beanName)
                    throws BeansException
            {
    
                if (bean instanceof DataSource source && !(bean instanceof ProxyDataSource)) {
                {
                   return ProxyDataSourceBuilder
                                .create(source)
                                .countQuery()
                                .name("MyDS")
                                .build();
                    // @formatter:on
    
                }
                return bean; // you can return any other object as well
            }
        }
    }