如何使用pytest组织自动化测试用例结构？

测试界的彭于晏

于 2024-07-01 20:53:48 发布

阅读量642

点赞数 24

分类专栏：测试工程师自动化测试文章标签： pytest appium android 压力测试单元测试自动化测试软件测试

本文链接：https://blog.csdn.net/IT_LanTian/article/details/140109866

版权

自动化测试同时被 2 个专栏收录

1518 篇文章 70 订阅

订阅专栏

测试工程师

247 篇文章 4 订阅

订阅专栏

如何组织自动化测试工程的目录结构？这篇文章介绍了我是如何组织整个自动化工程目录结构的，本篇介绍下我是如何利用pytest框架组织一个测试用例文件的。

用例文件组织原则

整个testsuite目录下整体上按照特性模块划分目录，每个目录下可以只包含一个"test"开头的用例文件，也可以根据实际情况包含多个用例文件，尽量做到每个用例文件"test_xxx.py"只编写特性比较接近的用例，而且建议不要在一个文件中写过多的用例。

单个用例文件（test_xxx.py）如何组织用例结构

如果用例结构组织不合理，往往积累到一定量的用例时就会发现再增加用例时就会受制于各种因素的影响而举步维艰，往往为了规避影响需要写大量冗余代码，这样的惩罚可能还不足以让你记忆深刻，最痛苦的莫过于大量的自动化用例并发运行时一些意想不到的因素互相影响导致通过率始终无法达到预期的目标，调试、定位、修复用例消耗大量精力。解决这些问题需要有丰富的经验，开始编写用例时就精心组织、潜心思考、仔细推敲，就是付出成本最小的办法。

pytest框架可以很方便地组织我们的测试用例，默认配置下pytest会识别test开头的文件和test开头的方法，每一个方法就会被当做一个测试用例，就像下面这个示例文件包含了n个测试用例，拉起自动化任务时这些方法都会被运行。

# 用例文件名：test_feature01.py
# setup和teardown代码
...
def test_用例001:
  # 用例代码
  ...
  
def test_用例002：
  # 用例代码
  ..
  
def test_用例00n:
  # 用例代码
  ...

编写测试用例和开发写代码也是类似的，都有一些通用的原则，下面几个是针对测试用例代码比较重要的原则：

DRY原则：Don't Repeat Yourself，意思就是不要写重复代码，重复代码写得越多，你就会发现后面自动化维护就是个噩梦。实际判断的原则就是，如果你发现有些代码你需要再大于2个地方使用它，就要想办法把它封装为一个关键字。
每个用例都要添加检查点，否则用例就没有任何意义了，pytest框架只需要使用assert进行检查就可以了。
每个测试用例要能够独立执行，不能与其他用例有任何顺序依赖等关系。

每一种产品的自动化场景千差万别，大家公认的自动化用例的执行步骤包括环境初始化setup-->用例执行-->环境清理teardown三大部分，使用pytest的fixture固件可以很方便地实现模块级、方法级的setup和teardown（还支持会话级的），自动化测试用例编写人员的代码技能一般都不会太高，最好是能形成统一的用例模板和用例编写规范，测试人员只要按照模板级规范要求去写测试用例代码就可以了，下面是我使用的一种用例组织结构（项目中实际使用的自动化测试用例代码，摘取了关键部分），关键在注释中进行了一一说明，对其他的代码不需要做过多关注，只需要关注整个用例的执行流程即可。

# 文件名：test_远程扫描配置.py
import pytest

from logic.logic import *
from logic.mysql import *
from conf.settings import *
from utils.utils import *

""" 这是一个模块级setup及teardown示例
	1- yield之前的部分为setup，之后的部分为teardown
  2- 拉起自动化后该文件下的所有用例执行前只进行一次系统登录和打开菜单的操作
	（因为都是同一个菜单下的特性用例）
  3- 该文件下的所有用例执行完毕后仅执行一次系统关闭操作	
"""
@pytest.fixture(scope="module")
def csam():
   # 该特性下所有用例公共使用的初始化配置都放在yield之前编写
    csam = CSAM()
    log.info("======setup======")
    csam.login()
    csam.menu("远程扫描配置")		
    yield csam		
		# 该特性下所有用例公共使用的初始化配置清理放在yield之后编写
    log.info("======teardown======")
    csam.driver.quit()
		
""" 这是一个方法级setup及teardown示例
	1- yield之前的部分为setup，之后的部分为teardown
  2- 每个用例执行前都会执行一次yield之前的代码
  3- 每个用例执行后都会执行一次yield之后的代码	
"""
@pytest.fixture
def setup(csam):
		# 每个用例独立的初始化配置放在yield之前编写
    # ts是一个时间戳字符串，目的是为每个用例提供一个唯一的标识符供用例代码使用
    # 主要是为了避免创建的配置信息出现重名等问题
    ts = timestamp()
    yield csam, ts
    # 每个用例独立的配置清理放在yield之后编写
		# 其中清理部分的代码也使用ts这个时间戳，主要目的为了避免删除了其他用例的配置而导致影响
    mysql.run("delete from csam.rs_task where task_name like '%{0}%';".format(ts))
    mysql.run("delete from csam.scan_targets where name like '%{0}%';".format(ts))
    pgsql.run("delete from schedules where name like '%{0}%';".format(ts))
    pgsql.conn.commit()

def test_探测任务_扫描任务管理_新增扫描任务_资产扫描(setup):
    csam, ts = setup
    csam.button_click(name="新增")
    csam.dropdown_menu_select("资产扫描")
    asset_scan = {
        "name": "asset_{0}".format(ts),
        "desc": "资产扫描",
    }
    csam.scan_task_basic(asset_scan)
    csam.button_click(name="下一步")
    # 新增扫描目标
    csam.link_click(name="新增")
    target = {
        "name": "target_{0}".format(ts),
        "ip": "192.168.30.148",
        "gport": "TOP 10",
        "desc": "auto test",
    }
    csam.scan_target_new(target)
    csam.button_click(name="保 存")
    csam.button_click(name="下一步")
    csam.button_click(name="保存")
    # 结果检查
    assert csam.text(csam.table_cell_filter(asset_scan["name"], "任务名称", "任务名称")) == asset_scan["name"]
    assert csam.text(csam.table_cell_filter(asset_scan["name"], "任务名称", "任务类型")) == "资产扫描"
    assert csam.text(csam.table_cell_filter(asset_scan["name"], "任务名称", "扫描状态")) in ["未执行", "执行中", "执行完成"]
    assert csam.text(csam.table_cell_filter(asset_scan["name"], "任务名称", "扫描目标")) == target["name"]

def test_探测任务_扫描任务管理_新增扫描任务_漏洞扫描(setup):
    csam, ts = setup
    csam.button_click(name="新增")
    csam.dropdown_menu_select("漏洞扫描")
    vul_scan = {
        "name": "vul_{0}".format(ts),
        "desc": "漏洞扫描",
    }
    csam.scan_task_basic(vul_scan)
    csam.button_click(name="下一步")
    # 新增扫描目标
    csam.link_click(name="新增")
    target = {
        "name": "target_{0}".format(ts),
        "ip": "192.168.30.148",
        "gport": "All IANA assigned TCP",
        "desc": "扫描目标",
    }
    csam.scan_target_new(target)
    csam.button_click(name="保 存")
    csam.button_click(name="下一步")
    # 新增漏扫计划
    csam.link_click(name="新增")
    csam.input_set("plan_{0}".format(ts), label="计划名称")
    csam.datetime_set(datetime_shift(days=10), label="第一次执行时间")
    csam.datetime_set(datetime_shift(days=12), label="第一次结束时间")
    csam.select_dropdown("一次", label="重复频率")
    csam.textarea_set("漏扫计划", label="说明")
    csam.button_click(name="保 存")
    csam.button_click(name="保存")
    # 结果检查
    assert csam.text(csam.table_cell_filter(vul_scan["name"], "任务名称", "任务名称")) == vul_scan["name"]
    assert csam.text(csam.table_cell_filter(vul_scan["name"], "任务名称", "任务类型")) == "漏洞扫描"
    assert csam.text(csam.table_cell_filter(vul_scan["name"], "任务名称", "扫描器")) == "脚本库扫描器"
    assert csam.text(csam.table_cell_filter(vul_scan["name"], "任务名称", "扫描状态")) in ["未执行", "执行中", "执行完成"]
    assert csam.text(csam.table_cell_filter(vul_scan["name"], "任务名称", "扫描目标")) == target["name"]

# 后面的用例代码省略了...

针对示例，用例在执行期间的执行流程示意见下图