This is an automated email from the ASF dual-hosted git repository.
github-merge-queue[bot] 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 5734e4feb5 [Fix][Connector-V2] Declare all Jdbc source and sink
options read by the connector (#12800)
5734e4feb5 is described below
commit 5734e4feb583cf8d0d1d2b4e1fd5129b32a1a3d8
Author: FatMan <[email protected]>
AuthorDate: Fri Oct 16 17:30:47 2026 +0000
[Fix][Connector-V2] Declare all Jdbc source and sink options read by the
connector (#12800)
Co-authored-by: chen <[email protected]>
---
.../seatunnel/jdbc/sink/JdbcSinkFactory.java | 15 +++
.../seatunnel/jdbc/source/JdbcSourceFactory.java | 10 ++
.../jdbc/JdbcOptionRuleCompletenessTest.java | 111 +++++++++++++++++++++
.../seatunnel/jdbc/sink/JdbcSinkFactoryTest.java | 43 ++++++++
.../jdbc/source/JdbcSourceFactoryTest.java | 22 ++++
5 files changed, 201 insertions(+)
diff --git
a/seatunnel-connectors-v2/connector-jdbc/src/main/java/org/apache/seatunnel/connectors/seatunnel/jdbc/sink/JdbcSinkFactory.java
b/seatunnel-connectors-v2/connector-jdbc/src/main/java/org/apache/seatunnel/connectors/seatunnel/jdbc/sink/JdbcSinkFactory.java
index da59ed68a2..b77843556e 100644
---
a/seatunnel-connectors-v2/connector-jdbc/src/main/java/org/apache/seatunnel/connectors/seatunnel/jdbc/sink/JdbcSinkFactory.java
+++
b/seatunnel-connectors-v2/connector-jdbc/src/main/java/org/apache/seatunnel/connectors/seatunnel/jdbc/sink/JdbcSinkFactory.java
@@ -212,9 +212,24 @@ public class JdbcSinkFactory implements TableSinkFactory,
SupportSinkDryRunValid
new ExactlyOnceMaxRetriesValidator()))
.optional(
JdbcSinkOptions.CREATE_INDEX,
+ JdbcSinkOptions.TABLE,
+ JdbcSinkOptions.SCHEMA,
JdbcSinkOptions.USERNAME,
JdbcSinkOptions.PASSWORD,
+ JdbcSinkOptions.PROPERTIES,
JdbcSinkOptions.CONNECTION_CHECK_TIMEOUT_SEC,
+ JdbcSinkOptions.CONNECT_TIMEOUT_MS,
+ JdbcSinkOptions.SOCKET_TIMEOUT_MS,
+ JdbcSinkOptions.DECIMAL_TYPE_NARROWING,
+ JdbcSinkOptions.INT_TYPE_NARROWING,
+ JdbcSinkOptions.HANDLE_BLOB_AS_STRING,
+ JdbcSinkOptions.USE_KERBEROS,
+ JdbcSinkOptions.KERBEROS_PRINCIPAL,
+ JdbcSinkOptions.KERBEROS_KEYTAB_PATH,
+ JdbcSinkOptions.KRB5_PATH,
+ JdbcSinkOptions.ACCESS_KEY_ID,
+ JdbcSinkOptions.SECRET_ACCESS_KEY,
+ JdbcSinkOptions.REGION,
JdbcSinkOptions.BATCH_SIZE,
JdbcSinkOptions.BATCH_INTERVAL_MS,
JdbcSinkOptions.GENERATE_SINK_SQL,
diff --git
a/seatunnel-connectors-v2/connector-jdbc/src/main/java/org/apache/seatunnel/connectors/seatunnel/jdbc/source/JdbcSourceFactory.java
b/seatunnel-connectors-v2/connector-jdbc/src/main/java/org/apache/seatunnel/connectors/seatunnel/jdbc/source/JdbcSourceFactory.java
index d4baf3a550..bac60b8d7d 100644
---
a/seatunnel-connectors-v2/connector-jdbc/src/main/java/org/apache/seatunnel/connectors/seatunnel/jdbc/source/JdbcSourceFactory.java
+++
b/seatunnel-connectors-v2/connector-jdbc/src/main/java/org/apache/seatunnel/connectors/seatunnel/jdbc/source/JdbcSourceFactory.java
@@ -84,6 +84,16 @@ public class JdbcSourceFactory implements
TableSourceFactory, SupportSourceDryRu
JdbcSourceOptions.USERNAME,
JdbcSourceOptions.PASSWORD,
JdbcSourceOptions.CONNECTION_CHECK_TIMEOUT_SEC,
+ JdbcSourceOptions.CONNECT_TIMEOUT_MS,
+ JdbcSourceOptions.SOCKET_TIMEOUT_MS,
+ JdbcSourceOptions.HANDLE_BLOB_AS_STRING,
+ JdbcSourceOptions.USE_KERBEROS,
+ JdbcSourceOptions.KERBEROS_PRINCIPAL,
+ JdbcSourceOptions.KERBEROS_KEYTAB_PATH,
+ JdbcSourceOptions.KRB5_PATH,
+ JdbcSourceOptions.ACCESS_KEY_ID,
+ JdbcSourceOptions.SECRET_ACCESS_KEY,
+ JdbcSourceOptions.REGION,
JdbcSourceOptions.FETCH_SIZE,
JdbcSourceOptions.PARTITION_COLUMN,
JdbcSourceOptions.PARTITION_UPPER_BOUND,
diff --git
a/seatunnel-connectors-v2/connector-jdbc/src/test/java/org/apache/seatunnel/connectors/seatunnel/jdbc/JdbcOptionRuleCompletenessTest.java
b/seatunnel-connectors-v2/connector-jdbc/src/test/java/org/apache/seatunnel/connectors/seatunnel/jdbc/JdbcOptionRuleCompletenessTest.java
new file mode 100644
index 0000000000..bb8ea91d84
--- /dev/null
+++
b/seatunnel-connectors-v2/connector-jdbc/src/test/java/org/apache/seatunnel/connectors/seatunnel/jdbc/JdbcOptionRuleCompletenessTest.java
@@ -0,0 +1,111 @@
+/*
+ * 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.connectors.seatunnel.jdbc;
+
+import org.apache.seatunnel.api.configuration.Option;
+import org.apache.seatunnel.api.configuration.ReadonlyConfig;
+import org.apache.seatunnel.api.configuration.util.ConfigValidator;
+import org.apache.seatunnel.api.configuration.util.OptionRule;
+import org.apache.seatunnel.connectors.seatunnel.jdbc.config.JdbcCommonOptions;
+import org.apache.seatunnel.connectors.seatunnel.jdbc.config.JdbcSinkOptions;
+import org.apache.seatunnel.connectors.seatunnel.jdbc.config.JdbcSourceOptions;
+import org.apache.seatunnel.connectors.seatunnel.jdbc.sink.JdbcSinkFactory;
+import org.apache.seatunnel.connectors.seatunnel.jdbc.source.JdbcSourceFactory;
+
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+
+import java.lang.reflect.Field;
+import java.lang.reflect.Modifier;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Map;
+import java.util.Set;
+
+/**
+ * Every option the Jdbc connector defines must be declared in the factory
option rule.
+ *
+ * <p>{@code --check}, {@code --dry-run} and the Flink/Spark config validation
reject any key that
+ * is not declared in the rule ({@link ConfigValidator#validateUnknownKeys}),
so a defined but
+ * undeclared option makes a valid config fail validation. The options are
collected by reflection,
+ * so an option added later is covered without changing this test.
+ */
+class JdbcOptionRuleCompletenessTest {
+
+ /** Sink-only options that the source does not read. */
+ private static final Set<String> NOT_SOURCE_OPTIONS =
+ Collections.unmodifiableSet(
+ new
HashSet<>(Arrays.asList(JdbcCommonOptions.SCHEMA.key())));
+
+ @Test
+ void testSourceRuleDeclaresAllSourceOptions() {
+ assertAllDeclared(
+ new JdbcSourceFactory().optionRule(),
+ collectOptionKeys(JdbcSourceOptions.class,
NOT_SOURCE_OPTIONS));
+ }
+
+ @Test
+ void testSinkRuleDeclaresAllSinkOptions() {
+ assertAllDeclared(
+ new JdbcSinkFactory().optionRule(),
+ collectOptionKeys(JdbcSinkOptions.class,
Collections.emptySet()));
+ }
+
+ private static void assertAllDeclared(OptionRule rule, Set<String>
optionKeys) {
+ Map<String, Object> config = new HashMap<>();
+ for (String key : optionKeys) {
+ // Only the key matters for the unknown-key check, not the value
+ config.put(key, "value");
+ }
+ Assertions.assertDoesNotThrow(
+ () ->
+ ConfigValidator.validateUnknownKeys(
+ ReadonlyConfig.fromMap(config), rule, "Jdbc"));
+ }
+
+ /**
+ * Returns the keys of all public static {@link Option} fields of the
given options class and
+ * its superclasses (such as {@link JdbcCommonOptions}), minus the
excluded keys.
+ */
+ private static Set<String> collectOptionKeys(Class<?> optionsClass,
Set<String> excluded) {
+ Set<String> keys = new HashSet<>();
+ for (Class<?> clazz = optionsClass; clazz != null; clazz =
clazz.getSuperclass()) {
+ for (Field field : clazz.getDeclaredFields()) {
+ int modifiers = field.getModifiers();
+ if (Modifier.isPublic(modifiers)
+ && Modifier.isStatic(modifiers)
+ && Option.class.isAssignableFrom(field.getType())) {
+ keys.add(readOption(field).key());
+ }
+ }
+ }
+ keys.removeAll(excluded);
+ Assertions.assertFalse(keys.isEmpty(), "No option found in " +
optionsClass.getName());
+ return keys;
+ }
+
+ private static Option<?> readOption(Field field) {
+ try {
+ return (Option<?>) field.get(null);
+ } catch (IllegalAccessException e) {
+ throw new IllegalStateException("Cannot read option field " +
field.getName(), e);
+ }
+ }
+}
diff --git
a/seatunnel-connectors-v2/connector-jdbc/src/test/java/org/apache/seatunnel/connectors/seatunnel/jdbc/sink/JdbcSinkFactoryTest.java
b/seatunnel-connectors-v2/connector-jdbc/src/test/java/org/apache/seatunnel/connectors/seatunnel/jdbc/sink/JdbcSinkFactoryTest.java
index b2f55e410a..bdcd346fa4 100644
---
a/seatunnel-connectors-v2/connector-jdbc/src/test/java/org/apache/seatunnel/connectors/seatunnel/jdbc/sink/JdbcSinkFactoryTest.java
+++
b/seatunnel-connectors-v2/connector-jdbc/src/test/java/org/apache/seatunnel/connectors/seatunnel/jdbc/sink/JdbcSinkFactoryTest.java
@@ -189,6 +189,49 @@ class JdbcSinkFactoryTest {
Assertions.assertThrows(OptionValidationException.class, () ->
validate(cfg));
}
+ /**
+ * The strict unknown-key check used by {@code --check} and {@code
--dry-run} only accepts keys
+ * declared in the option rule, so every option the sink reads must be
declared there.
+ */
+ @Test
+ void testDocumentedSinkOptionsAreNotUnknownKeys() {
+ Map<String, Object> cfg = baseConfig();
+ cfg.put("table", "TEST_TABLE");
+ cfg.put("schema", "ST");
+ cfg.put("properties",
Collections.singletonMap("oracle.jdbc.timezoneAsRegion", "false"));
+ cfg.put("connect_timeout_ms", 30000);
+ cfg.put("socket_timeout_ms", 60000);
+ cfg.put("decimal_type_narrowing", true);
+ cfg.put("int_type_narrowing", true);
+ cfg.put("handle_blob_as_string", false);
+ cfg.put("use_kerberos", true);
+ cfg.put("kerberos_principal", "[email protected]");
+ cfg.put("kerberos_keytab_path", "/etc/seatunnel.keytab");
+ cfg.put("krb5_path", "/etc/krb5.conf");
+ cfg.put("access_key_id", "ak");
+ cfg.put("secret_access_key", "sk");
+ cfg.put("region", "us-east-1");
+
+ Assertions.assertDoesNotThrow(
+ () ->
+ ConfigValidator.validateUnknownKeys(
+ ReadonlyConfig.fromMap(cfg), rule, "Jdbc"));
+ }
+
+ @Test
+ void testUndeclaredSinkOptionIsUnknownKey() {
+ Map<String, Object> cfg = baseConfig();
+ cfg.put("tabel", "TEST_TABLE");
+
+ OptionValidationException exception =
+ Assertions.assertThrows(
+ OptionValidationException.class,
+ () ->
+ ConfigValidator.validateUnknownKeys(
+ ReadonlyConfig.fromMap(cfg), rule,
"Jdbc"));
+ Assertions.assertTrue(exception.getMessage().contains("[tabel]"));
+ }
+
// ---- Entry-level regression tests through factory-context path ----
@Test
diff --git
a/seatunnel-connectors-v2/connector-jdbc/src/test/java/org/apache/seatunnel/connectors/seatunnel/jdbc/source/JdbcSourceFactoryTest.java
b/seatunnel-connectors-v2/connector-jdbc/src/test/java/org/apache/seatunnel/connectors/seatunnel/jdbc/source/JdbcSourceFactoryTest.java
index 2a398704fa..649ce772e7 100644
---
a/seatunnel-connectors-v2/connector-jdbc/src/test/java/org/apache/seatunnel/connectors/seatunnel/jdbc/source/JdbcSourceFactoryTest.java
+++
b/seatunnel-connectors-v2/connector-jdbc/src/test/java/org/apache/seatunnel/connectors/seatunnel/jdbc/source/JdbcSourceFactoryTest.java
@@ -65,6 +65,28 @@ class JdbcSourceFactoryTest {
Assertions.assertDoesNotThrow(() -> validate(cfg));
}
+ /**
+ * The strict unknown-key check used by {@code --check} and {@code
--dry-run} only accepts keys
+ * declared in the option rule, so every option the source reads must be
declared there.
+ */
+ @Test
+ void testDocumentedSourceOptionsAreNotUnknownKeys() {
+ Map<String, Object> cfg = baseConfig();
+ cfg.put("table_path", "test.users");
+ cfg.put("connect_timeout_ms", 30000);
+ cfg.put("socket_timeout_ms", 60000);
+ cfg.put("handle_blob_as_string", false);
+ cfg.put("use_kerberos", true);
+ cfg.put("kerberos_principal", "[email protected]");
+ cfg.put("kerberos_keytab_path", "/etc/seatunnel.keytab");
+ cfg.put("krb5_path", "/etc/krb5.conf");
+
+ Assertions.assertDoesNotThrow(
+ () ->
+ ConfigValidator.validateUnknownKeys(
+ ReadonlyConfig.fromMap(cfg), rule, "Jdbc"));
+ }
+
@Test
void testValidConfigWithQuery() {
Map<String, Object> cfg = baseConfig();
