Skip to content

docs: Add contributor guide page for SQL file tests#3333

Merged
andygrove merged 4 commits intoapache:mainfrom
andygrove:docs-sql-file-tests
Jan 31, 2026
Merged

docs: Add contributor guide page for SQL file tests#3333
andygrove merged 4 commits intoapache:mainfrom
andygrove:docs-sql-file-tests

Conversation

@andygrove
Copy link
Member

@andygrove andygrove commented Jan 29, 2026

Summary

This PR adds documentation for the new testing approach in #3328.

I am creating this separate PR for the docs so that we do not have to run all of the tests every time we change the docs.

  • Add a new page to the contributor guide documenting CometSqlFileTestSuite
  • Covers the .sql file format, all directives (Config, ConfigMatrix, MinSparkVersion), all query assertion modes, how to add new tests, and how to handle failures
  • Add entry to contributor guide table of contents

🤖 Generated with Claude Code

Document the CometSqlFileTestSuite test framework including file format,
directives (Config, ConfigMatrix, MinSparkVersion), query assertion modes,
how to add new tests, and how to handle failures.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@andygrove andygrove changed the title Add contributor guide page for SQL file tests docs: Add contributor guide page for SQL file tests Jan 29, 2026
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
andygrove and others added 2 commits January 31, 2026 10:50
Add guidance on covering all combinations of literal and column arguments,
edge cases, and using agentic coding tools. Move SQL file tests section
higher in the development guide as the recommended approach for expression
testing.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@andygrove andygrove marked this pull request as ready for review January 31, 2026 17:59
Copy link
Contributor

@mbutrovich mbutrovich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks @andygrove!

@andygrove andygrove merged commit fe2de33 into apache:main Jan 31, 2026
1 check passed
@andygrove andygrove deleted the docs-sql-file-tests branch January 31, 2026 19:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants