Only override ConfigurationSourceProvider if explicitly provided (#2720)

Fixes #2719
dropwizard · Apr 6, 2019 · 6c17257 · 6c17257
1 parent e5f99de
commit 6c17257
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 8 deletions.
diff --git a/dropwizard-testing/src/main/java/io/dropwizard/testing/DropwizardTestSupport.java b/dropwizard-testing/src/main/java/io/dropwizard/testing/DropwizardTestSupport.java
@@ -6,7 +6,6 @@
 import io.dropwizard.cli.Command;
 import io.dropwizard.cli.ServerCommand;
 import io.dropwizard.configuration.ConfigurationSourceProvider;
-import io.dropwizard.configuration.FileConfigurationSourceProvider;
 import io.dropwizard.configuration.YamlConfigurationFactory;
 import io.dropwizard.lifecycle.Managed;
 import io.dropwizard.setup.Bootstrap;
@@ -46,6 +45,7 @@ public class DropwizardTestSupport<C extends Configuration> {
 
     @Nullable
     protected final String configPath;
+    @Nullable
     protected final ConfigurationSourceProvider configSourceProvider;
     protected final Set<ConfigOverride> configOverrides;
     @Nullable
@@ -80,7 +80,7 @@ public DropwizardTestSupport(Class<? extends Application<C>> applicationClass,
 
     public DropwizardTestSupport(Class<? extends Application<C>> applicationClass,
                                  @Nullable String configPath,
-                                 ConfigurationSourceProvider configSourceProvider,
+                                 @Nullable ConfigurationSourceProvider configSourceProvider,
                                  ConfigOverride... configOverrides) {
         this(applicationClass, configPath, configSourceProvider, null, configOverrides);
     }
@@ -98,7 +98,7 @@ public DropwizardTestSupport(Class<? extends Application<C>> applicationClass,
 
     public DropwizardTestSupport(Class<? extends Application<C>> applicationClass,
                                  @Nullable String configPath,
-                                 ConfigurationSourceProvider configSourceProvider,
+                                 @Nullable ConfigurationSourceProvider configSourceProvider,
                                  @Nullable String customPropertyPrefix,
                                  ConfigOverride... configOverrides) {
         this(applicationClass, configPath, configSourceProvider, customPropertyPrefix, ServerCommand::new, configOverrides);
@@ -128,12 +128,12 @@ public DropwizardTestSupport(Class<? extends Application<C>> applicationClass,
                                  @Nullable String customPropertyPrefix,
                                  Function<Application<C>, Command> commandInstantiator,
                                  ConfigOverride... configOverrides) {
-        this(applicationClass, configPath, new FileConfigurationSourceProvider(), customPropertyPrefix, commandInstantiator, configOverrides);
+        this(applicationClass, configPath, null, customPropertyPrefix, commandInstantiator, configOverrides);
     }
 
     public DropwizardTestSupport(Class<? extends Application<C>> applicationClass,
                                  @Nullable String configPath,
-                                 ConfigurationSourceProvider configSourceProvider,
+                                 @Nullable ConfigurationSourceProvider configSourceProvider,
                                  @Nullable String customPropertyPrefix,
                                  Function<Application<C>, Command> commandInstantiator,
                                  ConfigOverride... configOverrides) {
@@ -180,7 +180,7 @@ public DropwizardTestSupport(Class<? extends Application<C>> applicationClass,
         }
         this.applicationClass = applicationClass;
         this.configPath = "";
-        this.configSourceProvider = new FileConfigurationSourceProvider();
+        this.configSourceProvider = null;
         this.configOverrides = Collections.emptySet();
         this.customPropertyPrefix = null;
         this.configuration = configuration;
@@ -288,7 +288,9 @@ public void run(C configuration, Environment environment) throws Exception {
         };
 
         getApplication().initialize(bootstrap);
-        bootstrap.setConfigurationSourceProvider(configSourceProvider);
+        if (configSourceProvider != null) {
+            bootstrap.setConfigurationSourceProvider(configSourceProvider);
+        }
 
         if (explicitConfig) {
             bootstrap.setConfigurationFactoryFactory((klass, validator, objectMapper, propertyPrefix) ->

diff --git a/.../test/java/io/dropwizard/testing/DropwizardTestSupportWithResourceConfigProviderTest.java b/.../test/java/io/dropwizard/testing/DropwizardTestSupportWithResourceConfigProviderTest.java
@@ -1,16 +1,21 @@
 package io.dropwizard.testing;
 
 import io.dropwizard.configuration.ResourceConfigurationSourceProvider;
+import io.dropwizard.setup.Bootstrap;
 import io.dropwizard.setup.Environment;
-import io.dropwizard.testing.app.TestApplication;
 import io.dropwizard.testing.app.TestConfiguration;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
 
+import java.io.IOException;
+import java.io.InputStream;
+
 import static org.assertj.core.api.Assertions.assertThat;
 
 class DropwizardTestSupportWithResourceConfigProviderTest {
+    private static final TestResourceConfigurationSourceProvider TEST_CONFIG_SOURCE_PROVIDER =
+            new TestResourceConfigurationSourceProvider();
     private static final DropwizardTestSupport<TestConfiguration> TEST_SUPPORT = new DropwizardTestSupport<>(
             TestApplication.class, "test-config.yaml", new ResourceConfigurationSourceProvider());
 
@@ -41,4 +46,33 @@ void returnsEnvironment() {
         final Environment environment = TEST_SUPPORT.getEnvironment();
         assertThat(environment.getName()).isEqualTo("TestApplication");
     }
+
+    @Test
+    void doesNotOverwriteConfigSourceProviderIfNotProvidedInConstructor() throws Exception {
+        DropwizardTestSupport<TestConfiguration> support = new DropwizardTestSupport<>(
+                TestApplication.class, "test-config.yaml");
+        try {
+            support.before();
+            assertThat(TEST_CONFIG_SOURCE_PROVIDER.openCalled).isTrue();
+        } finally {
+            support.after();
+        }
+    }
+
+    public static class TestResourceConfigurationSourceProvider extends ResourceConfigurationSourceProvider {
+        volatile boolean openCalled = false;
+
+        @Override
+        public InputStream open(String path) throws IOException {
+            openCalled = true;
+            return super.open(path);
+        }
+    }
+
+    public static class TestApplication extends io.dropwizard.testing.app.TestApplication {
+        @Override
+        public void initialize(Bootstrap<TestConfiguration> bootstrap) {
+            bootstrap.setConfigurationSourceProvider(TEST_CONFIG_SOURCE_PROVIDER);
+        }
+    }
 }