This is an automated email from the ASF dual-hosted git repository.
shenghang pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/seatunnel.git
The following commit(s) were added to refs/heads/dev by this push:
new 74ff365ddd [Improve][Core] Support nested option validation (#10592)
74ff365ddd is described below
commit 74ff365ddd47c9d3954d705b4759d2c3303b6099
Author: Jarvis <[email protected]>
AuthorDate: Tue Mar 24 22:12:07 2026 +0800
[Improve][Core] Support nested option validation (#10592)
---
.../api/configuration/util/ConditionRule.java | 52 ++++++++++
.../api/configuration/util/ConfigValidator.java | 31 ++++--
.../api/configuration/util/OptionRule.java | 93 ++++++++++++++---
.../configuration/util/ConfigValidatorTest.java | 112 +++++++++++++++++++++
4 files changed, 269 insertions(+), 19 deletions(-)
diff --git
a/seatunnel-api/src/main/java/org/apache/seatunnel/api/configuration/util/ConditionRule.java
b/seatunnel-api/src/main/java/org/apache/seatunnel/api/configuration/util/ConditionRule.java
new file mode 100644
index 0000000000..6e8234e10c
--- /dev/null
+++
b/seatunnel-api/src/main/java/org/apache/seatunnel/api/configuration/util/ConditionRule.java
@@ -0,0 +1,52 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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
+ *
+ * http://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.apache.seatunnel.api.configuration.util;
+
+import lombok.Getter;
+
+import java.util.Objects;
+
+@Getter
+public class ConditionRule {
+
+ private final Expression expression;
+ private final OptionRule optionRule;
+
+ public ConditionRule(Expression expression, OptionRule optionRule) {
+ this.expression = expression;
+ this.optionRule = optionRule;
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) {
+ return true;
+ }
+ if (!(o instanceof ConditionRule)) {
+ return false;
+ }
+ ConditionRule that = (ConditionRule) o;
+ return Objects.equals(expression, that.expression)
+ && Objects.equals(optionRule, that.optionRule);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(expression, optionRule);
+ }
+}
diff --git
a/seatunnel-api/src/main/java/org/apache/seatunnel/api/configuration/util/ConfigValidator.java
b/seatunnel-api/src/main/java/org/apache/seatunnel/api/configuration/util/ConfigValidator.java
index 884e82034d..11103a2a7c 100644
---
a/seatunnel-api/src/main/java/org/apache/seatunnel/api/configuration/util/ConfigValidator.java
+++
b/seatunnel-api/src/main/java/org/apache/seatunnel/api/configuration/util/ConfigValidator.java
@@ -42,9 +42,13 @@ public class ConfigValidator {
}
public void validate(OptionRule rule) {
+ validate(rule, null);
+ }
+
+ public void validate(OptionRule rule, Expression expression) {
List<RequiredOption> requiredOptions = rule.getRequiredOptions();
for (RequiredOption requiredOption : requiredOptions) {
- validate(requiredOption);
+ validate(requiredOption, expression);
for (Option<?> option : requiredOption.getOptions()) {
if
(SingleChoiceOption.class.isAssignableFrom(option.getClass())) {
@@ -64,6 +68,13 @@ public class ConfigValidator {
validateSingleChoice(option);
}
}
+
+ List<ConditionRule> conditionRules = rule.getConditionRules();
+ for (ConditionRule conditionRule : conditionRules) {
+ if (validate(conditionRule.getExpression())) {
+ validate(conditionRule.getOptionRule(),
conditionRule.getExpression());
+ }
+ }
}
void validateSingleChoice(Option option) {
@@ -90,9 +101,9 @@ public class ConfigValidator {
}
}
- void validate(RequiredOption requiredOption) {
+ void validate(RequiredOption requiredOption, Expression expression) {
if (requiredOption instanceof
RequiredOption.AbsolutelyRequiredOptions) {
- validate((RequiredOption.AbsolutelyRequiredOptions)
requiredOption);
+ validate((RequiredOption.AbsolutelyRequiredOptions)
requiredOption, expression);
return;
}
if (requiredOption instanceof RequiredOption.BundledRequiredOptions) {
@@ -124,14 +135,22 @@ public class ConfigValidator {
return absent;
}
- void validate(RequiredOption.AbsolutelyRequiredOptions requiredOption) {
+ void validate(RequiredOption.AbsolutelyRequiredOptions requiredOption,
Expression expression) {
List<Option<?>> absentOptions =
getAbsentOptions(requiredOption.getRequiredOption());
if (absentOptions.size() == 0) {
return;
}
throw new OptionValidationException(
- "There are unconfigured options, the options(%s) are
required.",
- getOptionKeys(absentOptions));
+ "There are unconfigured options, the options(%s) are
required%s",
+ getOptionKeys(absentOptions),
getExpressionExceptionHintMessage(expression));
+ }
+
+ String getExpressionExceptionHintMessage(Expression expression) {
+ if (expression == null) {
+ return ".";
+ } else {
+ return " when [" + expression + "].";
+ }
}
boolean hasOption(Option<?> option) {
diff --git
a/seatunnel-api/src/main/java/org/apache/seatunnel/api/configuration/util/OptionRule.java
b/seatunnel-api/src/main/java/org/apache/seatunnel/api/configuration/util/OptionRule.java
index 0d700bdbc1..048f3015ec 100644
---
a/seatunnel-api/src/main/java/org/apache/seatunnel/api/configuration/util/OptionRule.java
+++
b/seatunnel-api/src/main/java/org/apache/seatunnel/api/configuration/util/OptionRule.java
@@ -23,9 +23,13 @@ import lombok.NonNull;
import java.util.ArrayList;
import java.util.Arrays;
+import java.util.Collections;
+import java.util.HashMap;
import java.util.List;
+import java.util.Map;
import java.util.Objects;
import java.util.concurrent.atomic.AtomicBoolean;
+import java.util.stream.Collectors;
/**
* Validation rule for {@link Option}.
@@ -80,9 +84,15 @@ public class OptionRule {
*/
private final List<RequiredOption> requiredOptions;
- OptionRule(List<Option<?>> optionalOptions, List<RequiredOption>
requiredOptions) {
+ private final List<ConditionRule> conditionRules;
+
+ OptionRule(
+ List<Option<?>> optionalOptions,
+ List<RequiredOption> requiredOptions,
+ List<ConditionRule> conditionRules) {
this.optionalOptions = optionalOptions;
this.requiredOptions = requiredOptions;
+ this.conditionRules = conditionRules;
}
public List<Option<?>> getOptionalOptions() {
@@ -93,6 +103,16 @@ public class OptionRule {
return requiredOptions;
}
+ public List<ConditionRule> getConditionRules() {
+ return conditionRules;
+ }
+
+ private boolean hasOptions() {
+ return !(optionalOptions.isEmpty()
+ && requiredOptions.isEmpty()
+ && conditionRules.isEmpty());
+ }
+
@Override
public boolean equals(Object o) {
if (this == o) {
@@ -103,12 +123,13 @@ public class OptionRule {
}
OptionRule that = (OptionRule) o;
return Objects.equals(optionalOptions, that.optionalOptions)
- && Objects.equals(requiredOptions, that.requiredOptions);
+ && Objects.equals(requiredOptions, that.requiredOptions)
+ && Objects.equals(conditionRules, that.conditionRules);
}
@Override
public int hashCode() {
- return Objects.hash(optionalOptions, requiredOptions);
+ return Objects.hash(optionalOptions, requiredOptions, conditionRules);
}
public static OptionRule.Builder builder() {
@@ -119,6 +140,7 @@ public class OptionRule {
public static class Builder {
private final List<Option<?>> optionalOptions = new ArrayList<>();
private final List<RequiredOption> requiredOptions = new ArrayList<>();
+ private final Map<Expression, OptionRule> conditionRulesMap = new
HashMap<>();
private Builder() {}
@@ -174,15 +196,10 @@ public class OptionRule {
/** Each parameter can only be controlled by one other parameter */
Expression expression =
- Expression.of(Condition.of(conditionalOption,
expectValues.get(0)));
- for (int i = 0; i < expectValues.size(); i++) {
- if (i != 0) {
- expression =
- expression.or(
- Expression.of(
- Condition.of(conditionalOption,
expectValues.get(i))));
- }
- }
+ expectValues.stream()
+ .map(v ->
Expression.of(Condition.of(conditionalOption, v)))
+ .reduce(Expression::or)
+ .get();
RequiredOption.ConditionalRequiredOptions option =
RequiredOption.ConditionalRequiredOptions.of(
@@ -218,8 +235,58 @@ public class OptionRule {
return this;
}
+ public <T> Builder conditionalRule(
+ @NonNull Option<T> conditionalOption,
+ @NonNull List<T> expectValues,
+ @NonNull OptionRule conditionalOptionRule) {
+ verifyConditionalExists(conditionalOption);
+
+ if (expectValues.isEmpty()) {
+ throw new OptionValidationException(
+ String.format(
+ "conditional option '%s' must have expect
values .",
+ conditionalOption.key()));
+ }
+
+ if (!conditionalOptionRule.hasOptions()) {
+ throw new OptionValidationException(
+ String.format(
+ "conditional option rule for '%s' must have
options.",
+ conditionalOption.key()));
+ }
+
+ Expression expression =
+ expectValues.stream()
+ .map(v ->
Expression.of(Condition.of(conditionalOption, v)))
+ .reduce(Expression::or)
+ .get();
+
+ if (conditionRulesMap.containsKey(expression)) {
+ throw new OptionValidationException(
+ String.format(
+ "conditional option rule for '%s' with
expression '%s' already exists.",
+ conditionalOption.key(),
expression.toString()));
+ }
+ this.conditionRulesMap.put(expression, conditionalOptionRule);
+ return this;
+ }
+
+ public <T> Builder conditionalRule(
+ @NonNull Option<T> conditionalOption,
+ @NonNull T expectValue,
+ @NonNull OptionRule conditionalOptionRule) {
+ return conditionalRule(
+ conditionalOption,
+ Collections.singletonList(expectValue),
+ conditionalOptionRule);
+ }
+
public OptionRule build() {
- return new OptionRule(optionalOptions, requiredOptions);
+ List<ConditionRule> conditionRuleList =
+ conditionRulesMap.entrySet().stream()
+ .map(e -> new ConditionRule(e.getKey(),
e.getValue()))
+ .collect(Collectors.toList());
+ return new OptionRule(optionalOptions, requiredOptions,
conditionRuleList);
}
private void verifyRequiredOptionDefaultValue(@NonNull Option<?>
option) {
diff --git
a/seatunnel-api/src/test/java/org/apache/seatunnel/api/configuration/util/ConfigValidatorTest.java
b/seatunnel-api/src/test/java/org/apache/seatunnel/api/configuration/util/ConfigValidatorTest.java
index 18a176b78c..23fe6b0c66 100644
---
a/seatunnel-api/src/test/java/org/apache/seatunnel/api/configuration/util/ConfigValidatorTest.java
+++
b/seatunnel-api/src/test/java/org/apache/seatunnel/api/configuration/util/ConfigValidatorTest.java
@@ -293,4 +293,116 @@ public class ConfigValidatorTest {
"ErrorCode:[API-02], ErrorDescription:[Option item validate
failed] - These options('single_choice_test') are SingleChoiceOption, the
value(N) must be one of the optionValues([A, B, C]).",
assertThrows(OptionValidationException.class,
executable).getMessage());
}
+
+ @Test
+ public void testNestedOptionRule() {
+ Option<String> test_key =
+
Options.key("test_key").stringType().noDefaultValue().withDescription("for
test");
+ OptionRule adminUserOption =
OptionRule.builder().required(test_key).build();
+ OptionRule subOption1 =
+ OptionRule.builder()
+ .required(KEY_USERNAME, KEY_PASSWORD)
+ .conditionalRule(KEY_USERNAME, "admin",
adminUserOption)
+ .build();
+ OptionRule subOption2 =
OptionRule.builder().required(KEY_BEARER_TOKEN).build();
+
+ // the final rule is :
+ // key_kerberos_ticket is required
+ // single_choice_test is optional (the default value is A)
+ // when single_choice_test == A, username and password are required,
and when username ==
+ // admin, test_key is required
+ // when single_choice_test == B, bearer_token is required
+ // when single_choice_test == C, no extra options are required
+ OptionRule optionRule =
+ OptionRule.builder()
+ .required(KEY_KERBEROS_TICKET)
+ .optional(SINGLE_CHOICE_VALUE_TEST)
+ .conditionalRule(SINGLE_CHOICE_VALUE_TEST, "A",
subOption1)
+ .conditionalRule(SINGLE_CHOICE_VALUE_TEST, "B",
subOption2)
+ .build();
+
+ Map<String, Object> config = new HashMap<>();
+ config.put(KEY_KERBEROS_TICKET.key(), "A");
+ config.put(SINGLE_CHOICE_VALUE_TEST.key(), "C");
+ Executable executable = () -> validate(config, optionRule);
+ Assertions.assertDoesNotThrow(executable);
+
+ config.put(SINGLE_CHOICE_VALUE_TEST.key(), "A");
+ executable = () -> validate(config, optionRule);
+ assertEquals(
+ "ErrorCode:[API-02], ErrorDescription:[Option item validate
failed] - There are unconfigured options, the options('username', 'password')
are required when ['single_choice_test' == A].",
+ assertThrows(OptionValidationException.class,
executable).getMessage());
+
+ config.put(KEY_USERNAME.key(), "root");
+ config.put(KEY_PASSWORD.key(), "111");
+ executable = () -> validate(config, optionRule);
+ Assertions.assertDoesNotThrow(executable);
+
+ config.put(KEY_USERNAME.key(), "admin");
+ executable = () -> validate(config, optionRule);
+ assertEquals(
+ "ErrorCode:[API-02], ErrorDescription:[Option item validate
failed] - There are unconfigured options, the options('test_key') are required
when ['username' == admin].",
+ assertThrows(OptionValidationException.class,
executable).getMessage());
+
+ config.put(test_key.key(), "111");
+ executable = () -> validate(config, optionRule);
+ Assertions.assertDoesNotThrow(executable);
+ }
+
+ @Test
+ public void testEmptyNestedOption() {
+ OptionRule emptyRule = OptionRule.builder().build();
+ Executable executable =
+ () ->
+ OptionRule.builder()
+ .optional(SINGLE_CHOICE_VALUE_TEST)
+ .conditionalRule(SINGLE_CHOICE_VALUE_TEST,
"A", emptyRule)
+ .build();
+ assertEquals(
+ "ErrorCode:[API-02], ErrorDescription:[Option item validate
failed] - conditional option rule for 'single_choice_test' must have options.",
+ assertThrows(OptionValidationException.class,
executable).getMessage());
+ }
+
+ @Test
+ public void testDuplicatedNestedOption() {
+ OptionRule subOption1 =
OptionRule.builder().required(KEY_USERNAME).build();
+ OptionRule subOption2 =
OptionRule.builder().required(KEY_PASSWORD).build();
+ Executable executable =
+ () ->
+ OptionRule.builder()
+ .required(KEY_KERBEROS_TICKET)
+ .optional(SINGLE_CHOICE_VALUE_TEST)
+ .conditionalRule(SINGLE_CHOICE_VALUE_TEST,
"A", subOption1)
+ .conditionalRule(SINGLE_CHOICE_VALUE_TEST,
"A", subOption2)
+ .build();
+ assertEquals(
+ "ErrorCode:[API-02], ErrorDescription:[Option item validate
failed] - conditional option rule for 'single_choice_test' with expression
''single_choice_test' == A' already exists.",
+ assertThrows(OptionValidationException.class,
executable).getMessage());
+ }
+
+ @Test
+ public void testMultipleValueNestedRule() {
+ OptionRule subOption1 = OptionRule.builder().required(KEY_USERNAME,
KEY_PASSWORD).build();
+ OptionRule subOption2 =
OptionRule.builder().required(KEY_BEARER_TOKEN).build();
+ OptionRule optionRule =
+ OptionRule.builder()
+ .optional(SINGLE_CHOICE_VALUE_TEST)
+ .conditionalRule(
+ SINGLE_CHOICE_VALUE_TEST, Arrays.asList("A",
"B"), subOption1)
+ .build();
+
+ Map<String, Object> config = new HashMap<>();
+ config.put(KEY_KERBEROS_TICKET.key(), "A");
+ config.put(SINGLE_CHOICE_VALUE_TEST.key(), "B");
+ Executable executable = () -> validate(config, optionRule);
+ assertEquals(
+ "ErrorCode:[API-02], ErrorDescription:[Option item validate
failed] - There are unconfigured options, the options('username', 'password')
are required when ['single_choice_test' == A || 'single_choice_test' == B].",
+ assertThrows(OptionValidationException.class,
executable).getMessage());
+
+ config.put(SINGLE_CHOICE_VALUE_TEST.key(), "B");
+ executable = () -> validate(config, optionRule);
+ assertEquals(
+ "ErrorCode:[API-02], ErrorDescription:[Option item validate
failed] - There are unconfigured options, the options('username', 'password')
are required when ['single_choice_test' == A || 'single_choice_test' == B].",
+ assertThrows(OptionValidationException.class,
executable).getMessage());
+ }
}
