Rust Redis测试插件库redis-test的使用指南

介绍

redis-test是一个专为Rust设计的Redis测试插件库，它简化了在Rust项目中与Redis交互的功能测试流程。该库提供了简洁的API来建立Redis连接、执行操作以及清理测试环境，特别适合在单元测试和集成测试场景中使用。

主要特性

• 轻量级Redis连接管理
• 自动清理测试数据
• 支持同步和异步操作
• 内置常用Redis命令的便捷方法
• 测试友好的设计

安装

在Cargo.toml中添加依赖：

[dependencies]
redis-test = "0.1"
redis = "0.22"  # 基础redis库

基本使用方法

1. 同步测试示例

use redis_test::{RedisTest, RedisTestError};

#[test]
fn test_basic_operations() -> Result<(), RedisTestError> {
    // 创建测试实例
    let redis = RedisTest::new()?;
    
    // 设置键值
    redis.set("test_key", "test_value")?;
    
    // 获取值
    let value: String = redis.get("test_key")?;
    assert_eq(value, "test_value");
    
    // 测试完成后自动清理
    Ok(())
}

2. 异步测试示例

use redis_test::{AsyncRedisTest, RedisTestError};

#[tokio::test]
async fn test_async_operations() -> Result<(), RedisTestError> {
    // 创建异步测试实例
    let redis = AsyncRedisTest::new().await?;
    
    // 异步设置键值
    redis.set_async("async_key", "async_value").await?;
    
    // 异步获取值
    let value: String = redis.get_async("async_key").await?;
    assert_eq(value, "async_value");
    
    Ok(())
}

高级用法

自定义Redis连接配置

use redis_test::{RedisTest, RedisTestConfig};

let config = RedisTestConfig {
    host: "127.0.0.1".to_string(),
    port: 6379,
    db: 1,  // 使用特定数据库
    ..Default::default()
};

let redis = RedisTest::with_config(config)?;

测试事务操作

#[test]
fn test_transaction() -> Result<(), RedisTestError> {
    let redis = RedisTest::new()?;
    
    let (value1, value2): (i32, i32) = redis.transaction(|pipe| {
        pipe.set("tx_key1", 42)
            .ignore()
            .set("tx_key2", 24)
            .ignore()
            .get("tx_key1")
            .get("tx_key2")
    })?;
    
    assert_eq(value1, 42);
    assert_eq(value2, 24);
    
    Ok(())
}

测试哈希操作

#[test]
fn test_hash_operations() -> Result<(), RedisTestError> {
    let redis = RedisTest::new()?;
    
    // 设置哈希字段
    redis.hset("user:1", "name", "Alice")?;
    redis.hset("user:1", "age", 30)?;
    
    // 获取哈希字段
    let name: String = redis.hget("user:1", "name")?;
    let age: i32 = redis.hget("user:1", "age")?;
    
    assert_eq(name, "Alice");
    assert_eq(age, 30);
    
    Ok(())
}

完整示例代码

下面是一个完整的测试模块示例，展示了如何使用redis-test进行多种Redis操作测试：

use redis_test::{RedisTest, AsyncRedisTest, RedisTestError, RedisTestConfig};

// 同步测试模块
mod sync_tests {
    use super::*;
    
    #[test]
    fn test_string_operations() -> Result<(), RedisTestError> {
        // 创建测试实例
        let redis = RedisTest::new()?;
        
        // 测试SET/GET命令
        redis.set("my_string", "hello")?;
        let value: String = redis.get("my_string")?;
        assert_eq!(value, "hello");
        
        Ok(())
    }
    
    #[test]
    fn test_list_operations() -> Result<(), RedisTestError> {
        let redis = RedisTest::new()?;
        
        // 测试列表操作
        redis.lpush("my_list", "item1")?;
        redis.lpush("my_list", "item2")?;
        
        let len: i64 = redis.llen("my_list")?;
        assert_eq!(len, 2);
        
        let item: String = redis.lpop("my_list")?;
        assert_eq!(item, "item2");
        
        Ok(())
    }
}

// 异步测试模块
mod async_tests {
    use super::*;
    
    #[tokio::test]
    async fn test_async_set_get() -> Result<(), RedisTestError> {
        let redis = AsyncRedisTest::new().await?;
        
        // 异步设置和获取
        redis.set_async("async_key", 42).await?;
        let value: i32 = redis.get_async("async_key").await?;
        assert_eq!(value, 42);
        
        Ok(())
    }
}

// 使用自定义配置的测试
#[test]
fn test_with_custom_config() -> Result<(), RedisTestError> {
    let config = RedisTestConfig {
        host: "127.0.0.1".to_string(),
        port: 6379,
        db: 2, // 使用数据库2
        prefix: "custom:".to_string(), // 自定义键前缀
        ..Default::default()
    };
    
    let redis = RedisTest::with_config(config)?;
    
    redis.set("config_test", "works")?;
    let value: String = redis.get("config_test")?;
    assert_eq!(value, "works");
    
    Ok(())
}

// 测试事务和哈希组合操作
#[test]
fn test_transaction_with_hash() -> Result<(), RedisTestError> {
    let redis = RedisTest::new()?;
    
    let (name, age): (String, i32) = redis.transaction(|pipe| {
        pipe.hset("user:100", "name", "Bob")
            .ignore()
            .hset("user:100", "age", 35)
            .ignore()
            .hget("user:100", "name")
            .hget("user:100", "age")
    })?;
    
    assert_eq!(name, "Bob");
    assert_eq!(age, 35);
    
    Ok(())
}

清理策略

redis-test默认会在测试完成后自动清理所有创建的键。你也可以自定义清理行为：

let redis = RedisTest::new()
    .auto_clean(false)  // 禁用自动清理
    .prefix("my_test:") // 设置键前缀
    .build()?;

// 手动清理
redis.clean()?;

最佳实践

1. 为不同的测试模块使用不同的Redis数据库或键前缀
2. 在测试前确保Redis服务可用
3. 对于长时间运行的测试，考虑禁用自动清理以检查测试数据
4. 在CI环境中使用专门的测试Redis实例

注意事项

• 该库假设Redis服务器运行在本地默认端口(6379)
• 测试键默认以"test:"作为前缀，可通过配置修改
• 确保测试环境中的Redis服务器版本支持所使用的命令

通过redis-test库，你可以更高效地编写与Redis相关的功能测试，而无需担心测试数据的污染和清理问题。