You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@datafusion.apache.org by "gabotechs (via GitHub)" <gi...@apache.org> on 2025/05/24 17:34:49 UTC
[PR] Add `--substrait-round-trip` option in sqllogictests [datafusion]
gabotechs opened a new pull request, #16183:
URL: https://github.com/apache/datafusion/pull/16183
## Which issue does this PR close?
<!--
We generally require a GitHub issue to be filed for all bug fixes and enhancements and this helps us generate change logs for our releases. You can link an issue to this PR using the GitHub syntax. For example `Closes #123` indicates that this PR will close issue #123.
-->
It probably does not fully closes it but it partially addresses:
- https://github.com/apache/datafusion/issues/15069
## Rationale for this change
<!--
Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed.
Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes.
-->
Being able to execute the full sqllogictest suite adding a Substrait roundtrip. This means:
- Parsing the test statement
- Building a logical plan out of it
- Converting the logical plan to Substrait
- Converting the Substrait plan back to logical
- Execute it
## What changes are included in this PR?
<!--
There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR.
-->
Adds a new `DataFusionSubstraitRoundTrip` sqllogictest runner implementation that will do a Substrait roundtrip where it makes sense, and a new `--substrait-round-trip` option to the sqllogictest CLI.
Example:
Runs the full aggregate.slt file doing a Substrait roundtrip on each individual statement
```shell
cargo test --test sqllogictests -- --substrait-round-trip aggregate
```
Runs an individual failing test reproducing one specific issue with the current Substrait conversions
```shell
cargo test --test sqllogictests -- --substrait-round-trip aggregate:1522
```
This is still not enforced in the CI, and I would say the expectations are that it's just another tool to catch existing bugs in the current Substrait conversion code and better communicate them so that contributors have a clear path forward for contributing fixes.
## Are these changes tested?
<!--
We typically require tests for all PRs in order to:
1. Prevent the code from being accidentally broken by subsequent changes
2. Serve as another way to document the expected behavior of the code
If tests are not included in your PR, please explain why (for example, are they covered by existing tests)?
-->
N/A
## Are there any user-facing changes?
No
<!--
If there are user-facing changes then we may require documentation to be updated before approving the PR.
-->
<!--
If there are any breaking changes to public APIs, please add the `api change` label.
-->
--
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: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Add `--substrait-round-trip` option in sqllogictests [datafusion]
Posted by "Blizzara (via GitHub)" <gi...@apache.org>.
Blizzara commented on PR #16183:
URL: https://github.com/apache/datafusion/pull/16183#issuecomment-2930065323
I'm not familiar with the sqllogictests code so will leave it to Andrew to review, but I really like this additional testing for Substrait!
--
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: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Add `--substrait-round-trip` option in sqllogictests [datafusion]
Posted by "gabotechs (via GitHub)" <gi...@apache.org>.
gabotechs commented on PR #16183:
URL: https://github.com/apache/datafusion/pull/16183#issuecomment-2929715787
This one is good for a review! cc @alamb @Blizzara
--
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: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Add `--substrait-round-trip` option in sqllogictests [datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on PR #16183:
URL: https://github.com/apache/datafusion/pull/16183#issuecomment-2945612836
Thank you for the review @2010YOUY01
--
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: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Add `--substrait-round-trip` option in sqllogictests [datafusion]
Posted by "gabotechs (via GitHub)" <gi...@apache.org>.
gabotechs commented on PR #16183:
URL: https://github.com/apache/datafusion/pull/16183#issuecomment-2939578353
> I suggest adding a CI test that exercises this option with a passing .slt file
Something like this https://github.com/apache/datafusion/pull/16183/commits/1a05ba290752813d37df794c80fdee1ca38ccf30?
--
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: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Add `--substrait-round-trip` option in sqllogictests [datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb merged PR #16183:
URL: https://github.com/apache/datafusion/pull/16183
--
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: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Add `--substrait-round-trip` option in sqllogictests [datafusion]
Posted by "findepi (via GitHub)" <gi...@apache.org>.
findepi commented on code in PR #16183:
URL: https://github.com/apache/datafusion/pull/16183#discussion_r2229222493
##########
datafusion/sqllogictest/bin/sqllogictests.rs:
##########
@@ -138,8 +140,22 @@ async fn run_tests() -> Result<()> {
let filters = options.filters.clone();
SpawnedTask::spawn(async move {
- match (options.postgres_runner, options.complete) {
- (false, false) => {
+ match (
+ options.postgres_runner,
+ options.complete,
+ options.substrait_round_trip,
+ ) {
+ (_, _, true) => {
+ run_test_file_substrait_round_trip(
+ test_file,
+ validator,
+ m_clone,
+ m_style_clone,
+ filters.as_ref(),
Review Comment:
good point and i haven't checked that
in the past i've observed some param combinations being ignored...
it's best if the clap does that (prints best error messages), but IMO the code further down should not rely on clap validation (think: args struct could come from some other source) and thus should re-validate.
anyway, that's a nit, since we have the clap validation
--
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: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Add `--substrait-round-trip` option in sqllogictests [datafusion]
Posted by "2010YOUY01 (via GitHub)" <gi...@apache.org>.
2010YOUY01 commented on code in PR #16183:
URL: https://github.com/apache/datafusion/pull/16183#discussion_r2125481070
##########
datafusion/sqllogictest/bin/sqllogictests.rs:
##########
@@ -102,6 +103,11 @@ async fn run_tests() -> Result<()> {
// to stdout and return OK so they can continue listing other tests.
return Ok(());
}
+ if options.substrait_round_trip && (options.postgres_runner || options.complete) {
Review Comment:
This might be helpful. We can perform those compatibility tests within option declarations.
https://docs.rs/clap/latest/clap/struct.ArgGroup.html#method.conflicts_with
##########
datafusion/sqllogictest/README.md:
##########
@@ -291,6 +291,27 @@ Tests that need to write temporary files should write (only) to this
directory to ensure they do not interfere with others concurrently
running tests.
+## Running tests: Substrait round-trip mode
+
+This mode will run all the .slt test files in validation mode, adding a Substrait conversion round-trip for each
+generated DataFusion logical plan (SQL statement → DF logical → Substrait → DF logical → DF physical → execute).
+
+Not all statements will be round-tripped, some statements like CREATE, INSERT, SET or EXPLAIN statements will be
+issued as is, but any other statement will be round-tripped to/from Substrait.
+
+_WARNING_: as there are still a lot of failures in this mode, it is not enforced in the CI, instead, it needs
Review Comment:
I recommend to open a tracking issue, and add the link here.
--
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: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Add `--substrait-round-trip` option in sqllogictests [datafusion]
Posted by "findepi (via GitHub)" <gi...@apache.org>.
findepi commented on code in PR #16183:
URL: https://github.com/apache/datafusion/pull/16183#discussion_r2228350408
##########
datafusion/sqllogictest/bin/sqllogictests.rs:
##########
@@ -138,8 +140,22 @@ async fn run_tests() -> Result<()> {
let filters = options.filters.clone();
SpawnedTask::spawn(async move {
- match (options.postgres_runner, options.complete) {
- (false, false) => {
+ match (
+ options.postgres_runner,
+ options.complete,
+ options.substrait_round_trip,
+ ) {
+ (_, _, true) => {
+ run_test_file_substrait_round_trip(
+ test_file,
+ validator,
+ m_clone,
+ m_style_clone,
+ filters.as_ref(),
Review Comment:
Don't ignore postgres_runner and complete arguments.
Unsupported arg combinations should be an error
--
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: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Add `--substrait-round-trip` option in sqllogictests [datafusion]
Posted by "gabotechs (via GitHub)" <gi...@apache.org>.
gabotechs commented on code in PR #16183:
URL: https://github.com/apache/datafusion/pull/16183#discussion_r2228450157
##########
datafusion/sqllogictest/bin/sqllogictests.rs:
##########
@@ -138,8 +140,22 @@ async fn run_tests() -> Result<()> {
let filters = options.filters.clone();
SpawnedTask::spawn(async move {
- match (options.postgres_runner, options.complete) {
- (false, false) => {
+ match (
+ options.postgres_runner,
+ options.complete,
+ options.substrait_round_trip,
+ ) {
+ (_, _, true) => {
+ run_test_file_substrait_round_trip(
+ test_file,
+ validator,
+ m_clone,
+ m_style_clone,
+ filters.as_ref(),
Review Comment:
I think clap should be taking care of that
https://github.com/apache/datafusion/blob/76ff87b132b62edac207bb1105836a52d32d269e/datafusion/sqllogictest/bin/sqllogictests.rs#L636-L642
As suggested in https://github.com/apache/datafusion/pull/16183#discussion_r2125481070.
If you try to run incompatible commands you would get something like this:
```
error: the argument '--substrait-round-trip' cannot be used with '--complete'
```
--
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: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Add `--substrait-round-trip` option in sqllogictests [datafusion]
Posted by "gabotechs (via GitHub)" <gi...@apache.org>.
gabotechs commented on code in PR #16183:
URL: https://github.com/apache/datafusion/pull/16183#discussion_r2126283562
##########
datafusion/sqllogictest/bin/sqllogictests.rs:
##########
@@ -102,6 +103,11 @@ async fn run_tests() -> Result<()> {
// to stdout and return OK so they can continue listing other tests.
return Ok(());
}
+ if options.substrait_round_trip && (options.postgres_runner || options.complete) {
Review Comment:
Nice! thanks for pointing that out, we've definitely should use that instead
##########
datafusion/sqllogictest/bin/sqllogictests.rs:
##########
@@ -102,6 +103,11 @@ async fn run_tests() -> Result<()> {
// to stdout and return OK so they can continue listing other tests.
return Ok(());
}
+ if options.substrait_round_trip && (options.postgres_runner || options.complete) {
Review Comment:
Nice! thanks for pointing that out, we definitely should use that instead
--
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: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Add `--substrait-round-trip` option in sqllogictests [datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on code in PR #16183:
URL: https://github.com/apache/datafusion/pull/16183#discussion_r2129704959
##########
.github/workflows/rust.yml:
##########
@@ -476,6 +476,28 @@ jobs:
POSTGRES_HOST: postgres
POSTGRES_PORT: ${{ job.services.postgres.ports[5432] }}
+ sqllogictest-substrait:
+ name: "Run sqllogictest in Substrait round-trip mode"
Review Comment:
❤️
--
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: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org