This is an automated email from the ASF dual-hosted git repository.
viirya pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/datafusion-comet.git
The following commit(s) were added to refs/heads/main by this push:
new 1a04805b doc: Add Plan Stability Testing to development guide (#432)
1a04805b is described below
commit 1a04805be5e0f3a634521a821b24c0e0efb43d31
Author: Liang-Chi Hsieh <[email protected]>
AuthorDate: Tue May 14 18:28:03 2024 -0700
doc: Add Plan Stability Testing to development guide (#432)
* doc: Add Plan Stability Testing to development guide
* For review
---
docs/source/contributor-guide/development.md | 28 +++++++++++++++++++++++++++-
1 file changed, 27 insertions(+), 1 deletion(-)
diff --git a/docs/source/contributor-guide/development.md
b/docs/source/contributor-guide/development.md
index b0d247c0..0121d9f4 100644
--- a/docs/source/contributor-guide/development.md
+++ b/docs/source/contributor-guide/development.md
@@ -80,11 +80,37 @@ argument, for example if you only want to execute the test
cases that contains *
in their name in `org.apache.comet.CometCastSuite` you can use
```sh
-mvn test -Dsuites="org.apache.comet.CometCastSuite valid"
-Dskip.surefire.tests=true
+./mvnw test -Dsuites="org.apache.comet.CometCastSuite valid"
-Dskip.surefire.tests=true
```
Other options for selecting specific suites are described in the [ScalaTest
Maven Plugin
documentation](https://www.scalatest.org/user_guide/using_the_scalatest_maven_plugin)
+## Plan Stability Testing
+
+Comet has a plan stability testing framework that can be used to test the
stability of the query plans generated by Comet.
+The plan stability testing framework is located in the `spark` module and can
be run using the following command:
+
+```sh
+./mvnw -pl spark
-Dsuites="org.apache.spark.sql.comet.CometTPCDSV1_4_PlanStabilitySuite" test
+```
+
+and
+```sh
+./mvnw -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
regenerate the golden files.
+To regenerate the golden files, you can run the following command:
+
+```sh
+SPARK_GENERATE_GOLDEN_FILES=1 ./mvnw -pl spark
-Dsuites="org.apache.spark.sql.comet.CometTPCDSV1_4_PlanStabilitySuite" test
+```
+
+and
+```sh
+SPARK_GENERATE_GOLDEN_FILES=1 ./mvnw -pl spark
-Dsuites="org.apache.spark.sql.comet.CometTPCDSV2_7_PlanStabilitySuite" test
+```
+
## Benchmark
There's a `make` command to run micro benchmarks in the repo. For
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
