Skip to content

Commit

Permalink
ZuulFiltersModule now injects AbstractConfiguration.
Browse files Browse the repository at this point in the history
ZuulFiltersModule used to statically load AbstractConfiguration via
ConfigurationManager.getConfigInstance(). This limits the user's ability
to bind various configuration loading mechanisms via the injector.
  • Loading branch information
codyrioux committed Jan 30, 2020
1 parent 9b6832d commit 0362066
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
import com.google.common.reflect.ClassPath;
import com.google.inject.AbstractModule;
import com.google.inject.Provides;
import com.netflix.config.ConfigurationManager;
import com.netflix.zuul.BasicFilterUsageNotifier;
import com.netflix.zuul.DynamicCodeCompiler;
import com.netflix.zuul.FilterFactory;
Expand Down Expand Up @@ -60,10 +59,8 @@ protected void configure() {
}

@Provides
FilterFileManagerConfig provideFilterFileManagerConfig() {
FilterFileManagerConfig provideFilterFileManagerConfig(AbstractConfiguration config) {
// Get filter directories.
final AbstractConfiguration config = ConfigurationManager.getConfigInstance();

String[] filterLocations = findFilterLocations(config);
String[] filterClassNames = findClassNames(config);

Expand Down
29 changes: 29 additions & 0 deletions zuul-core/src/test/java/com/netflix/zuul/init/InitTestModule.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
/*
* Copyright 2020 Netflix, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http:https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package com.netflix.zuul.init;

import com.google.inject.AbstractModule;
import com.netflix.config.ConfigurationManager;
import org.apache.commons.configuration.AbstractConfiguration;

public class InitTestModule extends AbstractModule {
@Override
protected void configure() {
bind(AbstractConfiguration.class).toInstance(ConfigurationManager.getConfigInstance());
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
import static org.junit.Assert.assertEquals;

@RunWith(GovernatorJunit4ClassRunner.class)
@ModulesForTesting({ZuulFiltersModule.class})
@ModulesForTesting({InitTestModule.class, ZuulFiltersModule.class})
public class ZuulFiltersModuleIntegTest {
@Inject
FilterFileManagerConfig filterFileManagerConfig;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
package com.netflix.zuul.sample;

import com.google.inject.Injector;
import com.netflix.config.ConfigurationManager;
import com.netflix.governator.InjectorBuilder;
import com.netflix.zuul.netty.server.BaseServerStartup;
import com.netflix.zuul.netty.server.Server;
Expand All @@ -42,7 +41,6 @@ public void start() {
Server server = null;

try {
ConfigurationManager.loadCascadedPropertiesFromResources("application");
Injector injector = InjectorBuilder.fromModule(new ZuulSampleModule()).createInjector();
BaseServerStartup serverStartup = injector.getInstance(BaseServerStartup.class);
server = serverStartup.server();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
package com.netflix.zuul.sample;

import com.google.inject.AbstractModule;
import com.netflix.config.ConfigurationManager;
import com.netflix.discovery.AbstractDiscoveryClientOptionalArgs;
import com.netflix.discovery.DiscoveryClient;
import com.netflix.netty.common.accesslog.AccessLogPublisher;
Expand All @@ -35,6 +36,7 @@
import com.netflix.zuul.origins.OriginManager;
import com.netflix.zuul.stats.BasicRequestMetricsPublisher;
import com.netflix.zuul.stats.RequestMetricsPublisher;
import org.apache.commons.configuration.AbstractConfiguration;

/**
* Zuul Sample Module
Expand All @@ -45,6 +47,14 @@
public class ZuulSampleModule extends AbstractModule {
@Override
protected void configure() {
try {
ConfigurationManager.loadCascadedPropertiesFromResources("application");
} catch (Exception ex) {
throw new RuntimeException("Error loading configuration: " + ex.getMessage(), ex);
}

bind(AbstractConfiguration.class).toInstance(ConfigurationManager.getConfigInstance());

// sample specific bindings
bind(BaseServerStartup.class).to(SampleServerStartup.class);

Expand Down

0 comments on commit 0362066

Please sign in to comment.