三、playwright+pytest-高阶篇-封装

背景

playwright、pytest的介绍，以及基础入门在这篇就不做详细介绍了。分别在前2篇中。

本篇主要是讲如何将playwright与pytest结合起来，做成通用的UI自动化框架。

众所周知：UI自动化最大的问题是后期维护困难，这个后期维护主要就在业务变动，导致元素变动定位不到。故而后面写的逻辑全部都无法使用；市场上也有其他的解决办法，比较火的airtest（图像识别）。感兴趣的可以去研究下，之前也写过相关的博客，搭建了框架。

这个框架在基础的PO【Page Object】模型上，又增加了一层将元素提取出来，将元素、操作、页面用例，严格分离开，这样就会减少很多后续维护成本，元素变动只需要更改元素页面。操作页面不受影响。

一、基本信息

框架使用：pytest、playwright

1.1 、pytest运行原理

https://www.cnblogs.com/hls-code/p/15785247.html

 1.2、钩子函数Hook

我自己理解就是状态监测函数。钩子监控到了某个状态变更了，就自动运行这个函数

特性：

1. 是个函数，在系统消息触发时被系统调用
2. 不是用户自己触发的
3. 使用时直接编写函数体
4. 钩子函数的名称是确定，当系统消息触发，自动会调用。

钩子函数分类

结合pytest的运行过程，官方文档给定的钩子函数也分为6大类，分别如下：

官方文档：API Reference — pytest documentation

引导钩子，初始化钩子、用例收集钩子、用例执行钩子、报告钩子、调试钩子。

• 引导钩子（setuptools hooks）
  • 引导钩子要求尽早注册插件（内部插件和 setuptools 插件）。
  • pytest_load_initial_conftests(early_config,parser,args): 在命令行选项解析之前实现初始conftest文件的加载。
  • pytest_cmdline_preparse(config,args): (废弃)在选项解析之前修改命令行参数。
  • pytest_cmdline_parse(pluginmanager,args): 返回一个初始化的配置对象,解析指定的args。
  • pytest_cmdline_main(config): 要求执行主命令行动作。默认实现将调用configure hooks和runtest_mainloop
• 初始化钩子（Initialization hooks）
  • 初始化钩子调用插件和conftest.py文件。
  • pytest_addoption(parser): 注册argparse样式的选项和ini样式的配置值，这些值在测试运行开始时被调用一次。
  • pytest_addhooks(pluginmanager): 在插件注册时调用，以允许通过调用来添加新的挂钩
  • pytest_configure(config): 允许插件和conftest文件执行初始配置。
  • pytest_unconfigure(config): 在退出测试过程之前调用。
  • pytest_sessionstart(session): 在Session创建对象之后，执行收集并进入运行测试循环之前调用。
  • pytest_sessionfinish(session,exitstatus): 在整个测试运行完成后调用，就在将退出状态返回系统之前。
  • pytest_plugin_registered(plugin,manager):一个新的pytest插件已注册。
• 用例收集钩子(Collection hooks)
  • pytest调用以下钩子函数来收集测试文件及目录。
  • pytest_collection(session): 执行给定会话的收集协议。
  • pytest_collect_directory(path, parent): 在遍历目录以获取集合文件之前调用。
  • pytest_collect_file(path, parent) 为给定的路径创建一个收集器，如果不相关，则创建“无”。
  • pytest_pycollect_makemodule(path: py._path.local.LocalPath, parent) 返回给定路径的模块收集器或无。
  • pytest_pycollect_makeitem(collector: PyCollector, name: str, obj: object) 返回模块中Python对象的自定义项目/收集器，或者返回None。在第一个非无结果处停止
  • pytest_generate_tests(metafunc: Metafunc) 生成（多个）对测试函数的参数化调用。
  • pytest_make_parametrize_id(config: Config, val: object, argname: str) 返回val 将由@ pytest.mark.parametrize调用使用的给定用户友好的字符串表示形式，如果挂钩不知道，则返回None val。
  • pytest_collection_modifyitems(session: Session, config: Config, items: List[Item]) 在执行收集后调用。可能会就地过滤或重新排序项目。
  • pytest_collection_finish(session: Session) 在执行并修改收集后调用。
• 用例执行钩子(Test running (runtest) hooks)
  • 运行测试相关的钩子，接收一个pytest.Item对象。
  • pytest_runtestloop(session: Session) 执行主运行测试循环（收集完成后）。
  • pytest_runtest_protocol(item: Item, nextitem: Optional[Item]) 对单个测试项目执行运行测试协议。
  • pytest_runtest_logstart(nodeid: str, location: Tuple[str, Optional[int], str]) 在运行单个项目的运行测试协议开始时调用。
  • pytest_runtest_logfinish(nodeid: str, location: Tuple[str, Optional[int], str])在为单个项目运行测试协议结束时调用。
  • pytest_runtest_setup(item: Item) 调用以执行测试项目的设置阶段。
  • pytest_runtest_call(item: Item) 调用以运行测试项目的测试（调用阶段）。
  • pytest_runtest_teardown(item: Item, nextitem: Optional[Item]) 调用以执行测试项目的拆卸阶段。
  • pytest_runtest_makereport(item: Item, call: CallInfo[None]) 被称为为_pytest.reports.TestReport测试项目的每个设置，调用和拆卸运行测试阶段创建一个。
  • pytest_pyfunc_call(pyfuncitem: Function) 调用基础测试功能。
• 报告钩子(Reporting hooks )
  • 与会话相关，断言相关的测试报告钩子。
  • pytest_collectstart(collector: Collector) 收集器开始收集。
  • pytest_make_collect_report(collector: Collector) 执行collector.collect()并返回一个CollectReport。
  • pytest_itemcollected(item: Item) 我们刚刚收集了一个测试项目。
  • pytest_collectreport(report: CollectReport) 收集器完成收集。
  • pytest_deselected(items: Sequence[Item]) 要求取消选择的测试项目，例如按关键字。
  • pytest_report_header(config: Config, startdir: py._path.local.LocalPath) 返回要显示为标题信息的字符串或字符串列表，以进行终端报告。
  • pytest_report_collectionfinish(config: Config, startdir: py._path.local.LocalPath, items: Sequence[Item]) 返回成功完成收集后将显示的字符串或字符串列表。
  • pytest_report_teststatus(report: Union[CollectReport, TestReport], config: Config) 返回结果类别，简写形式和详细词以进行状态报告。
  • pytest_terminal_summary(terminalreporter: TerminalReporter, exitstatus: ExitCode, config: Config) 在终端摘要报告中添加一个部分。
  • pytest_fixture_setup(fixturedef: FixtureDef[Any], request: SubRequest) 执行夹具设置执行。
  • pytest_fixture_post_finalizer(fixturedef: FixtureDef[Any], request: SubRequest) 在夹具拆除之后但在清除缓存之前调用，因此夹具结果fixturedef.cached_result仍然可用（不是 None）
  • pytest_warning_captured(warning_message: warnings.WarningMessage, when: Literal[‘config’, ‘collect’, ‘runtest’], item: Optional[Item], location: Optional[Tuple[str, int, str]]) （已弃用）处理内部pytest警告插件捕获的警告。
  • pytest_warning_recorded(warning_message: warnings.WarningMessage, when: Literal[‘config’, ‘collect’, ‘runtest’], nodeid: str, location: Optional[Tuple[str, int, str]]) 处理内部pytest警告插件捕获的警告。
  • pytest_runtest_logreport(report: TestReport) 处理项目的_pytest.reports.TestReport每个设置，调用和拆卸运行测试阶段产生的结果。
  • pytest_assertrepr_compare(config: Config, op: str, left: object, right: object) 返回失败断言表达式中的比较的说明。
  • pytest_assertion_pass(item: Item, lineno: int, orig: str, expl: str) （实验性的）在断言通过时调用。
• 调试钩子(Debugging/Interaction hooks)
  • 有几个钩子可以用于特殊报告或与异常交互。
  • pytest_internalerror(excrepr: ExceptionRepr, excinfo: ExceptionInfo[BaseException]) 要求内部错误。返回True以禁止对将INTERNALERROR消息直接打印到sys.stderr的回退处理。
  • pytest_keyboard_interrupt(excinfo: ExceptionInfo[Union[KeyboardInterrupt, Exit]]) 要求键盘中断。
  • pytest_exception_interact(node: Union[Item, Collector], call: CallInfo[Any], report: Union[CollectReport, TestReport]) 在引发可能可以交互处理的异常时调用。
  • pytest_enter_pdb(config: Config, pdb: pdb.Pdb) 调用了pdb.set_trace（）。

直接看UI自动化里面的代码钩子函数。更好理解

1.3、fixture函数

定义：

fixture修饰器来标记固定的工厂函数,在其他函数，模块，类或整个工程调用它时会被激活并优先执行,通常会被用于完成预置处理和重复操作

fixture(scope="function", params=None, autouse=False, ids=None, name=None)

• scope：被标记方法的作用域
  • “function” (default)：作用于每个测试方法，每个test都运行一次
  • “class”： 作用于整个类，每个class的所有test只运行一次
  • “module”：作用于整个模块，每个module的所有test只运行一次
  • “session”：作用于整个session(慎用)，每个session只运行一次
• params：(list类型)提供参数数据，供调用标记方法的函数使用
• autouse：是否自动运行,默认为False不运行，设置为True自动运行

用途：

• 装饰函数
• 装饰类
• 自己运行，不装饰任何（ autouse=True）
• 设置作用域（scope）
• 参数化，将返回值传递给测试用例
• 嵌套/覆盖/组合

事例：

如果测试用例的参数列表中包含fixture的名字，那么pytest会根据名字检测到该fixture，并在测试函数运行之前执行该fixture。

fixture可以完成测试任务，也可以返回数据给测试用例

import pytest

@pytest.fixture(scope="function", params=None, autouse=False, ids=None, name=None)
def func_01():
    print("这就定义了一个简单的fixture")
    return '结果'
    
def test_01(func_01):
    print(type(func_01), func_01) 
    
if __name__ == '__main__':
    pytest.main()

import pytest

@pytest.fixture(scope="function", params=None, autouse=False, ids=None, name=None)
def func_01():
    def _test(a):
        print(a)

    print("这就定义了一个简单的fixture")
    return _test

def test_01(func_01):
    print(type(func_01))
    func_01("自己调用")


if __name__ == '__main__':
    pytest.main()

 

直接看UI自动化里面的代码fixture函数。更好理解

1.4、conftest.py 文件

conftest.py是fixture函数的一个集合，可以理解为公共的提取出来放在一个文件里，然后供其它模块调用。不同于普通被调用的模块，conftest.py使用时不需要导入，Pytest会自动查找。

特点：

• 文件名字是固定不可改变，conftest.py
• 所有同目录测试文件运行前都会执行conftest.py文件， 不需要import导入

1.5、pytest.ini文件

全局配置文件，

• 一定要放在项目的根目录下
• 名称固定pytest.ini，不能更改
• 不管命令行运行还是主函数运行，都会加载ini配置文件进行运行（我们可在控制台执行时看到pytest.ini文件是否生效）
• 行首必须带[pytest]

二、目录文件说明

• ui-automation
  • allure-reports
  • allure-results
  • case
    • conftest.py
    • test_demo.py
    • test_login.py
  • config
    • data
      • demo.yaml
    • ele
      • demo.yaml
  • core
    • config.py
    • utils.py
  • network
  • pytest.ini
  • readme.md
  • requirements.txt
  • run.py
  • trace.zip

三、使用说明

3.1、原则：

1. 尽量用例按照最小模块编写，避免一个文件下步骤太长，后续不易维护
2. 元素定位按照xxxxxxxxx
3. 元素定位与操作分开写，两个文件，命名可以统一，方便后续维护

3.2、新增用例方法：

1、新增元素定位文件

在config/ele/文件夹下新建xxx.yaml文件

• 元素定位方法：text css xpath....
  • id： "#xxx" or "//[@id='xxxx']"
  • class： ".xxxx" or "//[class='xxxx']"
  • text： "text='xxxx'" or "//*[text()='xxxx']"
  • css： "input[name=\"wd\"]"
  • xpath： "xpath=//h2"

官方文档：https://playwright.dev/python/docs/next/selectors

ps：可以浏览器使用ChroPath工具、也可使用playwright带的playwright codegen进行定位

登录注册:
  账号输入框: //input[@class='phoneView']
  用户协议: .checkBox
  密码输入框: //input[@type='password']
  重置密码: text=重置密码

如上：“登录注册”是模块名。“账号输入框”是元素名称。元素用中文去定义，模块下名称要唯一

2、操作元素，编写步骤

在config/data/文件夹下新建xxx.yaml文件，最好跟ele文件夹下同名称

编写规则：

login: #用例名称,必须与第三步骤中的test_xxx一致。且该名称要整个项目唯一
  - title: 整个用例执行的一个简写名称
    des:  该文件用例描述
    need_cookie: False #是否需要登录cookie，默认是“是”，可不写
    steps: #下面是用例的步骤
        #下面是目前实现的能力，可根据步骤填写
        - name: 事例demo  #本次步骤要做什么
          generate:   #本次造什么数据
            email: email #在core/util/data_f()下自定义的变量
          get:
            base_url: base_url   #从存的或者generate生成的变量取值
          operate:  #元素操作
            selector: selector #在ele中存放的元素，对应中文名称
            method: fill  #事件方法click、fill、等
            data: 102@1.lanhu  #使用字符串
            data: $<email> #使用生成的字段，get或者generate
          assertion:  #断言
            selector: selector #在ele中存放的元素，对应中文名称
            method: to_be_visible  #通过什么断言方式断言
            except: value #是否有期望值没有就不写
          set:
            selector: selector #在ele里面写的元素
            key: cookie / url / 任意str #cookie跟url是两个特殊的
            method: input_value #如何获取元素里面的信息
          tab: new #new：切换tab/create新开tab

定位方法：Locators | Playwright Python

操作行为：Locator | Playwright Python

断言方法：Assertions | Playwright Python

3、组装成执行的用例

在case下面增加一个test_xxx.py文件，同上面两步名称一致

class TestXxx:  
    def test_xxx(self, page, value, run_case): #xxx与第二步骤操作元素的第一层级名称一致
        run_case(page, value)

也可在原有的py文件下增加上述代码。

四、运行

• run.py文件
  • 修改用例地址；cases = f"./case/test_demo.py"
• 命令行运行
  • python3 run.py

五、查看报告

• 查看allure报告
  • 在run.py文件中打开
  • 在目录树上打开allure-reports下的index.html
• 查看playwright带的trace报告（运行时直接生成了）
  • 命令行执行：playwright show-trace trace.zip，即可打开