This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/datafusion-comet.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 95cede41 Publish built docs triggered by
1a04805be5e0f3a634521a821b24c0e0efb43d31
95cede41 is described below
commit 95cede41fac0094e4a623a2ae365239e034e1865
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Wed May 15 01:28:29 2024 +0000
Publish built docs triggered by 1a04805be5e0f3a634521a821b24c0e0efb43d31
---
_sources/contributor-guide/development.md.txt | 28 ++++++++++++++++++++++++++-
contributor-guide/development.html | 28 ++++++++++++++++++++++++++-
searchindex.js | 2 +-
3 files changed, 55 insertions(+), 3 deletions(-)
diff --git a/_sources/contributor-guide/development.md.txt
b/_sources/contributor-guide/development.md.txt
index b0d247c0..0121d9f4 100644
--- a/_sources/contributor-guide/development.md.txt
+++ b/_sources/contributor-guide/development.md.txt
@@ -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
diff --git a/contributor-guide/development.html
b/contributor-guide/development.html
index 58e9048a..f413a7d2 100644
--- a/contributor-guide/development.html
+++ b/contributor-guide/development.html
@@ -283,6 +283,11 @@ under the License.
</li>
</ul>
</li>
+ <li class="toc-h2 nav-item toc-entry">
+ <a class="reference internal nav-link" href="#plan-stability-testing">
+ Plan Stability Testing
+ </a>
+ </li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#benchmark">
Benchmark
@@ -406,12 +411,33 @@ However if the tests is related to the native side.
Please make sure to run <cod
<p>It is possible to specify which ScalaTest suites you want to run from the
CLI using the <code class="docutils literal notranslate"><span
class="pre">suites</span></code>
argument, for example if you only want to execute the test cases that contains
<em>valid</em>
in their name in <code class="docutils literal notranslate"><span
class="pre">org.apache.comet.CometCastSuite</span></code> you can use</p>
-<div class="highlight-sh notranslate"><div
class="highlight"><pre><span></span>mvn<span class="w"> </span><span
class="nb">test</span><span class="w"> </span>-Dsuites<span
class="o">=</span><span class="s2">"org.apache.comet.CometCastSuite
valid"</span><span class="w"> </span>-Dskip.surefire.tests<span
class="o">=</span><span class="nb">true</span>
+<div class="highlight-sh notranslate"><div
class="highlight"><pre><span></span>./mvnw<span class="w"> </span><span
class="nb">test</span><span class="w"> </span>-Dsuites<span
class="o">=</span><span class="s2">"org.apache.comet.CometCastSuite
valid"</span><span class="w"> </span>-Dskip.surefire.tests<span
class="o">=</span><span class="nb">true</span>
</pre></div>
</div>
<p>Other options for selecting specific suites are described in the <a
class="reference external"
href="https://www.scalatest.org/user_guide/using_the_scalatest_maven_plugin";>ScalaTest
Maven Plugin documentation</a></p>
</section>
</section>
+<section id="plan-stability-testing">
+<h2>Plan Stability Testing<a class="headerlink" href="#plan-stability-testing"
title="Link to this heading">¶</a></h2>
+<p>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 <code class="docutils
literal notranslate"><span class="pre">spark</span></code> module and can be
run using the following command:</p>
+<div class="highlight-sh notranslate"><div
class="highlight"><pre><span></span>./mvnw<span class="w"> </span>-pl<span
class="w"> </span>spark<span class="w"> </span>-Dsuites<span
class="o">=</span><span
class="s2">"org.apache.spark.sql.comet.CometTPCDSV1_4_PlanStabilitySuite"</span><span
class="w"> </span><span class="nb">test</span>
+</pre></div>
+</div>
+<p>and</p>
+<div class="highlight-sh notranslate"><div
class="highlight"><pre><span></span>./mvnw<span class="w"> </span>-pl<span
class="w"> </span>spark<span class="w"> </span>-Dsuites<span
class="o">=</span><span
class="s2">"org.apache.spark.sql.comet.CometTPCDSV2_7_PlanStabilitySuite"</span><span
class="w"> </span><span class="nb">test</span>
+</pre></div>
+</div>
+<p>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:</p>
+<div class="highlight-sh notranslate"><div
class="highlight"><pre><span></span><span
class="nv">SPARK_GENERATE_GOLDEN_FILES</span><span class="o">=</span><span
class="m">1</span><span class="w"> </span>./mvnw<span class="w">
</span>-pl<span class="w"> </span>spark<span class="w"> </span>-Dsuites<span
class="o">=</span><span
class="s2">"org.apache.spark.sql.comet.CometTPCDSV1_4_PlanStabilitySuite"</span><span
class="w"> </span><span class="nb">test</span>
+</pre></div>
+</div>
+<p>and</p>
+<div class="highlight-sh notranslate"><div
class="highlight"><pre><span></span><span
class="nv">SPARK_GENERATE_GOLDEN_FILES</span><span class="o">=</span><span
class="m">1</span><span class="w"> </span>./mvnw<span class="w">
</span>-pl<span class="w"> </span>spark<span class="w"> </span>-Dsuites<span
class="o">=</span><span
class="s2">"org.apache.spark.sql.comet.CometTPCDSV2_7_PlanStabilitySuite"</span><span
class="w"> </span><span class="nb">test</span>
+</pre></div>
+</div>
+</section>
<section id="benchmark">
<h2>Benchmark<a class="headerlink" href="#benchmark" title="Link to this
heading">¶</a></h2>
<p>There’s a <code class="docutils literal notranslate"><span
class="pre">make</span></code> command to run micro benchmarks in the repo. For
diff --git a/searchindex.js b/searchindex.js
index 32a410b3..47e36fcc 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles": {"ANSI mode": [[5, "ansi-mode"]], "ASF Links":
[[4, null]], "Additional Info": [[1, "additional-info"]], "After your debugging
is done": [[1, "after-your-debugging-is-done"]], "Apache DataFusion Comet":
[[4, "apache-datafusion-comet"]], "Architecture": [[11, "architecture"]],
"Asking for Help": [[0, "asking-for-help"]], "Benchmark": [[2, "benchmark"]],
"Build & Test": [[2, "build-test"]], "Building From Source": [[9,
"building-from-source"]], "CLion": [[2, " [...]
\ No newline at end of file
+Search.setIndex({"alltitles": {"ANSI mode": [[5, "ansi-mode"]], "ASF Links":
[[4, null]], "Additional Info": [[1, "additional-info"]], "After your debugging
is done": [[1, "after-your-debugging-is-done"]], "Apache DataFusion Comet":
[[4, "apache-datafusion-comet"]], "Architecture": [[11, "architecture"]],
"Asking for Help": [[0, "asking-for-help"]], "Benchmark": [[2, "benchmark"]],
"Build & Test": [[2, "build-test"]], "Building From Source": [[9,
"building-from-source"]], "CLion": [[2, " [...]
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
