/*
* Copyright 2018-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.
* 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.vault.annotation;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;
import org.mockito.Mockito;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
import org.springframework.vault.core.VaultTemplate;
import org.springframework.vault.core.lease.SecretLeaseContainer;
import org.springframework.vault.core.lease.domain.RequestedSecret;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoMoreInteractions;
import static org.springframework.vault.annotation.VaultPropertySource.Renewal.RENEW;
/**
* Unit test for {@link VaultPropertySource}.
*
* @author Mark Paluch
*/
class VaultPropertySourceUnitTests {
@Configuration
static class Config {
@Bean
VaultTemplate vaultTemplate() {
return Mockito.mock(VaultTemplate.class);
}
@Bean
SecretLeaseContainer secretLeaseContainer() {
return Mockito.mock(SecretLeaseContainer.class);
}
}
@Configuration
@Profile("demo")
@VaultPropertySource("foo")
static class DemoProfile {
}
@Configuration
@Profile("dev")
@VaultPropertySource("bar")
static class DevProfile {
}
@Configuration
@VaultPropertySource("foo/${my_property}")
static class NonRenewableConfig {
}
@Configuration
@VaultPropertySource(value = "foo/${my_property}", renewal = RENEW)
static class RenewableConfig {
}
@AfterEach
void tearDown() {
System.clearProperty("my_property");
}
@Test
void shouldNotEnablePropertySource() {
AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
ctx.register(Config.class);
ctx.register(DemoProfile.class);
ctx.register(DevProfile.class);
ctx.refresh();
VaultTemplate templateMock = ctx.getBean(VaultTemplate.class);
verify(templateMock).afterPropertiesSet();
verifyNoMoreInteractions(templateMock);
}
@Test
void shouldEnablePropertySourceByProfile() {
AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
ctx.getEnvironment().addActiveProfile("demo");
ctx.register(Config.class);
ctx.register(DemoProfile.class);
ctx.register(DevProfile.class);
ctx.refresh();
VaultTemplate templateMock = ctx.getBean(VaultTemplate.class);
verify(templateMock).afterPropertiesSet();
verify(templateMock).read("foo");
verify(templateMock, never()).read("bar");
}
@Test
void shouldResolvePlaceholderForNonRenewablePropertySource() {
System.setProperty("my_property", "non-renewable");
AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
ctx.register(Config.class);
ctx.register(NonRenewableConfig.class);
ctx.refresh();
VaultTemplate templateMock = ctx.getBean(VaultTemplate.class);
verify(templateMock).afterPropertiesSet();
verify(templateMock).read("sys/internal/ui/mounts/foo/non-renewable");
verify(templateMock).read("foo/non-renewable");
verifyNoMoreInteractions(templateMock);
}
@Test
void shouldResolvePlaceholderForRenewablePropertySource() throws Exception {
System.setProperty("my_property", "renewable");
AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
ctx.register(Config.class);
ctx.register(RenewableConfig.class);
ctx.refresh();
SecretLeaseContainer leaseContainerMock = ctx.getBean(SecretLeaseContainer.class);
verify(leaseContainerMock).afterPropertiesSet();
verify(leaseContainerMock).addLeaseListener(any());
verify(leaseContainerMock).addErrorListener(any());
verify(leaseContainerMock).addRequestedSecret(RequestedSecret.renewable("foo/renewable"));
verifyNoMoreInteractions(leaseContainerMock);
}
}
