root
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Actions 15 Packages Projects Releases Wiki Activity

Apply Wavefront token type to auto-configured WavefrontSender 

Closes gh-37165
This commit is contained in:
Moritz Halbritter 2023-10-11 09:12:26 +02:00
parent 4ab104f5af
commit 1bd14652d8
5 changed files with 119 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/wavefront/WavefrontPropertiesConfigAdapter.java
View File

@ -22,7 +22,6 @@ import io.micrometer.wavefront.WavefrontConfig;
import org.springframework.boot.actuate.autoconfigure.metrics.export.properties.PushRegistryPropertiesConfigAdapter;
import org.springframework.boot.actuate.autoconfigure.wavefront.WavefrontProperties;
import org.springframework.boot.actuate.autoconfigure.wavefront.WavefrontProperties.Metrics.Export;
import org.springframework.boot.actuate.autoconfigure.wavefront.WavefrontProperties.TokenType;
/**
* Adapter to convert {@link WavefrontProperties} to a {@link WavefrontConfig}.
@ -88,16 +87,7 @@ public class WavefrontPropertiesConfigAdapter
@Override
public Type apiTokenType() {
TokenType apiTokenType = this.properties.getApiTokenType();
if (apiTokenType == null) {
return WavefrontConfig.super.apiTokenType();
}
return switch (apiTokenType) {
case NO_TOKEN -> Type.NO_TOKEN;
case WAVEFRONT_API_TOKEN -> Type.WAVEFRONT_API_TOKEN;
case CSP_API_TOKEN -> Type.CSP_API_TOKEN;
case CSP_CLIENT_CREDENTIALS -> Type.CSP_CLIENT_CREDENTIALS;
};
return this.properties.getWavefrontApiTokenType();
}
}

21
spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/wavefront/WavefrontProperties.java
View File

@ -25,6 +25,8 @@ import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import com.wavefront.sdk.common.clients.service.token.TokenService.Type;
import org.springframework.boot.actuate.autoconfigure.metrics.export.properties.PushRegistryProperties;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.source.InvalidConfigurationPropertyValueException;
@ -137,7 +139,7 @@ public class WavefrontProperties {
* @return the API token
*/
public String getApiTokenOrThrow() {
if (this.apiToken == null && !usesProxy()) {
if (this.apiTokenType != TokenType.NO_TOKEN && this.apiToken == null && !usesProxy()) {
throw new InvalidConfigurationPropertyValueException("management.wavefront.api-token", null,
"This property is mandatory whenever publishing directly to the Wavefront API");
}
@ -180,6 +182,23 @@ public class WavefrontProperties {
this.apiTokenType = apiTokenType;
}
/**
* Returns the {@link Type Wavefront token type}.
* @return the Wavefront token type
* @since 3.2.0
*/
public Type getWavefrontApiTokenType() {
if (this.apiTokenType == null) {
return usesProxy() ? Type.NO_TOKEN : Type.WAVEFRONT_API_TOKEN;
}
return switch (this.apiTokenType) {
case NO_TOKEN -> Type.NO_TOKEN;
case WAVEFRONT_API_TOKEN -> Type.WAVEFRONT_API_TOKEN;
case CSP_API_TOKEN -> Type.CSP_API_TOKEN;
case CSP_CLIENT_CREDENTIALS -> Type.CSP_CLIENT_CREDENTIALS;
};
}
public static class Application {
/**

3
spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/wavefront/WavefrontSenderConfiguration.java
View File

@ -52,7 +52,8 @@ public class WavefrontSenderConfiguration {
@ConditionalOnMissingBean
@Conditional(WavefrontTracingOrMetricsCondition.class)
public WavefrontSender wavefrontSender(WavefrontProperties properties) {
Builder builder = new Builder(properties.getEffectiveUri().toString(), properties.getApiTokenOrThrow());
Builder builder = new Builder(properties.getEffectiveUri().toString(), properties.getWavefrontApiTokenType(),
properties.getApiTokenOrThrow());
PropertyMapper map = PropertyMapper.get().alwaysApplyingWhenNonNull();
WavefrontProperties.Sender sender = properties.getSender();
map.from(sender.getMaxQueueSize()).to(builder::maxQueueSize);

57
spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/wavefront/WavefrontPropertiesTests.java
View File

@ -18,8 +18,12 @@ package org.springframework.boot.actuate.autoconfigure.wavefront;
import java.net.URI;
import com.wavefront.sdk.common.clients.service.token.TokenService.Type;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.EnumSource;
import org.springframework.boot.actuate.autoconfigure.wavefront.WavefrontProperties.TokenType;
import org.springframework.boot.context.properties.source.InvalidConfigurationPropertyValueException;
import static org.assertj.core.api.Assertions.assertThat;
@ -34,21 +38,54 @@ class WavefrontPropertiesTests {
@Test
void apiTokenIsOptionalWhenUsingProxy() {
WavefrontProperties sut = new WavefrontProperties();
sut.setUri(URI.create("proxy://localhost:2878"));
sut.setApiToken(null);
assertThat(sut.getApiTokenOrThrow()).isNull();
assertThat(sut.getEffectiveUri()).isEqualTo(URI.create("http://localhost:2878"));
WavefrontProperties properties = new WavefrontProperties();
properties.setUri(URI.create("proxy://localhost:2878"));
properties.setApiToken(null);
assertThat(properties.getApiTokenOrThrow()).isNull();
assertThat(properties.getEffectiveUri()).isEqualTo(URI.create("http://localhost:2878"));
}
@Test
void apiTokenIsMandatoryWhenNotUsingProxy() {
WavefrontProperties sut = new WavefrontProperties();
sut.setUri(URI.create("http://localhost:2878"));
sut.setApiToken(null);
assertThat(sut.getEffectiveUri()).isEqualTo(URI.create("http://localhost:2878"));
assertThatThrownBy(sut::getApiTokenOrThrow).isInstanceOf(InvalidConfigurationPropertyValueException.class)
WavefrontProperties properties = new WavefrontProperties();
properties.setUri(URI.create("http://localhost:2878"));
properties.setApiToken(null);
assertThat(properties.getEffectiveUri()).isEqualTo(URI.create("http://localhost:2878"));
assertThatThrownBy(properties::getApiTokenOrThrow)
.isInstanceOf(InvalidConfigurationPropertyValueException.class)
.hasMessageContaining("management.wavefront.api-token");
}
@Test
void shouldNotFailIfTokenTypeIsSetToNoToken() {
WavefrontProperties properties = new WavefrontProperties();
properties.setUri(URI.create("http://localhost:2878"));
properties.setApiTokenType(TokenType.NO_TOKEN);
properties.setApiToken(null);
assertThat(properties.getApiTokenOrThrow()).isNull();
}
@Test
void wavefrontApiTokenTypeWhenUsingProxy() {
WavefrontProperties properties = new WavefrontProperties();
properties.setUri(URI.create("proxy://localhost:2878"));
assertThat(properties.getWavefrontApiTokenType()).isEqualTo(Type.NO_TOKEN);
}
@Test
void wavefrontApiTokenTypeWhenNotUsingProxy() {
WavefrontProperties properties = new WavefrontProperties();
properties.setUri(URI.create("http://localhost:2878"));
assertThat(properties.getWavefrontApiTokenType()).isEqualTo(Type.WAVEFRONT_API_TOKEN);
}
@ParameterizedTest
@EnumSource(TokenType.class)
void wavefrontApiTokenMapping(TokenType from) {
WavefrontProperties properties = new WavefrontProperties();
properties.setApiTokenType(from);
Type expected = Type.valueOf(from.name());
assertThat(properties.getWavefrontApiTokenType()).isEqualTo(expected);
}
}

49
spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/wavefront/WavefrontSenderConfigurationTests.java
View File

@ -19,6 +19,9 @@ package org.springframework.boot.actuate.autoconfigure.wavefront;
import java.util.concurrent.LinkedBlockingQueue;
import com.wavefront.sdk.common.WavefrontSender;
import com.wavefront.sdk.common.clients.service.token.CSPTokenService;
import com.wavefront.sdk.common.clients.service.token.NoopProxyTokenService;
import com.wavefront.sdk.common.clients.service.token.WavefrontTokenService;
import org.assertj.core.api.InstanceOfAssertFactories;
import org.junit.jupiter.api.Test;
@ -27,6 +30,7 @@ import org.springframework.boot.test.context.FilteredClassLoader;
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.test.util.ReflectionTestUtils;
import static org.assertj.core.api.Assertions.as;
import static org.assertj.core.api.Assertions.assertThat;
@ -118,6 +122,51 @@ class WavefrontSenderConfigurationTests {
.run((context) -> assertThat(context).hasSingleBean(WavefrontSender.class).hasBean("customSender"));
}
@Test
void shouldApplyTokenTypeWavefrontApiToken() {
this.contextRunner
.withPropertyValues("management.wavefront.api-token-type=WAVEFRONT_API_TOKEN",
"management.wavefront.api-token=abcde")
.run((context) -> {
WavefrontSender sender = context.getBean(WavefrontSender.class);
Object tokenService = ReflectionTestUtils.getField(sender, "tokenService");
assertThat(tokenService).isInstanceOf(WavefrontTokenService.class);
});
}
@Test
void shouldApplyTokenTypeCspApiToken() {
this.contextRunner
.withPropertyValues("management.wavefront.api-token-type=CSP_API_TOKEN",
"management.wavefront.api-token=abcde")
.run((context) -> {
WavefrontSender sender = context.getBean(WavefrontSender.class);
Object tokenService = ReflectionTestUtils.getField(sender, "tokenService");
assertThat(tokenService).isInstanceOf(CSPTokenService.class);
});
}
@Test
void shouldApplyTokenTypeCspClientCredentials() {
this.contextRunner
.withPropertyValues("management.wavefront.api-token-type=CSP_CLIENT_CREDENTIALS",
"management.wavefront.api-token=clientid=cid,clientsecret=csec")
.run((context) -> {
WavefrontSender sender = context.getBean(WavefrontSender.class);
Object tokenService = ReflectionTestUtils.getField(sender, "tokenService");
assertThat(tokenService).isInstanceOf(CSPTokenService.class);
});
}
@Test
void shouldApplyTokenTypeNoToken() {
this.contextRunner.withPropertyValues("management.wavefront.api-token-type=NO_TOKEN").run((context) -> {
WavefrontSender sender = context.getBean(WavefrontSender.class);
Object tokenService = ReflectionTestUtils.getField(sender, "tokenService");
assertThat(tokenService).isInstanceOf(NoopProxyTokenService.class);
});
}
@Configuration(proxyBeanMethods = false)
static class CustomSenderConfiguration {