Lua单元测试编写指南

Lua单元测试编写指南

目录结构&命名规范

如图所示，在phonest 根目录下，有Test测试目录，里面放着phonest库的所有单元测试。在该目录下，有多个子目录，每个子目录表示的是某个功能模块的测试集合；在该目录下，由不同的单元测试合集组成；对于每个单元测试，测试文件的入口必须以Test.lua命名，同时要求加入README.md用于描述该单元测试主要测试的功能

单元测试编写示例

一般测试用例
我们以一个Class的单元测试为例，来描述如何使用单元测试框架。
JSON复制代码
local env = require(“Test.Framework.TestEnv”)
env.init({“lfs”, “cmsgpack”, “testDerivedComponent”})

在最开头，需要从测试框架层，引入env，并将env初始化。需要注意的是，因为我们phonest框架内hook了_G,所以我们需要在init传入需要使用的global变量，其中"testXXXX"就是我们此次需要测试的function。（必须以test开头的函数才能被测试）

JSON复制代码

local class = require(“Core.Framework.Class”)
local ServerEntity = require(“Core.Server.ServerEntity”)
local TestClass = class.Class(“TestClass”, ServerEntity)

local DerivedComponent = require(“Test.ClassTest.Test1.ClassTest_Test1_DerivedComponent”)
class.AddComponents(TestClass, {DerivedComponent,})

function testDerivedComponent()
local t = TestClass()

luaunit.assertEquals(t.baseCtor, true)
luaunit.assertEquals(2, t:apply())
luaunit.assertEquals(1, t:finish())

end

此段代码是本次测试的逻辑代码，需要注意的是测试函数名一定要被init过
env.run()
触发测试环境的执行，整个测试会被完整的执行

执行结果如下
Started on 09/24/21 11:45:07
testDerivedComponent … Ok
Ran 1 tests in 0.000 seconds, 1 success, 0 failures
OK

协程测试用例

luaunit原始框架不支持协程模式，但是我们phonest框架的RPC以及Timer是依赖底层c++回调的，需要有一定的驱动时间，我们将这些语义封装到了框架内部，外部测试者，不再需要关注底层细节，我们以TimerManager为例进行说明。

注意第三行，我们告诉env，开启了一个TestTimerManager的class，他里面会有比较多的函数需要测试（必须以Test开头）

注意第22行，我们会暂停testOnce一定时间，等待底层启动TimerManager调用，然后再进行判断；需要注意的是，在第24行，我们需要return 0，告知外部不需要额外的等待时间

更复杂的测试用例，用于测试repeat timer和remove接口，思路都是通过一定的时间等待后确认操作逻辑

开启测试的启动脚本与非协程模式不同

注意事项

ConfigGenerator
在phonest单元测试框架下，Config的生成与demo_server一致，请大家严格按照decorator的方式去定义Component，Property，RpcMethod等等