一.整体框架说明 自动化项目的整体框架以及各个功能模块的划分如下图所示。

二.接口开发规范 主要针对testlib/api中的python代码开发进行规范说明。

1.开发接口时按照上述功能模块划分，将对应的接口实现写到对应的模块中；

2.所有实现的前后端接口应尽量参数化，避免将参数写死，http请求中携带的每个字段的值都应该有来源，要么是用户传入的，要么是通过调用其他接口获取到的；

3.大部分通用接口，如复杂数据结构的解析、一些基本的校验已经实现了，在开发接口时首先查阅一下类似的用例或关键字是否已经调用过类似的接口，避免重复造轮子，如不清楚是否有相关接口，可咨询：田飞 / 张杭；

4.接口代码规范参考：Python/Robotframework 代码编写规范

三.关键字开发规范 主要针对testlib/通用关键字开发进行说明。

1.关键字以中文命名，尽量通过名称准确的表达出关键字的功能；

2.对于关键字中较为晦涩的变量名称或变量值，应在documents中予以说明；

3.关键字尽量使用关键字参数，即：以&{kwargs}形式调用能更清楚的知道每个入参字段的含义；

四.用例开发规范 主要针对所有的RF用例开发进行说明。

1.所有自动化用例参照禅道中的功能用例来实现，且必须完全覆盖禅道用例的校验点，如部分校验点无法实现，应考虑将这部分校验点从该禅道用例中拆分出来，否则此用例不实现自动化；

2.凡实现自动化的禅道用例，在自动化用例的标签中加上禅道用例的id作为一个用例标签，同时在对应的禅道用例的关键词中加上“已自动化”，无法自动化的用例则在关键词中加上"不自动化"；

3.测试资源尽量复用，以缩短用例执行时间。如购买单个ECS的步骤可以放在测试套的setup中，单个ECS的配额、账管、生命周期相关的用例都放在这一个测试套下，复用此ECS资源；

4.用例之间不应该有相互依赖，用例本身应可以反复执行、在不同测试环境执行、在不同自动化环境执行、通过不同测试账号执行；

5.用例必须有tag，当前常用的Tag包括：

        done: 表示用例已完成，可以使用；

        iaas: 表示iaas环境可执行的用例，主要包括ECS/EBS/SLB/EIP相关云产品的用例及其他通用用例；

        ui+api：需要通过接口+UI方式才能实现的用例

        禅道用例id tag（如：70167，对应禅道用例-“ECS-购买-购买最小时长（1个月）”）

6.合理使用测试套和用例级别的set_up和tear_down，保证在用例执行完成之后环境恢复；

7.自动化用例创建的资源命名时应加上”auto“以示区分，如：购买ECS时实例名称命名为"auto_ecs_+随机数字"；

8.测试套和用例的命名以数字开头，以便于快速定位到某一条用例；测试套和用例的命名以"_"连接模块、子模块、子功能，例如：“01.云产品_ECS_购买ECS_购买云服务器-武汉region”；

9.RF用例中应尽量避免出现IF语句，这样会降低用例的可读性；

10.凡是在超过两条用例中出现的相同操作，应考虑封装成关键字；

11.新增用例都放到\专有云cecstack用例集\03.cecstack禅道用例覆盖目录下，其中ui+接口实现的用例放到\专有云cecstack用例集\03.cecstack禅道用例覆盖\04.UI+接口下；

12.自动化调试和冒烟之后及时清理账号下的云产品资源，避免资源占用过多；

五.代码合入规范 1.所有的代码操作都基于cecstack分支，这是专有云自动化测试的主分支，当完成某个版本的测试后，自动化会基于cecstack分支拉对应版本号的分支进行代码封版