You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@datafusion.apache.org by gi...@apache.org on 2024/10/30 16:33:11 UTC
(datafusion) branch asf-site updated: Publish built docs triggered by d36c229e03551f55dada8be41fc4646d897c7b78
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.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 63e4b99616 Publish built docs triggered by d36c229e03551f55dada8be41fc4646d897c7b78
63e4b99616 is described below
commit 63e4b996162573053922957f5f3d7f7834386e6a
Author: github-actions[bot] <gi...@users.noreply.github.com>
AuthorDate: Wed Oct 30 16:33:06 2024 +0000
Publish built docs triggered by d36c229e03551f55dada8be41fc4646d897c7b78
---
_sources/contributor-guide/testing.md.txt | 26 +++++++++++++++++++++-----
contributor-guide/testing.html | 17 ++++++++++++-----
searchindex.js | 2 +-
3 files changed, 34 insertions(+), 11 deletions(-)
diff --git a/_sources/contributor-guide/testing.md.txt b/_sources/contributor-guide/testing.md.txt
index 90e39c0057..b955b09050 100644
--- a/_sources/contributor-guide/testing.md.txt
+++ b/_sources/contributor-guide/testing.md.txt
@@ -21,11 +21,27 @@
Tests are critical to ensure that DataFusion is working properly and
is not accidentally broken during refactorings. All new features
-should have test coverage.
+should have test coverage and the entire test suite is run as part of CI.
-DataFusion has several levels of tests in its [Test
-Pyramid](https://martinfowler.com/articles/practical-test-pyramid.html)
-and tries to follow the Rust standard [Testing Organization](https://doc.rust-lang.org/book/ch11-03-test-organization.html) in the The Book.
+DataFusion has several levels of tests in its [Test Pyramid] and tries to follow
+the Rust standard [Testing Organization] described in [The Book].
+
+Run tests using `cargo`:
+
+```shell
+cargo test
+```
+
+You can also use other runners such as [cargo-nextest].
+
+```shell
+cargo nextest run
+```
+
+[test pyramid]: https://martinfowler.com/articles/practical-test-pyramid.html
+[testing organization]: https://doc.rust-lang.org/book/ch11-03-test-organization.html
+[the book]: https://doc.rust-lang.org/book/
+[cargo-nextest]: https://nexte.st/
## Unit tests
@@ -34,7 +50,7 @@ The [test_util](https://github.com/apache/datafusion/tree/main/datafusion/common
## sqllogictests Tests
-DataFusion's SQL implementation is tested using [sqllogictest](https://github.com/apache/datafusion/tree/main/datafusion/sqllogictest) which are run like any other Rust test using `cargo test --test sqllogictests`.
+DataFusion's SQL implementation is tested using [sqllogictest](https://github.com/apache/datafusion/tree/main/datafusion/sqllogictest) which are run like other tests using `cargo test --test sqllogictests`.
`sqllogictests` tests may be less convenient for new contributors who are familiar with writing `.rs` tests as they require learning another tool. However, `sqllogictest` based tests are much easier to develop and maintain as they 1) do not require a slow recompile/link cycle and 2) can be automatically updated via `cargo test --test sqllogictests -- --complete`.
diff --git a/contributor-guide/testing.html b/contributor-guide/testing.html
index 11f7f264cb..00d7eccc39 100644
--- a/contributor-guide/testing.html
+++ b/contributor-guide/testing.html
@@ -617,10 +617,17 @@
<h1>Testing<a class="headerlink" href="#testing" title="Link to this heading">¶</a></h1>
<p>Tests are critical to ensure that DataFusion is working properly and
is not accidentally broken during refactorings. All new features
-should have test coverage.</p>
-<p>DataFusion has several levels of tests in its <a class="reference external" href="https://martinfowler.com/articles/practical-test-pyramid.html">Test
-Pyramid</a>
-and tries to follow the Rust standard <a class="reference external" href="https://doc.rust-lang.org/book/ch11-03-test-organization.html">Testing Organization</a> in the The Book.</p>
+should have test coverage and the entire test suite is run as part of CI.</p>
+<p>DataFusion has several levels of tests in its <a class="reference external" href="https://martinfowler.com/articles/practical-test-pyramid.html">Test Pyramid</a> and tries to follow
+the Rust standard <a class="reference external" href="https://doc.rust-lang.org/book/ch11-03-test-organization.html">Testing Organization</a> described in <a class="reference external" href="https://doc.rust-lang.org/book/">The Book</a>.</p>
+<p>Run tests using <code class="docutils literal notranslate"><span class="pre">cargo</span></code>:</p>
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>cargo<span class="w"> </span><span class="nb">test</span>
+</pre></div>
+</div>
+<p>You can also use other runners such as <a class="reference external" href="https://nexte.st/">cargo-nextest</a>.</p>
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>cargo<span class="w"> </span>nextest<span class="w"> </span>run
+</pre></div>
+</div>
<section id="unit-tests">
<h2>Unit tests<a class="headerlink" href="#unit-tests" title="Link to this heading">¶</a></h2>
<p>Tests for code in an individual module are defined in the same source file with a <code class="docutils literal notranslate"><span class="pre">test</span></code> module, following Rust convention.
@@ -628,7 +635,7 @@ The <a class="reference external" href="https://github.com/apache/datafusion/tre
</section>
<section id="sqllogictests-tests">
<h2>sqllogictests Tests<a class="headerlink" href="#sqllogictests-tests" title="Link to this heading">¶</a></h2>
-<p>DataFusion’s SQL implementation is tested using <a class="reference external" href="https://github.com/apache/datafusion/tree/main/datafusion/sqllogictest">sqllogictest</a> which are run like any other Rust test using <code class="docutils literal notranslate"><span class="pre">cargo</span> <span class="pre">test</span> <span class="pre">--test</span> <span class="pre">sqllogictests</span></code>.</p>
+<p>DataFusion’s SQL implementation is tested using <a class="reference external" href="https://github.com/apache/datafusion/tree/main/datafusion/sqllogictest">sqllogictest</a> which are run like other tests using <code class="docutils literal notranslate"><span class="pre">cargo</span> <span class="pre">test</span> <span class="pre">--test</span> <span class="pre">sqllogictests</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">sqllogictests</span></code> tests may be less convenient for new contributors who are familiar with writing <code class="docutils literal notranslate"><span class="pre">.rs</span></code> tests as they require learning another tool. However, <code class="docutils literal notranslate"><span class="pre">sqllogictest</span></code> based tests are much easier to develop and maintain as they 1) do not require a slow recompile/link [...]
<p>Like similar systems such as <a class="reference external" href="https://duckdb.org/dev/testing">DuckDB</a>, DataFusion has chosen to trade off a slightly higher barrier to contribution for longer term maintainability.</p>
</section>
diff --git a/searchindex.js b/searchindex.js
index 693b20d60e..092cdc3a26 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles": {"!=": [[47, "op-neq"]], "!~": [[47, "op-re-not-match"]], "!~*": [[47, "op-re-not-match-i"]], "!~~": [[47, "id18"]], "!~~*": [[47, "id19"]], "#": [[47, "op-bit-xor"]], "%": [[47, "op-modulo"]], "&": [[47, "op-bit-and"]], "(relation, name) tuples in logical fields and logical columns are unique": [[9, "relation-name-tuples-in-logical-fields-and-logical-columns-are-unique"]], "*": [[47, "op-multiply"]], "+": [[47, "op-plus"]], "-": [[47, "op-minus"]], "/": [[4 [...]
\ No newline at end of file
+Search.setIndex({"alltitles": {"!=": [[47, "op-neq"]], "!~": [[47, "op-re-not-match"]], "!~*": [[47, "op-re-not-match-i"]], "!~~": [[47, "id18"]], "!~~*": [[47, "id19"]], "#": [[47, "op-bit-xor"]], "%": [[47, "op-modulo"]], "&": [[47, "op-bit-and"]], "(relation, name) tuples in logical fields and logical columns are unique": [[9, "relation-name-tuples-in-logical-fields-and-logical-columns-are-unique"]], "*": [[47, "op-multiply"]], "+": [[47, "op-plus"]], "-": [[47, "op-minus"]], "/": [[4 [...]
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datafusion.apache.org
For additional commands, e-mail: commits-help@datafusion.apache.org