Ngone51 opened a new pull request #29270:
URL: https://github.com/apache/spark/pull/29270
<!--
Thanks for sending a pull request! Here are some tips for you:
1. If this is your first time, please read our contributor guidelines:
https://spark.apache.org/contributing.html
2. Ensure you have added or run the appropriate tests for your PR:
https://spark.apache.org/developer-tools.html
3. If the PR is unfinished, add '[WIP]' in your PR title, e.g.,
'[WIP][SPARK-XXXX] Your PR title ...'.
4. Be sure to keep the PR description updated to reflect all changes.
5. Please write your PR title to summarize what this PR proposes.
6. If possible, provide a concise example to reproduce the issue for a
faster review.
7. If you want to add a new configuration, please read the guideline first
for naming configurations in
'core/src/main/scala/org/apache/spark/internal/config/ConfigEntry.scala'.
-->
### What changes were proposed in this pull request?
<!--
Please clarify what changes you are proposing. The purpose of this section
is to outline the changes and how this PR fixes the issue.
If possible, please consider writing useful notes for better and faster
reviews in your PR. See the examples below.
1. If you refactor some codes with changing classes, showing the class
hierarchy will help reviewers.
2. If you fix some SQL features, you can provide some references of other
DBMSes.
3. If there is design documentation, please add the link.
4. If there is a discussion in the mailing list, please add the link.
-->
This PR proposes to detect possible regression inside `SparkPlan`. To
achieve this goal, this PR added a base test suite called
`PlanStabilitySuite`. The basic workflow of this test suite is similar to
`SQLQueryTestSuite`. It also uses `SPARK_GENERATE_GOLDEN_FILES` to decide
whether it should regenerate the golden files or compare to the golden result
for each input query. The difference is, `PlanStabilitySuite` uses the
serialized explain result(.txt format) of the `SparkPlan` as the output of a
query, instead of the data result.
And since `SparkPlan` is non-deterministic for various reasons, e.g.,
expressions ids changes, expression order changes, we'd reduce the plan to a
simplified version that only contains node names and references. And we only
identify those important nodes, e.g., `Exchange`, `SubqueryExec`, in the
simplified plan.
And we'd reuse TPC-DS queries(v1.4, v2.7, modified) to test plans'
stability. Currently, one TPC-DS query can only have one corresponding
simplified golden plan. Though, we've also exposed a parameter called `variant`
to support multiple simplified golden plans in case there would be a query that
has multiple acceptable SparkPlan. And it's also useful for debugging when the
query is not approved by the golden file with the proposed change. In this
case, the developer could set to allow multiple golden plans and check the
difference between them.
This PR also did a few refactor, which extracts `TPCDSBase` from
`TPCDSQuerySuite`. So, `PlanStabilitySuite` can use the TPC-DS queries as well.
### Why are the changes needed?
<!--
Please clarify why the changes are needed. For instance,
1. If you propose a new API, clarify the use case for a new API.
2. If you fix a bug, you can clarify why it is a bug.
-->
Nowadays, Spark is getting more and more complex. Any changes might cause
regression unintentionally. Spark already has some benchmark to catch the
performance regression. But, yet, it doesn't have a way to detect the
regression inside `SparkPlan`. It would be good if we could detect the possible
regression early during the compile phase before the runtime phase.
### 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 Spark versions or within the unreleased branches such as master.
If no, write 'No'.
-->
No.
### 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.
-->
Added `PlanStabilitySuite` and it's subclasses.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]