Optional decoration of routing datasources (#74)

* Optional decorating of routing datasources

Add property to allow disable decorating of AbstractRoutingDataSSource

* Add some test

* Update README.md

Author: oburgosm

README.md

@@ -289,4 +289,6 @@ public DataSourceDecorator customDecorator() {
 
 #### Disable Decorating
 
-If you want to disable decorating set `decorator.datasource.exclude-beans` with bean names you want to exclude or set `decorator.datasource.enabled` to `false` if you want to disable all decorators for all datasources.
+If you want to disable decorating set `decorator.datasource.exclude-beans` with bean names you want to exclude.
+Also, you can disable decorating for `AbstractRoutingDataSource` setting property `decorator.datasource.ignore-routing-data-sources` to `true`
+Set `decorator.datasource.enabled` to `false` if you want to disable all decorators for all datasources. 

datasource-decorator-spring-boot-autoconfigure/src/main/java/com/github/gavlyukovskiy/boot/jdbc/decorator/DataSourceDecoratorBeanPostProcessor.java

@@ -23,6 +23,7 @@
 import org.springframework.context.ApplicationContextAware;
 import org.springframework.core.Ordered;
 import org.springframework.core.annotation.AnnotationAwareOrderComparator;
+import org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource;
 
 import javax.sql.DataSource;
 import java.util.ArrayList;
@@ -52,6 +53,7 @@ public Object postProcessBeforeInitialization(Object bean, String beanName) thro
     public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
         if (bean instanceof DataSource
                 && !ScopedProxyUtils.isScopedTarget(beanName)
+                && !((bean instanceof AbstractRoutingDataSource) && getDataSourceDecoratorProperties().isIgnoreRoutingDataSources())
                 && !getDataSourceDecoratorProperties().getExcludeBeans().contains(beanName)) {
             DataSource dataSource = (DataSource) bean;
             DataSource decoratedDataSource = dataSource;

datasource-decorator-spring-boot-autoconfigure/src/main/java/com/github/gavlyukovskiy/boot/jdbc/decorator/DataSourceDecoratorProperties.java

@@ -43,6 +43,11 @@ public class DataSourceDecoratorProperties {
      * Beans that won't be decorated.
      */
     private Collection<String> excludeBeans = Collections.emptyList();
+    
+    /**
+     * If AbstractRoutingDataSource will be decorated or not
+     */
+    private boolean ignoreRoutingDataSources = false;
 
     @NestedConfigurationProperty
     private DataSourceProxyProperties datasourceProxy = new DataSourceProxyProperties();
@@ -68,6 +73,10 @@ public Collection<String> getExcludeBeans() {
         return this.excludeBeans;
     }
 
+    public boolean isIgnoreRoutingDataSources() {
+        return ignoreRoutingDataSources;
+    }
+
     public DataSourceProxyProperties getDatasourceProxy() {
         return this.datasourceProxy;
     }
@@ -97,6 +106,11 @@ public void setExcludeBeans(Collection<String> excludeBeans) {
         this.excludeBeans = excludeBeans;
     }
 
+    public void setIgnoreRoutingDataSources(boolean ignoreRoutingDataSources) {
+        this.ignoreRoutingDataSources = ignoreRoutingDataSources;
+    }
+    
+
     public void setDatasourceProxy(DataSourceProxyProperties datasourceProxy) {
         this.datasourceProxy = datasourceProxy;
     }

datasource-decorator-spring-boot-autoconfigure/src/test/java/com/github/gavlyukovskiy/boot/jdbc/decorator/DataSourceDecoratorAutoConfigurationTests.java

@@ -35,11 +35,14 @@
 import org.springframework.context.annotation.Scope;
 import org.springframework.context.annotation.ScopedProxyMode;
 import org.springframework.context.support.GenericApplicationContext;
+import org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource;
 
 import javax.sql.DataSource;
 import java.io.PrintWriter;
 import java.sql.Connection;
 import java.util.List;
+import java.util.HashMap;
+import java.util.Map;
 import java.util.concurrent.ThreadLocalRandom;
 import java.util.logging.Logger;
 
@@ -226,6 +229,30 @@ void testDecorateDynamicallyRegisteredBeans() {
             assertThat(dataSource2).isInstanceOf(DecoratedDataSource.class);
         });
     }
+    
+    @Test
+    void testRoutingDataSourceIsDecorated() {
+        ApplicationContextRunner contextRunner = this.contextRunner.withUserConfiguration(TestAbstractRoutingDataSourceConfiguration.class);
+
+        contextRunner.run(context -> {
+            DataSource dataSource = context.getBean(DataSource.class);
+            assertThat(dataSource).isInstanceOf(DecoratedDataSource.class);
+            DataSource realDataSource = ((DecoratedDataSource) dataSource).getRealDataSource();
+            assertThat(realDataSource).isInstanceOf(AbstractRoutingDataSource.class);
+        });
+    }
+    
+    @Test
+    void testRoutingDataSourceIsNotDecorated() {
+        ApplicationContextRunner contextRunner = this.contextRunner.withPropertyValues("decorator.datasource.ignore-routing-data-sources=true")
+                .withUserConfiguration(TestAbstractRoutingDataSourceConfiguration.class);
+
+        contextRunner.run(context -> {
+            DataSource dataSource = context.getBean(DataSource.class);
+            assertThat(dataSource).isNotInstanceOf(DecoratedDataSource.class);
+            assertThat(dataSource).isInstanceOf(AbstractRoutingDataSource.class);
+        });
+    }
 
     private AbstractListAssert<?, List<?>, Object, ObjectAssert<Object>> assertThatDataSourceDecoratingChain(DataSource dataSource) {
         return assertThat(((DecoratedDataSource) dataSource).getDecoratingChain()).extracting("dataSource").extracting("class");
@@ -289,6 +316,29 @@ public DataSource dataSource() {
             return pool;
         }
     }
+    
+    @Configuration(proxyBeanMethods = false)
+    static class TestAbstractRoutingDataSourceConfiguration {
+
+        @Bean
+        public DataSource dataSource() {
+            AbstractRoutingDataSource routingDs = new AbstractRoutingDataSource() {
+              @Override
+              protected Object determineCurrentLookupKey() {
+                return "ds1";
+              }
+            };
+            BasicDataSource pool = new BasicDataSource();
+            pool.setDriverClassName("org.hsqldb.jdbcDriver");
+            pool.setUrl("jdbc:hsqldb:target/routingds");
+            pool.setUsername("sa");
+            Map<Object, Object> targetDataSources = new HashMap<>();
+            targetDataSources.put("ds1", pool);
+            routingDs.setTargetDataSources(targetDataSources);
+            routingDs.setDefaultTargetDataSource(pool);
+            return routingDs;
+        }
+    }
 
     /**
      * Custom proxy data source for tests.