Docs: Enhance testing documentation with examples and links #18851
+27
−5
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added examples and links for running tests and using test utilities in the contributor guide.
alamb
commented
Nov 20, 2025
| 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`. | ||
| DataFusion's SQL implementation is tested using [sqllogictest](https://github.com/apache/datafusion/tree/main/datafusion/sqllogictest). You can run these tests with a command like this: | ||
|
|
||
| ```shell |
Contributor
Author
There was a problem hiding this comment.
I pulled these examples out to make it clearer to see
| cargo test -p datafusion | ||
| ``` | ||
|
|
||
| The [test_util](https://github.com/apache/datafusion/tree/main/datafusion/common/src/test_util.rs) module provides useful macros to write unit tests effectively, such as [`assert_batches_sorted_eq`] and [`assert_batches_eq`] for RecordBatches and [`assert_contains`] / [`assert_not_contains`] which are used extensively in the codebase. |
comphead
reviewed
Nov 20, 2025
| cargo test --profile=ci --test sqllogictests | ||
| ``` | ||
|
|
||
| ```shell |
Contributor
There was a problem hiding this comment.
wouldbe helpful to include how to run a single test file
cargo test --test sqllogictests -- aggregate.slt
Jefffrey
approved these changes
Nov 21, 2025
Co-authored-by: Jeffrey Vo <jeffrey.vo.australia@gmail.com>
github-merge-queue bot
pushed a commit
that referenced
this pull request
Nov 21, 2025
Updated the contributor guide to include testing information. ## Which issue does this PR close? - part of #7013 ## Rationale for this change Similarly to #18851, I was trying to find the right documentation to point people (and AI tools) at for running the tests wanted to make it easier to find the testing instructions immediately on the contributing landing page: https://datafusion.apache.org/contributor-guide/index.html#development-environment <img width="672" height="153" alt="Screenshot 2025-11-20 at 12 45 35 PM" src="https://github.com/user-attachments/assets/403d7047-fe37-4c78-b108-f56870a5c9ab" /> ## What changes are included in this PR? Add a link to the testing page directly ## Are these changes tested? I ran it locally ## Are there any user-facing changes? <!-- If there are user-facing changes then we may require documentation to be updated before approving the PR. --> <!-- If there are any breaking changes to public APIs, please add the `api change` label. -->
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
Rationale for this change
I was trying to find the right documentation to point people (and AI tools) at for running the tests and found some improvements to the existing testing page that would be nice: https://datafusion.apache.org/contributor-guide/testing.html
What changes are included in this PR?
Added examples and links for running tests and using test utilities in the contributor guide.
Are these changes tested?
I downloaded it locally
Are there any user-facing changes?
Better testing guide