CON:Rust智能合約養成日記：編寫Rust智能合約單元測試用例_MoonTrust

往期回顧：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模塊或代碼塊的頂部。

Huobi Trust聘請前美國國土安全部官員擔任首席運營官:金色財經報道，火幣科技的美國子公司Huobi Trust已聘請前美國國土安全部官員Robert Whitaker擔任首席運營官(COO)。據悉，Whitaker在國土安全部工作了近12年，從2014年到2017年是該機構的非法融資和犯罪收益部門的監督官員，在此期間調查了暗網市場的刑事案件和其他與加密相關的活動。[2021/8/6 1:37: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??}?

Web 3.0登錄服務提供商Torus推出白標服務:官方消息，Web 3.0登錄服務提供商Torus宣布為區塊鏈網絡和品牌提供白標（White-label）的錢包服務，他們表示該服務與任何區塊鏈都可以兼容。雖然此前Torus支持了以太坊、幣安智能鏈、Polygon和xDai等網絡，但是其他希望增加Torus支持的區塊鏈可以通過Torus的白標版本實現，可以利用目前Torus的核心功能，比如反向域名解析器或者法幣通道等。[2021/8/4 1:34:09]

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最大值，并附加到當前的合約調用中。

TrustSwap將于1月推出NFT和ERC20代幣交易平臺SWAPPABLE:TrustSwap宣布將于1月推出NFT和ERC20代幣交易平臺SWAPPABLE。據悉，SWAPPABLE將支持ERC-721和ERC-1155 NFT的鑄造、購買、銷售。[2021/1/3 16:19:59]

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聲明導入。

在定義完函數get_context()后，我們便可以在test模塊中逐個地編寫單元測試的內容了。

2.單元測試一

企業以太坊聯盟 EEA 啟動 EthTrust 安全計劃:企業以太坊聯盟（EEA）宣布組織 EEA EthTrust 安全級別工作組。工作組將由以太坊信任聯盟（ETA）領導。目前智能合約僅需代碼中的一個小缺陷即可立即鎖定或損失數千萬美元，EthTrust 的任務是使組織和個人可輕松判斷智能合約是否已通過專業團隊的全面安全審核，增強以太坊生態的彼此信任。從而進一步提高市場對以太坊的信心，使其成為所有類型交易的全球結算層。[2020/11/20 21:31:41]

如下是單元測試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()的聲明。

動態 | Kleiman訴訟案新文件顯示或存在第二個Tulip Trust:據CoinDesk消息，訴訟案的一份聲明文件詳細說明了澳本聰（Craig Wright）所謂的所有權以及Tulip Trust受托人計劃，該計劃據稱持有超過一百萬比特幣。根據新文件，獲得信托的持有權需要所有受托人的參與，其中至少有一名受托人澳本聰已多年沒有與其聯系過。該法院文件最初于5月8日提交，并指出存在第二個Tulip Trust，即Tulip Trust II。此外，Tulip Trust合并了澳本聰在在2009年至2011年期間挖掘及購買的比特幣。[2019/6/21]

代碼的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)上運行。

Tags：CONCONTONTNEARConcern Poverty ChainContentosMoonTrustnear幣是下一個以太坊嗎

幣贏