ClaireLytt opened a new pull request, #11921:
URL: https://github.com/apache/seatunnel/pull/11921
<!--
Thank you for contributing to SeaTunnel! Please make sure that your code
changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
## Contribution Checklist
- Make sure that the pull request corresponds to a [GITHUB
issue](https://github.com/apache/seatunnel/issues).
- Name the pull request in the form "[Feature] [component] Title of the
pull request", where *Feature* can be replaced by `Hotfix`, `Bug`, etc.
- Minor fixes should be named following this pattern: `[hotfix] [docs] Fix
typo in README.md doc`.
-->
### Purpose of this pull request
<!-- Describe the purpose of this pull request. For example: This pull
request adds checkstyle plugin.-->
Part of #11007 (migrate imperative connector config validation to
declarative OptionRule). Follow-up to #11675, which aligned the Iceberg
OptionRules with the actual behavior ahead of this migration.
This PR migrates the last imperative config validation in the Iceberg
connector — the "upsert mode requires explicit primary keys" check in the
`IcebergSinkConfig` constructor — into declarative conditional rules on
`IcebergSinkFactory.optionRule()`, and adds one new declarative value
constraint on the source side.
main changes:
- **IcebergSinkFactory**: add two conditional rules — when
`iceberg.table.upsert-mode-enabled = true`, `iceberg.table.primary-keys`
becomes conditionally required (catches the option being absent) and must be
non-blank via `Conditions.notBlank` (catches a whitespace-only value). This is
the same paired pattern already used by the Elasticsearch connector.
- **IcebergSinkConfig**: remove the now-redundant `if`/`throw
IllegalArgumentException` block from the constructor. The check is enforced
earlier (at job submission) by `ConfigValidator` instead of at sink creation
time.
- **IcebergSourceFactory**: declare
`Conditions.greaterThan(KEY_INCREMENT_SCAN_INTERVAL, 0L)` on
`increment.scan-interval` — a non-positive polling interval was previously
accepted by validation but is meaningless at runtime. This is a validation
tightening; see the user-facing section below.
- **IcebergFactoryTest**: add rule-structure assertions (conditional
requirement on `primary-keys` present, value constraint on `scan-interval`
present) plus `ConfigValidator` accept/reject cases: upsert with/without/blank
primary keys, upsert disabled without primary keys, and
`increment.scan-interval` of `2000` / `0` / `-1`.
- **SchemaUtilsTest**: remove
`testIcebergSinkConfigThrowsWhenUpsertModeEnabledWithoutPrimaryKeys` — it
asserted the old implementation detail (constructor throwing
`IllegalArgumentException`). Its scenario is now covered by
`IcebergFactoryTest#sinkUpsertWithoutPrimaryKeysRejected` at the new validation
point.
- **e2e**: add `IcebergValidationIT` with two negative conf cases
(`upsert-without-pk`, `nonpositive-scan-interval`) asserting the job is
rejected at submission with a non-zero exit code and an `Option validation
failed` message naming the offending key. No Iceberg environment is required —
validation fails before any catalog is touched.
### Does this PR introduce _any_ user-facing change?
<!--
Note that it means *any* user-facing change including all aspects such as
the documentation fix.
If yes, please clarify the previous behavior and the change this PR proposes
- provide the console output, description and/or an example to show the
behavior difference if possible.
If possible, please also clarify if this is a user-facing change compared to
the released SeaTunnel versions or within the unreleased branches such as dev.
If no, write 'No'.
If you are adding/modifying connector documents, please follow our new
specifications: https://github.com/apache/seatunnel/issues/4544.
-->
Two changes, both in error-reporting/validation only:
1. **Same rule, earlier and clearer failure**: an upsert-enabled sink
without explicit primary keys previously failed at sink creation time with an
`IllegalArgumentException`; it now fails at job submission with an aggregated
`OptionValidationException`, and the rule is visible in the exported option
metadata (REST `/option-rules` / Web UI). No previously-valid config is
affected by this part.
2. **Validation tightening (new)**: `increment.scan-interval <= 0` was
previously accepted by validation; it is now rejected at job submission. Such
values were never meaningful at runtime (the streaming incremental scan polls
at this interval in milliseconds), so only already-broken configs are affected.
The default (`2000`) and any positive value are unaffected.
No option key or default value changes.
### How was this patch tested?
<!--
If tests were added, say they were added here. Please make sure to add some
test cases that check the changes thoroughly including negative and positive
cases if possible.
If it was tested in a way different from regular unit tests, please clarify
how you tested step by step, ideally copy and paste-able, so that other
reviewers can test and check, and descendants can verify in the future.
If tests were not added, please describe why they were not added and/or why
it was difficult to add.
If you are adding E2E test cases, maybe refer to
https://github.com/apache/seatunnel/blob/dev/seatunnel-e2e/seatunnel-connector-v2-e2e/connector-cdc-mysql-e2e/src/test/resources/mysqlcdc_to_mysql.conf,
here is a good example.
-->
- `./mvnw spotless:check -pl seatunnel-connectors-v2/connector-iceberg` →
pass
- `./mvnw test -pl seatunnel-connectors-v2/connector-iceberg
-Dtest=IcebergFactoryTest` → all pass
- `./mvnw test -pl seatunnel-connectors-v2/connector-iceberg
-Dtest=SchemaUtilsTest` → all pass
- `IcebergValidationIT` added under `connector-iceberg-e2e`, runs in CI
(asserts submission-time rejection; no external service needed)
### Check list
* [ ] If any new Jar binary package adding in your PR, please add License
Notice according
[New License
Guide](https://github.com/apache/seatunnel/blob/dev/docs/en/developer/new-license.md)
* [ ] If necessary, please update the documentation to describe the new
feature. https://github.com/apache/seatunnel/tree/dev/docs
* [ ] If necessary, please update `incompatible-changes.md` to describe the
incompatibility caused by this PR.
* [x] If you are contributing the connector code, please check that the
following files are updated:
1. Update
[plugin-mapping.properties](https://github.com/apache/seatunnel/blob/dev/plugin-mapping.properties)
and add new connector information in it
2. Update the pom file of
[seatunnel-dist](https://github.com/apache/seatunnel/blob/dev/seatunnel-dist/pom.xml)
3. Add ci label in
[label-scope-conf](https://github.com/apache/seatunnel/blob/dev/.github/workflows/labeler/label-scope-conf.yml)
4. Add e2e testcase in
[seatunnel-e2e](https://github.com/apache/seatunnel/tree/dev/seatunnel-e2e/seatunnel-connector-v2-e2e/)
5. Update connector
[plugin_config](https://github.com/apache/seatunnel/blob/dev/config/plugin_config)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
