Apache DataFusion 中 sqllogictest 测试失败的本地调试指南

问题背景

在使用 Apache DataFusion 进行开发时，开发者可能会遇到一个常见问题：在本地运行 sqllogictest 测试时出现失败，而这些测试在持续集成(CI)环境中却能顺利通过。这种不一致性给本地开发和调试带来了不便。

问题现象

当开发者在本地执行以下命令时：

cargo test --test sqllogictests

或

cargo test --profile ci --features backtrace --test sqllogictests

测试会失败，并显示类似如下的错误信息：

[SQL] SELECT approx_percentile_cont(0.95, c1) WITHIN GROUP (ORDER BY c3) FROM aggregate_test_100
Error: Execution("1 failures")

根本原因分析

经过深入调查，发现这个问题与错误信息的格式化方式有关。在 CI 环境中，测试会自动设置 RUST_BACKTRACE=1 环境变量，这使得错误信息包含了更详细的堆栈跟踪信息。而在本地运行时，如果没有显式设置这个环境变量，错误信息的格式会有所不同，导致测试断言失败。

具体来说，测试期望的错误信息格式是包含多行详细信息的，但本地运行时产生的错误信息格式较为简洁，因此无法匹配测试的预期结果。

解决方案

开发者可以采用以下两种方法之一来解决这个问题：

1. 临时解决方案：在本地运行测试时显式设置 RUST_BACKTRACE 环境变量

RUST_BACKTRACE=1 cargo test --profile ci --features backtrace --test sqllogictests

2. 永久解决方案：修改测试用例，使其不依赖于 RUST_BACKTRACE 的设置。这需要调整测试中对错误信息的断言，使其能够接受不同格式的错误信息。

技术细节

这个问题涉及到 DataFusion 中 approx_percentile_cont 和 approx_percentile_cont_with_weight 函数的类型检查机制。当传入不兼容的类型参数时，系统会生成详细的错误信息，列出所有可接受的函数签名组合。

在测试中，这些错误信息的精确匹配对于验证函数行为非常重要。然而，错误信息的详细程度会受到 RUST_BACKTRACE 设置的影响，这就导致了本地和 CI 环境中的不一致行为。

最佳实践建议

对于 DataFusion 开发者，建议：

1. 在编写测试时，尽量避免对错误信息格式的严格依赖，特别是那些可能受环境变量影响的部分。

2. 在本地开发环境中，可以设置一致的 RUST_BACKTRACE 配置，或者在 CI 配置中明确指定所需的测试环境。

3. 对于涉及复杂错误信息验证的测试用例，考虑使用更灵活的匹配方式，如正则表达式或部分字符串匹配，而不是完全匹配。

通过理解这个问题及其解决方案，开发者可以更高效地在本地环境中进行 DataFusion 的开发和测试工作，提高开发效率。