Yat用例编写规范.md · 赵鹏程-G/Yat

![avatar](./images/openGauss.png)

版权所有 © 2023 openGauss社区 您对“本文档”的复制、使用、修改及分发受知识共享(Creative Commons)署名—相同方式共享4.0国际公共许可协议(以下简称“CC BY-SA 4.0”)的约束。为了方便用户理解，您可以通过访问[*https://creativecommons.org/licenses/by-sa/4.0/*](https://gitee.com/link?target=https%3A%2F%2Fcreativecommons.org%2Flicenses%2Fby-sa%2F4.0%2F) 了解CC BY-SA 4.0的概要 (但不是替代)。CC BY-SA 4.0的完整协议内容您可以访问如下网址获取：[*https://creativecommons.org/licenses/by-sa/4.0/legalcode*](https://gitee.com/link?target=https%3A%2F%2Fcreativecommons.org%2Flicenses%2Fby-sa%2F4.0%2Flegalcode)。

## 1 通用规范

1）用例中命名规则：

- 用例名：Opengauss\_特性名\_Case00xx.sql/Opengauss\_特性名\_Case00xx.py
- 禁止出现有特殊含义的密码

- 类名使用大驼峰，如BigAuditFile
- 变量名、函数名小写，下划线连接，如avail_size
- 数据库相关变量命名
  - 表空间名：ts\_用例名
  - 表名：t\_[特性\_]用例名\_1、t\_[特性\_]用例名\_2
  - 索引名：i\_[特性\_]用例名\_1、i\_[特性\_]用例名\_2
  - 用户名：u\_[特性\_]用例名
  - audit policy: ap_[特性_]用例名_1
  - aggregate: agg_[特性_]用例名_1
  - column encryption key: cek_[特性_]用例名_1
  - client master key: cmk_[特性_]用例名_
  - cursor: cur_[特性_]用例名_1
  - data source: ds_[特性_]用例名_1
  - database: db_[特性_]用例名_1
  - directory: dir_[特性_]用例名_1
  - group: group_[特性_]用例名_1
  - index: i_[特性_]用例名_1
  - language：l_[特性_]用例名_1
  - masking policy：mp_[特性_]用例名_1
  - materialized view：mv_[特性_]用例名_1
  - model：m_[特性_]用例名_1
  - operator：o_[特性_]用例名_1
  - prepare: pp_[特性_]用例名_1 
  - package：pac_[特性_]用例名_1
  - procedure：pro_[特性_]用例名_1
  - publication：pub_[特性_]用例名_1
  - resource label：rl_[特性_]用例名_1
  - resource pool：rp_[特性_]用例名_1
  - role：role_[特性_]用例名_1
  - row level security policy：rlsp_[特性_]用例名_1
  - rule：rule_[特性_]用例名_1
  - schema：sch_[特性_]用例名_1
  - sequence：seq_[特性_]用例名_1
  - server：ser_[特性_]用例名_1
  - subscription：ss_[特性_]用例名_1
  - subtype：st_[特性_]用例名_1
  - synonym：syn_[特性_]用例名_1
  - savepoint: sp_[特性_]用例名_1
  - table partition：tp_[特性_]用例名_1
  - table subpartition：tsp_[特性_]用例名_1
  - text search configuration：tsc_[特性_]用例名_1
  - text search dictionary：tsd_[特性_]用例名_1
  - trigger：tri_[特性_]用例名_1
  - type：type_[特性_]用例名_1
  - tablespace: ts_[特性_]用例名_1
  - table: t_[特性_]用例名_1
  - user: u_[特性_]用例名_1
  - user mapping：um_[特性_]用例名_1
  - view：v_[特性_]用例名_1
  - weak password dictionary：wpd_[特性_]用例名_1
  - function：f_[特性_]用例名_1
  - foreign table: ft_[特性_]用例名_1

2）保证用例的独立性，除特殊情况外（如兼容性用例增加整体setup和teardown文件）， 每个用例都需要能单独执行

3）可提取的公共函数放到utils/xUtils

- utils中存放shell节点/数据库节点等公共方法
- xUtils中方法针对不同特性提取的公共方法

3）门禁为单机环境，若有非sql用例在主备环境才执行的，类定义时请参考如下处理：@unittest.skipIf(pri_sh.get_node_num()<=1,'单机环境不执行')

4）断言要精准，不可出现假通过，如self.assertIn('1', res)，数字1在多种场景都会出现，关键字信息不足。

5）python用例中，涉及路径的参数避免使用字符串拼接，用os.path.join()代替

6）不同场景结果不同且无特殊意义的输出语句，用正则进行模糊匹配，如Position数字、time时间等

## 2 sql用例代码编写规范

1）测试点中有ERROR报错语句时，-- @testpoint总述中需含有“合理报错”标识。

2）修改已合入用例，需添加 -- @history说明项

3）用例最后需清除掉创建的数据

用例模板见：

yat-master\template\testcase\Opengauss_template_include_error_Case0001.sql

yat-master\template\testcase\Opengauss_template_include_error_Case0001

yat-master\template\testcase\Opengauss_template_include_error_Case0002.sql

yat-master\template\testcase\Opengauss_template_include_error_Case0002

## 3 python用例代码编写规范

1）修改已合入用例，需添加 -- @history说明项

2）用例编写注意事项

- setup：初始化用到的节点信息等，记录需修改的参数的原始值，备份文件等
- test：添加必要的执行步骤说明，建议定义为 ---stepX：重要步骤描述---
- teardown：清理环境，包括删除创建的表、表空间等，恢复修改的参数，文件等；为了避免某一个断言校验失败，导致后续清理步骤无法执行，请在所有清理步骤完成后进行断言

用例模板见：

yat-master\template\testcase\Opengauss_template_Case0003.py

## 4 schedule命名规范

赵鹏程-G/Yat

简介

发行版

贡献者

近期动态

赵鹏程-G/Yat .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

赵鹏程-G/Yat