测试

项目结构

NiceGUI 包提供了一个 pytest 插件，可通过 pytest_plugins = ['nicegui.testing.plugin'] 激活。这使得专门的测试夹具可用于测试你的 NiceGUI 用户界面。使用 screen 夹具，你可以通过无头浏览器运行测试（较慢），而使用 user 夹具则完全在 Python 中模拟（较快）。如果只需要一种测试夹具，也可以使用插件 nicegui.testing.user_plugin 或 nicegui.testing.screen_plugin。

构建项目和测试的方式多种多样。这里我们仅介绍两种我们认为有用的方法，一种适用于小型应用和实验，另一种模块化方法适用于大型项目。你可以在 pytest 文档中找到更多信息。

用户夹具

我们建议尽可能使用用户夹具（user fixture）而非 屏幕夹具（screen fixture），因为其执行速度与单元测试相当，且通过 pytest_plugins = ['nicegui.testing.user_plugin'] 加载时无需依赖 Selenium。用户夹具移除了浏览器，完全通过 Python 轻量级模拟实现。具体配置说明请参阅项目结构文档。

你可断言"看到"特定元素或内容、点击按钮、向输入框键入文本及触发事件。我们致力于提供简洁的API，使验收测试编写如故事般流畅易懂。由于执行速度极快，传统认为UI测试缓慢昂贵的测试金字塔模型已不再适用。

await user.open('/')
user.find('Username').type('user1')
user.find('Password').type('pass1').trigger('keydown.enter')
await user.should_see('Hello user1!')
user.find('logout').click()
await user.should_see('Log in')

提示

用户夹具功能较新，目前仍缺少一些特性。请在 GitHub 上通过单独的功能请求告知我们。

限定范围

页面经常会在布局的不同部分复用相同的标记或内容。要将 user.should_see(...)、user.should_not_see(...) 和 user.find(...) 限制在页面的某一部分，可以用 user.scope(...) 进入该部分。在代码块内部，只会搜索所进入元素的后代元素。它接受与 user.find(...) 相同的筛选参数，必须恰好匹配一个元素，并会返回该元素以便进一步使用。

3.16.0 版本新增。

# UI 代码
with ui.card().mark('left'):
    ui.label('Apple')
    ui.button('Buy')
with ui.card().mark('right'):
    ui.label('Banana')
    ui.button('Buy')

# 用户断言
with user.scope(marker='left'):
    await user.should_see('Apple')
    await user.should_not_see('Banana')
    user.find('Buy').click()

屏幕夹具

屏幕测试装置会启动一个真实的（无头）浏览器来与你的应用程序交互。仅当你需要测试特定于浏览器的行为时才需使用此功能。NiceGUI 本身已通过该装置进行全面测试，确保每个组件都能按预期工作。因此，仅在必要时使用它。

from selenium.webdriver.common.keys import Keys

screen.open('/')
screen.type(Keys.TAB) # to focus on the first input
screen.type('user1')
screen.type(Keys.TAB) # to focus the second input
screen.type('pass1')
screen.click('Log in')
screen.should_contain('Hello user1!')
screen.click('logout')
screen.should_contain('Log in')