From e330a6cbae9957e6493ddc052bc91ef458b763ae Mon Sep 17 00:00:00 2001 From: Mark Paluch Date: Wed, 10 Mar 2021 14:18:44 +0100 Subject: [PATCH] Remove ConditionalOnBean for VaultHealthIndicatorAutoConfiguration. VaultHealthIndicatorAutoConfiguration is now activated regardless of the presence of VaultBootstrapConfiguration. We also ensure that VaultHealthIndicatorAutoConfiguration gets configured after VaultAutoConfiguration and VaultReactiveAutoConfiguration to correctly detect VaultOperations and ReactiveVaultOperations beans. Closes gh-574. --- ...VaultHealthIndicatorAutoConfiguration.java | 4 +- ...HealthIndicatorAutoConfigurationTests.java | 83 +++++++++++++++++++ 2 files changed, 85 insertions(+), 2 deletions(-) create mode 100644 spring-cloud-vault-config/src/test/java/org/springframework/cloud/vault/config/VaultHealthIndicatorAutoConfigurationTests.java diff --git a/spring-cloud-vault-config/src/main/java/org/springframework/cloud/vault/config/VaultHealthIndicatorAutoConfiguration.java b/spring-cloud-vault-config/src/main/java/org/springframework/cloud/vault/config/VaultHealthIndicatorAutoConfiguration.java index 985a4384..fdf4c278 100644 --- a/spring-cloud-vault-config/src/main/java/org/springframework/cloud/vault/config/VaultHealthIndicatorAutoConfiguration.java +++ b/spring-cloud-vault-config/src/main/java/org/springframework/cloud/vault/config/VaultHealthIndicatorAutoConfiguration.java @@ -19,8 +19,8 @@ package org.springframework.cloud.vault.config; import org.springframework.boot.actuate.autoconfigure.health.ConditionalOnEnabledHealthIndicator; import org.springframework.boot.actuate.autoconfigure.health.HealthContributorAutoConfiguration; import org.springframework.boot.actuate.health.HealthIndicator; +import org.springframework.boot.autoconfigure.AutoConfigureAfter; import org.springframework.boot.autoconfigure.AutoConfigureBefore; -import org.springframework.boot.autoconfigure.condition.ConditionalOnBean; import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; import org.springframework.context.annotation.Configuration; @@ -35,10 +35,10 @@ import org.springframework.context.annotation.Import; */ @Configuration(proxyBeanMethods = false) @ConditionalOnEnabledHealthIndicator("vault") -@ConditionalOnBean(VaultBootstrapConfiguration.class) @ConditionalOnClass(HealthIndicator.class) @ConditionalOnProperty(name = "spring.cloud.vault.enabled", matchIfMissing = true) @AutoConfigureBefore(HealthContributorAutoConfiguration.class) +@AutoConfigureAfter({ VaultAutoConfiguration.class, VaultReactiveAutoConfiguration.class }) @Import({ VaultHealthIndicatorConfiguration.class, VaultReactiveHealthIndicatorConfiguration.class }) public class VaultHealthIndicatorAutoConfiguration { diff --git a/spring-cloud-vault-config/src/test/java/org/springframework/cloud/vault/config/VaultHealthIndicatorAutoConfigurationTests.java b/spring-cloud-vault-config/src/test/java/org/springframework/cloud/vault/config/VaultHealthIndicatorAutoConfigurationTests.java new file mode 100644 index 00000000..ff7aba32 --- /dev/null +++ b/spring-cloud-vault-config/src/test/java/org/springframework/cloud/vault/config/VaultHealthIndicatorAutoConfigurationTests.java @@ -0,0 +1,83 @@ +/* + * Copyright 2020-2021 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.cloud.vault.config; + +import org.junit.jupiter.api.Test; + +import org.springframework.boot.autoconfigure.AutoConfigurations; +import org.springframework.boot.test.context.runner.ApplicationContextRunner; +import org.springframework.context.annotation.Bean; +import org.springframework.vault.core.ReactiveVaultOperations; +import org.springframework.vault.core.VaultOperations; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.mockito.Mockito.mock; + +/** + * Unit tests for {@link VaultHealthIndicatorAutoConfiguration}. + * + * @author Mark Paluch + */ +class VaultHealthIndicatorAutoConfigurationTests { + + private final ApplicationContextRunner contextRunner = new ApplicationContextRunner() + .withConfiguration(AutoConfigurations.of(VaultHealthIndicatorAutoConfiguration.class)); + + @Test + void shouldNotConfigureHealthIndicatorWithoutVaultOperations() { + + this.contextRunner.run(context -> { + assertThat(context).doesNotHaveBean("vaultHealthIndicator").doesNotHaveBean("vaultReactiveHealthIndicator"); + }); + } + + @Test + void shouldConfigureHealthIndicator() { + + this.contextRunner.withUserConfiguration(ImperativeConfiguration.class).run(context -> { + assertThat(context).hasBean("vaultHealthIndicator"); + }); + } + + @Test + void shouldConfigureReactiveHealthIndicator() { + + this.contextRunner.withUserConfiguration(ReactiveConfiguration.class).run(context -> { + assertThat(context).hasBean("vaultReactiveHealthIndicator"); + }); + + } + + static class ImperativeConfiguration { + + @Bean + VaultOperations vaultOperations() { + return mock(VaultOperations.class); + } + + } + + static class ReactiveConfiguration { + + @Bean + ReactiveVaultOperations vaultOperations() { + return mock(ReactiveVaultOperations.class); + } + + } + +}