You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by pa...@apache.org on 2022/12/11 04:57:37 UTC
[shardingsphere] branch master updated: Add PluginConfigurationValidator (#22795)
This is an automated email from the ASF dual-hosted git repository.
panjuan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere.git
The following commit(s) were added to refs/heads/master by this push:
new 00dc34baec9 Add PluginConfigurationValidator (#22795)
00dc34baec9 is described below
commit 00dc34baec9077e1039824b887058f9d5e9f4bbb
Author: Liang Zhang <zh...@apache.org>
AuthorDate: Sun Dec 11 12:57:31 2022 +0800
Add PluginConfigurationValidator (#22795)
---
.../agent/config/AgentConfiguration.java | 2 +-
.../agent/config/PluginConfiguration.java | 12 --------
.../validator/PluginConfigurationValidator.java} | 35 ++++++++--------------
.../PluginConfigurationValidatorTest.java} | 17 +++++++----
.../service/JaegerTracingPluginBootService.java | 3 +-
.../service/ZipkinTracingPluginBootService.java | 3 +-
6 files changed, 30 insertions(+), 42 deletions(-)
diff --git a/agent/api/src/main/java/org/apache/shardingsphere/agent/config/AgentConfiguration.java b/agent/api/src/main/java/org/apache/shardingsphere/agent/config/AgentConfiguration.java
index ee2c582e2f4..ba729edbb5e 100644
--- a/agent/api/src/main/java/org/apache/shardingsphere/agent/config/AgentConfiguration.java
+++ b/agent/api/src/main/java/org/apache/shardingsphere/agent/config/AgentConfiguration.java
@@ -25,8 +25,8 @@ import java.util.Map;
/**
* Agent configuration.
*/
-@Getter
@RequiredArgsConstructor
+@Getter
public final class AgentConfiguration {
private final Map<String, PluginConfiguration> plugins;
diff --git a/agent/api/src/main/java/org/apache/shardingsphere/agent/config/PluginConfiguration.java b/agent/api/src/main/java/org/apache/shardingsphere/agent/config/PluginConfiguration.java
index 407119afdeb..cf5abe99155 100644
--- a/agent/api/src/main/java/org/apache/shardingsphere/agent/config/PluginConfiguration.java
+++ b/agent/api/src/main/java/org/apache/shardingsphere/agent/config/PluginConfiguration.java
@@ -17,8 +17,6 @@
package org.apache.shardingsphere.agent.config;
-import com.google.common.base.Preconditions;
-import com.google.common.base.Strings;
import lombok.Getter;
import lombok.RequiredArgsConstructor;
@@ -38,14 +36,4 @@ public final class PluginConfiguration {
private final String password;
private final Properties props;
-
- /**
- * Validate.
- *
- * @param type plugin component type
- */
- public void validate(final String type) {
- Preconditions.checkArgument(!Strings.isNullOrEmpty(host), "Hostname of %s is required", type);
- Preconditions.checkArgument(port > 0, "Port `%s` of %s must be a positive number", port, type);
- }
}
diff --git a/agent/api/src/main/java/org/apache/shardingsphere/agent/config/PluginConfiguration.java b/agent/core/src/main/java/org/apache/shardingsphere/agent/core/config/validator/PluginConfigurationValidator.java
similarity index 53%
copy from agent/api/src/main/java/org/apache/shardingsphere/agent/config/PluginConfiguration.java
copy to agent/core/src/main/java/org/apache/shardingsphere/agent/core/config/validator/PluginConfigurationValidator.java
index 407119afdeb..a8cd0508250 100644
--- a/agent/api/src/main/java/org/apache/shardingsphere/agent/config/PluginConfiguration.java
+++ b/agent/core/src/main/java/org/apache/shardingsphere/agent/core/config/validator/PluginConfigurationValidator.java
@@ -15,37 +15,28 @@
* limitations under the License.
*/
-package org.apache.shardingsphere.agent.config;
+package org.apache.shardingsphere.agent.core.config.validator;
import com.google.common.base.Preconditions;
import com.google.common.base.Strings;
-import lombok.Getter;
-import lombok.RequiredArgsConstructor;
-
-import java.util.Properties;
+import lombok.AccessLevel;
+import lombok.NoArgsConstructor;
+import org.apache.shardingsphere.agent.config.PluginConfiguration;
/**
- * Plugin configuration.
+ * Plugin configuration validator.
*/
-@RequiredArgsConstructor
-@Getter
-public final class PluginConfiguration {
-
- private final String host;
-
- private final int port;
-
- private final String password;
-
- private final Properties props;
+@NoArgsConstructor(access = AccessLevel.PRIVATE)
+public final class PluginConfigurationValidator {
/**
- * Validate.
+ * Validate plugin configuration.
*
- * @param type plugin component type
+ * @param type plugin type
+ * @param pluginConfig to be validated plugin configuration
*/
- public void validate(final String type) {
- Preconditions.checkArgument(!Strings.isNullOrEmpty(host), "Hostname of %s is required", type);
- Preconditions.checkArgument(port > 0, "Port `%s` of %s must be a positive number", port, type);
+ public static void validate(final String type, final PluginConfiguration pluginConfig) {
+ Preconditions.checkArgument(!Strings.isNullOrEmpty(pluginConfig.getHost()), "Hostname of %s is required.", type);
+ Preconditions.checkArgument(pluginConfig.getPort() > 0, "Port `%s` of %s must be a positive number.", pluginConfig.getPort(), type);
}
}
diff --git a/agent/api/src/test/java/org/apache/shardingsphere/agent/config/PluginConfigurationTest.java b/agent/core/src/test/java/org/apache/shardingsphere/agent/core/config/validator/PluginConfigurationValidatorTest.java
similarity index 55%
rename from agent/api/src/test/java/org/apache/shardingsphere/agent/config/PluginConfigurationTest.java
rename to agent/core/src/test/java/org/apache/shardingsphere/agent/core/config/validator/PluginConfigurationValidatorTest.java
index 1edb757dd36..e2adf1c8bde 100644
--- a/agent/api/src/test/java/org/apache/shardingsphere/agent/config/PluginConfigurationTest.java
+++ b/agent/core/src/test/java/org/apache/shardingsphere/agent/core/config/validator/PluginConfigurationValidatorTest.java
@@ -15,26 +15,33 @@
* limitations under the License.
*/
-package org.apache.shardingsphere.agent.config;
+package org.apache.shardingsphere.agent.core.config.validator;
+import org.apache.shardingsphere.agent.config.PluginConfiguration;
import org.junit.Test;
import static org.junit.Assert.assertThrows;
-public final class PluginConfigurationTest {
+public final class PluginConfigurationValidatorTest {
+
+ @Test
+ public void assertValidateSuccess() {
+ PluginConfigurationValidator.validate("foo_type", new PluginConfiguration("localhost", 8080, "pwd", null));
+ }
@Test
public void assertValidateWhenHostIsEmpty() {
- assertThrows("Hostname of foo_host is required", IllegalArgumentException.class, () -> new PluginConfiguration("", 8080, "pwd", null).validate("foo_host"));
+ assertThrows("Hostname of foo_type is required", IllegalArgumentException.class, () -> PluginConfigurationValidator.validate("foo_type", new PluginConfiguration("", 8080, "pwd", null)));
}
@Test
public void assertValidateWhenHostIsNull() {
- assertThrows("Hostname of foo_host is required", IllegalArgumentException.class, () -> new PluginConfiguration(null, 8080, "pwd", null).validate("foo_host"));
+ assertThrows("Hostname of foo_type is required", IllegalArgumentException.class, () -> PluginConfigurationValidator.validate("foo_type", new PluginConfiguration(null, 8080, "pwd", null)));
}
@Test
public void assertValidateWhenPortLessThanOne() {
- assertThrows("Port `0` of foo_host must be a positive number", IllegalArgumentException.class, () -> new PluginConfiguration("localhost", 0, "pwd", null).validate("foo_host"));
+ assertThrows("Port `0` of foo_host must be a positive number", IllegalArgumentException.class,
+ () -> PluginConfigurationValidator.validate("foo_type", new PluginConfiguration("localhost", 0, "pwd", null)));
}
}
diff --git a/agent/plugins/tracing/jaeger/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/jaeger/service/JaegerTracingPluginBootService.java b/agent/plugins/tracing/jaeger/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/jaeger/service/JaegerTracingPluginBootService.java
index f3f21beb961..bf70f15d816 100644
--- a/agent/plugins/tracing/jaeger/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/jaeger/service/JaegerTracingPluginBootService.java
+++ b/agent/plugins/tracing/jaeger/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/jaeger/service/JaegerTracingPluginBootService.java
@@ -20,6 +20,7 @@ package org.apache.shardingsphere.agent.plugin.tracing.jaeger.service;
import io.jaegertracing.Configuration;
import io.opentracing.util.GlobalTracer;
import org.apache.shardingsphere.agent.config.PluginConfiguration;
+import org.apache.shardingsphere.agent.core.config.validator.PluginConfigurationValidator;
import org.apache.shardingsphere.agent.spi.PluginBootService;
import java.util.Optional;
@@ -38,7 +39,7 @@ public final class JaegerTracingPluginBootService implements PluginBootService {
@SuppressWarnings("AccessOfSystemProperties")
@Override
public void start(final PluginConfiguration pluginConfig, final boolean isEnhancedForProxy) {
- pluginConfig.validate("Jaeger");
+ PluginConfigurationValidator.validate(getType(), pluginConfig);
pluginConfig.getProps().forEach((key, value) -> setSystemProperty(String.valueOf(key), String.valueOf(value)));
Configuration.SamplerConfiguration samplerConfig = Configuration.SamplerConfiguration.fromEnv();
Configuration.ReporterConfiguration reporterConfig = Configuration.ReporterConfiguration.fromEnv()
diff --git a/agent/plugins/tracing/zipkin/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/zipkin/service/ZipkinTracingPluginBootService.java b/agent/plugins/tracing/zipkin/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/zipkin/service/ZipkinTracingPluginBootService.java
index a2ed4bb1055..47869d92348 100644
--- a/agent/plugins/tracing/zipkin/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/zipkin/service/ZipkinTracingPluginBootService.java
+++ b/agent/plugins/tracing/zipkin/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/zipkin/service/ZipkinTracingPluginBootService.java
@@ -22,6 +22,7 @@ import brave.sampler.BoundarySampler;
import brave.sampler.RateLimitingSampler;
import brave.sampler.Sampler;
import org.apache.shardingsphere.agent.config.PluginConfiguration;
+import org.apache.shardingsphere.agent.core.config.validator.PluginConfigurationValidator;
import org.apache.shardingsphere.agent.spi.PluginBootService;
import zipkin2.reporter.brave.AsyncZipkinSpanHandler;
import zipkin2.reporter.okhttp3.OkHttpSender;
@@ -58,7 +59,7 @@ public final class ZipkinTracingPluginBootService implements PluginBootService {
@Override
public void start(final PluginConfiguration pluginConfig, final boolean isEnhancedForProxy) {
- pluginConfig.validate("Zipkin");
+ PluginConfigurationValidator.validate(getType(), pluginConfig);
Properties props = pluginConfig.getProps();
String urlVersion = Optional.ofNullable(props.getProperty(KEY_URL_VERSION)).orElse(DEFAULT_URL_VERSION);
String serviceName = Optional.ofNullable(props.getProperty(KEY_SERVICE_NAME)).orElse(DEFAULT_SERVICE_NAME);