如何将网站添加到域名,湖北建站中心,wordpress几十万篇文章,冯耀宗seo博客优化title: 如何在seata中编写测试用例 keywords: [Seata, unit test, junit, mockito, assertj] description: 这篇文章主要介绍了Seata中已经使用的测试用例相关框架#xff0c;以及社区建议开发者如何更好的编写测试用例 author: 汪忠祥 - trustdecision 技术专家 date: 2024-0…
title: 如何在seata中编写测试用例 keywords: [Seata, unit test, junit, mockito, assertj] description: 这篇文章主要介绍了Seata中已经使用的测试用例相关框架以及社区建议开发者如何更好的编写测试用例 author: 汪忠祥 - trustdecision 技术专家 date: 2024-02-20
本文转载自Seata官网https://seata.apache.org/zh-cn/blog/
背景
随着 Seata 项目的不断发展和壮大我们的贡献者群体也在持续扩大。项目的功能不断增强对于代码质量的要求也在提高。在这个过程中我们期望每一位贡献者在提交功能代码的同时能够附带规范、完备的测试用例。
一个优秀的项目其完备的单元测试是基本保障。Test-Driven DevelopmentTDD理念已经提出多年它强调在编写功能代码之前先编写测试用例。通过编写单元测试开发者可以更深入地理解代码中相关类和方法的作用掌握核心逻辑熟悉各种场景的运行情况。同时单元测试也为开源项目提供了稳定安全的保障使得项目在接受贡献者代码时能够确保代码的质量和稳定性。 单元测试是质量保障的第一环有效的单元测试能够提前发现90%以上的代码Bug问题同时也能防止代码的腐化。在项目重构和演进过程中单元测试起到了至关重要的作用它能够确保重构后的代码仍然能够正常工作不会引入新的Bug。
在社区看来贡献合理的测试用例代码和贡献功能代码同样重要为了帮助开发者编写出高质量的测试用例本文给出一些基础的规范和建议。
推荐的框架
当前社区使用以下三个框架编写测试用例
junit5
junit是Java中最常用的单元测试框架用于编写和运行可重复的测试用例。 junit-jupiter.version5.8.2/junit-jupiter.versiondependencygroupIdorg.junit/groupIdartifactIdjunit-bom/artifactIdversion${junit-jupiter.version}/version/dependencymockito
mockito是一个mock框架主要是用来做mock测试他可以模拟任何 Spring管理的 bean、模拟方法的返回值、模拟抛出异常等可以让我们在缺乏一些依赖的情况下完成测试及验证。 mockito.version4.11.0/mockito.versiondependencygroupIdorg.mockito/groupIdartifactIdmockito-core/artifactIdversion${mockito.version}/version/dependencydependencygroupIdorg.mockito/groupIdartifactIdmockito-junit-jupiter/artifactIdversion${mockito.version}/version/dependencydependencygroupIdorg.mockito/groupIdartifactIdmockito-inline/artifactIdversion${mockito.version}/version/dependencyassertj
assertj是一个断言库提供了一组易于使用和可读性很强的断言方法当junit的断言难以满足时可以使用assertj进行断言
请注意我们在seata-dependencies的pom.xml中统一管理了这三个库的版本。 assertj-core.version3.12.2/assertj-core.versiondependencygroupIdorg.assertj/groupIdartifactIdassertj-core/artifactIdversion${assertj-core.version}/version/dependency规范
我们参考阿里巴巴JAVA开发手册整理了一些建议及规范分为不同的级别其中【【强制】部分开发者需要严格遵守社区在合并代码时会按照强制规则进行review【【推荐】【参考】部分方便大家更好的了解我们对于测试用例的考量和原则。
1.【强制】单元测试必须遵守 AIR 原则。
说明好的单元测试宏观上来说具有自动化、独立性、可重复执行的特点。
AAutomatic自动化IIndependent独立性RRepeatable可重复
2.【强制】单元测试应该是全自动执行的并且非交互式的。
测试用例通常是被定期执行的执行过程必须完全自动化才有意义。输出结果需要人工检查的测试不是一个好的单元测试。单元测试中不准使用 System.out 来进行人肉验证必须使用 assert 来验证。
3.【强制】保持单元测试的独立性。为了保证单元测试稳定可靠且便于维护单元测试用例之间决不能互相调用也不能依赖执行的先后次序。
反例method2 需要依赖 method1 的执行将执行结果作为 method2 的输入。
4.【强制】单元测试是可以重复执行的不能受到外界环境的影响。
说明单元测试通常会被放到持续集成中每次有代码 check in 时单元测试都会被执行。如果单测对外部环境网络、服务、中间件等有依赖容易导致持续集成机制的不可用。
正例为了不受外界环境影响要求设计代码时就把 SUT 的依赖改成注入在测试时用 spring 这样的 DI框架注入一个本地内存实现或者 Mock 实现。
5.【强制】对于单元测试要保证测试粒度足够小有助于精确定位问题。单测粒度至多是类级别一般是方法级别。
说明只有测试粒度小才能在出错时尽快定位到出错位置。单测不负责检查跨类或者跨系统的交互逻辑那是集成测试的领域。
6.【强制】核心业务、核心应用、核心模块的增量代码确保单元测试通过。
说明新增代码及时补充单元测试如果新增代码影响了原有单元测试请及时修正。
7.【强制】单元测试代码必须写在如下工程目录src/test/java不允许写在业务代码目录下。
说明源码编译时会跳过此目录而单元测试框架默认是扫描此目录。
8.【强制】单元测试的基本目标语句覆盖率达到 70%核心模块的语句覆盖率和分支覆盖率都要达到 100%。
说明在工程规约的应用分层中提到的 DAO 层Manager 层可重用度高的 Service都应该进行单元测试。
9.【推荐】编写单元测试代码遵守 BCDE 原则以保证被测试模块的交付质量。
BBorder边界值测试包括循环边界、特殊取值、特殊时间点、数据顺序等。CCorrect正确的输入并得到预期的结果。DDesign与设计文档相结合来编写单元测试。EError强制错误信息输入如非法数据、异常流程、业务允许外等并得到预期的结果。
10.【推荐】对于数据库相关的查询更新删除等操作不能假设数据库里的数据是存在的或者直接操作数据库把数据插入进去请使用程序插入或者导入数据的方式来准备数据。
反例删除某一行数据的单元测试在数据库中先直接手动增加一行作为删除目标但是这一行新增数据并不符合业务插入规则导致测试结果异常。
11.【推荐】和数据库相关的单元测试可以设定自动回滚机制不给数据库造成脏数据。或者对单元测试产生的数据有明确的前后缀标识。
12.【推荐】对于不可测的代码在适当的时机做必要的重构使代码变得可测避免为了达到测试要求而书写不规范测试代码。
13.【推荐】单元测试作为一种质量保障手段在提交pr前完成单元测试的编写及验证。
14.【参考】为了更方便地进行单元测试业务代码应避免以下情况
构造方法中做的事情过多。存在过多的全局变量和静态方法。存在过多的外部依赖。存在过多的条件语句。 说明多层条件语句建议使用卫语句、策略模式、状态模式等方式重构。
