关键词：
Solidity智能合约单元测试介绍
当前在各种区块链中，生态最全的要属兼容EVM的区块链，在该类区块链上的智能合约绝大部分使用Solidity编写。因此，对Solidity编写的智能合约进行单元测试便成为一项经常性的工作。本文简要的介绍一下怎样使用hardhat进行Solidity智能合约单元测试。
一、什么是Hardhat
我们来看其官方文档的描述:
Hardhat is a development environment to compile, deploy, test, and debug your Ethereum software.
意思为 Hardhat是一个编译，部署，测试和调试以太坊程序的开发环境，在这里本文只涉及到其测试功能。
在Hardhat之前，我们使用truffle做为开发、部署和测试环境。作为后来者，Hardhat的功能更强大，因此现在我们一般使用Hardhat来作为智能合约开发和测试工具。
官方文档介绍了两种测试方式：ethers.js + Waffle和Web3.js + Truffle。在这里我们使用ethers.js + Waffle模式。
二、测试内容
我们进行单元测试，经常性的测试内容有：
- 状态检查，例如合约部署后检查初始状态是否正确，函数调用后检查状态是否改变。一般状态检查为读取view函数。
- 事件触发。基本上，合约中的关键操作都应该触发事件进行相应追踪。在单元测试中了可以测试事件是否触发，抛出的参数是否正确。
- 交易重置。在测试一些非预期条件时，交易应当重置并给出相应的原因。使用单元测试可以检测是否重置及错误原因是否相同。
- 函数计算。例如要计算不同条件下某函数的返回值（例如奖励值），我们需要循环调用 某个函数并输入不同的参数，看是否结果相符。
- 完全功能测试。例如我们合约中涉及到了区块高度或者 区块时间，比如质押一年后才能提取。此时我们一般需要加速区块时间或者区块高度来进行测试。幸运的是，
hardhat提供了接口可以方便的进行此项测试。 - 测试覆盖率。包含代码覆盖率，函数覆盖率和分支覆盖率。一般情况下，应该追求 100%完全覆盖。比如你写了一个
modifier，但是忘记加到函数上去了，而单元测试也漏掉了，此时代码覆盖就会显示该代码未测试，这样可以发现一些简单的BUG。特殊情况下或者确定有代码不会执行的情况下，不追求100%覆盖率。
接下来我们来详细介绍每项内容的测试方法。
三、示例合约
我们按照官方介绍新建一个示例工程Greeting。在工作目录下运行下列命令：
mkdir Greeting
cd Greeting
npm install --save-dev hardhat
npx hardhat
此时选择第二项，创建一个高级示例项目（当然也可以选第3项使用typescrit）,等待依赖库安装完毕。
运行code .使用vocode打开当前目录。
我们可以看到项目的contracts目录下已经生成了一个示例合约Greeter.sol，内容如下：
//SPDX-License-Identifier: Unlicense
pragma solidity ^0.8.0;
import "hardhat/console.sol";
contract Greeter
string private greeting;
constructor(string memory _greeting)
console.log("Deploying a Greeter with greeting:", _greeting);
greeting = _greeting;
function greet() public view returns (string memory)
return greeting;
function setGreeting(string memory _greeting) public
console.log("Changing greeting from '%s' to '%s'", greeting, _greeting);
greeting = _greeting;
代码比较简单，需要注意的是它使用了一个hardhat/console.sol插件，该插件可以在hardhat netwrok环境中打印出相应的值，方便开发时调试。可以看到，它支持占位符模式。
进一步查看其文档，它实现了类似Node.js的console.log格式，其底层调用是util.format。这里我们看到它只使用了%s这一种占位符。
四、示例测试
打开项目根目录下的test目录，我们可以看到有一个sample-test.js的文件，其内容如下:
const expect = require("chai");
const ethers = require("hardhat");
describe("Greeter", function ()
it("Should return the new greeting once it's changed", async function ()
const Greeter = await ethers.getContractFactory("Greeter");
const greeter = await Greeter.deploy("Hello, world!");
await greeter.deployed();
expect(await greeter.greet()).to.equal("Hello, world!");
const setGreetingTx = await greeter.setGreeting("Hola, mundo!");
// wait until the transaction is mined
await setGreetingTx.wait();
expect(await greeter.greet()).to.equal("Hola, mundo!");
);
);
这里的测试也比较简单，一般使用describe来代表测试某个项目或者功能，使用it来代表具体某项测试。注意，describe和it是函数，在javascript中，一切都是函数。因此，我们可以在describe中再次嵌套describe，这样最外层的describe代表整个项目，内部的describe代表某项目功能。
在该测试文件中，先进行了合约的部署，然后验证合约的状态变量greeting是否为部署时提供的Hello, world!。然后运行setGreeting函数改变问候语为Hola, mundo!，并再次验证更改后的greeting。
五、运行测试
我们运行npx hardhat test ./test/sample-test.js，结果如下：
Compiled 2 Solidity files successfully
Greeter
Deploying a Greeter with greeting: Hello, world!
Changing greeting from 'Hello, world!' to 'Hola, mundo!'
✔ Should return the new greeting once it's changed (946ms)
1 passing (949ms)
这里可以看到，我们打印出来了两个日志，刚好是我们合约中的console.log语句。
六、测试console
这里，console.log支持的数据类型有限，它仅支持4种数据类型：
- uint
- string
- bool
- address
但是它又提供了额外的API来支持其它类型，如console.logBytes(bytes memory b)等。详情见https://hardhat.org/hardhat-network/reference/#console-log 。
我们来简单测试一下，在Greeter.sol中添加如下函数：
function testConsole() public view returns(bool)
console.log("Caller is '%s'", msg.sender);
console.log("Caller is '%d'", msg.sender);
console.log("Caller is ", msg.sender);
console.log("Number is '%s'", 0xff);
console.log("Number is '%d'", 0xff);
console.logBytes1(bytes1(0xff));
console.logBytes(abi.encode(msg.sender));
console.log("Reslut is ", true);
return true;
在sample-test.js中添加一行代码expect(await greeter.testConsole()).to.be.equal(true);，再次运行npx hardhat test ./test/sample-test.js，结果如下：
Compiled 1 Solidity file successfully
Greeter
Deploying a Greeter with greeting: Hello, world!
Changing greeting from 'Hello, world!' to 'Hola, mundo!'
Caller is '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266'
Caller is '1.3908492957860717e+48'
Caller is 0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266
Number is '255'
Number is '255'
0xff
0x000000000000000000000000f39fd6e51aad88f6f4ce6ab8827279cfffb92266
Reslut is true
✔ Should return the new greeting once it's changed (707ms)
1 passing (709ms)
可以看到，当我们把地址类型当成整数打印时，它打印了对应的整数值。通常情况下，对于console.log支持的四种类型，我们可以不使用通配符或者全部使用%s作为字符串输出,特殊类型的数据使用相应的API进行打印。
七、事件测试
我们知道，合约中重要的操作基本上都会触发事件，因此，捕获抛出的事件并检查事件中的参数也是一项经常性的工作。在合约中添加如下代码。
function eventTest() public
emit CallerEmit(msg.sender, 500);
我们这次修改我们的测试文件，将各功能均写一个describe来进行，代码如下:
const expect, util, assert = require("chai");
const ethers = require("hardhat");
describe("Greeter", function ()
let greeter;
let owner, user1, users;
beforeEach(async () =>
[owner, user1, ...users] = await ethers.getSigners();
const Greeter = await ethers.getContractFactory("Greeter");
greeter = await Greeter.deploy("Hello, world!");
await greeter.deployed();
);
describe("State check test", function ()
it("Should return the new greeting once it's changed", async function ()
expect(await greeter.greet()).to.equal("Hello, world!");
const setGreetingTx = await greeter.setGreeting("Hola, mundo!");
// wait until the transaction is mined
await setGreetingTx.wait();
expect(await greeter.greet()).to.equal("Hola, mundo!");
);
);
describe("Console test", function ()
it("Console.log should be successful", async function ()
expect(await greeter.testConsole()).to.be.equal(true);
);
);
describe("Event test", function ()
it("owner emit test", async () =>
await expect(greeter.eventTest())
.to.be.emit(greeter, "CallerEmit")
.withArgs(owner.address, 500);
);
it("user1 emit test", async () =>
await expect(greeter.connect(user1).eventTest())
.to.be.emit(greeter, "CallerEmit")
.withArgs(user1.address, 500);
);
it("Get emit params test", async () =>
const tx = await greeter.connect(users[0]).eventTest();
await tx.wait();
const receipt = await ethers.provider.getTransactionReceipt(tx.hash);
const hash = ethers.utils.solidityKeccak256(
["string"],
["CallerEmit(address,uint256)"]
);
const infos = receipt.logs[0];
assert.equal(infos.topics[0], hash);
const sender = ethers.utils.getAddress(
"0x" + infos.topics[1].substring(26)
);
assert.equal(sender, users[0].address);
const value = ethers.BigNumber.from(infos.data);
expect(value).to.be.equal(500);
);
);
);
可以看到，我们测试事件时进行了三项测试，分别为：
- 正常测试，主要是检查事件是否触发，参数是否正确。
- 同上，主要是切换合约调用者为
user1。 - 这里是解析事件来获取事件参数，此场景应用于某些事件参数无法提前获取等，比如一个伪随机数。
八、重置测试
我们来测试条件不满足时的交易重置，在合约中添加如下代码：
function revertTest(uint a, uint b) public
require(a > 10, "a <= 10");
if(b > 10)
revert("b > 10 ");
else
revert();
注意：这里会有编译警告，提示我们最后一个revert缺少提示字符串，我们是故意这样的，请忽略它。
在测试文件中添加如下describe：
describe("Revert test", function ()
it("a < 10 should be failed", async () =>
await expect(greeter.revertTest(5, 5)).to.be.revertedWith("a <= 10");
);
it("b > 10 should be failed", async () =>
await expect(greeter.revertTest(15, 55)).to.be.revertedWith("b > 10");
);
it("b < 10 should be failed", async () =>
await expect(greeter.revertTest(15, 5)).to.be.reverted;
);
);
然后我们运行测试通过。
九、区块测试
当我们合约中的内容涉及到区块时，一般需要进行相应区块高度或者区块时间的条件测试。先在测试合约中添加如下内容：
function blockNumberTest() public
require(block.number >= 10000,"not matched block number");
console.log("block number: %d", block.number);
function blockTimeTest() public
require(block.timestamp >= 1750631915,"not matched block time");
console.log("block timestamp: %d", block.timestamp);
编译时会提示上面两个函数为view函数，但是如果我们把它标记为view函数，那么测试时便不会mine一个新区块。为了模拟真实场景，我们不把它标记为view函数，从而在调用时产生一个新的区块。
然后在测试文件中增加如下describe：
describe("Block test", () =>
let block;
let timestamp;
// 用来去除16进制的左边自动补零
function convertNum(num)
let big = ethers.BigNumber.from("" + num)
let str = big.toHexString()
let index = 0
for(let i=2;i<str.length;i++)
if(str[i] !== "0")
index = i;
break;
if(index === 0)
return str;
else
return str.substring(0,2) + str.substring(index)
beforeEach(async () =>
block = await ethers.provider.getBlockNumber();
timestamp = (await ethers.provider.getBlock(block)).timestamp;
);
// 注意，这里hardhat network 默认是一秒一个区块
it("Call before timestamp 1651631915 should be failed", async () =>
assert.ok(timestamp < 1651631915);
await expect(greeter.blockTimeTest()).to.be.revertedWith(
"not matched block time"
);
);
it("Call at timestamp 1651631915 should be successfult", async () =>
await ethers.provider.send("evm_mine", [1651631915 - 1]);
await greeter.blockTimeTest();
);
it("Call before block 10000 should be failed", async () =>
assert.ok(block < 10000);
await expect(greeter.blockNumberTest()).to.be.revertedWith(
"not matched block number"
);
);
it("Call at block 10000 should be successful", async () =>
let value = 10000 - block - 1;
//快速推进到100000区块前一个
await ethers.provider.send("hardhat_mine", [convertNum(value]);
await greeter.blockNumberTest();
);
);
注意，在上面的子describe中又使用了beforeEach函数。这里讲一下beforeEach和before的区别，beforeEach 顾名思义，在每项it测试前都会执行一次；而before，在一个describe中只会执行一次。
这里it函数要使用的describe函数内的变量都放在describe中定义，通常我们测试时会使用一个全新的状态，所以一般使用beforeEach而不是before。但特殊场景会有时会使用before，比如后面的测试依赖于前面的测试结果的。
执行测试后输出的结果显示，我们确定是在block == 10000和timestamp == 5555555555调用了相应的函数。
这里，我们采用的是hardhat自动出块策略。此时，每笔交易不管成功还是失败，都会出一个块，并且每个区块内就只有一个交易。但是如果我们想一个区块内包含多个交易怎么办？hardhat也提供了相应的rpc接口，例如evm_setAutomine和evm_setIntervalMining来模拟真实的出块场景。
我们在测试合约中增加如下代码：
uint public curBlock;
uint public counter;
modifier oneBlock()
if(curBlock != 0)
require(block.number == curBlock,"not in one block");
_;
if(curBlock == 0)
curBlock = block.number;
function addCounter() external oneBlock
counter ++;
这里增加了一个函数addCounter用来在一个区块内改变记数器。如果不在一个区块内，则会revert。
相应的测试文件增加如下代码，在Block test里增加：
it("addCounter test", async () =>
expect(await greeter.counter()).to.be.equal(0);
expect(await greeter.curBlock())第一行代码：以太坊-使用solidity语言开发和测试智能合约(代码片段)
智能合约是以太坊的核心之一，用户可以利用智能合约实现更灵活的代币以及其他DApp。不过在深入讲解如何开发智能合约之前，需要先介绍一下以太坊中用于开发智能合约的Solidity语言，以及相关的开发和测试环境。智能合约就... 查看详情
智能合约语言solidity教程系列5-数组介绍(代码片段)
...的文章列表请查看分类-Solidity。写在前面Solidity是以太坊智能合约编程语言，阅读本文前，你应该对以太坊、智能合约有所了解，如果你还不了解，建议你先看以太坊是什么本文前半部分是参考Solidity官方文档（当前最新版本：0.... 查看详情
智能合约语言solidity教程系列1-类型介绍(代码片段)
...的都比它好，大家还是别看了。写在前面Solidity是以太坊智能合约编程语言，阅读本文前，你应该对以太坊、智能合约有所了解，如果你还不了解，建议你先看以太坊是什么Solidity教程会是一系列文章，本文是第一篇：介绍Solidity... 查看详情
第一行代码：以太坊-使用更多的工具编写和测试智能合约(代码片段)
...文中已经使用了Remix环境运行和测试了本书编写的第一个智能合约程序，不过编写和测试智能合约的测试方式很多，例如，在testrpc环境测试；在IntellijIDEA集成开发环境中用Solidity语言编写智能合约；在纯Web环境中测试智能合约；... 查看详情
智能合约语言solidity教程系列3-函数类型(代码片段)
...的文章列表请查看分类-Solidity。写在前面Solidity是以太坊智能合约编程语言，阅读本文前，你应该对以太坊、智能合约有所了解，如果你还不了解，建议你先看以太坊是什么本文前半部分是参考Solidity官方文档（当前最新版本：0.... 查看详情
solidity开发以太坊代币智能合约(代码片段)
智能合约开发是以太坊编程的核心之一，而代币是区块链应用的关键环节，下面我们来用solidity语言开发一个代币合约的实例，希望对大家有帮助。以太坊的应用被称为去中心化应用（DApp），DApp的开发主要包括两大部分：智能... 查看详情
solidity：智能合约结构介绍(代码片段)
...声明。其中SPDX-License-Identifier(SPDX许可标示)是标注当前的智能合约采用什么样的对外开放标准，该标准规定了别人是否拥有商业开发，学习使用等权利。代码中使用的MIT规定了其他人随便用该代码，但出问题不负责。M... 查看详情
智能合约语言solidity教程系列9-错误处理(代码片段)
...请扫描下面的二维码查看。 写在前面Solidity是以太坊智能合约编程语言，阅读本文前，你应该对以太坊、智能合约有所了解，如果你还不了解，建议你先看以太坊是什么欢迎订阅区块链技术专栏阅读更全面的分析文章。什么... 查看详情
创建hardhat工程,用于solidity测试(代码片段)
hardhat是一个专门用来进行Solidity智能合约开发、部署和测试的软件工具集，它既可以像ganache一样，在本地自动化部署一个以太坊网络，又可以像truffle一样，快捷的部署、测试和调试Solidity智能合约。即hardhat&#... 查看详情
智能合约语言solidity教程系列7-以太单位及时间单位(代码片段)
...的文章列表请查看分类-Solidity。写在前面Solidity是以太坊智能合约编程语言，阅读本文前，你应该对以太坊、智能合约有所了解，如果你还不了解，建议你先看以太坊是什么货币单位（EtherUnits）一个数字常量（字面量）后面跟随... 查看详情
智能合约从入门到精通：调用数据的布局和abi(代码片段)
简介：本文将介绍Solidity语言的调用数据的布局和ABI详解。其中调用数据的布局将主要介绍以太坊合约间调用时的消息格式ABI。好久时间没有更新文章，前文中我们介绍了Solidity的特性与内部机制，本文我们将Solidity的调用数据的... 查看详情
—solidity中的helloword(代码片段)
...文章---solidity中的HelloWord前言一、solidity是什么？二、智能合约的HelloWorld1.引入solidity版本2.编写空合约练习时间前言本系列教程将从零开始记入笔者学习区块链的过程，欢迎批评指正。一、solidity是什么？Solidity的代码... 查看详情
智能合约实战solidity语法学习11[以太坊发币验证合约体验下过程]附代码(代码片段)
1.编写合约； 2.选用小狐狸钱包，选择ropsten测试网络； 3.在ropsten的水龙上领取测试币； 4.使用remix进行合约部署； 5.验证合约； 6.truffle方式部署合约。1.编写合约为了尽快体验发布过程，直接在etherscan上拿了HU... 查看详情
openzeppelin批量测试solidity合约(代码片段)
openzeppelin是用于Solidity合约进行审计、代码安全测试的库，其中test-environment、test-helpers使用起来非常方便。下面，介绍对ERC20GuDingToken.sol、ERC20XiaoHuiToken.sol这2个合约的批量测试。1、创建工程onecoin1.1创建工程和文件夹... 查看详情
智能合约语言solidity教程系列5-数组介绍
写在前面Solidity是以太坊智能合约编程语言，阅读本文前，你应该对以太坊、智能合约有所了解，如果你还不了解，建议你先看以太坊是什么本文前半部分是参考Solidity官方文档（当前最新版本：0.4.20）进行翻译，后半部分对官... 查看详情
solidity编写智能合约遇到的各种问题(代码片段)
solidity编写智能合约遇到的各种问题合约部署1.creationofXXXXXerrored:transactionexecutionfailed2.creationofCSerrored:Errorencodingarguments:SyntaxError:UnexpectedtokenxinJSONatposition47合约调用1.通过接口调用其他.sol文件内的函数solidity的数据结构1.Mapping的删... 查看详情
使用browser-solidity在go-ethereum上进行简单的智能合约部署(代码片段)
...在本文讲解之前，先介绍以下几点基本概念。1.1、什么是智能合约? 智能合约是存储在区块链上的一段代码，它们可以被区块链上的交易所触发，触发后，这段代码可以从区块链上读取数据或者向区块链上写入数据。 1.2... 查看详情
通过一个案例精通以太坊智能合约和solidity(代码片段)
作者介绍SilverCEO星际区块链信息发展有限公司项目组件??这个项目是一个构建在以太坊上的游戏，感谢这个团队给我们提供的案例：https://cryptozombies.io??从功能的角度看，有如下脚本：zombiefactory.sol:定义zombie和生成zombie。zombiefeedi... 查看详情