我的实用小工具-单元测试模块

一、单元测试对开发者的重要性

1. 确保代码质量。通过编写单元测试,可以确保代码遵循设计要求和业务逻辑,功能正确。这可以大大减少 bug 的产生,保证代码质量。

2. 简化集成测试。有了可靠的单元测试作为基础,集成测试的难度和范围就能大大减小。集成测试可以更 focused 地检验模块之间的集成与接口。

3. 便于重构。有了单元测试,开发者可以随时重构代码而不用担心改动后的代码出现问题。重构后的代码仍然可以通过单元测试,这可以给开发者很大信心。

4. 文档化。单元测试可以视为代码的一种文档,阅读单元测试可以了解代码要实现的功能和业务逻辑。这在新人上手项目或老代码维护时 especially 有用。

5. 可持续集成的基石。可持续集成的第一步就是运行所有的单元测试。只有单元测试通过,代码才能被合并进入主线。这可以最大限度地确保主线代码的质量。

6. 所以总的来说,编写单元测试可以让开发更高效、代码更健壮。它是构建高质量代码和可持续集成的基础,是现代软件工程中不可或缺的一部分。开发者要养成为任何代码编写单元测试的好习惯。

二、简介

是依赖于python3+以及pytest模块，用于构建api接口测试用例数据模板的生成与读取(保存在excel文件中目前仅支持xls格式)，并提供flask与sanic框架的通用测试用例方法的自动生成。

三、安装

四、使用

1.  在项目工程根目录下创建包，您的测试用例文件都可以写在其中

2. 本工具提供关于flask和sanic框架通用的单元测试样例脚本，可自动生成测试样例脚本供参考，代码如下

3.  根据测试样例脚本的提示，准备您预测试的接口json报文样例,并按要求在报文根节点下添加uri、method、result、message节点，例如下面示例

4. 报文及测试样例写好后，就可以在terminal下执行如下命令，进行单元测试

五、测试用例样例

六、备注说明

本工具初始化会自动生成测试用例数据源excel文件，pytest.ini配置文件，单元测试脚本模板文件

保存测试数据到excel表 表格式说明如下：

1. 每个sheet【标签页】代表一个接口

2. 每列表示请求报文中的字段，如果涉及到层级关系需要以点分隔，如biz.dataObject.code，如果是列表将增加数字代表列表index

3. 测试数据文件名默认为:mock_data.xls,支持自定义

4. 提供的报文必须在json一级中增加字段：uri【接口资源路径】，method【接口请求方法】,result【预期结果】,message【对预期结果的说明】

5. 如果一次提交多个接口，以列表包裹字典，每个字典代表一个接口

6. 支持自定字段是存在每列，或每行

7. 用户可以编辑excel文件，为每个excel添加多组数据，测试不同的预期结果