doc: Add Plan Stability Testing to development guide #432
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kazuyukitanimura
approved these changes
May 14, 2024
| The plan stability testing framework is located in the `spark` module and can be run using the following command: | ||
|
|
||
| ``` | ||
| mvn -pl spark -Dsuites="org.apache.spark.sql.comet.CometTPCDSV1_4_PlanStabilitySuite" test |
There was a problem hiding this comment.
I think we should recommend to use ./mvnw
| mvn -pl spark -Dsuites="org.apache.spark.sql.comet.CometTPCDSV2_7_PlanStabilitySuite" test | ||
| ``` | ||
|
|
||
| If your pull request changes the query plans generated by Comet, you should run the plan stability tests to regenerate the golden files. |
There was a problem hiding this comment.
nit: I guess we can remove run the plan stability tests to
There was a problem hiding this comment.
Should we have a CI check that runs the plan stability tests to generate the golden files and then fail the build if the generated files cause a local diff?
There was a problem hiding this comment.
Actually, never mind. We don't need this because the build would fail anyway if the golden files do not match the output from the test.
There was a problem hiding this comment.
nit: I guess we can remove
run the plan stability tests to
Okay.
andygrove
approved these changes
May 14, 2024
|
Merged. Thanks @kazuyukitanimura @andygrove |
himadripal
pushed a commit
to himadripal/datafusion-comet
that referenced
this pull request
Sep 7, 2024
* doc: Add Plan Stability Testing to development guide * For review (cherry picked from commit 1a04805)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
Closes #.
Rationale for this change
What changes are included in this PR?
How are these changes tested?