From 002a7c6e876c4aa46366c509aa59c813dfea5ed2 Mon Sep 17 00:00:00 2001 From: Ali Gurbuz Date: Mon, 30 Mar 2020 17:20:20 +0300 Subject: [PATCH 1/2] Disable Hazelcast auto-configuration when Jet is present See gh-20729 --- .../hazelcast/HazelcastAutoConfiguration.java | 2 + .../HazelcastJetConfigMissingCondition.java | 44 +++++++++++++++++++ .../HazelcastAutoConfigurationTests.java | 35 +++++++++++++++ 3 files changed, 81 insertions(+) create mode 100644 spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/hazelcast/HazelcastJetConfigMissingCondition.java diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/hazelcast/HazelcastAutoConfiguration.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/hazelcast/HazelcastAutoConfiguration.java index 353a39fa9cb..280c093ee88 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/hazelcast/HazelcastAutoConfiguration.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/hazelcast/HazelcastAutoConfiguration.java @@ -21,6 +21,7 @@ import com.hazelcast.core.HazelcastInstance; import org.springframework.boot.autoconfigure.EnableAutoConfiguration; import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.context.annotation.Conditional; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Import; @@ -35,6 +36,7 @@ import org.springframework.context.annotation.Import; * @see HazelcastConfigResourceCondition */ @Configuration(proxyBeanMethods = false) +@Conditional(HazelcastJetConfigMissingCondition.class) @ConditionalOnClass(HazelcastInstance.class) @EnableConfigurationProperties(HazelcastProperties.class) @Import({ HazelcastClientConfiguration.class, HazelcastServerConfiguration.class }) diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/hazelcast/HazelcastJetConfigMissingCondition.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/hazelcast/HazelcastJetConfigMissingCondition.java new file mode 100644 index 00000000000..854f67eea2b --- /dev/null +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/hazelcast/HazelcastJetConfigMissingCondition.java @@ -0,0 +1,44 @@ +/* + * Copyright 2012-2019 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 + * + * 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 org.springframework.boot.autoconfigure.hazelcast; + +import org.springframework.boot.autoconfigure.condition.ConditionOutcome; +import org.springframework.boot.autoconfigure.condition.SpringBootCondition; +import org.springframework.context.annotation.ConditionContext; +import org.springframework.core.io.Resource; +import org.springframework.core.type.AnnotatedTypeMetadata; + +/** + * {@link SpringBootCondition} that checks if the Hazelcast Jet is missing on the + * classpath by looking up the default configuration file. + * + * @author Ali Gurbuz + * @since 2.3.0 + */ +public class HazelcastJetConfigMissingCondition extends SpringBootCondition { + + private static final String HAZELCAST_JET_CONFIG_FILE = "classpath:/hazelcast-jet-default.yaml"; + + public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata) { + Resource resource = context.getResourceLoader().getResource(HAZELCAST_JET_CONFIG_FILE); + if (resource.exists()) { + return ConditionOutcome.noMatch("Found Hazelcast Jet default config file on the classpath"); + } + return ConditionOutcome.match("Hazelcast Jet default config file is missing on the classpath"); + } + +} diff --git a/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/hazelcast/HazelcastAutoConfigurationTests.java b/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/hazelcast/HazelcastAutoConfigurationTests.java index f389c683a7c..9a4c47b926d 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/hazelcast/HazelcastAutoConfigurationTests.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/hazelcast/HazelcastAutoConfigurationTests.java @@ -16,8 +16,12 @@ package org.springframework.boot.autoconfigure.hazelcast; +import java.net.MalformedURLException; +import java.net.URL; + import com.hazelcast.config.Config; import com.hazelcast.core.HazelcastInstance; +import org.jetbrains.annotations.Nullable; import org.junit.jupiter.api.Test; import org.springframework.boot.autoconfigure.AutoConfigurations; @@ -47,4 +51,35 @@ class HazelcastAutoConfigurationTests { }); } + @Test + void testHazelcastInstanceNotCreatedWhenJetIsPresent() { + this.contextRunner.withClassLoader(new JetConfigClassLoader()) + .run((context) -> assertThat(context).doesNotHaveBean(HazelcastInstance.class)); + } + + /** + * A specific class loader which emulates that default Hazelcast Jet configuration + * file exists on the classpath. + */ + static class JetConfigClassLoader extends ClassLoader { + + JetConfigClassLoader() { + super(JetConfigClassLoader.class.getClassLoader()); + } + + @Nullable + @Override + public URL getResource(String name) { + if (name.equals("hazelcast-jet-default.yaml")) { + try { + return new URL("file://hazelcast-jet-default.yaml"); + } + catch (MalformedURLException ignored) { + } + } + return super.getResource(name); + } + + } + } From 617786e06fba82e3373b737119137523770e97d4 Mon Sep 17 00:00:00 2001 From: Stephane Nicoll Date: Wed, 1 Apr 2020 15:30:03 +0200 Subject: [PATCH 2/2] Polish "Disable Hazelcast auto-configuration when Jet is present" See gh-20729 --- .../hazelcast/HazelcastAutoConfiguration.java | 30 +++++++++++-- .../HazelcastJetConfigMissingCondition.java | 44 ------------------- .../HazelcastAutoConfigurationTests.java | 35 +++++++++------ 3 files changed, 48 insertions(+), 61 deletions(-) delete mode 100644 spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/hazelcast/HazelcastJetConfigMissingCondition.java diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/hazelcast/HazelcastAutoConfiguration.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/hazelcast/HazelcastAutoConfiguration.java index 280c093ee88..8f6f5148caf 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/hazelcast/HazelcastAutoConfiguration.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/hazelcast/HazelcastAutoConfiguration.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2019 the original author or authors. + * Copyright 2012-2020 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. @@ -19,14 +19,22 @@ package org.springframework.boot.autoconfigure.hazelcast; import com.hazelcast.core.HazelcastInstance; import org.springframework.boot.autoconfigure.EnableAutoConfiguration; +import org.springframework.boot.autoconfigure.condition.ConditionMessage; +import org.springframework.boot.autoconfigure.condition.ConditionMessage.Builder; +import org.springframework.boot.autoconfigure.condition.ConditionOutcome; import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; +import org.springframework.boot.autoconfigure.condition.SpringBootCondition; +import org.springframework.boot.autoconfigure.hazelcast.HazelcastAutoConfiguration.HazelcastDataGridCondition; import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.context.annotation.ConditionContext; import org.springframework.context.annotation.Conditional; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Import; +import org.springframework.core.io.Resource; +import org.springframework.core.type.AnnotatedTypeMetadata; /** - * {@link EnableAutoConfiguration Auto-configuration} for Hazelcast. Creates a + * {@link EnableAutoConfiguration Auto-configuration} for Hazelcast IMDG. Creates a * {@link HazelcastInstance} based on explicit configuration or when a default * configuration file is found in the environment. * @@ -36,10 +44,26 @@ import org.springframework.context.annotation.Import; * @see HazelcastConfigResourceCondition */ @Configuration(proxyBeanMethods = false) -@Conditional(HazelcastJetConfigMissingCondition.class) +@Conditional(HazelcastDataGridCondition.class) @ConditionalOnClass(HazelcastInstance.class) @EnableConfigurationProperties(HazelcastProperties.class) @Import({ HazelcastClientConfiguration.class, HazelcastServerConfiguration.class }) public class HazelcastAutoConfiguration { + static class HazelcastDataGridCondition extends SpringBootCondition { + + private static final String HAZELCAST_JET_CONFIG_FILE = "classpath:/hazelcast-jet-default.yaml"; + + @Override + public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata) { + Builder message = ConditionMessage.forCondition(HazelcastDataGridCondition.class.getSimpleName()); + Resource resource = context.getResourceLoader().getResource(HAZELCAST_JET_CONFIG_FILE); + if (resource.exists()) { + return ConditionOutcome.noMatch(message.because("Found Hazelcast Jet on the classpath")); + } + return ConditionOutcome.match(message.because("Hazelcast Jet not found on the classpath")); + } + + } + } diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/hazelcast/HazelcastJetConfigMissingCondition.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/hazelcast/HazelcastJetConfigMissingCondition.java deleted file mode 100644 index 854f67eea2b..00000000000 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/hazelcast/HazelcastJetConfigMissingCondition.java +++ /dev/null @@ -1,44 +0,0 @@ -/* - * Copyright 2012-2019 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 - * - * 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 org.springframework.boot.autoconfigure.hazelcast; - -import org.springframework.boot.autoconfigure.condition.ConditionOutcome; -import org.springframework.boot.autoconfigure.condition.SpringBootCondition; -import org.springframework.context.annotation.ConditionContext; -import org.springframework.core.io.Resource; -import org.springframework.core.type.AnnotatedTypeMetadata; - -/** - * {@link SpringBootCondition} that checks if the Hazelcast Jet is missing on the - * classpath by looking up the default configuration file. - * - * @author Ali Gurbuz - * @since 2.3.0 - */ -public class HazelcastJetConfigMissingCondition extends SpringBootCondition { - - private static final String HAZELCAST_JET_CONFIG_FILE = "classpath:/hazelcast-jet-default.yaml"; - - public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata) { - Resource resource = context.getResourceLoader().getResource(HAZELCAST_JET_CONFIG_FILE); - if (resource.exists()) { - return ConditionOutcome.noMatch("Found Hazelcast Jet default config file on the classpath"); - } - return ConditionOutcome.match("Hazelcast Jet default config file is missing on the classpath"); - } - -} diff --git a/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/hazelcast/HazelcastAutoConfigurationTests.java b/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/hazelcast/HazelcastAutoConfigurationTests.java index 9a4c47b926d..9fcf6f62cdd 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/hazelcast/HazelcastAutoConfigurationTests.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/hazelcast/HazelcastAutoConfigurationTests.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2019 the original author or authors. + * Copyright 2012-2020 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. @@ -16,17 +16,18 @@ package org.springframework.boot.autoconfigure.hazelcast; -import java.net.MalformedURLException; +import java.io.IOException; import java.net.URL; +import java.net.URLClassLoader; import com.hazelcast.config.Config; import com.hazelcast.core.HazelcastInstance; -import org.jetbrains.annotations.Nullable; import org.junit.jupiter.api.Test; import org.springframework.boot.autoconfigure.AutoConfigurations; import org.springframework.boot.test.context.runner.ApplicationContextRunner; import org.springframework.core.io.ClassPathResource; +import org.springframework.core.io.Resource; import static org.assertj.core.api.Assertions.assertThat; @@ -52,34 +53,40 @@ class HazelcastAutoConfigurationTests { } @Test - void testHazelcastInstanceNotCreatedWhenJetIsPresent() { + void hazelcastInstanceNotCreatedWhenJetIsPresent() { this.contextRunner.withClassLoader(new JetConfigClassLoader()) .run((context) -> assertThat(context).doesNotHaveBean(HazelcastInstance.class)); } /** - * A specific class loader which emulates that default Hazelcast Jet configuration - * file exists on the classpath. + * A test {link {@link URLClassLoader} that emulates the default Hazelcast Jet + * configuration file exists on the classpath. */ - static class JetConfigClassLoader extends ClassLoader { + static class JetConfigClassLoader extends URLClassLoader { + + private static final Resource FALLBACK = new ClassPathResource("hazelcast.yaml"); JetConfigClassLoader() { - super(JetConfigClassLoader.class.getClassLoader()); + super(new URL[0], JetConfigClassLoader.class.getClassLoader()); } - @Nullable @Override public URL getResource(String name) { if (name.equals("hazelcast-jet-default.yaml")) { - try { - return new URL("file://hazelcast-jet-default.yaml"); - } - catch (MalformedURLException ignored) { - } + return getEmulatedJestConfigUrl(); } return super.getResource(name); } + private URL getEmulatedJestConfigUrl() { + try { + return FALLBACK.getURL(); + } + catch (IOException ex) { + throw new IllegalArgumentException(ex); + } + } + } }