自动化脚本编写规范

1 前言

本文的目标是为自动化测试工程师编码规范统一、命名规则统一，确保自动化脚本的规范性与可阅读性，方便自动化测试脚本的管理。

Note：此规则在有必要时可被修改并打破。

2 名词注释

无

3 测试脚本命令规范

3.1 每个功能脚本模块的命名规范

针对每一个功能模块头部必须有一下字段内容（示例：图1）：

测试用例标题：阐述用例标题且与用例场景中标题一致

测试场景：阐述脚本的使用场景

创建者：脚本创建者

创建日期：记录脚本的创建日期

最后修改日期：记录脚本的最后修改日期

输入参数：描述脚本的输入参数

输出参数：描述脚本的输出参数

路径：用例保存的物理路径

3.2 目录结构文件夹命名

自动化目录结构名称应一致，文件夹的命名规则应统一（示例：图2）。

一个项目自动化实现应包含三级目录结构：

TestObject：一级目录位项目名称

TestSuite：分类别存放测试数据、测试用例、测试报告等

TestUnit:具体的数据文本一级脚本文件（有需要可再增加目录分类）

3.3脚本命名规则

脚本命名规则与设计文档中的命名一致。

3.4 参数命名规则

变量命名应该简单，应尽量使用缩写。如果是一般的值类型（如integer string），则直接使用变量用途命名。尽量使用全名，例如，String name；如果是一般的临时性变量定义，应该尽可能地简单，例如，Int i；如果名称由多个单词组成，则取每个单词的首字母，如EntityManager缩写为em，ProcedureManager缩写为pm；如果名称由一个单词组成，则对单词进行分段取首字母，如Entity缩写为et。缩写应该控制在3个字母以内，且尽量清晰。

3.5 常量命名

常量的命名应该全部用大写，使用"_"作为单词间的分隔符，单词尽量使用全名称，如，Public String SG_EMPTY_ROW = "有空行存在"。

3.6 参数命名

参数命名的原则是全部用小写，如果参数包括两个或两个以上的单词时，首单词字母小写，其他单词首字母大写，如stepName、stepDescription。

3.7 接口、函数、方法命名

此处函数、方法、接口表示的是一个动作，所以它的结构应该是动词+名词，动词必须小写，后面的名称首字母大写，如getMaterialCode。函数命名尽量不要使用缩写，而且它的名称应该使人一目了然，能够从名称就知道这个函数的功能，不要使用无意义的函数名称。当函数名称不足以表达其功能时，应使用在函数头部加上让调用者足够明白的注释。

备注：方法和方法之间、函数与函数之间必须用一个空行进行分割。

4脚本的版本控制

自动化组成员再SVN有相应的权限。自动化脚本更新，在编写成员调试通过后，代码提交前需要自动化测试组评审，通过以后方可提交版本。并再本机环境备份修改脚本