From 111a95d262a66e4f2eae1bf915aabcbb0355f1b2 Mon Sep 17 00:00:00 2001 From: Spencer Gibb Date: Tue, 29 Nov 2016 16:29:40 -0700 Subject: [PATCH] Fix Eureka Ribbon Auto Config conditions. Specifically, add `@ConditionalOnBean(EurekaClient.class)`. Fixes an issue where eureka and ribbon are on the classpath, eureka.client.enabled=false which would cause a bean not found exception. fixes gh-1511 (cherry picked from commit d1f8c03) --- .../eureka/RibbonEurekaAutoConfiguration.java | 35 ++++++- ...lientPropertyOverrideIntegrationTests.java | 12 +-- ...bonClientPreprocessorIntegrationTests.java | 10 +- .../RibbonEurekaAutoConfigurationTests.java | 99 +++++++++++++++++++ spring-cloud-netflix-eureka-server/pom.xml | 5 + spring-cloud-netflix-turbine/pom.xml | 5 + 6 files changed, 152 insertions(+), 14 deletions(-) create mode 100644 spring-cloud-netflix-eureka-client/src/test/java/org/springframework/cloud/netflix/ribbon/eureka/RibbonEurekaAutoConfigurationTests.java diff --git a/spring-cloud-netflix-eureka-client/src/main/java/org/springframework/cloud/netflix/ribbon/eureka/RibbonEurekaAutoConfiguration.java b/spring-cloud-netflix-eureka-client/src/main/java/org/springframework/cloud/netflix/ribbon/eureka/RibbonEurekaAutoConfiguration.java index a6b07fc776..7ba3e0be1a 100644 --- a/spring-cloud-netflix-eureka-client/src/main/java/org/springframework/cloud/netflix/ribbon/eureka/RibbonEurekaAutoConfiguration.java +++ b/spring-cloud-netflix-eureka-client/src/main/java/org/springframework/cloud/netflix/ribbon/eureka/RibbonEurekaAutoConfiguration.java @@ -16,7 +16,14 @@ package org.springframework.cloud.netflix.ribbon.eureka; +import java.lang.annotation.Documented; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + import org.springframework.boot.autoconfigure.AutoConfigureAfter; +import org.springframework.boot.autoconfigure.condition.AllNestedConditions; import org.springframework.boot.autoconfigure.condition.ConditionalOnBean; import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; @@ -24,8 +31,10 @@ import org.springframework.cloud.netflix.ribbon.RibbonAutoConfiguration; import org.springframework.cloud.netflix.ribbon.RibbonClients; import org.springframework.cloud.netflix.ribbon.SpringClientFactory; +import org.springframework.context.annotation.Conditional; import org.springframework.context.annotation.Configuration; +import com.netflix.discovery.EurekaClient; import com.netflix.niws.loadbalancer.DiscoveryEnabledNIWSServerList; /** @@ -33,11 +42,31 @@ */ @Configuration @EnableConfigurationProperties -@ConditionalOnClass(DiscoveryEnabledNIWSServerList.class) -@ConditionalOnBean(SpringClientFactory.class) -@ConditionalOnProperty(value = "ribbon.eureka.enabled", matchIfMissing = true) +@RibbonEurekaAutoConfiguration.ConditionalOnRibbonAndEurekaEnabled @AutoConfigureAfter(RibbonAutoConfiguration.class) @RibbonClients(defaultConfiguration = EurekaRibbonClientConfiguration.class) public class RibbonEurekaAutoConfiguration { + @Target({ ElementType.TYPE, ElementType.METHOD }) + @Retention(RetentionPolicy.RUNTIME) + @Documented + @Conditional(OnRibbonAndEurekaEnabledCondition.class) + @interface ConditionalOnRibbonAndEurekaEnabled { + + } + + private static class OnRibbonAndEurekaEnabledCondition extends AllNestedConditions { + + public OnRibbonAndEurekaEnabledCondition() { + super(ConfigurationPhase.REGISTER_BEAN); + } + + @ConditionalOnClass(DiscoveryEnabledNIWSServerList.class) + @ConditionalOnBean(SpringClientFactory.class) + @ConditionalOnProperty(value = "ribbon.eureka.enabled", matchIfMissing = true) + static class Defaults {} + + @ConditionalOnBean(EurekaClient.class) + static class EurekaBeans {} + } } diff --git a/spring-cloud-netflix-eureka-client/src/test/java/org/springframework/cloud/netflix/ribbon/eureka/EurekaRibbonClientPropertyOverrideIntegrationTests.java b/spring-cloud-netflix-eureka-client/src/test/java/org/springframework/cloud/netflix/ribbon/eureka/EurekaRibbonClientPropertyOverrideIntegrationTests.java index cd51607e67..948799d16e 100644 --- a/spring-cloud-netflix-eureka-client/src/test/java/org/springframework/cloud/netflix/ribbon/eureka/EurekaRibbonClientPropertyOverrideIntegrationTests.java +++ b/spring-cloud-netflix-eureka-client/src/test/java/org/springframework/cloud/netflix/ribbon/eureka/EurekaRibbonClientPropertyOverrideIntegrationTests.java @@ -16,11 +16,10 @@ package org.springframework.cloud.netflix.ribbon.eureka; -import static org.mockito.Mockito.mock; - import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.autoconfigure.ImportAutoConfiguration; import org.springframework.boot.autoconfigure.PropertyPlaceholderAutoConfiguration; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.cloud.commons.util.UtilAutoConfiguration; @@ -30,9 +29,8 @@ import org.springframework.cloud.netflix.ribbon.SpringClientFactory; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; -import org.springframework.context.annotation.Import; import org.springframework.test.annotation.DirtiesContext; -import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; +import org.springframework.test.context.junit4.SpringRunner; import com.netflix.discovery.EurekaClient; import com.netflix.loadbalancer.ConfigurationBasedServerList; @@ -41,10 +39,12 @@ import com.netflix.loadbalancer.ZoneAwareLoadBalancer; import com.netflix.niws.loadbalancer.NIWSDiscoveryPing; +import static org.mockito.Mockito.mock; + /** * @author Spencer Gibb */ -@RunWith(SpringJUnit4ClassRunner.class) +@RunWith(SpringRunner.class) @SpringBootTest(classes = EurekaRibbonClientPropertyOverrideIntegrationTests.TestConfiguration.class) @DirtiesContext public class EurekaRibbonClientPropertyOverrideIntegrationTests { @@ -72,7 +72,7 @@ private ZoneAwareLoadBalancer getLoadBalancer(String name) { @Configuration @RibbonClients - @Import({ UtilAutoConfiguration.class, PropertyPlaceholderAutoConfiguration.class, + @ImportAutoConfiguration({ UtilAutoConfiguration.class, PropertyPlaceholderAutoConfiguration.class, ArchaiusAutoConfiguration.class, RibbonAutoConfiguration.class, RibbonEurekaAutoConfiguration.class }) protected static class TestConfiguration { diff --git a/spring-cloud-netflix-eureka-client/src/test/java/org/springframework/cloud/netflix/ribbon/eureka/RibbonClientPreprocessorIntegrationTests.java b/spring-cloud-netflix-eureka-client/src/test/java/org/springframework/cloud/netflix/ribbon/eureka/RibbonClientPreprocessorIntegrationTests.java index b78d48c499..db13e522b9 100644 --- a/spring-cloud-netflix-eureka-client/src/test/java/org/springframework/cloud/netflix/ribbon/eureka/RibbonClientPreprocessorIntegrationTests.java +++ b/spring-cloud-netflix-eureka-client/src/test/java/org/springframework/cloud/netflix/ribbon/eureka/RibbonClientPreprocessorIntegrationTests.java @@ -16,12 +16,11 @@ package org.springframework.cloud.netflix.ribbon.eureka; -import static org.junit.Assert.assertEquals; - import org.junit.Test; import org.junit.runner.RunWith; import org.mockito.Mockito; import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.autoconfigure.ImportAutoConfiguration; import org.springframework.boot.autoconfigure.PropertyPlaceholderAutoConfiguration; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.cloud.commons.util.InetUtils; @@ -35,7 +34,6 @@ import org.springframework.cloud.netflix.ribbon.eureka.RibbonClientPreprocessorIntegrationTests.TestConfiguration; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; -import org.springframework.context.annotation.Import; import org.springframework.test.annotation.DirtiesContext; import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; @@ -44,6 +42,8 @@ import com.netflix.loadbalancer.ZoneAvoidanceRule; import com.netflix.loadbalancer.ZoneAwareLoadBalancer; +import static org.junit.Assert.assertEquals; + /** * @author Dave Syer */ @@ -83,14 +83,14 @@ public void serverListFilterOverride() throws Exception { @Configuration @RibbonClient("foo") - @Import({ PropertyPlaceholderAutoConfiguration.class, + @ImportAutoConfiguration({ PropertyPlaceholderAutoConfiguration.class, ArchaiusAutoConfiguration.class, RibbonAutoConfiguration.class }) protected static class PlainConfiguration { } @Configuration @RibbonClient(name = "foo", configuration = FooConfiguration.class) - @Import({ PropertyPlaceholderAutoConfiguration.class, + @ImportAutoConfiguration({ PropertyPlaceholderAutoConfiguration.class, ArchaiusAutoConfiguration.class, RibbonAutoConfiguration.class, RibbonEurekaAutoConfiguration.class }) protected static class TestConfiguration { diff --git a/spring-cloud-netflix-eureka-client/src/test/java/org/springframework/cloud/netflix/ribbon/eureka/RibbonEurekaAutoConfigurationTests.java b/spring-cloud-netflix-eureka-client/src/test/java/org/springframework/cloud/netflix/ribbon/eureka/RibbonEurekaAutoConfigurationTests.java new file mode 100644 index 0000000000..32929d0070 --- /dev/null +++ b/spring-cloud-netflix-eureka-client/src/test/java/org/springframework/cloud/netflix/ribbon/eureka/RibbonEurekaAutoConfigurationTests.java @@ -0,0 +1,99 @@ +/* + * Copyright 2013-2016 the original author or authors. + * + * 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://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 org.springframework.cloud.netflix.ribbon.eureka; + +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.CommandLineRunner; +import org.springframework.boot.SpringBootConfiguration; +import org.springframework.boot.autoconfigure.EnableAutoConfiguration; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.cloud.client.ServiceInstance; +import org.springframework.cloud.client.discovery.EnableDiscoveryClient; +import org.springframework.cloud.client.loadbalancer.LoadBalancerClient; +import org.springframework.context.annotation.Bean; +import org.springframework.test.context.junit4.SpringRunner; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.springframework.boot.test.context.SpringBootTest.WebEnvironment.RANDOM_PORT; + +/** + * @author Spencer Gibb + */ +@RunWith(SpringRunner.class) +@SpringBootTest(classes = RibbonEurekaAutoConfigurationTests.EurekaClientDisabledApp.class, + properties = { "eureka.client.enabled=false", "spring.application.name=eurekadisabledtest" }, + webEnvironment = RANDOM_PORT) +public class RibbonEurekaAutoConfigurationTests { + + @Autowired + TestLoadbalancerClient testLoadbalancerClient; + + @Test + public void contextLoads() { + assertThat(testLoadbalancerClient.instanceFound).isFalse(); + } + + @SpringBootConfiguration + @EnableAutoConfiguration + @EnableDiscoveryClient + public static class EurekaClientDisabledApp { + + @Bean + public TestLoadbalancerClient testLoadbalanceClient(LoadBalancerClient loadBalancerClient) { + return new TestLoadbalancerClient(loadBalancerClient); + } + + @Bean + public CommandLineRunner commandLineRunner(final TestLoadbalancerClient testLoadbalancerClient) { + return new CommandLineRunner() { + @Override + public void run(String... args) throws Exception { + testLoadbalancerClient.doStuff(); + } + }; + } + } + + private static class TestLoadbalancerClient { + + Log log = LogFactory.getLog(this.getClass()); + + private LoadBalancerClient loadBalancerClient; + private boolean instanceFound = false; + + public TestLoadbalancerClient(LoadBalancerClient loadBalancerClient) { + this.loadBalancerClient = loadBalancerClient; + } + + public void doStuff() { + ServiceInstance serviceInstance = loadBalancerClient.choose("http://host/doStuff"); + if (serviceInstance != null) { + log.info("There is a service instance, because Eureka discovery is enabled and the service is registered"); + instanceFound = true; + } + else { + log.warn("No instance found, because Eureka is disabled or there is no service matching."); + } + } + } + +} diff --git a/spring-cloud-netflix-eureka-server/pom.xml b/spring-cloud-netflix-eureka-server/pom.xml index b5b84f6e64..77faf34b98 100644 --- a/spring-cloud-netflix-eureka-server/pom.xml +++ b/spring-cloud-netflix-eureka-server/pom.xml @@ -37,6 +37,11 @@ org.springframework.cloud spring-cloud-commons + + org.springframework.cloud + spring-cloud-context + true + org.springframework.cloud spring-cloud-netflix-core diff --git a/spring-cloud-netflix-turbine/pom.xml b/spring-cloud-netflix-turbine/pom.xml index 29de183acf..d82c144b6d 100644 --- a/spring-cloud-netflix-turbine/pom.xml +++ b/spring-cloud-netflix-turbine/pom.xml @@ -61,6 +61,11 @@ org.springframework.cloud spring-cloud-commons + + org.springframework.cloud + spring-cloud-context + true + org.springframework.cloud spring-cloud-netflix-core