Octopus测试脚本规范
1、 设计规约
三层结构：测试数据层、测试对象层、测试实施层。如下图1.1 所示：
图1.1
如图1.1所示，数据池中存储所有的测试数据，测试对象层中包含所有的测试对象，验证点中包含所有的验证点，测试实施层测试对象、测试数据、验证点完成整个测试流程。如遇到版本升级需要新增功能或者验证点，只需在测试对象层和验证点中新增功能然后又测试实施层调用即可。如测试数据需要变动，只需在数据池中修改无需更改程序。
一个rft项目应该分为三部分即测试数据层、测试对象层、测试实施层，其中测试对象层包括测试对象和验证点。应充分利用rft中的数据池实现测试数据与脚本的分离减少脚本与数据的耦合，使脚本的维护变得简单。减少测试对象与测试实施之间的耦合，降低维护成本。
2、 命名规约
2.1、包名(package)
一般java项目中package命名规范为，采用完整意义的小写单词，将你的 Internet 域名反转并接上包名，例如com.ambysoft.www.persistence。
2.2、类名(class)
必须采用完整的英文描述符，大小写混合，所有单词的第一个字母大写。 对于首字母大写的缩略语可以全部字母大写，名字要求简单并且具有描述性，尽量避免使用缩略语和缩写（除非是非常广泛使用的）。严禁出现类似于H_001之类的让人费解的类名。
测试对象类：类名后缀 “TestObj”。
验证点类：类名后缀“VP”
异常类：类名后缀“Exception”
测试实施类：类名后缀“Test”
2.3、方法名(method)
采用具有明确业务含义的名称描述，方法名首字母小写，其他单词首字母大写。一般不建议出现类似于“bc”这样令人费解的拼音组合方法名。
设置成员方法：被访问的成员方法名添加前缀“set”。如setTaxpayerName();
获取成员方法：被访问字段/属性名添加前缀“get”。如getFirstName();
布尔型成员方法：所有的布尔型成员方法均添加前缀“is”。如isString();
验证点成员方法：所有的验证点成员方法均添加后缀“VP”。如notFoundTaxVP();
普通成员方法：采用完整的英文描述说明成员方法功能，第一个单词尽可能采用一个贴切具体且没有歧义的动词，第一个字母小写。如addAccount()；
2.4、变量(variable)
名词，首字母小写，其他的每个单词的首字母大写，具有描述性和助记性（便于记忆和描述其作用）。其中常量和静态常量需要全部采用大写。
2.5、测试对象(testObject)
统一采用“测试对象类型_测试对象中文名称”的格式命名。如text_用户名。严禁出现类似于“text_text”或者“text_text4”之类的名称。
2.6、数据池(datapool)
采用具有明确业务含义的大小写英文单词组合，首字母小写，其他英文单词首字母大写。
2.7、数据池变量(variable of datapool)
统一采用对应的测试对象的中文名称命名。如测试对象“text_用户名”对应的数据池变量名为“用户名”。严禁出现类似于“yhm”之类的晦涩难懂的名称。
3、 注释规约
3.1、类注释
类实现的功能，是否依赖测试数据，有哪些上游业务对其产生影响，对那些下游业务产生影响。
3.2、方法注释
该方法实现的功能，参数的含义，是否有返回值，返回值的类型。对于设置成员方法或者获取成员方法可以只采取简单的单句注释即可。
3.3、普通成员方法内部注释
控制结构和业务逻辑，代码做了些什么以及为什么这样做，处理顺序以及一些特殊处理等。
3.4、数据池中测试数据的备注
每个数据池都必须添加“备注”变量，并且每条测试数据都必须编写备注。备注应为中文格式，内容需简单明了，以说明该条测试数据的具体用途。
发表于 2013-5-20 14:51:41
