Rust中在内部作用域编写测试的惯用方式及SQL宏测试方案

核心思路：拆分宏的功能 #

把sql!宏拆分为两个独立部分，分离编译期与运行时的工作：

• 编译期：仅做轻量静态检查（比如SQL语法解析、参数类型校验），完全避免启动数据库
• 运行期：在测试流程中统一执行数据库连接、schema验证和查询有效性测试

具体实现步骤 #

1. 重构sql!宏 #

让宏仅生成查询字符串和必要的类型信息，剥离编译期数据库相关操作：

macro_rules! sql {
    ($query:literal) => {
        $query
    };
}

如果原宏有参数化逻辑，仅保留编译期可完成的部分（比如占位符的类型检查）。

2. 实现查询注册机制 #

创建全局静态集合，在测试模式下自动收集所有sql!调用的查询语句：

use std::sync::Mutex;
use lazy_static::lazy_static;

lazy_static! {
    static ref TEST_QUERIES: Mutex<Vec<&'static str>> = Mutex::new(Vec::new());
}

// 辅助宏：在测试模式下注册查询
macro_rules! register_sql_test {
    ($query:literal) => {
        #[cfg(test)]
        lazy_static! {
            static ref _REG: () = {
                TEST_QUERIES.lock().unwrap().push($query);
            };
        }
    };
}

3. 整合宏与注册逻辑 #

修改sql!宏，在测试模式下自动触发查询注册，不影响生产环境代码：

macro_rules! sql {
    ($query:literal) => {{
        register_sql_test!($query);
        $query
    }};
}

4. 编写统一的测试验证函数 #

在模块根目录编写测试函数，遍历所有注册的查询并执行数据库验证：

#[cfg(test)]
mod tests {
    use super::*;
    use sqlx::PgPool; // 根据你的数据库类型替换（比如MySQL/SQLite）

    #[tokio::test] // 异步数据库驱动需搭配tokio测试
    async fn validate_all_sql_queries() {
        // 初始化测试环境数据库连接池
        let pool = PgPool::connect("postgres://user:pass@localhost/test_db")
            .await
            .unwrap();

        // 遍历所有注册的查询，验证语法与schema兼容性
        for query in TEST_QUERIES.lock().unwrap().iter() {
            pool.prepare(*query)
                .await
                .expect(&format!("Query validation failed: {}", query));
        }
    }
}

方案优势 #

• 编译速度不受影响：编译期仅做轻量检查，完全避免数据库启动开销
• 测试集中管理：所有SQL查询的验证逻辑统一在一处，无需在业务代码中插入测试片段
• 无侵入性：原有业务代码无需大幅修改，仅需调整宏的实现逻辑

替代方案：生成独立测试函数（proc-macro实现） #

如果需要为每个查询生成单独的测试函数（方便单独排查问题），可以使用过程宏实现：

use proc_macro::TokenStream;
use quote::quote;

#[proc_macro]
pub fn sql(input: TokenStream) -> TokenStream {
    let query = input.to_string().trim_matches('"').to_string();

    // 生成生产环境代码：返回查询字符串
    let business_code = quote! { #query };

    // 生成测试代码：为当前查询创建独立测试函数
    let test_code = quote! {
        #[cfg(test)]
        #[tokio::test]
        async fn validate_sql_query() {
            let pool = PgPool::connect("postgres://user:pass@localhost/test_db")
                .await
                .unwrap();
            pool.prepare(#query)
                .await
                .expect("Query validation failed");
        }
    };

    // 合并代码，仅在测试模式下包含测试函数
    quote! {
        #business_code
        #[cfg(test)]
        #test_code
    }.into()
}

这种方式会为每个sql!调用生成独立测试，缺点是编译时会生成更多代码，但测试时可以单独运行某个查询的验证用例。

内容的提问来源于stack exchange，提问作者jm4ier