理解项目代码，我做了什么

测试人员如何快速熟悉项目代码，是一个比较头疼的问题，作为测试架构师，有义务去解决这个问题，最近在为团队赋能的时候，做了三件事，来帮助团队成员快速熟悉业务代码，方便后期更好的做测试策略设计。

01

项目比较复杂，有众多的微服务需要关注，刚进入项目组，没办法快速了解有多少应用，他们的调用关系如何。于是尝试引入skywalking，来快速了解每个大功能可能涉及到的服务（为什么不直接问开发？因为团队较大，也没有人完全熟悉系统）。为什么是skywalking呢？因为它对代码没有业务入侵（这点非常重要，所以哪怕它粗略些，也能接受）。步骤如下：

1. 找到运维，在业务的基础镜像中加入skywalking-agent包；

1. 在项目工程的deployment.ymal中增加启动命令；

1. 启动skywalking-apm，同时启动应用，通过PostMan调用接口（可以先对核心功能做调用），生成数据；
2. 在skywalking-Ui界面就可以直接查看生成的调用链路，了解业务功能涉及到的微服务有哪些。

注：skywalking的使用，官网地址：https://skywalking.apache.org/

02

在大体上熟悉了项目的核心组件后，接下来就是要看看代码了，如果直接查看源代码，也是件比较痛苦的事，业务的关联性比较强，又没有相关的文档说明（诸如时序图、数据库关系图等）。那有什么办法可以比较好的了解代码呢？

在IDEA中，有个非常有用的插件，那就是SequenceDiagram，它可以快速生成时序图，让你看代码轻松许多。

安装好SequenceDiagram后，你可以在代码的controller层中，找到对外暴露的接口，右键快速生成时序图。

生成的结果如下：

支持导出，也支持设置遍历深度，这图不管是用来自己熟悉代码，还是做代码评审、业务逻辑梳理，都是非常有用的。

注：SequenceDiagram直接在IDEA的插件库中搜索即可安装。

03

在项目发版的时候，测试人员无法获知发布的版本内容，没有发布日志。需要开发人员去梳理发布日志（或者也可以根据需求来获知发布内容，但容易对应不上，或者开发偷偷携带其它内容），这个问题如何解决呢？

1. 规范commit提交格式，通过Commit Template定义标准的提交格式，并在项目组中推广。

1. 通过commitlint + husky检查提交规范，如果不符合规范，代码将无法被合并到项目中；
2. 通过standard-version 来自动化生成 CHANGELOG.md。这样，每次代码发布前，就可以通过检查CHANGELOG中的信息，就可以知道精确的发布范围，减少测试遗漏或者发布范围超纲。

注：standard-version只适合于前端，后端没找到现成的工具使用，解决思路是通过JGit库拿到本地的gitlog，然后解析并生成对应的changelog，把这个方法放到Spring boot的启动类中去，这样工程启动的时候，就会自动成生。要注意在发布分支上生成，才是准确的。开发分支可以不生成。

04

通过以上几件事，基本上就可以从代码层快速熟悉业务，并保障发布内容。至于业务层面的熟悉，那就是水磨的功夫了，需要花时间，不论找熟悉业务的同学，还是看存量的测试用例，甚至是直接做探索性测试，都是可行的方案。当然，如果你有相关业务的积累，那就更容易了。

个人认为，这些才是测试开发的价值所在。能够帮助业务测试的同学快速梳理业务，协调资源（上面第3点，就需要沟通业务团队，制定合适的规范）通过技术的手段规范相关内容，保障测试活动的进行。

往期推荐：

软件测试经验与教训

测开造轮子漫谈

你对测试开发是否有误解

用心维护自己的职场标签

你还记得测试策略么

END

标星、点赞、关注三连走起，感谢支持。

如果想阅读更多文章，请关注我的公众号。