编码规范
参考遵循 PEP8
接口注释
所有接口函数都要求填写完整标准注释
接口注释格式示例:
Description:
命令功能: <命令功能介绍> # 例如:查询fru信息
命令格式(可选): <命令格式介绍> # 例如:ipmcget -d furinfo
Args:
arg1(str): <arg1参数介绍>
arg2(int): <arg2参数介绍>
arg3(list): <arg3参数介绍>
arg4(dict): {
key1(type1): <key1参数介绍>
key2(type2): <key2参数介绍>
key3(type3): <key3参数介绍>
}
Returns:
None / result1(type1): <result1介绍>
Raises:
None / <异常信息>
Examples:
<一段代码或者文字举例如何使用该api方法> # 调用此接口方法大概示例 self.xx_api.yy_method(p1, p2)
用例规范
用例脚本类名命名与用例编号一致,可忽略编码规范
用例格式参考:
class SNMP_LONG_PASSWORD_CHECK(Case):
"""
CaseId:
SNMP_LONG_PASSWORD_CHECK
RunLevel:
Level 3
CaseName:
密码复杂度开启、超长口令关闭读写密码长度异常测试
PreCondition:
1、openUBMC正常运行
2、密码检查开启,关闭超长口令。
TestStep:
1、WEB设置读写团体名为7位字符,有结果A)
2、WEB设置读写团体名为33位字符,有结果A)
ExpectedResult:
A)保存按钮置灰,无法设置
Remark:
无
"""
# 测试执行前置操作
def pre_test_case(self):
...
# 测试步骤
def procedure(self):
# 打印步骤需要与上面TestStep中描述一致
# 序号格式可以是纯数字1、2 或者【步骤1】【步骤2】
# 测试步骤实现要与文本用例保持一致
self.log_step("1、WEB设置读写团体名为7位字符,有结果A)")
...
self.log_step("2、WEB设置读写团体名为33位字符,有结果A)")
...
# 恢复环境
def post_test_case(self):
...
注意:
标注注释格式中所有符号均使用英文半角符号,所有缩进均为四个空格