ClaireLytt opened a new pull request, #11675:
URL: https://github.com/apache/seatunnel/pull/11675
<!--
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.-->
Before working on the Iceberg connector changes for #11007, I reviewed the
connector and found the source/sink OptionRules were out of sync with the docs
and with the options each side actually reads. This small, self-contained PR
fixes them ahead. No new feature behavior, no public option key/default change.
main changes:
- `IcebergSourceFactory`: add `query` to the source rule — it is documented
and read when building the source config, but was missing. Move `catalog_name`
and `namespace` from required to optional — both have default value
`"default"`, so the required declaration was a no-op (ConfigValidator skips
options with defaults) and misleading in the exported option metadata.
- `IcebergSinkFactory`: move `catalog_name`, `namespace` and `table` from
required to optional — the first two have defaults, and `table` falls back to
the upstream table name when absent (see `renameCatalogTable`), so none of them
is actually required.
- docs (en/zh, source/sink): change `catalog_name`/`namespace`/`table` from
required `yes` to `no`, document their defaults, and document the sink `table`
fallback-to-upstream-table-name behavior, so the docs match the actual behavior
and the rule.
- strengthen `IcebergFactoryTest`: replace the single `assertNotNull` with
assertions on rule contents (`query` present, `catalog_props` still required,
`table`/`table_list` exclusivity) plus ConfigValidator accept/reject cases
covering single-table, multi-table and sink-without-table configs.
### 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.
-->
No runtime/job behavior change. Conforming configs that follow the docs are
unaffected. Only the exported option metadata (required → optional) and the
docs change, both now reflecting the actual behavior.
### 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.
-->
Scoped to the connector-iceberg module (the only module this PR changes):
- `./mvnw spotless:check -pl seatunnel-connectors-v2/connector-iceberg` pass.
- `./mvnw test -pl seatunnel-connectors-v2/connector-iceberg
-Dtest=IcebergFactoryTest` → 14/14, 0 failures
### 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.
* [ ] 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]
