Rust测试框架插件cairo-lang-test-plugin的使用，Cairo语言单元测试与智能合约自动化测试解决方案

安装

在项目目录中运行以下Cargo命令：

cargo add cairo-lang-test-plugin

或者在Cargo.toml中添加以下行：

cairo-lang-test-plugin = "2.12.0"

使用示例

以下是内容中提供的两个完整示例：

示例1：基本Cairo合约测试

// 首先引入必要的模块
use cairo_lang_test_plugin::TestPlugin;
use cairo_lang_syntax::node::db::SyntaxGroup;
use cairo_lang_syntax::node::helpers::QueryAttrs;
use cairo_lang_syntax::test_utils::create_test_syntax_db;

// 创建一个测试函数
#[test]
fn test_cairo_contract() {
    // 初始化测试数据库
    let db = &create_test_syntax_db();
    
    // 创建测试插件实例
    let test_plugin = TestPlugin::default();
    
    // 定义要测试的Cairo代码
    let cairo_code = r#"
        %lang starknet
        
        @contract
        fn test_function() -> felt252 {
            42
        }
    "#;
    
    // 使用插件测试代码
    let test_results = test_plugin.test_code(db, cairo_code.to_string());
    
    // 断言测试结果
    assert!(test_results.passed(), "Tests failed: {:?}", test_results);
}

示例2：智能合约完整测试

// 智能合约测试示例
#[test]
fn test_starknet_contract() {
    let db = &create_test_syntax_db();
    let test_plugin = TestPlugin::default();
    
    let contract_code = r#"
        %lang starknet
        
        @storage_var
        func balance() -> (res: felt252) {
        }
        
        @constructor
        func constructor(initial_balance: felt252) {
            balance.write(initial_balance);
        }
        
        @external
        func get_balance() -> (res: felt252) {
            balance.read()
        }
        
        @external
        func set_balance(new_balance: felt252) {
            balance.write(new_balance);
        }
    "#;
    
    // 测试构造函数
    let constructor_test = test_plugin.test_constructor(
        db,
        contract_code.to_string(),
        "constructor(100)"
    );
    assert!(constructor_test.passed());
    
    // 测试getter函数
    let get_test = test_plugin.test_function(
        db,
        contract_code.to_string(),
        "get_balance()"
    );
    assert_eq!(get_test.result().unwrap(), "100");
    
    // 测试setter函数
    let set_test = test_plugin.test_function(
        db,
        contract_code.to_string(),
        "set_balance(200)"
    );
    assert!(set_test.passed());
    
    // 验证状态变化
    let updated_get_test = test_plugin.test_function(
        db,
        contract_code.to_string(),
        "get_balance()"
    );
    assert_eq!(updated_get_test.result().unwrap(), "200");
}

完整示例demo

以下是一个更完整的Cairo智能合约测试示例，包含更多测试场景：

use cairo_lang_test_plugin::TestPlugin;
use cairo_lang_syntax::test_utils::create_test_syntax_db;

#[test]
fn full_contract_test_suite() {
    let db = &create_test_syntax_db();
    let test_plugin = TestPlugin::default();
    
    // 定义完整的智能合约代码
    let contract_code = r#"
        %lang starknet
        
        @storage_var
        func counter() -> (res: felt252) {
        }
        
        @storage_var 
        func owner() -> (res: felt252) {
        }
        
        @constructor
        func constructor(initial_owner: felt252) {
            owner.write(initial_owner);
            counter.write(0);
        }
        
        @external
        fn increment() {
            let current = counter.read();
            counter.write(current + 1);
        }
        
        @external
        fn get_counter() -> (res: felt252) {
            counter.read()
        }
        
        @external
        fn get_owner() -> (res: felt252) {
            owner.read()
        }
        
        @external
        fn transfer_ownership(new_owner: felt252) {
            let current_owner = owner.read();
            assert(current_owner == 12345, "Not owner");
            owner.write(new_owner);
        }
    "#;
    
    // 1. 测试构造函数
    let constructor_test = test_plugin.test_constructor(
        db,
        contract_code.to_string(),
        "constructor(12345)"  // 初始化所有者地址为12345
    );
    assert!(constructor_test.passed());
    
    // 2. 测试初始状态
    let owner_test = test_plugin.test_function(
        db,
        contract_code.to_string(),
        "get_owner()"
    );
    assert_eq!(owner_test.result().unwrap(), "12345");
    
    let counter_test = test_plugin.test_function(
        db,
        contract_code.to_string(),
        "get_counter()"
    );
    assert_eq!(counter_test.result().unwrap(), "0");
    
    // 3. 测试递增功能
    let increment_test = test_plugin.test_function(
        db,
        contract_code.to_string(),
        "increment()"
    );
    assert!(increment_test.passed());
    
    // 验证计数器值增加
    let updated_counter = test_plugin.test_function(
        db,
        contract_code.to_string(),
        "get_counter()"
    );
    assert_eq!(updated_counter.result().unwrap(), "1");
    
    // 4. 测试所有权转移（成功情况）
    let transfer_test = test_plugin.test_function(
        db,
        contract_code.to_string(),
        "transfer_ownership(67890)"
    );
    assert!(transfer_test.passed());
    
    // 验证新所有者
    let new_owner = test_plugin.test_function(
        db,
        contract_code.to_string(),
        "get_owner()"
    );
    assert_eq!(new_owner.result().unwrap(), "67890");
    
    // 5. 测试失败场景 - 非所有者尝试转移
    let fail_transfer = test_plugin.test_function(
        db,
        contract_code.to_string(),
        "transfer_ownership(11111)"
    );
    assert!(!fail_transfer.passed());  // 应失败，因为当前所有者是67890不是12345
}

功能说明

cairo-lang-test-plugin 提供了以下主要功能：

1. 单元测试支持：可以直接测试Cairo函数的功能和返回值
2. 智能合约测试：支持测试StarkNet合约的构造函数、外部函数和存储变量
3. 状态管理：可以在测试过程中跟踪和验证合约状态的变化
4. 断言支持：提供多种断言方法来验证测试结果

测试报告

测试完成后，插件会生成详细的测试报告，包括：

• 通过/失败的测试数量
• 每个测试的执行结果
• 失败测试的错误信息
• 合约状态的变化历史