使用Python和Pytest运行Playwright测试：常见问题与解决方案_技术教程

本教程旨在解决使用python和pytest运行playwright测试时常见的测试文件未被发现的问题。文章将详细阐述pytest的测试发现机制、正确的测试文件和函数命名规范、项目目录结构的最佳实践，并提供一个完整的示例代码和运行指南，帮助开发者顺利执行playwright自动化测试，提升测试效率和可靠性。

理解Pytest的测试发现机制

在使用Python进行自动化测试时，Pytest是一个功能强大且广泛使用的测试框架。它通过一套默认的规则来自动发现测试文件和测试函数。当您遇到测试无法运行，或者Pytest报告“collected 0 items”时，通常是由于这些发现规则未被满足。

Pytest的默认测试发现规则包括：

文件命名约定：Pytest会查找所有以test_开头或以_test.py结尾的Python文件。
函数/方法命名约定：在这些测试文件中，Pytest会查找所有以test_开头的函数或方法。
类命名约定：如果测试函数包含在类中，该类名必须以Test开头（且不能有__init__方法）。

如果您的测试文件或测试函数不符合这些命名约定，Pytest将无法识别它们为测试，从而导致测试无法被执行。

环境准备与项目结构建议

在开始编写和运行Playwright测试之前，请确保您的环境中已安装必要的库。

1. 安装Playwright和Pytest

您可以通过pip安装Playwright和Pytest：

pip install pytest playwright
playwright install

playwright install命令会下载所需的浏览器二进制文件。

2. 推荐的项目目录结构

为了确保Pytest能够正确发现您的测试，建议采用清晰的项目目录结构。以下是一个推荐的示例：

your_project/
├── tests/
│   ├── __init__.py  (可选，但推荐，使其成为一个Python包)
│   ├── test_example.py
│   └── test_another_feature.py
├── src/
│   └── your_application_code.py
├── requirements.txt
└── pyproject.toml (或 pytest.ini 用于Pytest配置)

将所有的测试文件放在一个专门的tests目录下是一个良好的实践。

编写Playwright测试用例

Playwright提供了一套简洁的API用于浏览器自动化。结合Pytest，您可以编写结构化的测试用例。以下是基于您提供的代码进行优化的示例：

创建一个名为tests/test_web_navigation.py的文件（请注意文件名前缀test_）：

import re
from playwright.sync_api import Page, expect

def test_has_title(page: Page):
    """
    测试导航到Playwright官网后，页面标题是否包含“Playwright”字样。
    """
    page.goto("https://playwright.dev/")

    # 期望页面标题包含正则表达式匹配的“Playwright”
    expect(page).to_have_title(re.compile("Playwright"))
    print("测试通过：页面标题包含'Playwright'")

def test_get_started_link(page: Page):
    """
    测试点击“Get started”链接后，是否能看到“Installation”标题。
    """
    page.goto("https://playwright.dev/")

    # 点击名为“Get started”的链接
    page.get_by_role("link", name="Get started").click()

    # 期望页面上存在名为“Installation”的标题，并且它是可见的
    expect(page.get_by_role("heading", name="Installation")).to_be_visible()
    print("测试通过：成功导航到安装页面")

# 注意：Playwright通常与pytest-playwright插件一起使用，
# 该插件会自动为每个测试函数提供一个`page` fixture。
# 如果您没有安装该插件，您可能需要手动初始化浏览器和页面上下文。
# 但对于Playwright的官方教程，通常默认您会使用pytest-playwright。

在这个示例中：

文件名为test_web_navigation.py，符合Pytest的文件发现规则。
函数名test_has_title和test_get_started_link都以test_开头，符合Pytest的函数发现规则。
page: Page是Playwright提供的类型提示，page对象由pytest-playwright插件作为fixture自动注入到测试函数中。

执行Playwright测试

在您的项目根目录下（或者在tests目录内），打开终端并运行pytest命令：

pytest

如果您的测试文件位于tests子目录中，pytest通常会自动递归查找。如果不在当前目录或其子目录中，您可以指定路径：

pytest tests/test_web_navigation.py

或者运行特定目录下的所有测试：

pytest tests/

成功运行后，您应该会看到类似以下的输出（具体内容可能因Pytest版本和测试结果而异）：

============================= test session starts ==============================
platform darwin -- Python 3.10.9, pytest-7.1.2, pluggy-1.0.0
rootdir: /Users/your_user/your_project
plugins: anyio-3.5.0, playwright-0.3.0
collected 2 items

tests/test_web_navigation.py ..                                          [100%]

============================== 2 passed in X.XXs ===============================

这里的..表示两个测试都通过了。

常见问题与故障排除

如果您仍然遇到“collected 0 items”的问题，请检查以下几点：

文件命名：确保您的测试文件以test_开头（例如test_my_app.py）或以_test.py结尾（例如my_app_test.py）。
函数命名：确保您的测试函数以test_开头（例如def test_login_feature():）。
目录结构：确认您在正确的目录执行pytest命令，或者指定了正确的测试文件/目录路径。
pytest-playwright插件：确保您已经安装了pytest-playwright插件，它是Playwright与Pytest集成的关键，负责提供page fixture等功能。
Python包：如果您的tests目录是一个Python包（即包含__init__.py文件），Pytest在某些情况下可能需要更明确的路径来发现测试。但在大多数简单场景下，这不会是问题。
Pytest版本：确保您使用的Pytest版本不是过旧或存在已知bug的版本。