使用Python编写自动化测试代码规范整理-LMLPHP

        大家好,我们平时在写自动化测试脚本或者性能测试脚本时,需要注意代码规范,提高代码的可读性与维护性,之前给大家分享过pycharm的两个插件,大家可以参考:Pycharm代码规范与代码格式化插件安装

        本文中主要从自动化测试代码与性能测试代码的功能性、可读性、维护性和版本控制出发,和大家一起探讨一下规范与需要注意的点,希望能给大家带来一点帮助。

一、代码功能性

1、测试用例的准确性: 

1)确保测试用例的执行期望结果是正确的,并且与实际预期功能一致。
2)测试用例应该覆盖预期的各种场景。

2、测试用例的隔离性:

1)确保测试用例之间相互隔离,以防止一个测试用例的失败影响其他用例的执行。

3、步骤清晰程度:

1)确保测试用例的执行步骤清晰、详细,能够被其他人容易理解、维护和执行。

4、测试用例的断言与验证:

1)确保测试用例中的断言和验证机制正确,并且能够准确地判断测试是否通过。
2)断言应该与预期结果相匹配。

5、测试数据管理:

1)检查测试数据的来源和测试数据管理方法。
2)确保测试用例能够在不同环境中正确执行。

6、测试用例的边界条件:

1)确保测试用例涵盖了边界条件,例如测试参数的最大、最小和临界值。

7、异常情况与稳定性:

1)确保测试用例包含了对预期异常情况的处理,例如错误输入、无效数据或异常状态等。
2)确保系统在异常情况下能够适当地处理,不会崩溃或产生非预期后果。

二、可读性与可维护性

1、命名规范:

1)确保变量、函数、类和测试用例的命名清晰明了,并且语义命名,能够准确地反映其功能和目的。

2、代码注释: 

1)在关键逻辑或者步骤添加注释,解释代码的逻辑、用途、特殊情况等。
2)注释需要简洁明了,不宜过多或者过少。

3、代码缩进与格式化:

1)检查测试代码是否符合团队的编码规范和风格,统一代码缩进和格式化以提高代码的可读性。
2)确保代码块的缩进正确,代码对齐整齐。

4、函数与方法分解:

1)将长函数或方法拆分尽可能为更小、更简洁的功能单元。
2)每个函数或方法应该专注于一个特定的任务或逻辑。

5、重复代码:

1)检查是否有重复的代码块,需要将其提取为可复用的函数、类或模块,以减少代码冗余,降低代码重复率。

6、模块化和可复用性:

1)检查测试代码是否具有良好的模块化结构,便于测试用例可以被复用、维护和管理。

7、代码复杂度:

1)避免过于复杂的逻辑结构,保持代码的简洁性,这样其他人在阅读代码时能够更容易理解代码逻辑。

8、文档与说明:

1)提供适当的文档,解释代码的结构、用途、依赖关系等,便于其他人维护和快速上手。

三、版本控制

1、分支与版本号:

1)在重要的发布点上使用标签和版本号,以便随时能够回滚到特定版本的代码。

分支标签:

feat:新增feature

fix:修复bug

docs:仅仅修改了文档,比如 README、CHANGELOG等等

style:仅仅修改了空格、格式缩进、逗号等等,不改变代码逻辑

refactor:代码重构,没有加新功能或者修复 bug

perf:优化相关,比如提升性能、体验

test:测试用例,包括单元测试、集成测试等

chore:改变构建流程、或者增加依赖库、工具等

revert:回滚版本

2、提交信息:

1)编写实际代码改动功能的提交信息,说明提交的更改内容,便于其他人理解此次代码变更的目的。

3、频繁提交:

1)鼓励团队频繁提交代码,而不是等到所有工作都完成后再一次性提交。
2)减小每次提交的规模,更容易跟踪代码变更。

4、代码冲突:

1)在代码合并时,需要将最新的master或者main分支合并到自己的分支,并且处理出现的代码冲突。
2)存在代码冲突时,无法进行分支合并。

5、忽略文件:

1)确保提交的代码变更或者其他内容中忽略不必要的临时文件、构建产物等,便于保持代码仓库的整洁性。

05-05 00:26