Rust智能合约养成日记:编写Rust智能合约单元测试用例_CON:CONT

往期回顾:Rust智能合约养成日记合约状态数据定义与方法实现

在上一期BlockSec针对Rust智能合约开发的文章中,我们介绍了如何为合约StatusMessage定义合约状态,并为该合约实现了不同的方法。本期我们将继续基于该合约展开叙述,详细介绍编写单元测试用例的方法,并在本地进行合约的测试。

1.准备单元测试环境

为编写单元测试,首先我们需要在src/lib.rs中加入如下代码,对单元测试进行环境设置:

1?#2?#3?mod?tests?{4????use?super::*;5????use?near_sdk::MockedBlockchain;6????use?near_sdk::{testing_env,?VMContext};78???...9}?

在上述代码的第1-3行中,我们为StatusMessage添加了tests子模块(使用mod关键字声明该新模块),并在该模块的代码片段之前标注了cfg属性宏#。此外,由于Rust的本地单元测试无需获得Wasm代码,因此可为该测试模块配置Rust编译条件#。

代码第4-6行从near_sdk中导入了合约测试环境的相关依赖项。具体观察代码的每一行中,use关键词的用法类似于python语言代码在导入其他所依赖的模块时所使用的import。use声明可创建一个或多个与其他路径同义的局部名称绑定,即通常可使用use关键词来声明引用模块项所需的路径,且这些声明通常可能出现在Rust模块或代码块的顶部。

Ledger新增支持Trust Wallet浏览器插件:2月28日消息,硬件钱包 Ledger 新增支持多链自托管钱包 Trust Wallet 浏览器插件。通过本次合作,Trust wallet 用户将可以通过硬件解决方案为账户增加一层安全保护,Ledger 用户也可以快速灵活访问链上 DApp 和一键式管理多钱包资产,同时实现线上线下钱包的轻松切换。[2023/2/28 12:34:38]

在第4行中,super关键字可用于从当前模块访问父模块StatusMessage,使得能够访问父模块中所定义的功能与方法,如之前我们为StatusMessage合约所定义的方法函数set_status与get_status。第5行使用use关键词引用了nearsdk所提供的模拟区块链MockedBlockchain支持模块,可用于智能合约的测试。第6行则从nearsdk引入了合约测试执行的环境,以及有关测试环境上下文信息格式的支持。

在导入支持NEAR智能合约单元测试所需的外部依赖模块后,我们还需要在测试模块中定义如下函数get_context(),用于配置并返回测试环境中所需使用的上下文信息:VMContext。

1????fn?get_default_context(view_call:?bool)?->?VMContext?{2??????VMContext?{3????????current_account_id:?"alice_near".to_string(),4????????signer_account_id:?"bob_near".to_string(),5????????signer_account_pk:?vec!,6????????predecessor_account_id:?"carol_near".to_string(),7????????input:?vec!,8????????block_index:?0,9????????block_timestamp:?0,10???????account_balance:?0,11???????account_locked_balance:?0,12???????storage_usage:?0,13???????attached_deposit:?0,14???????prepaid_gas:?10u64.pow(18),15???????random_seed:?vec!,16???????is_view:?view_call,17???????output_data_receivers:?vec!,18???????epoch_height:?0,19????}20??}?

SPDR Gold Trust持仓较上日减少3.8吨或0.3%:全球最大黄金ETF--SPDR Gold Trust持仓较上日减少3.8吨或0.3%,当前持仓量为1248.29吨。全球最大白银ETF--iShares Silver Trust持仓较上日减少217.22吨,当前持仓量为17855.07吨。[2020/8/15]

VMContext设定了多个模拟的,合约用户账户信息,以及包括区块高度,区块时间戳,合约存储用量等在内的区块链底层相关的上下文配置信息。

下面首先对VMContext中几处关键的属性配置加以说明:

current_account_id:执行当前合约的帐户。

signer_account_id:触发当前合约函数调用执行的交易签名者。所有的合约调用都是某个交易的结果,且该交易由某个帐户使用其访问密钥(AccessKey)签署,该账户即为signer_account_id。

signer_account_pk:交易签名者所使用的AccessKey公钥(PublicKey)。

predecessor_account_id:当合约的执行属于跨合约调用或回调时,该属性指代了该调用的发起者帐户。而当进行单一的合约内部函数调用时,该值将与signer_account_id一致。

prepaid_gas:在区块链中执行合约时存在一个特点,即用户需要支付一定的交易执行费用(gasfee)。这里的prepaid_gas设定了可供当前交易合约函数调用时所能扣除的Gas最大值,并附加到当前的合约调用中。

声音 | Suterusu郭大治:全部配置BTC不一定是最优策略,还有更好的赛道:今日晚间,Suterusu CSO郭大治做客MXC抹茶社群直播间时表示,“比特币减半行情下的最优策略并不一定是全部配置BTC,市场中还有一些新的热点正在聚集,比如隐私保护赛道,BTC和这类热点的组合应该是一种更为积极的策略。”

MXC抹茶《大佬有话说》AMA是MXC抹茶推出的一档AMA活动,不定期邀请重量级嘉宾在社群进行分享。[2020/2/14]

is_view:该参数is_view(类型为bool)可设置合约函数的调用能否对合约的状态数据进行修改。若该值为ture,则合约函数执行时,合约的状态数据是只读的。反之如果该值为false,则合约的执行环境将允许对合约数据进行修改。

VMContext中其余属性的内容和用法将在后续的文章中详细展开描述。

当执行NEAR合约时,程序可配合一些NEARSDK所提供的相关API读取这些已设置的上下文信息。例如:

near_sdk::env::current_account_id()near_sdk::env::predecessor_account_id()near_sdk::env::signer_account_pk()near_sdk::env::input()near_sdk::env::predecessor_account_id()?

上述API均可返回上下文具体属性的值,这些API可以使用前文所述的use声明导入。

动态 | ConsenSys子公司启动以太坊应用程序TruSat监视卫星轨道:据Geekwire报道,以太坊创业公司ConsenSys的子公司ConsenSys Space已经启动了一个基于以太坊的应用程序TruSat,用于监视卫星的轨道。[2019/10/23]

在定义完函数get_context()后,我们便可以在test模块中逐个地编写单元测试的内容了。

2.单元测试一

如下是单元测试1的代码片段:

1???#2???fn?set_get_message(){3?????let?context?=?get_default_context(false);4?????testing_env!(context);5?????letmut?contract?=?StatusMessage::default();6?????contract.set_status("hello".to_string());7?????assert_eq!(8???????"hello".to_string(),9???????contract.get_status("bob_near".to_string()).unwrap()10????);11??}?

现在我们对测试用例的具体写法展开描述:

上述代码片段的第1行,我们为该单元测试函数标注了#宏,表明这是该单元测试的起点。紧接着第2行,便是该单元测试函数set_get_message()的声明。

动态 | UTRUST与ETC开发团队达成合作:据cryptoninjas报道,加密支付解决方案UTRUST今日宣布,已与ETC开发团队达成合作,双方签署了一份谅解备忘录,将把ETC集成到UTRUST平台上。[2018/9/12]

代码的3-10行即该单元测试函数内部的主要测试逻辑,其中的代码实现首先将调用前面所定义的get_context初始化一个测试环境中所使用的上下文context。此外值得一提的是,由于本单元测试需要向合约的状态数据中写入数据,因此需要为get_context设置参数,将前文所述VMContext中的is_view属性设置为false,否则单元测试内部将引发panic导致测试无法通过。

在设置得到一个合理的合约执行上下文后,代码的第4行将利用该上下文VMContext,使用testing_env!宏初始化一个用于智能合约交互的MockedBlockchain实例。代码的第5行将调用父模块中定义的StatusMessage::default()生成初始化后的合约对象contract。

在后续的代码中,测试会首先调用父模块StatusMessage所定义的set_status方法,在合约状态数据中保存字符串"Hello"。随后再利用get_status从合约状态数据中读取该条数据,并与期望所获得内容进行对比。如果内容相互匹配,则通过该单元测试,若不匹配则会在该测试线程中触发"assertionfailed"类型的panic。

有关单元测试中利用断言assert进行校验的写法描述如下:

assert!(expression)宏可检验boolean值,当且仅当expression表达式所指代的内容为true时则通过检验;assert_eq!(left,right)宏常用于校验是否相等,当且仅当left和right表达式所指代的内容一致时通过校验;assert_ne!(left,right)宏常用于校验是否不同,当且仅当left和right表达式所指代的内容不同时通过校验;

3.单元测试二

如下是单元测试2的代码片段:

1???#2???fn?get_nonexistent_message(){3?????let?context?=?get_default_context(true);4?????testing_env!(context);5?????let?contract?=?StatusMessage::default();6?????assert_eq!(None,?contract.get_status("francis.near".to_string()));7??}?

在第6行的测试中,assert_eq右边的表达式利用合约方法get_status尝试从合约状态数据中查询StatusMessage合约用户francis.near所对应的message信息。但是由于代码的第5行仅仅初始化了整个合约的状态,因此此时的合约数据整体为空,因此其返回值将是None。最终由于该结果符合预期,因此断言正确,可以通过该单元测试。

4.执行测试用例

在编写完上述单元测试后,我们还需要在该StatusMessageRust项目中配置该合约的Cargo.toml文件,即在该文件的小节中添加对near-sdk的依赖。

near-sdk?=?"3.1.0"?

同时我们还需要在src/lib.rs文件的开头处导入这些来自于near_sdk所提供的模块或包:

use?near_sdk::borsh::{self,?BorshDeserialize,?BorshSerialize};use?near_sdk::collections::LookupMap;use?near_sdk::{env,?near_bindgen};?

在配置完合约项目的依赖后,我们便可以利用cargo执行所有的单元测试用例。具体的命令如下:

$cargo?test?--package?status-message?

测试将返回具体的测试结果:

testresult:ok.?2?passed;?0?failed;?0?ignored;?0?measured;?0?filteredout;finished?in0.00s?

此外,我们还可以单独指定单元测试的运行:

$cargo?test?--package?status-messageset_get_message?

同样地,我们可以获得单独测试的结果:

testresult:ok.?1?passed;?0?failed;?0?ignored;?0?measured;?1?filteredout;finished?in0.00s?

本期总结和预告

这是BlockSec针对Rust合约开发的第二期blog,本期我们介绍了如何编写单元测试用例,以及在本地进行测试的方法。下一期我们将进一步描述如何编译合约代码生成WASM目标代码,并最终部署到NEAR测试链(testnet)上运行。

郑重声明: 本文版权归原作者所有, 转载文章仅为传播更多信息之目的, 如作者信息标记有误, 请第一时间联系我们修改或删除, 多谢。

水星链

[0:15ms0-1:645ms