Rust TOML测试工具toml-test-harness的使用，高效验证TOML解析器与序列化器

关于toml-test-harness

toml-test-harness是一个用于验证TOML解析器的Cargo测试工具。该工具提供了语言无关的TOML解析器规范验证，并将测试用例作为Rust测试暴露出来。

许可证

可选择以下任一许可证使用：

• Apache License, Version 2.0
• MIT license

使用示例

首先在Cargo.toml中添加依赖：

[dependencies]
toml-test-harness = "1.3.2"

或者运行命令：

cargo add toml-test-harness

下面是一个完整的测试示例，展示如何使用toml-test-harness验证TOML解析器：

// 导入测试框架
use toml_test_harness::Decoder;

// 定义测试模块
#[cfg(test)]
mod tests {
    use super::*;
    
    #[test]
    fn test_toml_decoder() {
        // 示例TOML数据
        let toml_data = r#"
            title = "TOML Example"
            
            [owner]
            name = "Tom Preston-Werner"
            dob = 1979-05-27T07:32:00-08:00
            
            [database]
            server = "192.168.1.1"
            ports = [ 8001, 8001, 8002 ]
            connection_max = 5000
            enabled = true
        "#;
        
        // 使用toml-test-harness解码
        let decoded = Decoder::decode(toml_data).unwrap();
        
        // 验证解码结果
        assert_eq!(decoded["title"], "TOML Example");
        assert_eq!(decoded["owner"]["name"], "Tom Preston-Werner");
        assert_eq!(decoded["database"]["ports"][0], 8001);
        assert_eq!(decoded["database"]["enabled"], true);
    }
}

完整示例demo

以下是一个更完整的示例，展示如何使用toml-test-harness进行解析和序列化测试：

// 导入必要的模块
use toml_test_harness::{Decoder, Encoder};
use serde::{Serialize, Deserialize};

// 定义测试数据结构
#[derive(Debug, Serialize, Deserialize, PartialEq)]
struct Config {
    title: String,
    owner: Owner,
    database: Database,
}

#[derive(Debug, Serialize, Deserialize, PartialEq)]
struct Owner {
    name: String,
    dob: String,
}

#[derive(Debug, Serialize, Deserialize, PartialEq)]
struct Database {
    server: String,
    ports: Vec<u16>,
    connection_max: u32,
    enabled: bool,
}

// 测试模块
#[cfg(test)]
mod tests {
    use super::*;
    
    #[test]
    fn test_toml_roundtrip() {
        // 示例TOML数据
        let toml_data = r#"
            title = "TOML Example"
            
            [owner]
            name = "Tom Preston-Werner"
            dob = "1979-05-27T07:32:00-08:00"
            
            [database]
            server = "192.168.1.1"
            ports = [8001, 8001, 8002]
            connection_max = 5000
            enabled = true
        "#;
        
        // 解析TOML数据
        let decoded = Decoder::decode(toml_data).unwrap();
        
        // 验证解析结果
        assert_eq!(decoded["title"], "TOML Example");
        assert_eq!(decoded["owner"]["name"], "Tom Preston-Werner");
        assert_eq!(decoded["database"]["ports"][0], 8001);
        
        // 将解析结果转换为结构体
        let config: Config = Decoder::decode_to(toml_data).unwrap();
        
        // 验证结构体内容
        assert_eq!(config.title, "TOML Example");
        assert_eq!(config.owner.name, "Tom Preston-Werner");
        assert_eq!(config.database.ports[0], 8001);
        
        // 序列化回TOML
        let serialized = Encoder::encode(&config).unwrap();
        
        // 验证序列化结果可以再次解析
        let config2: Config = Decoder::decode_to(&serialized).unwrap();
        assert_eq!(config, config2);
    }
}

贡献

除非您明确声明，否则任何有意提交给本作品的贡献，如Apache-2.0许可证中所定义，都将按照上述双重许可证许可，不附加任何额外条款或条件。