Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Improve][Api] Supports simultaneous config of conditions and optional options #7788

Merged
merged 2 commits into from
Oct 8, 2024
Merged

[Improve][Api] Supports simultaneous config of conditions and optional options #7788

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ce753be
[Improve][Api] Supports simultaneous config of conditions and optiona…
corgy-w Oct 7, 2024
c8a46b7
[Improve][Api] Optimize code
corgy-w Oct 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 14 additions & 5 deletions seatunnel-api/src/main/java/org/apache/seatunnel/api/configuration/util/OptionRule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ public <T> Builder conditional(
@NonNull Option<?>... requiredOptions) {
verifyConditionalExists(conditionalOption);

if (expectValues.size() == 0) {
if (expectValues.isEmpty()) {
throw new OptionValidationException(
String.format(
"conditional option '%s' must have expect values .",
Expand All @@ -187,7 +187,7 @@ public <T> Builder conditional(
RequiredOption.ConditionalRequiredOptions option =
RequiredOption.ConditionalRequiredOptions.of(
expression, new ArrayList<>(Arrays.asList(requiredOptions)));
verifyRequiredOptionDuplicate(option);
verifyRequiredOptionDuplicate(option, true);
this.requiredOptions.add(option);
return this;
}
Expand All @@ -204,7 +204,7 @@ public <T> Builder conditional(
RequiredOption.ConditionalRequiredOptions.of(
expression, new ArrayList<>(Arrays.asList(requiredOptions)));

verifyRequiredOptionDuplicate(conditionalRequiredOption);
verifyRequiredOptionDuplicate(conditionalRequiredOption, true);
this.requiredOptions.add(conditionalRequiredOption);
return this;
}
Expand Down Expand Up @@ -242,12 +242,21 @@ private void verifyDuplicateWithOptionOptions(
}

private void verifyRequiredOptionDuplicate(@NonNull RequiredOption requiredOption) {
verifyRequiredOptionDuplicate(requiredOption, false);
}

private void verifyRequiredOptionDuplicate(
@NonNull RequiredOption requiredOption,
@NonNull Boolean ignoreVerifyDuplicateWithOptionOptions) {
corgy-w marked this conversation as resolved.
Show resolved Hide resolved
corgy-w marked this conversation as resolved.
Show resolved Hide resolved
requiredOption
.getOptions()
.forEach(
option -> {
verifyDuplicateWithOptionOptions(
option, requiredOption.getClass().getSimpleName());
// Check if the option is duplicate with other required options
if (!ignoreVerifyDuplicateWithOptionOptions) {
verifyDuplicateWithOptionOptions(
option, requiredOption.getClass().getSimpleName());
}
requiredOptions.forEach(
ro -> {
if (ro
Expand Down
27 changes: 27 additions & 0 deletions seatunnel-api/src/test/java/org/apache/seatunnel/api/configuration/util/OptionRuleTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@

import static org.apache.seatunnel.api.configuration.OptionTest.TEST_MODE;
import static org.apache.seatunnel.api.configuration.OptionTest.TEST_NUM;
import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;

Expand Down Expand Up @@ -155,6 +156,32 @@ public void testVerify() {
assertEquals(
"ErrorCode:[API-02], ErrorDescription:[Option item validate failed] - ConditionalRequiredOptions 'option.timestamp' duplicate in ConditionalRequiredOptions options.",
assertThrows(OptionValidationException.class, executable).getMessage());

// Test conditional only does not conflict with optional options
// Test option TEST_TIMESTAMP
executable =
() -> {
OptionRule.builder()
.optional(TEST_NUM, TEST_MODE, TEST_TIMESTAMP)
.exclusive(TEST_TOPIC_PATTERN, TEST_TOPIC)
.required(TEST_PORTS)
.conditional(TEST_MODE, OptionTest.TestMode.TIMESTAMP, TEST_TIMESTAMP)
.conditional(TEST_MODE, OptionTest.TestMode.LATEST, TEST_TIMESTAMP)
.build();
};
assertDoesNotThrow(executable);
executable =
() -> {
OptionRule.builder()
.optional(TEST_NUM, TEST_MODE)
.exclusive(TEST_TOPIC_PATTERN, TEST_TOPIC, TEST_TIMESTAMP)
.required(TEST_PORTS)
.conditional(TEST_MODE, OptionTest.TestMode.TIMESTAMP, TEST_TIMESTAMP)
.build();
};
assertEquals(
"ErrorCode:[API-02], ErrorDescription:[Option item validate failed] - ConditionalRequiredOptions 'option.timestamp' duplicate in ExclusiveRequiredOptions options.",
assertThrows(OptionValidationException.class, executable).getMessage());
}

@Test
Expand Down
Loading