Skip to content

Commit bd7daff

Browse files
alambcomphead
andauthored
Improve documentation about extended tests (#14320)
* Improve documentation about extended tests * Improvements * clarify extent of overage * Update docs/source/contributor-guide/testing.md --------- Co-authored-by: Oleks V <[email protected]>
1 parent faa8c1b commit bd7daff

File tree

2 files changed

+17
-3
lines changed

2 files changed

+17
-3
lines changed

.github/workflows/extended.yml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,11 @@ concurrency:
2323

2424
# https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows#running-your-pull_request-workflow-when-a-pull-request-merges
2525
#
26-
# this job is intended to only run only on the main branch as it is time consuming
27-
# and should not fail often. However, it is important coverage to ensure correctness
28-
# in the (very rare) event of a hash failure or sqlite query failure.
26+
# These jobs only run on the `main` branch as they are time consuming
27+
# and should not fail often.
28+
#
29+
# We still run them as they provide important coverage to ensure correctness
30+
# in the (very rare) event of a hash failure or sqlite library query failure.
2931
on:
3032
# Run on all commits to main
3133
push:

docs/source/contributor-guide/testing.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,18 @@ Like similar systems such as [DuckDB](https://duckdb.org/dev/testing), DataFusio
5858

5959
DataFusion has integrated [sqlite's test suite](https://sqlite.org/sqllogictest/doc/trunk/about.wiki) as a supplemental test suite that is run whenever a PR is merged into DataFusion. To run it manually please refer to the [README](https://github.com/apache/datafusion/blob/main/datafusion/sqllogictest/README.md#running-tests-sqlite) file for instructions.
6060

61+
## Extended Tests
62+
63+
In addition to the standard CI test suite that is run on all PRs prior to merge,
64+
DataFusion has "extended" tests (defined in [extended.yml]) that are run on each
65+
commit to `main`. These tests rarely fail but take significantly longer to run
66+
than the standard test suite and add important test coverage such as that the
67+
code works when there are hash collisions as well as running the relevant
68+
portions of the entire [sqlite test suite].
69+
70+
[extended.yml]: https://github.com/apache/datafusion/blob/main/.github/workflows/extended.yml
71+
[sqlite test suite]: https://www.sqlite.org/sqllogictest/dir?ci=tip
72+
6173
## Rust Integration Tests
6274

6375
There are several tests of the public interface of the DataFusion library in the [tests](https://github.com/apache/datafusion/tree/main/datafusion/core/tests) directory.

0 commit comments

Comments
 (0)