Polish "Support sending metrics to InfluxDB v2"

See gh-25721

Author: snicoll

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/influx/InfluxProperties.java

@@ -21,7 +21,6 @@
 
 import org.springframework.boot.actuate.autoconfigure.metrics.export.properties.StepRegistryProperties;
 import org.springframework.boot.context.properties.ConfigurationProperties;
-import org.springframework.util.StringUtils;
 
 /**
  * {@link ConfigurationProperties @ConfigurationProperties} for configuring Influx metrics
@@ -35,7 +34,7 @@
 public class InfluxProperties extends StepRegistryProperties {
 
 	/**
-	 * Database to send metrics to when using an InfluxDB 1.x database.
+	 * Database to send metrics to. InfluxDB v1 only.
 	 */
 	private String db = "mydb";
 
@@ -45,12 +44,12 @@ public class InfluxProperties extends StepRegistryProperties {
 	private InfluxConsistency consistency = InfluxConsistency.ONE;
 
 	/**
-	 * Login user of the Influx server.
+	 * Login user of the Influx server. InfluxDB v1 only.
 	 */
 	private String userName;
 
 	/**
-	 * Login password of the Influx server.
+	 * Login password of the Influx server. InfluxDB v1 only.
 	 */
 	private String password;
 
@@ -91,7 +90,7 @@ public class InfluxProperties extends StepRegistryProperties {
 
 	/**
 	 * Whether to create the Influx database if it does not exist before attempting to
-	 * publish metrics to it.
+	 * publish metrics to it. InfluxDB v1 only.
 	 */
 	private boolean autoCreateDb = true;
 
@@ -102,13 +101,13 @@ public class InfluxProperties extends StepRegistryProperties {
 	private InfluxApiVersion apiVersion;
 
 	/**
-	 * InfluxDB v2 org to write metrics.
+	 * Org to write metrics to. InfluxDB v2 only.
 	 */
 	private String org;
 
 	/**
-	 * InfluxDB v2 bucket for metrics. Use either the bucket name or ID. Defaults to the
-	 * value of the db property if not set.
+	 * Bucket for metrics. Use either the bucket name or ID. Defaults to the value of the
+	 * db property if not set. InfluxDB v2 only.
 	 */
 	private String bucket;
 
@@ -207,10 +206,7 @@ public void setAutoCreateDb(boolean autoCreateDb) {
 	}
 
 	public InfluxApiVersion getApiVersion() {
-		if (this.apiVersion != null) {
-			return this.apiVersion;
-		}
-		return StringUtils.hasText(this.org) ? InfluxApiVersion.V2 : InfluxApiVersion.V1;
+		return this.apiVersion;
 	}
 
 	public void setApiVersion(InfluxApiVersion apiVersion) {
@@ -226,10 +222,7 @@ public void setOrg(String org) {
 	}
 
 	public String getBucket() {
-		if (this.bucket != null) {
-			return this.bucket;
-		}
-		return this.db;
+		return this.bucket;
 	}
 
 	public void setBucket(String bucket) {

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/export/influx/InfluxPropertiesConfigAdapterTests.java

@@ -0,0 +1,61 @@
+/*
+ * Copyright 2012-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.boot.actuate.autoconfigure.metrics.export.influx;
+
+import io.micrometer.influx.InfluxApiVersion;
+import org.junit.jupiter.api.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for {@link InfluxPropertiesConfigAdapter}.
+ *
+ * @author Stephane Nicoll
+ */
+class InfluxPropertiesConfigAdapterTests {
+
+	@Test
+	void adaptInfluxV1BasicConfig() {
+		InfluxProperties properties = new InfluxProperties();
+		properties.setDb("test-db");
+		properties.setUri("https://influx.example.com:8086");
+		properties.setUserName("user");
+		properties.setPassword("secret");
+		InfluxPropertiesConfigAdapter adapter = new InfluxPropertiesConfigAdapter(properties);
+		assertThat(adapter.apiVersion()).isEqualTo(InfluxApiVersion.V1);
+		assertThat(adapter.db()).isEqualTo("test-db");
+		assertThat(adapter.uri()).isEqualTo("https://influx.example.com:8086");
+		assertThat(adapter.userName()).isEqualTo("user");
+		assertThat(adapter.password()).isEqualTo("secret");
+	}
+
+	@Test
+	void adaptInfluxV2BasicConfig() {
+		InfluxProperties properties = new InfluxProperties();
+		properties.setOrg("test-org");
+		properties.setBucket("test-bucket");
+		properties.setUri("https://influx.example.com:8086");
+		properties.setToken("token");
+		InfluxPropertiesConfigAdapter adapter = new InfluxPropertiesConfigAdapter(properties);
+		assertThat(adapter.apiVersion()).isEqualTo(InfluxApiVersion.V2);
+		assertThat(adapter.org()).isEqualTo("test-org");
+		assertThat(adapter.bucket()).isEqualTo("test-bucket");
+		assertThat(adapter.uri()).isEqualTo("https://influx.example.com:8086");
+		assertThat(adapter.token()).isEqualTo("token");
+	}
+
+}

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/export/influx/InfluxPropertiesTests.java

@@ -46,9 +46,7 @@ void defaultValuesAreConsistent() {
 		assertThat(properties.getUri()).isEqualTo(config.uri());
 		assertThat(properties.isCompressed()).isEqualTo(config.compressed());
 		assertThat(properties.isAutoCreateDb()).isEqualTo(config.autoCreateDb());
-		assertThat(properties.getApiVersion()).isEqualTo(config.apiVersion());
 		assertThat(properties.getOrg()).isEqualTo(config.org());
-		assertThat(properties.getBucket()).isEqualTo(config.bucket());
 		assertThat(properties.getToken()).isEqualTo(config.token());
 	}