[SPARK-21914] Running examples as tests in SQL builtin function documentation

• Type: Test
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 2.3.0
• Fix Version/s: 3.0.0
• Component/s: SQL
• Assignee: Max Gekk
• Reporter: Hyukjin Kwon
• Created: 05/Sep/17 01:07
• Updated: 12/Dec/22 18:11
• Resolved: 27/Sep/19 12:31

Description

It looks we have added many examples in ExpressionDescription for builtin functions.
Actually, if I have seen correctly, we have fixed many examples so far in some minor PRs and sometimes require to add the examples as tests sql and golden files.

As we have formatted examples in ExpressionDescription.examples - https://github.com/apache/spark/blob/ba327ee54c32b11107793604895bd38559804858/sql/catalyst/src/main/java/org/apache/spark/sql/catalyst/expressions/ExpressionDescription.java#L44-L50, and we have `SQLQueryTestSuite`, I think we could run the examples as tests like Python's doctests.

Rough way I am thinking:

1. Loads the example in ExpressionDescription.
2. identify queries by >.
3. identify the rest of them as the results.
4. run the examples by reusing SQLQueryTestSuite if possible.
5. compare the output by reusing SQLQueryTestSuite if possible.

Advantages of doing this I could think for now:

• Reduce the number of PRs to fix the examples
• De-duplicate the test cases that should be added into sql and golden files.
• Correct documentation with correct examples.
• Reduce reviewing costs for documentation fix PRs.

Issue Links

• is duplicated by: SPARK-29242 Check results of expression examples automatically
• is related to: SPARK-24378 Incorrect examples for date_trunc function in spark 2.3.0
• links to: GitHub Pull Request #25942
• links to: GitHub Pull Request #25956