Skip to content

Laravel Dusk

介绍

Laravel Dusk 提供了一种富有表现力且易于使用的浏览器自动化和测试 API。默认情况下,Dusk 不需要在本地计算机上安装 JDK 或 Selenium。相反,Dusk 使用独立的 ChromeDriver 安装。不过,您可以自由使用任何其他兼容 Selenium 的驱动程序。

安装

要开始使用,您应该安装 Google Chrome 并将 laravel/dusk Composer 依赖项添加到您的项目中:

shell
composer require --dev laravel/dusk
exclamation

如果您手动注册 Dusk 的服务提供者,您绝不应该在生产环境中注册它,因为这样做可能会导致任意用户能够与您的应用程序进行身份验证。

安装 Dusk 包后,执行 dusk:install Artisan 命令。dusk:install 命令将创建一个 tests/Browser 目录、一个示例 Dusk 测试,并为您的操作系统安装 Chrome Driver 二进制文件:

shell
php artisan dusk:install

接下来,在应用程序的 .env 文件中设置 APP_URL 环境变量。此值应与您在浏览器中访问应用程序时使用的 URL 匹配。

lightbulb

如果您使用 Laravel Sail 来管理本地开发环境,请同时查阅 Sail 文档以了解 配置和运行 Dusk 测试

管理 ChromeDriver 安装

如果您想安装与 Laravel Dusk 通过 dusk:install 命令安装的版本不同的 ChromeDriver 版本,可以使用 dusk:chrome-driver 命令:

shell
# 为您的操作系统安装最新版本的 ChromeDriver...
php artisan dusk:chrome-driver

# 为您的操作系统安装指定版本的 ChromeDriver...
php artisan dusk:chrome-driver 86

# 为所有支持的操作系统安装指定版本的 ChromeDriver...
php artisan dusk:chrome-driver --all

# 为您的操作系统安装与检测到的 Chrome / Chromium 版本匹配的 ChromeDriver 版本...
php artisan dusk:chrome-driver --detect
exclamation

Dusk 需要 chromedriver 二进制文件可执行。如果您在运行 Dusk 时遇到问题,您应该使用以下命令确保二进制文件可执行:chmod -R 0755 vendor/laravel/dusk/bin/

使用其他浏览器

默认情况下,Dusk 使用 Google Chrome 和独立的 ChromeDriver 安装来运行您的浏览器测试。不过,您可以启动自己的 Selenium 服务器,并在任何您希望的浏览器上运行测试。

要开始,打开 tests/DuskTestCase.php 文件,这是应用程序的基本 Dusk 测试用例。在此文件中,您可以删除对 startChromeDriver 方法的调用。这将阻止 Dusk 自动启动 ChromeDriver:

php
/**
 * 准备 Dusk 测试执行。
 *
 * @beforeClass
 * @return void
 */
public static function prepare()
{
    // static::startChromeDriver();
}

接下来,您可以修改 driver 方法以连接到您选择的 URL 和端口。此外,您可以修改应传递给 WebDriver 的“期望能力”:

php
/**
 * 创建 RemoteWebDriver 实例。
 *
 * @return \Facebook\WebDriver\Remote\RemoteWebDriver
 */
protected function driver()
{
    return RemoteWebDriver::create(
        'http://localhost:4444/wd/hub', DesiredCapabilities::phantomjs()
    );
}

入门

生成测试

要生成 Dusk 测试,请使用 dusk:make Artisan 命令。生成的测试将放置在 tests/Browser 目录中:

shell
php artisan dusk:make LoginTest

在每个测试后重置数据库

您编写的大多数测试将与从应用程序数据库中检索数据的页面交互;然而,您的 Dusk 测试不应使用 RefreshDatabase trait。RefreshDatabase trait 利用数据库事务,这在 HTTP 请求之间不可用或不可用。相反,您有两个选项:DatabaseMigrations trait 和 DatabaseTruncation trait。

使用数据库迁移

DatabaseMigrations trait 将在每个测试之前运行您的数据库迁移。然而,为每个测试删除并重新创建数据库表通常比截断表要慢:

php
<?php

namespace Tests\Browser;

use App\Models\User;
use Illuminate\Foundation\Testing\DatabaseMigrations;
use Laravel\Dusk\Chrome;
use Tests\DuskTestCase;

class ExampleTest extends DuskTestCase
{
    use DatabaseMigrations;
}
exclamation

执行 Dusk 测试时不能使用 SQLite 内存数据库。由于浏览器在其自己的进程中执行,因此无法访问其他进程的内存数据库。

使用数据库截断

在使用 DatabaseTruncation trait 之前,您必须使用 Composer 包管理器安装 doctrine/dbal 包:

shell
composer require --dev doctrine/dbal

DatabaseTruncation trait 将在第一个测试中迁移您的数据库,以确保您的数据库表已正确创建。然而,在后续测试中,数据库的表将仅被截断 - 提供比重新运行所有数据库迁移更快的速度提升:

php
<?php

namespace Tests\Browser;

use App\Models\User;
use Illuminate\Foundation\Testing\DatabaseTruncation;
use Laravel\Dusk\Chrome;
use Tests\DuskTestCase;

class ExampleTest extends DuskTestCase
{
    use DatabaseTruncation;
}

默认情况下,此 trait 将截断除 migrations 表之外的所有表。如果您想自定义应截断的表,可以在测试类上定义 $tablesToTruncate 属性:

php
/**
 * 指示应截断哪些表。
 *
 * @var array
 */
protected $tablesToTruncate = ['users'];

或者,您可以在测试类上定义 $exceptTables 属性,以指定应从截断中排除哪些表:

php
/**
 * 指示应从截断中排除哪些表。
 *
 * @var array
 */
protected $exceptTables = ['users'];

要指定应截断其表的数据库连接,可以在测试类上定义 $connectionsToTruncate 属性:

php
/**
 * 指示应截断其表的连接。
 *
 * @var array
 */
protected $connectionsToTruncate = ['mysql'];

运行测试

要运行浏览器测试,请执行 dusk Artisan 命令:

shell
php artisan dusk

如果您上次运行 dusk 命令时测试失败,您可以通过使用 dusk:fails 命令重新运行失败的测试来节省时间:

shell
php artisan dusk:fails

dusk 命令接受 PHPUnit 测试运行器通常接受的任何参数,例如允许您仅运行给定 的测试:

shell
php artisan dusk --group=foo
lightbulb

如果您使用 Laravel Sail 来管理本地开发环境,请查阅 Sail 文档以了解 配置和运行 Dusk 测试

手动启动 ChromeDriver

默认情况下,Dusk 将自动尝试启动 ChromeDriver。如果这对您的特定系统不起作用,您可以在运行 dusk 命令之前手动启动 ChromeDriver。如果您选择手动启动 ChromeDriver,您应该注释掉 tests/DuskTestCase.php 文件中的以下行:

php
/**
 * 准备 Dusk 测试执行。
 *
 * @beforeClass
 * @return void
 */
public static function prepare()
{
    // static::startChromeDriver();
}

此外,如果您在 9515 以外的端口上启动 ChromeDriver,您应该修改同一类的 driver 方法以反映正确的端口:

php
/**
 * 创建 RemoteWebDriver 实例。
 *
 * @return \Facebook\WebDriver\Remote\RemoteWebDriver
 */
protected function driver()
{
    return RemoteWebDriver::create(
        'http://localhost:9515', DesiredCapabilities::chrome()
    );
}

环境处理

要强制 Dusk 在运行测试时使用其自己的环境文件,请在项目根目录中创建 .env.dusk.{environment} 文件。例如,如果您将从 local 环境启动 dusk 命令,您应该创建一个 .env.dusk.local 文件。

运行测试时,Dusk 将备份您的 .env 文件并将您的 Dusk 环境重命名为 .env。测试完成后,您的 .env 文件将被恢复。

浏览器基础

创建浏览器

要开始,让我们编写一个测试来验证我们可以登录到应用程序。生成测试后,我们可以修改它以导航到登录页面,输入一些凭据,并点击“登录”按钮。要创建浏览器实例,您可以从 Dusk 测试中调用 browse 方法:

php
<?php

namespace Tests\Browser;

use App\Models\User;
use Illuminate\Foundation\Testing\DatabaseMigrations;
use Laravel\Dusk\Chrome;
use Tests\DuskTestCase;

class ExampleTest extends DuskTestCase
{
    use DatabaseMigrations;

    /**
     * 一个基本的浏览器测试示例。
     *
     * @return void
     */
    public function test_basic_example()
    {
        $user = User::factory()->create([
            'email' => 'taylor@laravel.com',
        ]);

        $this->browse(function ($browser) use ($user) {
            $browser->visit('/login')
                    ->type('email', $user->email)
                    ->type('password', 'password')
                    ->press('Login')
                    ->assertPathIs('/home');
        });
    }
}

如上例所示,browse 方法接受一个闭包。Dusk 将自动将浏览器实例传递给此闭包,并且是用于与应用程序交互和进行断言的主要对象。

创建多个浏览器

有时您可能需要多个浏览器才能正确执行测试。例如,可能需要多个浏览器来测试与 websockets 交互的聊天屏幕。要创建多个浏览器,只需在传递给 browse 方法的闭包签名中添加更多浏览器参数:

php
$this->browse(function ($first, $second) {
    $first->loginAs(User::find(1))
          ->visit('/home')
          ->waitForText('Message');

    $second->loginAs(User::find(2))
           ->visit('/home')
           ->waitForText('Message')
           ->type('message', 'Hey Taylor')
           ->press('Send');

    $first->waitForText('Hey Taylor')
          ->assertSee('Jeffrey Way');
});

导航

visit 方法可用于导航到应用程序中的给定 URI:

php
$browser->visit('/login');

您可以使用 visitRoute 方法导航到 命名路由

php
$browser->visitRoute('login');

您可以使用 backforward 方法导航“后退”和“前进”:

php
$browser->back();

$browser->forward();

您可以使用 refresh 方法刷新页面:

php
$browser->refresh();

调整浏览器窗口大小

您可以使用 resize 方法调整浏览器窗口的大小:

php
$browser->resize(1920, 1080);

maximize 方法可用于最大化浏览器窗口:

php
$browser->maximize();

fitContent 方法将调整浏览器窗口的大小以匹配其内容的大小:

php
$browser->fitContent();

当测试失败时,Dusk 将自动调整浏览器的大小以适应内容,然后再截取屏幕截图。您可以通过在测试中调用 disableFitOnFailure 方法来禁用此功能:

php
$browser->disableFitOnFailure();

您可以使用 move 方法将浏览器窗口移动到屏幕上的不同位置:

php
$browser->move($x = 100, $y = 100);

浏览器宏

如果您想定义一个可以在各种测试中重用的自定义浏览器方法,可以在 Browser 类上使用 macro 方法。通常,您应该从 服务提供者boot 方法中调用此方法:

php
<?php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;
use Laravel\Dusk\Browser;

class DuskServiceProvider extends ServiceProvider
{
    /**
     * 注册 Dusk 的浏览器宏。
     *
     * @return void
     */
    public function boot()
    {
        Browser::macro('scrollToElement', function ($element = null) {
            $this->script("$('html, body').animate({ scrollTop: $('$element').offset().top }, 0);");

            return $this;
        });
    }
}

macro 函数接受一个名称作为第一个参数,一个闭包作为第二个参数。当在 Browser 实例上调用宏作为方法时,将执行宏的闭包:

php
$this->browse(function ($browser) use ($user) {
    $browser->visit('/pay')
            ->scrollToElement('#credit-card-details')
            ->assertSee('Enter Credit Card Details');
});

认证

通常,您将测试需要认证的页面。您可以使用 Dusk 的 loginAs 方法,以避免在每次测试期间与应用程序的登录屏幕交互。loginAs 方法接受与您的可认证模型关联的主键或可认证模型实例:

php
use App\Models\User;

$this->browse(function ($browser) {
    $browser->loginAs(User::find(1))
          ->visit('/home');
});
exclamation

使用 loginAs 方法后,用户会话将在文件中的所有测试中保持。

Cookies

您可以使用 cookie 方法获取或设置加密 cookie 的值。默认情况下,Laravel 创建的所有 cookie 都是加密的:

php
$browser->cookie('name');

$browser->cookie('name', 'Taylor');

您可以使用 plainCookie 方法获取或设置未加密 cookie 的值:

php
$browser->plainCookie('name');

$browser->plainCookie('name', 'Taylor');

您可以使用 deleteCookie 方法删除给定的 cookie:

php
$browser->deleteCookie('name');

执行 JavaScript

您可以使用 script 方法在浏览器中执行任意 JavaScript 语句:

php
$browser->script('document.documentElement.scrollTop = 0');

$browser->script([
    'document.body.scrollTop = 0',
    'document.documentElement.scrollTop = 0',
]);

$output = $browser->script('return window.location.pathname');

截屏

您可以使用 screenshot 方法截取屏幕截图并将其存储为给定的文件名。所有屏幕截图将存储在 tests/Browser/screenshots 目录中:

php
$browser->screenshot('filename');

responsiveScreenshots 方法可用于在各种断点处截取一系列屏幕截图:

php
$browser->responsiveScreenshots('filename');

将控制台输出存储到磁盘

您可以使用 storeConsoleLog 方法将当前浏览器的控制台输出写入磁盘,并使用给定的文件名。控制台输出将存储在 tests/Browser/console 目录中:

php
$browser->storeConsoleLog('filename');

将页面源代码存储到磁盘

您可以使用 storeSource 方法将当前页面的源代码写入磁盘,并使用给定的文件名。页面源代码将存储在 tests/Browser/source 目录中:

php
$browser->storeSource('filename');

与元素交互

Dusk 选择器

选择用于与元素交互的良好 CSS 选择器是编写 Dusk 测试中最困难的部分之一。随着时间的推移,前端更改可能会导致以下 CSS 选择器破坏您的测试:

php
// HTML...

<button>Login</button>

// 测试...

$browser->click('.login-page .container div > button');

Dusk 选择器允许您专注于编写有效的测试,而不是记住 CSS 选择器。要定义选择器,请在 HTML 元素中添加 dusk 属性。然后,在与 Dusk 浏览器交互时,前缀选择器为 @ 以在测试中操作附加元素:

php
// HTML...

<button dusk="login-button">Login</button>

// 测试...

$browser->click('@login-button');

文本、值和属性

检索和设置值

Dusk 提供了几种方法来与页面上元素的当前值、显示文本和属性进行交互。例如,要获取与给定 CSS 或 Dusk 选择器匹配的元素的“值”,请使用 value 方法:

php
// 检索值...
$value = $browser->value('selector');

// 设置值...
$browser->value('selector', 'value');

您可以使用 inputValue 方法获取具有给定字段名称的输入元素的“值”:

php
$value = $browser->inputValue('field');

检索文本

text 方法可用于检索与给定选择器匹配的元素的显示文本:

php
$text = $browser->text('selector');

检索属性

最后,attribute 方法可用于检索与给定选择器匹配的元素的属性值:

php
$attribute = $browser->attribute('selector', 'value');

与表单交互

输入值

Dusk 提供了多种方法来与表单和输入元素进行交互。首先,让我们看一个将文本输入到输入字段的示例:

php
$browser->type('email', 'taylor@laravel.com');

请注意,尽管方法接受一个 CSS 选择器,但我们不需要在 type 方法中传递 CSS 选择器。如果未提供 CSS 选择器,Dusk 将搜索具有给定 name 属性的 inputtextarea 字段。

要在不清除内容的情况下向字段追加文本,可以使用 append 方法:

php
$browser->type('tags', 'foo')
        ->append('tags', ', bar, baz');

您可以使用 clear 方法清除输入的值:

php
$browser->clear('email');

您可以使用 typeSlowly 方法指示 Dusk 慢速输入。默认情况下,Dusk 在按键之间会暂停 100 毫秒。要自定义按键之间的时间量,可以将适当的毫秒数作为方法的第三个参数传递:

php
$browser->typeSlowly('mobile', '+1 (202) 555-5555');

$browser->typeSlowly('mobile', '+1 (202) 555-5555', 300);

您可以使用 appendSlowly 方法慢速追加文本:

php
$browser->type('tags', 'foo')
        ->appendSlowly('tags', ', bar, baz');

下拉菜单

要选择 select 元素上可用的值,可以使用 select 方法。与 type 方法一样,select 方法不需要完整的 CSS 选择器。传递值给 select 方法时,您应该传递底层选项值而不是显示文本:

php
$browser->select('size', 'Large');

您可以通过省略第二个参数来选择随机选项:

php
$browser->select('size');

通过将数组作为 select 方法的第二个参数提供,您可以指示方法选择多个选项:

php
$browser->select('categories', ['Art', 'Music']);

复选框

要“选中”复选框输入,可以使用 check 方法。与许多其他输入相关方法一样,不需要完整的 CSS 选择器。如果找不到 CSS 选择器匹配,Dusk 将搜索具有匹配 name 属性的复选框:

php
$browser->check('terms');

uncheck 方法可用于“取消选中”复选框输入:

php
$browser->uncheck('terms');

单选按钮

要“选择” radio 输入选项,可以使用 radio 方法。与许多其他输入相关方法一样,不需要完整的 CSS 选择器。如果找不到 CSS 选择器匹配,Dusk 将搜索具有匹配 namevalue 属性的 radio 输入:

php
$browser->radio('size', 'large');

附加文件

attach 方法可用于将文件附加到 file 输入元素。与许多其他输入相关方法一样,不需要完整的 CSS 选择器。如果找不到 CSS 选择器匹配,Dusk 将搜索具有匹配 name 属性的 file 输入:

php
$browser->attach('photo', __DIR__.'/photos/mountains.png');
exclamation

附加功能需要在服务器上安装并启用 Zip PHP 扩展。

按下按钮

press 方法可用于点击页面上的按钮元素。传递给 press 方法的参数可以是按钮的显示文本或 CSS / Dusk 选择器:

php
$browser->press('Login');

在提交表单时,许多应用程序在按下后禁用表单的提交按钮,然后在表单提交的 HTTP 请求完成时重新启用按钮。要按下按钮并等待按钮重新启用,可以使用 pressAndWaitFor 方法:

php
// 按下按钮并等待最多 5 秒钟以启用...
$browser->pressAndWaitFor('Save');

// 按下按钮并等待最多 1 秒钟以启用...
$browser->pressAndWaitFor('Save', 1);

点击链接

要点击链接,可以在浏览器实例上使用 clickLink 方法。clickLink 方法将点击具有给定显示文本的链接:

php
$browser->clickLink($linkText);

您可以使用 seeLink 方法确定页面上是否可见具有给定显示文本的链接:

php
if ($browser->seeLink($linkText)) {
    // ...
}
exclamation

这些方法与 jQuery 交互。如果页面上没有 jQuery,Dusk 将自动将其注入页面,以便在测试期间可用。

使用键盘

keys 方法允许您为给定元素提供比 type 方法通常允许的更复杂的输入序列。例如,您可以指示 Dusk 在输入值时按住修饰键。在此示例中,将在输入 taylor 时按住 shift 键。输入 taylor 后,将在没有任何修饰键的情况下输入 swift

php
$browser->keys('selector', ['{shift}', 'taylor'], 'swift');

keys 方法的另一个有价值的用例是将“键盘快捷键”组合发送到应用程序的主要 CSS 选择器:

php
$browser->keys('.app', ['{command}', 'j']);
lightbulb

所有修饰键(如 {command})都用 {} 字符包裹,并匹配 Facebook\WebDriver\WebDriverKeys 类中定义的常量,可以在 GitHub 上找到

使用鼠标

点击元素

click 方法可用于点击与给定 CSS 或 Dusk 选择器匹配的元素:

php
$browser->click('.selector');

clickAtXPath 方法可用于点击与给定 XPath 表达式匹配的元素:

php
$browser->clickAtXPath('//div[@class = "selector"]');

clickAtPoint 方法可用于点击浏览器可视区域内给定坐标处的最上层元素:

php
$browser->clickAtPoint($x = 0, $y = 0);

doubleClick 方法可用于模拟鼠标的双击:

php
$browser->doubleClick();

rightClick 方法可用于模拟鼠标的右键点击:

php
$browser->rightClick();

$browser->rightClick('.selector');

clickAndHold 方法可用于模拟鼠标按钮被点击并按住。随后调用 releaseMouse 方法将撤销此行为并释放鼠标按钮:

php
$browser->clickAndHold()
        ->pause(1000)
        ->releaseMouse();

鼠标悬停

mouseover 方法可用于在需要将鼠标移动到与给定 CSS 或 Dusk 选择器匹配的元素上时:

php
$browser->mouseover('.selector');

拖放

drag 方法可用于将与给定选择器匹配的元素拖动到另一个元素:

php
$browser->drag('.from-selector', '.to-selector');

或者,您可以在单个方向上拖动元素:

php
$browser->dragLeft('.selector', $pixels = 10);
$browser->dragRight('.selector', $pixels = 10);
$browser->dragUp('.selector', $pixels = 10);
$browser->dragDown('.selector', $pixels = 10);

最后,您可以通过给定的偏移量拖动元素:

php
$browser->dragOffset('.selector', $x = 10, $y = 10);

JavaScript 对话框

Dusk 提供了多种方法来与 JavaScript 对话框交互。例如,您可以使用 waitForDialog 方法等待 JavaScript 对话框出现。此方法接受一个可选参数,指示等待对话框出现的秒数:

php
$browser->waitForDialog($seconds = null);

assertDialogOpened 方法可用于断言对话框已显示并包含给定消息:

php
$browser->assertDialogOpened('Dialog message');

如果 JavaScript 对话框包含提示,您可以使用 typeInDialog 方法在提示中输入值:

php
$browser->typeInDialog('Hello World');

要通过点击“确定”按钮关闭打开的 JavaScript 对话框,您可以调用 acceptDialog 方法:

php
$browser->acceptDialog();

要通过点击“取消”按钮关闭打开的 JavaScript 对话框,您可以调用 dismissDialog 方法:

php
$browser->dismissDialog();

选择器范围

有时您可能希望在给定选择器内执行多个操作。例如,您可能希望断言某些文本仅在表格中存在,然后点击表格中的按钮。您可以使用 with 方法来实现这一点。在传递给 with 方法的闭包中执行的所有操作都将限定在原始选择器内:

php
$browser->with('.table', function ($table) {
    $table->assertSee('Hello World')
          ->clickLink('Delete');
});

您可能偶尔需要在当前范围之外执行断言。您可以使用 elsewhereelsewhereWhenAvailable 方法来实现这一点:

php
$browser->with('.table', function ($table) {
    // 当前范围是 `body .table`...

    $browser->elsewhere('.page-title', function ($title) {
        // 当前范围是 `body .page-title`...
        $title->assertSee('Hello World');
    });

    $browser->elsewhereWhenAvailable('.page-title', function ($title) {
        // 当前范围是 `body .page-title`...
        $title->assertSee('Hello World');
    });
 });

等待元素

在测试广泛使用 JavaScript 的应用程序时,通常需要“等待”某些元素或数据可用,然后再继续测试。Dusk 使这变得非常简单。使用多种方法,您可以等待元素在页面上变得可见,甚至可以等待给定的 JavaScript 表达式评估为 true

等待

如果您只需要暂停测试给定的毫秒数,请使用 pause 方法:

php
$browser->pause(1000);

如果您只需要在给定条件为 true 时暂停测试,请使用 pauseIf 方法:

php
$browser->pauseIf(App::environment('production'), 1000);

同样,如果您需要在给定条件为 true 时暂停测试,可以使用 pauseUnless 方法:

php
$browser->pauseUnless(App::environment('testing'), 1000);

等待选择器

waitFor 方法可用于暂停测试的执行,直到与给定 CSS 或 Dusk 选择器匹配的元素在页面上显示。默认情况下,这将暂停测试最多五秒钟,然后抛出异常。如果需要,您可以将自定义超时阈值作为方法的第二个参数传递:

php
// 最多等待五秒钟以获取选择器...
$browser->waitFor('.selector');

// 最多等待一秒钟以获取选择器...
$browser->waitFor('.selector', 1);

您还可以等待,直到与给定选择器匹配的元素包含给定文本:

php
// 最多等待五秒钟以获取选择器包含给定文本...
$browser->waitForTextIn('.selector', 'Hello World');

// 最多等待一秒钟以获取选择器包含给定文本...
$browser->waitForTextIn('.selector', 'Hello World', 1);

您还可以等待,直到与给定选择器匹配的元素从页面中消失:

php
// 最多等待五秒钟,直到选择器消失...
$browser->waitUntilMissing('.selector');

// 最多等待一秒钟,直到选择器消失...
$browser->waitUntilMissing('.selector', 1);

或者,您可以等待,直到与给定选择器匹配的元素被启用或禁用:

php
// 最多等待五秒钟,直到选择器被启用...
$browser->waitUntilEnabled('.selector');

// 最多等待一秒钟,直到选择器被启用...
$browser->waitUntilEnabled('.selector', 1);

// 最多等待五秒钟,直到选择器被禁用...
$browser->waitUntilDisabled('.selector');

// 最多等待一秒钟,直到选择器被禁用...
$browser->waitUntilDisabled('.selector', 1);

在可用时选择器范围

有时,您可能希望等待与给定选择器匹配的元素出现,然后与该元素交互。例如,您可能希望等待,直到模态窗口可用,然后按下模态中的“确定”按钮。whenAvailable 方法可用于实现这一点。在给定闭包中执行的所有元素操作都将限定在原始选择器内:

php
$browser->whenAvailable('.modal', function ($modal) {
    $modal->assertSee('Hello World')
          ->press('OK');
});

等待文本

waitForText 方法可用于等待,直到给定文本在页面上显示:

php
// 最多等待五秒钟以获取文本...
$browser->waitForText('Hello World');

// 最多等待一秒钟以获取文本...
$browser->waitForText('Hello World', 1);

您可以使用 waitUntilMissingText 方法等待,直到显示的文本从页面中删除:

php
// 最多等待五秒钟以删除文本...
$browser->waitUntilMissingText('Hello World');

// 最多等待一秒钟以删除文本...
$browser->waitUntilMissingText('Hello World', 1);

等待链接

waitForLink 方法可用于等待,直到给定链接文本在页面上显示:

php
// 最多等待五秒钟以获取链接...
$browser->waitForLink('Create');

// 最多等待一秒钟以获取链接...
$browser->waitForLink('Create', 1);

等待输入

waitForInput 方法可用于等待,直到给定输入字段在页面上可见:

php
// 最多等待五秒钟以获取输入...
$browser->waitForInput($field);

// 最多等待一秒钟以获取输入...
$browser->waitForInput($field, 1);

等待页面位置

在进行路径断言(如 $browser->assertPathIs('/home'))时,如果 window.location.pathname 正在异步更新,则断言可能会失败。您可以使用 waitForLocation 方法等待位置为给定值:

php
$browser->waitForLocation('/secret');

waitForLocation 方法还可用于等待当前窗口位置为完全限定的 URL:

php
$browser->waitForLocation('https://example.com/path');

您还可以等待 命名路由 的位置:

php
$browser->waitForRoute($routeName, $parameters);

等待页面重新加载

如果您需要在执行操作后等待页面重新加载,请使用 waitForReload 方法:

php
use Laravel\Dusk\Browser;

$browser->waitForReload(function (Browser $browser) {
    $browser->press('Submit');
})
->assertSee('Success!');

由于在点击按钮后通常需要等待页面重新加载,您可以使用 clickAndWaitForReload 方法以方便:

php
$browser->clickAndWaitForReload('.selector')
        ->assertSee('something');

等待 JavaScript 表达式

有时,您可能希望暂停测试的执行,直到给定的 JavaScript 表达式评估为 true。您可以使用 waitUntil 方法轻松实现这一点。将表达式传递给此方法时,您不需要包含 return 关键字或结束分号:

php
// 最多等待五秒钟以使表达式为 true...
$browser->waitUntil('App.data.servers.length > 0');

// 最多等待一秒钟以使表达式为 true...
$browser->waitUntil('App.data.servers.length > 0', 1);

等待 Vue 表达式

waitUntilVuewaitUntilVueIsNot 方法可用于等待 Vue 组件 属性具有给定值:

php
// 等待组件属性包含给定值...
$browser->waitUntilVue('user.name', 'Taylor', '@user');

// 等待组件属性不包含给定值...
$browser->waitUntilVueIsNot('user.name', null, '@user');

等待 JavaScript 事件

waitForEvent 方法可用于暂停测试的执行,直到发生 JavaScript 事件:

php
$browser->waitForEvent('load');

事件监听器附加到当前范围,默认情况下是 body 元素。使用限定选择器时,事件监听器将附加到匹配的元素:

php
$browser->with('iframe', function ($iframe) {
    // 等待 iframe 的 load 事件...
    $iframe->waitForEvent('load');
});

您还可以将选择器作为 waitForEvent 方法的第二个参数提供,以将事件监听器附加到特定元素:

php
$browser->waitForEvent('load', '.selector');

您还可以等待 documentwindow 对象上的事件:

php
// 等待文档滚动...
$browser->waitForEvent('scroll', 'document');

// 最多等待五秒钟,直到窗口调整大小...
$browser->waitForEvent('resize', 'window', 5);

使用回调等待

Dusk 中的许多“等待”方法依赖于底层的 waitUsing 方法。您可以直接使用此方法等待给定闭包返回 truewaitUsing 方法接受等待的最大秒数、评估闭包的间隔、闭包和可选的失败消息:

php
$browser->waitUsing(10, 1, function () use ($something) {
    return $something->isReady();
}, "Something wasn't ready in time.");

滚动元素到视图中

有时您可能无法点击元素,因为它在浏览器的可视区域之外。scrollIntoView 方法将滚动浏览器窗口,直到给定选择器的元素在视图中:

php
$browser->scrollIntoView('.selector')
        ->click('.selector');

可用断言

Dusk 提供了多种断言,您可以对应用程序进行断言。所有可用的断言都在下面的列表中记录:

assertTitle

断言页面标题与给定文本匹配:

php
$browser->assertTitle($title);

assertTitleContains

断言页面标题包含给定文本:

php
$browser->assertTitleContains($title);

assertUrlIs

断言当前 URL(不含查询字符串)与给定字符串匹配:

php
$browser->assertUrlIs($url);

assertSchemeIs

断言当前 URL 的方案与给定方案匹配:

php
$browser->assertSchemeIs($scheme);

assertSchemeIsNot

断言当前 URL 的方案不与给定方案匹配:

php
$browser->assertSchemeIsNot($scheme);

assertHostIs

断言当前 URL 的主机与给定主机匹配:

php
$browser->assertHostIs($host);

assertHostIsNot

断言当前 URL 的主机不与给定主机匹配:

php
$browser->assertHostIsNot($host);

assertPortIs

断言当前 URL 的端口与给定端口匹配:

php
$browser->assertPortIs($port);

assertPortIsNot

断言当前 URL 的端口不与给定端口匹配:

php
$browser->assertPortIsNot($port);

assertPathBeginsWith

断言当前 URL 的路径以给定路径开头:

php
$browser->assertPathBeginsWith('/home');

assertPathIs

断言当前路径与给定路径匹配:

php
$browser->assertPathIs('/home');

assertPathIsNot

断言当前路径不与给定路径匹配:

php
$browser->assertPathIsNot('/home');

assertRouteIs

断言当前 URL 与给定命名路由的 URL 匹配:

php
$browser->assertRouteIs($name, $parameters);

assertQueryStringHas

断言给定查询字符串参数存在:

php
$browser->assertQueryStringHas($name);

断言给定查询字符串参数存在并具有给定值:

php
$browser->assertQueryStringHas($name, $value);

assertQueryStringMissing

断言给定查询字符串参数不存在:

php
$browser->assertQueryStringMissing($name);

assertFragmentIs

断言 URL 的当前哈希片段与给定片段匹配:

php
$browser->assertFragmentIs('anchor');

assertFragmentBeginsWith

断言 URL 的当前哈希片段以给定片段开头:

php
$browser->assertFragmentBeginsWith('anchor');

assertFragmentIsNot

断言 URL 的当前哈希片段不与给定片段匹配:

php
$browser->assertFragmentIsNot('anchor');

assertHasCookie

断言给定加密的 cookie 存在:

php
$browser->assertHasCookie($name);

assertHasPlainCookie

断言给定未加密的 cookie 存在:

php
$browser->assertHasPlainCookie($name);

assertCookieMissing

断言给定加密的 cookie 不存在:

php
$browser->assertCookieMissing($name);

assertPlainCookieMissing

断言给定未加密的 cookie 不存在:

php
$browser->assertPlainCookieMissing($name);

assertCookieValue

断言加密的 cookie 具有给定值:

php
$browser->assertCookieValue($name, $value);

assertPlainCookieValue

断言未加密的 cookie 具有给定值:

php
$browser->assertPlainCookieValue($name, $value);

assertSee

断言页面上存在给定文本:

php
$browser->assertSee($text);

assertDontSee

断言页面上不存在给定文本:

php
$browser->assertDontSee($text);

assertSeeIn

断言给定文本在选择器内存在:

php
$browser->assertSeeIn($selector, $text);

assertDontSeeIn

断言给定文本在选择器内不存在:

php
$browser->assertDontSeeIn($selector, $text);

assertSeeAnythingIn

断言选择器内存在任何文本:

php
$browser->assertSeeAnythingIn($selector);

assertSeeNothingIn

断言选择器内不存在任何文本:

php
$browser->assertSeeNothingIn($selector);

assertScript

断言给定 JavaScript 表达式计算为给定值:

php
$browser->assertScript('window.isLoaded')
        ->assertScript('document.readyState', 'complete');

assertSourceHas

断言页面上存在给定源代码:

php
$browser->assertSourceHas($code);

assertSourceMissing

断言页面上不存在给定源代码:

php
$browser->assertSourceMissing($code);

断言页面上存在给定链接:

php
$browser->assertSeeLink($linkText);

断言页面上不存在给定链接:

php
$browser->assertDontSeeLink($linkText);

assertInputValue

断言给定输入字段具有给定值:

php
$browser->assertInputValue($field, $value);

assertInputValueIsNot

断言给定输入字段不具有给定值:

php
$browser->assertInputValueIsNot($field, $value);

assertChecked

断言给定复选框被选中:

php
$browser->assertChecked($field);

assertNotChecked

断言给定复选框未被选中:

php
$browser->assertNotChecked($field);

assertIndeterminate

断言给定复选框处于不确定状态:

php
$browser->assertIndeterminate($field);

assertRadioSelected

断言给定单选字段被选中:

php
$browser->assertRadioSelected($field, $value);

assertRadioNotSelected

断言给定单选字段未被选中:

php
$browser->assertRadioNotSelected($field, $value);

assertSelected

断言给定下拉框选择了给定值:

php
$browser->assertSelected($field, $value);

assertNotSelected

断言给定下拉框未选择给定值:

php
$browser->assertNotSelected($field, $value);

assertSelectHasOptions

断言给定值数组可供选择:

php
$browser->assertSelectHasOptions($field, $values);

assertSelectMissingOptions

断言给定值数组不可供选择:

php
$browser->assertSelectMissingOptions($field, $values);

assertSelectHasOption

断言给定字段上可供选择给定值:

php
$browser->assertSelectHasOption($field, $value);

assertSelectMissingOption

断言给定值不可供选择:

php
$browser->assertSelectMissingOption($field, $value);

assertValue

断言与给定选择器匹配的元素具有给定值:

php
$browser->assertValue($selector, $value);

assertValueIsNot

断言与给定选择器匹配的元素不具有给定值:

php
$browser->assertValueIsNot($selector, $value);

assertAttribute

断言与给定选择器匹配的元素在提供的属性中具有给定值:

php
$browser->assertAttribute($selector, $attribute, $value);

assertAttributeContains

断言与给定选择器匹配的元素在提供的属性中包含给定值:

php
$browser->assertAttributeContains($selector, $attribute, $value);

assertAriaAttribute

断言与给定选择器匹配的元素在提供的 aria 属性中具有给定值:

php
$browser->assertAriaAttribute($selector, $attribute, $value);

例如,给定标记 <button aria-label="Add"></button>,您可以像这样对 aria-label 属性进行断言:

php
$browser->assertAriaAttribute('button', 'label', 'Add')

assertDataAttribute

断言与给定选择器匹配的元素在提供的数据属性中具有给定值:

php
$browser->assertDataAttribute($selector, $attribute, $value);

例如,给定标记 <tr id="row-1" data-content="attendees"></tr>,您可以像这样对 data-label 属性进行断言:

php
$browser->assertDataAttribute('#row-1', 'content', 'attendees')

assertVisible

断言与给定选择器匹配的元素可见:

php
$browser->assertVisible($selector);

assertPresent

断言与给定选择器匹配的元素在源代码中存在:

php
$browser->assertPresent($selector);

assertNotPresent

断言与给定选择器匹配的元素在源代码中不存在:

php
$browser->assertNotPresent($selector);

assertMissing

断言与给定选择器匹配的元素不可见:

php
$browser->assertMissing($selector);

assertInputPresent

断言具有给定名称的输入存在:

php
$browser->assertInputPresent($name);

assertInputMissing

断言具有给定名称的输入在源代码中不存在:

php
$browser->assertInputMissing($name);

assertDialogOpened

断言打开了具有给定消息的 JavaScript 对话框:

php
$browser->assertDialogOpened($message);

assertEnabled

断言给定字段已启用:

php
$browser->assertEnabled($field);

assertDisabled

断言给定字段已禁用:

php
$browser->assertDisabled($field);

assertButtonEnabled

断言给定按钮已启用:

php
$browser->assertButtonEnabled($button);

assertButtonDisabled

断言给定按钮已禁用:

php
$browser->assertButtonDisabled($button);

assertFocused

断言给定字段已聚焦:

php
$browser->assertFocused($field);

assertNotFocused

断言给定字段未聚焦:

php
$browser->assertNotFocused($field);

assertAuthenticated

断言用户已认证:

php
$browser->assertAuthenticated();

assertGuest

断言用户未认证:

php
$browser->assertGuest();

assertAuthenticatedAs

断言用户已认证为给定用户:

php
$browser->assertAuthenticatedAs($user);

assertVue

Dusk 甚至允许您对 Vue 组件 数据的状态进行断言。例如,假设您的应用程序包含以下 Vue 组件:

php
// HTML...

<profile dusk="profile-component"></profile>

// 组件定义...

Vue.component('profile', {
    template: '<div>{{ user.name }}</div>',

    data: function () {
        return {
            user: {
                name: 'Taylor'
            }
        };
    }
});

您可以像这样对 Vue 组件的状态进行断言:

php
/**
 * 一个基本的 Vue 测试示例。
 *
 * @return void
 */
public function testVue()
{
    $this->browse(function (Browser $browser) {
        $browser->visit('/')
                ->assertVue('user.name', 'Taylor', '@profile-component');
    });
}

assertVueIsNot

断言给定 Vue 组件数据属性不与给定值匹配:

php
$browser->assertVueIsNot($property, $value, $componentSelector = null);

assertVueContains

断言给定 Vue 组件数据属性是一个数组并包含给定值:

php
$browser->assertVueContains($property, $value, $componentSelector = null);

assertVueDoesNotContain

断言给定 Vue 组件数据属性是一个数组并不包含给定值:

php
$browser->assertVueDoesNotContain($property, $value, $componentSelector = null);

页面

有时,测试需要按顺序执行几个复杂的操作。这可能会使您的测试难以阅读和理解。Dusk 页面允许您定义可在给定页面上通过单个方法执行的表达性操作。页面还允许您为应用程序或单个页面定义常用选择器的快捷方式。

生成页面

要生成页面对象,请执行 dusk:page Artisan 命令。所有页面对象将放置在应用程序的 tests/Browser/Pages 目录中:

php
php artisan dusk:page Login

配置页面

默认情况下,页面有三个方法:urlassertelements。我们现在将讨论 urlassert 方法。elements 方法将在下面详细讨论

url 方法

url 方法应返回表示页面的 URL 路径。Dusk 将在浏览器中导航到页面时使用此 URL:

php
/**
 * 获取页面的 URL。
 *
 * @return string
 */
public function url()
{
    return '/login';
}

assert 方法

assert 方法可以进行任何必要的断言,以验证浏览器实际上在给定页面上。实际上没有必要在此方法中放置任何内容;但是,如果您愿意,可以进行这些断言。这些断言将在导航到页面时自动运行:

php
/**
 * 断言浏览器在页面上。
 *
 * @return void
 */
public function assert(Browser $browser)
{
    $browser->assertPathIs($this->url());
}

导航到页面

定义页面后,您可以使用 visit 方法导航到它:

php
use Tests\Browser\Pages\Login;

$browser->visit(new Login);

有时您可能已经在给定页面上,并需要将页面的选择器和方法“加载”到当前测试上下文中。这在按下按钮并被重定向到给定页面而不显式导航到它时很常见。在这种情况下,您可以使用 on 方法加载页面:

php
use Tests\Browser\Pages\CreatePlaylist;

$browser->visit('/dashboard')
        ->clickLink('Create Playlist')
        ->on(new CreatePlaylist)
        ->assertSee('@create');

简写选择器

页面类中的 elements 方法允许您为页面上的任何 CSS 选择器定义快速、易记的快捷方式。例如,让我们为应用程序登录页面的“email”输入字段定义一个快捷方式:

php
/**
 * 获取页面的元素快捷方式。
 *
 * @return array
 */
public function elements()
{
    return [
        '@email' => 'input[name=email]',
    ];
}

定义快捷方式后,您可以在任何通常使用完整 CSS 选择器的地方使用简写选择器:

php
$browser->type('@email', 'taylor@laravel.com');

全局简写选择器

安装 Dusk 后,将在 tests/Browser/Pages 目录中放置一个基本 Page 类。此类包含一个 siteElements 方法,可用于定义在整个应用程序中每个页面上都应可用的全局简写选择器:

php
/**
 * 获取站点的全局元素快捷方式。
 *
 * @return array
 */
public static function siteElements()
{
    return [
        '@element' => '#selector',
    ];
}

页面方法

除了页面上定义的默认方法外,您还可以定义可在测试中使用的其他方法。例如,假设我们正在构建一个音乐管理应用程序。应用程序的一个页面的常见操作可能是创建播放列表。您可以在页面类上定义一个 createPlaylist 方法,而不是在每个测试中重写创建播放列表的逻辑:

php
<?php

namespace Tests\Browser\Pages;

use Laravel\Dusk\Browser;

class Dashboard extends Page
{
    // 其他页面方法...

    /**
     * 创建新播放列表。
     *
     * @param  \Laravel\Dusk\Browser  $browser
     * @param  string  $name
     * @return void
     */
    public function createPlaylist(Browser $browser, $name)
    {
        $browser->type('name', $name)
                ->check('share')
                ->press('Create Playlist');
    }
}

定义方法后,您可以在使用页面的任何测试中使用它。浏览器实例将自动作为第一个参数传递给自定义页面方法:

php
use Tests\Browser\Pages\Dashboard;

$browser->visit(new Dashboard)
        ->createPlaylist('My Playlist')
        ->assertSee('My Playlist');

组件

组件类似于 Dusk 的“页面对象”,但用于在应用程序中重复使用的 UI 和功能片段,例如导航栏或通知窗口。因此,组件不绑定到特定的 URL。

生成组件

要生成组件,请执行 dusk:component Artisan 命令。新组件放置在 tests/Browser/Components 目录中:

php
php artisan dusk:component DatePicker

如上所示,“日期选择器”是一个可能在应用程序的各种页面上存在的组件示例。在测试套件中的数十个测试中手动编写浏览器自动化逻辑以选择日期可能会变得繁琐。相反,我们可以定义一个 Dusk 组件来表示日期选择器,从而允许我们在组件中封装该逻辑:

php
<?php

namespace Tests\Browser\Components;

use Laravel\Dusk\Browser;
use Laravel\Dusk\Component as BaseComponent;

class DatePicker extends BaseComponent
{
    /**
     * 获取组件的根选择器。
     *
     * @return string
     */
    public function selector()
    {
        return '.date-picker';
    }

    /**
     * 断言浏览器页面包含组件。
     *
     * @param  Browser  $browser
     * @return void
     */
    public function assert(Browser $browser)
    {
        $browser->assertVisible($this->selector());
    }

    /**
     * 获取组件的元素快捷方式。
     *
     * @return array
     */
    public function elements()
    {
        return [
            '@date-field' => 'input.datepicker-input',
            '@year-list' => 'div > div.datepicker-years',
            '@month-list' => 'div > div.datepicker-months',
            '@day-list' => 'div > div.datepicker-days',
        ];
    }

    /**
     * 选择给定日期。
     *
     * @param  \Laravel\Dusk\Browser  $browser
     * @param  int  $year
     * @param  int  $month
     * @param  int  $day
     * @return void
     */
    public function selectDate(Browser $browser, $year, $month, $day)
    {
        $browser->click('@date-field')
                ->within('@year-list', function ($browser) use ($year) {
                    $browser->click($year);
                })
                ->within('@month-list', function ($browser) use ($month) {
                    $browser->click($month);
                })
                ->within('@day-list', function ($browser) use ($day) {
                    $browser->click($day);
                });
    }
}

使用组件

定义组件后,我们可以轻松地从任何测试中在日期选择器中选择日期。而且,如果选择日期所需的逻辑发生变化,我们只需更新组件:

php
<?php

namespace Tests\Browser;

use Illuminate\Foundation\Testing\DatabaseMigrations;
use Laravel\Dusk\Browser;
use Tests\Browser\Components\DatePicker;
use Tests\DuskTestCase;

class ExampleTest extends DuskTestCase
{
    /**
     * 一个基本的组件测试示例。
     *
     * @return void
     */
    public function testBasicExample()
    {
        $this->browse(function (Browser $browser) {
            $browser->visit('/')
                    ->within(new DatePicker, function ($browser) {
                        $browser->selectDate(2019, 1, 30);
                    })
                    ->assertSee('January');
        });
    }
}

持续集成

exclamation

大多数 Dusk 持续集成配置期望您的 Laravel 应用程序使用内置的 PHP 开发服务器在端口 8000 上提供服务。因此,在继续之前,您应确保您的持续集成环境具有 APP_URL 环境变量值 http://127.0.0.1:8000

Heroku CI

要在 Heroku CI 上运行 Dusk 测试,请将以下 Google Chrome 构建包和脚本添加到您的 Heroku app.json 文件中:

php
{
  "environments": {
    "test": {
      "buildpacks": [
        { "url": "heroku/php" },
        { "url": "https://github.com/heroku/heroku-buildpack-google-chrome" }
      ],
      "scripts": {
        "test-setup": "cp .env.testing .env",
        "test": "nohup bash -c './vendor/laravel/dusk/bin/chromedriver-linux > /dev/null 2>&1 &' && nohup bash -c 'php artisan serve --no-reload > /dev/null 2>&1 &' && php artisan dusk"
      }
    }
  }
}

Travis CI

要在 Travis CI 上运行您的 Dusk 测试,请使用以下 .travis.yml 配置。由于 Travis CI 不是图形环境,我们需要采取一些额外步骤来启动 Chrome 浏览器。此外,我们将使用 php artisan serve 启动 PHP 的内置 Web 服务器:

yaml
language: php

php:
  - 7.3

addons:
  chrome: stable

install:
  - cp .env.testing .env
  - travis_retry composer install --no-interaction --prefer-dist
  - php artisan key:generate
  - php artisan dusk:chrome-driver

before_script:
  - google-chrome-stable --headless --disable-gpu --remote-debugging-port=9222 http://localhost &
  - php artisan serve --no-reload &

script:
  - php artisan dusk

GitHub Actions

如果您使用 GitHub Actions 运行您的 Dusk 测试,您可以使用以下配置文件作为起点。与 TravisCI 类似,我们将使用 php artisan serve 命令启动 PHP 的内置 Web 服务器:

yaml
name: CI
on: [push]
jobs:

  dusk-php:
    runs-on: ubuntu-latest
    env:
      APP_URL: "http://127.0.0.1:8000"
      DB_USERNAME: root
      DB_PASSWORD: root
      MAIL_MAILER: log
    steps:
      - uses: actions/checkout@v3
      - name: Prepare The Environment
        run: cp .env.example .env
      - name: Create Database
        run: |
          sudo systemctl start mysql
          mysql --user="root" --password="root" -e "CREATE DATABASE \`my-database\` character set UTF8mb4 collate utf8mb4_bin;"
      - name: Install Composer Dependencies
        run: composer install --no-progress --prefer-dist --optimize-autoloader
      - name: Generate Application Key
        run: php artisan key:generate
      - name: Upgrade Chrome Driver
        run: php artisan dusk:chrome-driver --detect
      - name: Start Chrome Driver
        run: ./vendor/laravel/dusk/bin/chromedriver-linux &
      - name: Run Laravel Server
        run: php artisan serve --no-reload &
      - name: Run Dusk Tests
        run: php artisan dusk
      - name: Upload Screenshots
        if: failure()
        uses: actions/upload-artifact@v2
        with:
          name: screenshots
          path: tests/Browser/screenshots
      - name: Upload Console Logs
        if: failure()
        uses: actions/upload-artifact@v2
        with:
          name: console
          path: tests/Browser/console