Extra config conditions and tests for servlet config

Author: llinder

datadog-autoconfiguration/build.gradle

@@ -2,9 +2,9 @@
 dependencies {
 	compile "org.springframework.boot:spring-boot-autoconfigure:${springVersion}"
 	compile "org.projectlombok:lombok:1.16.10"
-	compile "org.coursera:dropwizard-metrics-datadog:1.1.6"
-	compileOnly "io.dropwizard.metrics:metrics-jvm:3.1.2"
-	compileOnly "io.dropwizard.metrics:metrics-logback:3.1.2"
+	compile "org.coursera:dropwizard-metrics-datadog:1.1.10"
+	compileOnly "io.dropwizard.metrics:metrics-jvm:${dropwizardVersion}"
+	compileOnly "io.dropwizard.metrics:metrics-logback:${dropwizardVersion}"
 
 	testCompile "org.springframework.boot:spring-boot-starter-test:${springVersion}"
 	testCompile "org.springframework.boot:spring-boot-starter-web:${springVersion}"

datadog-autoconfiguration/src/main/java/smartthings/springboot/metrics/autoconfiguration/dropwizard/DropwizardJvmAutoConfiguration.java

@@ -5,13 +5,17 @@
 import com.codahale.metrics.jvm.MemoryUsageGaugeSet;
 import javax.annotation.PostConstruct;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 
 /**
  * Automatically adds {@link MemoryUsageGaugeSet} and {@link GarbageCollectorMetricSet} to
  * the Datadog {@link MetricRegistry} when these classes are present on the classpath.
  */
-@ConditionalOnClass(value = {MemoryUsageGaugeSet.class, GarbageCollectorMetricSet.class})
+@ConditionalOnClass(value = {
+		MemoryUsageGaugeSet.class, GarbageCollectorMetricSet.class
+})
+@ConditionalOnBean(MetricRegistry.class)
 public class DropwizardJvmAutoConfiguration {
 
 	@Autowired

gradle.properties

@@ -1,4 +1,4 @@
 groovyVersion=2.4.1
 slf4jVersion=1.7.10
 springVersion=1.4.1.RELEASE
-dropwizardVersion=3.1.2
+dropwizardVersion=3.2.2

servlet-filter-autoconfiguration/build.gradle

@@ -13,6 +13,7 @@ dependencies {
 	testCompile "org.mockito:mockito-core:1.10.19"
 	testCompile "org.hamcrest:hamcrest-core:1.3"
 	testCompile "org.assertj:assertj-core:3.6.1"
+	testCompile project(":datadog-autoconfiguration")
 	testRuntime 'ch.qos.logback:logback-classic:1.1.2'
 	testRuntime "org.slf4j:log4j-over-slf4j:${slf4jVersion}"
 	testRuntime "org.slf4j:jcl-over-slf4j:${slf4jVersion}"

servlet-filter-autoconfiguration/src/main/java/smartthings/springboot/metrics/autoconfiguration/servlet/ServletFilterAutoConfiguration.java

@@ -4,17 +4,27 @@
 import com.codahale.metrics.servlet.InstrumentedFilter;
 import com.codahale.metrics.servlet.InstrumentedFilterContextListener;
 import javax.servlet.Filter;
+import org.springframework.boot.autoconfigure.condition.ConditionOutcome;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.boot.autoconfigure.condition.SpringBootCondition;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.boot.web.servlet.FilterRegistrationBean;
 import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.ConditionContext;
+import org.springframework.context.annotation.Conditional;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.core.type.AnnotatedTypeMetadata;
 
 /**
  * Automatically adds a {@link InstrumentedFilter} to the servlet configuration when one is
  * present on the classpath.
  */
 @Configuration
+@EnableConfigurationProperties(value = {ServletFilterProperties.class})
 @ConditionalOnClass(value = {InstrumentedFilter.class, Filter.class})
+@ConditionalOnBean(value = {MetricRegistry.class})
+@Conditional(ServletFilterAutoConfiguration.ServletFilterSetCondition.class)
 public class ServletFilterAutoConfiguration {
 
 	@Bean
@@ -47,4 +57,22 @@ private MetricRegistryContextListener(MetricRegistry metricRegistry) {
 		}
 	}
 
+	static final class ServletFilterSetCondition extends SpringBootCondition {
+		private static final String ENABLED_PROPERTY = "metrics.servlet.enabled";
+
+		@Override public ConditionOutcome getMatchOutcome(ConditionContext context,
+				AnnotatedTypeMetadata a) {
+
+			boolean enabled = isTrue(context.getEnvironment().getProperty(ENABLED_PROPERTY, Boolean.class));
+
+			return enabled ?
+					ConditionOutcome.match() :
+					ConditionOutcome.noMatch(ENABLED_PROPERTY + " is false or not set");
+		}
+
+		private static boolean isTrue(Boolean b) {
+			return b != null && b;
+		}
+	}
+
 }

servlet-filter-autoconfiguration/src/main/java/smartthings/springboot/metrics/autoconfiguration/servlet/ServletFilterProperties.java

@@ -8,7 +8,7 @@
 @ConfigurationProperties(prefix = "metrics.servlet")
 public class ServletFilterProperties {
 
-	private String namePrefix = "instrumented";
+	private String namePrefix = "servlet";
 
 	public String getNamePrefix() {
 		return this.namePrefix;

servlet-filter-autoconfiguration/src/test/java/smartthings/springboot/metrics/autoconfiguration/servlet/ServletFilterIntegrationTest.java

@@ -0,0 +1,43 @@
+package smartthings.springboot.metrics.autoconfiguration.servlet;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.test.context.TestPropertySource;
+import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+import org.springframework.test.context.web.WebAppConfiguration;
+import org.springframework.web.context.ConfigurableWebApplicationContext;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * ServletFilterIntegrationTest.
+ */
+@SpringBootTest(classes = TestServer.class)
+@RunWith(SpringJUnit4ClassRunner.class)
+@WebAppConfiguration
+@TestPropertySource(properties = {
+		"metrics.servlet.enabled=true",
+		"metrics.datadog.enabled=true",
+		"metrics.datadog.expansions=COUNT,MIN,MAX,MEDIAN",
+		"metrics.datadog.includes=counter.one,counter.two,counter.test",
+		"metrics.datadog.transport.type=http",
+		"metrics.datadog.transport.api-key=test"
+})
+@EnableConfigurationProperties(ServletFilterProperties.class)
+public class ServletFilterIntegrationTest {
+
+	@Autowired
+	ConfigurableWebApplicationContext context;
+
+	@Test
+	public void check_propertiesFromConfig() throws Exception {
+
+		ServletFilterProperties properties = context.getBean(ServletFilterProperties.class);
+
+		assertThat(properties.getNamePrefix()).isEqualTo("servlet");
+
+	}
+}

servlet-filter-autoconfiguration/src/test/java/smartthings/springboot/metrics/autoconfiguration/servlet/TestServer.java

@@ -0,0 +1,18 @@
+package smartthings.springboot.metrics.autoconfiguration.servlet;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.builder.SpringApplicationBuilder;
+
+/**
+ * SpringBootApplication used for integration tests.
+ */
+@SpringBootApplication
+public class TestServer {
+
+	public static void main(String[] args) {
+		new SpringApplicationBuilder(TestServer.class)
+				.properties("spring.config.name=test-server")
+				.run(args);
+	}
+
+}

servlet-filter-autoconfiguration/src/test/resources/test-server.yaml

@@ -0,0 +1,13 @@
+metrics:
+  datadog:
+    enabled: true
+    expansion:
+      - COUNT
+      - MIN
+      - MAX
+      - MEDIAN
+    transport:
+      type: http
+      api-key: test
+  servlet:
+  	enabled: true