跳到内容

Laravel Dusk

简介

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

安装

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

1composer require laravel/dusk --dev

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

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

1php artisan dusk:install

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

如果您使用 Laravel Sail 来管理您的本地开发环境,请同时查阅 Sail 文档中关于 配置和运行 Dusk 测试 的内容。

管理 ChromeDriver 安装

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

1# Install the latest version of ChromeDriver for your OS...
2php artisan dusk:chrome-driver
3 
4# Install a given version of ChromeDriver for your OS...
5php artisan dusk:chrome-driver 86
6 
7# Install a given version of ChromeDriver for all supported OSs...
8php artisan dusk:chrome-driver --all
9 
10# Install the version of ChromeDriver that matches the detected version of Chrome / Chromium for your OS...
11php artisan dusk:chrome-driver --detect

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

使用其他浏览器

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

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

1/**
2 * Prepare for Dusk test execution.
3 *
4 * @beforeClass
5 */
6public static function prepare(): void
7{
8 // static::startChromeDriver();
9}

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

1use Facebook\WebDriver\Remote\RemoteWebDriver;
2 
3/**
4 * Create the RemoteWebDriver instance.
5 */
6protected function driver(): RemoteWebDriver
7{
8 return RemoteWebDriver::create(
9 'https://127.0.0.1:4444/wd/hub', DesiredCapabilities::phantomjs()
10 );
11}

入门

生成测试

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

1php artisan dusk:make LoginTest

每次测试后重置数据库

您编写的大多数测试将与从您的应用程序数据库检索数据的页面进行交互; 但是,您的 Dusk 测试绝不应该使用 RefreshDatabase trait。 RefreshDatabase trait 利用数据库事务,这些事务将不适用于或无法跨 HTTP 请求使用。 相反,您有两个选择:DatabaseMigrations trait 和 DatabaseTruncation trait。

使用数据库迁移

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

1<?php
2 
3use Illuminate\Foundation\Testing\DatabaseMigrations;
4use Laravel\Dusk\Browser;
5 
6uses(DatabaseMigrations::class);
7 
8//
1<?php
2 
3namespace Tests\Browser;
4 
5use Illuminate\Foundation\Testing\DatabaseMigrations;
6use Laravel\Dusk\Browser;
7use Tests\DuskTestCase;
8 
9class ExampleTest extends DuskTestCase
10{
11 use DatabaseMigrations;
12 
13 //
14}

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

使用数据库截断

DatabaseTruncation trait 将在第一次测试时迁移您的数据库,以确保您的数据库表已正确创建。 但是,在后续测试中,数据库的表将仅被截断 - 与重新运行所有数据库迁移相比,这提供了速度提升

1<?php
2 
3use Illuminate\Foundation\Testing\DatabaseTruncation;
4use Laravel\Dusk\Browser;
5 
6uses(DatabaseTruncation::class);
7 
8//
1<?php
2 
3namespace Tests\Browser;
4 
5use App\Models\User;
6use Illuminate\Foundation\Testing\DatabaseTruncation;
7use Laravel\Dusk\Browser;
8use Tests\DuskTestCase;
9 
10class ExampleTest extends DuskTestCase
11{
12 use DatabaseTruncation;
13 
14 //
15}

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

如果您使用 Pest,您应该在基础 DuskTestCase 类或您的测试文件扩展的任何类上定义属性或方法。

1/**
2 * Indicates which tables should be truncated.
3 *
4 * @var array
5 */
6protected $tablesToTruncate = ['users'];

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

1/**
2 * Indicates which tables should be excluded from truncation.
3 *
4 * @var array
5 */
6protected $exceptTables = ['users'];

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

1/**
2 * Indicates which connections should have their tables truncated.
3 *
4 * @var array
5 */
6protected $connectionsToTruncate = ['mysql'];

如果您想在执行数据库截断之前或之后执行代码,您可以在您的测试类上定义 beforeTruncatingDatabaseafterTruncatingDatabase 方法

1/**
2 * Perform any work that should take place before the database has started truncating.
3 */
4protected function beforeTruncatingDatabase(): void
5{
6 //
7}
8 
9/**
10 * Perform any work that should take place after the database has finished truncating.
11 */
12protected function afterTruncatingDatabase(): void
13{
14 //
15}

运行测试

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

1php artisan dusk

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

1php artisan dusk:fails

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

1php artisan dusk --group=foo

如果您使用 Laravel Sail 来管理您的本地开发环境,请查阅 Sail 文档中关于 配置和运行 Dusk 测试 的内容。

手动启动 ChromeDriver

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

1/**
2 * Prepare for Dusk test execution.
3 *
4 * @beforeClass
5 */
6public static function prepare(): void
7{
8 // static::startChromeDriver();
9}

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

1use Facebook\WebDriver\Remote\RemoteWebDriver;
2 
3/**
4 * Create the RemoteWebDriver instance.
5 */
6protected function driver(): RemoteWebDriver
7{
8 return RemoteWebDriver::create(
9 'https://127.0.0.1:9515', DesiredCapabilities::chrome()
10 );
11}

环境处理

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

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

浏览器基础知识

创建浏览器

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

1<?php
2 
3use App\Models\User;
4use Illuminate\Foundation\Testing\DatabaseMigrations;
5use Laravel\Dusk\Browser;
6 
7uses(DatabaseMigrations::class);
8 
9test('basic example', function () {
10 $user = User::factory()->create([
11 'email' => '[email protected]',
12 ]);
13 
14 $this->browse(function (Browser $browser) use ($user) {
15 $browser->visit('/login')
16 ->type('email', $user->email)
17 ->type('password', 'password')
18 ->press('Login')
19 ->assertPathIs('/home');
20 });
21});
1<?php
2 
3namespace Tests\Browser;
4 
5use App\Models\User;
6use Illuminate\Foundation\Testing\DatabaseMigrations;
7use Laravel\Dusk\Browser;
8use Tests\DuskTestCase;
9 
10class ExampleTest extends DuskTestCase
11{
12 use DatabaseMigrations;
13 
14 /**
15 * A basic browser test example.
16 */
17 public function test_basic_example(): void
18 {
19 $user = User::factory()->create([
20 'email' => '[email protected]',
21 ]);
22 
23 $this->browse(function (Browser $browser) use ($user) {
24 $browser->visit('/login')
25 ->type('email', $user->email)
26 ->type('password', 'password')
27 ->press('Login')
28 ->assertPathIs('/home');
29 });
30 }
31}

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

创建多个浏览器

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

1$this->browse(function (Browser $first, Browser $second) {
2 $first->loginAs(User::find(1))
3 ->visit('/home')
4 ->waitForText('Message');
5 
6 $second->loginAs(User::find(2))
7 ->visit('/home')
8 ->waitForText('Message')
9 ->type('message', 'Hey Taylor')
10 ->press('Send');
11 
12 $first->waitForText('Hey Taylor')
13 ->assertSee('Jeffrey Way');
14});

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

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

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

1$browser->visitRoute($routeName, $parameters);

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

1$browser->back();
2 
3$browser->forward();

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

1$browser->refresh();

调整浏览器窗口大小

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

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

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

1$browser->maximize();

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

1$browser->fitContent();

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

1$browser->disableFitOnFailure();

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

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

浏览器宏

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

1<?php
2 
3namespace App\Providers;
4 
5use Illuminate\Support\ServiceProvider;
6use Laravel\Dusk\Browser;
7 
8class DuskServiceProvider extends ServiceProvider
9{
10 /**
11 * Register Dusk's browser macros.
12 */
13 public function boot(): void
14 {
15 Browser::macro('scrollToElement', function (string $element = null) {
16 $this->script("$('html, body').animate({ scrollTop: $('$element').offset().top }, 0);");
17 
18 return $this;
19 });
20 }
21}

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

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

身份验证

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

1use App\Models\User;
2use Laravel\Dusk\Browser;
3 
4$this->browse(function (Browser $browser) {
5 $browser->loginAs(User::find(1))
6 ->visit('/home');
7});

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

Cookies

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

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

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

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

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

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

执行 JavaScript

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

1$browser->script('document.documentElement.scrollTop = 0');
2 
3$browser->script([
4 'document.body.scrollTop = 0',
5 'document.documentElement.scrollTop = 0',
6]);
7 
8$output = $browser->script('return window.location.pathname');

截取屏幕截图

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

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

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

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

screenshotElement 方法可用于拍摄页面上特定元素的屏幕截图

1$browser->screenshotElement('#selector', 'filename');

将控制台输出存储到磁盘

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

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

将页面源代码存储到磁盘

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

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

与元素交互

Dusk 选择器

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

1// HTML...
2 
3<button>Login</button>
1// Test...
2 
3$browser->click('.login-page .container div > button');

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

1// HTML...
2 
3<button dusk="login-button">Login</button>
1// Test...
2 
3$browser->click('@login-button');

如果需要,您可以自定义 Dusk 选择器使用的 HTML 属性,通过 selectorHtmlAttribute 方法。 通常,此方法应从您的应用程序的 AppServiceProviderboot 方法中调用

1use Laravel\Dusk\Dusk;
2 
3Dusk::selectorHtmlAttribute('data-dusk');

文本、值和属性

检索和设置值

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

1// Retrieve the value...
2$value = $browser->value('selector');
3 
4// Set the value...
5$browser->value('selector', 'value');

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

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

检索文本

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

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

检索属性

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

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

与表单交互

键入值

Dusk 提供了各种与表单和输入元素交互的方法。 首先,让我们看一下将文本键入输入字段的示例

1$browser->type('email', '[email protected]');

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

要将文本附加到字段而不清除其内容,您可以使用 append 方法

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

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

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

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

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

您可以使用 appendSlowly 方法缓慢附加文本

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

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

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

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

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

通过提供一个数组作为第二个```php

``` 参数给 select 方法,您可以指示该方法选择多个选项

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

复选框

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

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

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

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

单选按钮

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

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

附加文件

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

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

attach 函数需要您的服务器上安装并启用 Zip PHP 扩展。

按下按钮

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

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

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

1// Press the button and wait a maximum of 5 seconds for it to be enabled...
2$browser->pressAndWaitFor('Save');
3 
4// Press the button and wait a maximum of 1 second for it to be enabled...
5$browser->pressAndWaitFor('Save', 1);

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

1$browser->clickLink($linkText);

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

1if ($browser->seeLink($linkText)) {
2 // ...
3}

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

使用键盘

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

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

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

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

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

流畅的键盘交互

Dusk 还提供了 withKeyboard 方法,允许您通过 Laravel\Dusk\Keyboard 类流畅地执行复杂的键盘交互。 Keyboard 类提供了 pressreleasetypepause 方法

1use Laravel\Dusk\Keyboard;
2 
3$browser->withKeyboard(function (Keyboard $keyboard) {
4 $keyboard->press('c')
5 ->pause(1000)
6 ->release('c')
7 ->type(['c', 'e', 'o']);
8});

键盘宏

如果您想定义可以在整个测试套件中轻松重复使用的自定义键盘交互,您可以使用 Keyboard 类提供的 macro 方法。 通常,您应该从 服务提供者的 boot 方法调用此方法

1<?php
2 
3namespace App\Providers;
4 
5use Facebook\WebDriver\WebDriverKeys;
6use Illuminate\Support\ServiceProvider;
7use Laravel\Dusk\Keyboard;
8use Laravel\Dusk\OperatingSystem;
9 
10class DuskServiceProvider extends ServiceProvider
11{
12 /**
13 * Register Dusk's browser macros.
14 */
15 public function boot(): void
16 {
17 Keyboard::macro('copy', function (string $element = null) {
18 $this->type([
19 OperatingSystem::onMac() ? WebDriverKeys::META : WebDriverKeys::CONTROL, 'c',
20 ]);
21 
22 return $this;
23 });
24 
25 Keyboard::macro('paste', function (string $element = null) {
26 $this->type([
27 OperatingSystem::onMac() ? WebDriverKeys::META : WebDriverKeys::CONTROL, 'v',
28 ]);
29 
30 return $this;
31 });
32 }
33}

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

1$browser->click('@textarea')
2 ->withKeyboard(fn (Keyboard $keyboard) => $keyboard->copy())
3 ->click('@another-textarea')
4 ->withKeyboard(fn (Keyboard $keyboard) => $keyboard->paste());

使用鼠标

单击元素

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

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

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

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

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

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

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

1$browser->doubleClick();
2 
3$browser->doubleClick('.selector');

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

1$browser->rightClick();
2 
3$browser->rightClick('.selector');

clickAndHold 方法可用于模拟鼠标按钮被单击并按住。 后续调用 releaseMouse 方法将撤消此行为并释放鼠标按钮

1$browser->clickAndHold('.selector');
2 
3$browser->clickAndHold()
4 ->pause(1000)
5 ->releaseMouse();

controlClick 方法可用于模拟浏览器中的 ctrl+click 事件

1$browser->controlClick();
2 
3$browser->controlClick('.selector');

鼠标悬停

当您需要将鼠标移动到与给定 CSS 或 Dusk 选择器匹配的元素上时,可以使用 mouseover 方法

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

拖放

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

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

或者,您可以沿单个方向拖动元素

1$browser->dragLeft('.selector', $pixels = 10);
2$browser->dragRight('.selector', $pixels = 10);
3$browser->dragUp('.selector', $pixels = 10);
4$browser->dragDown('.selector', $pixels = 10);

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

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

JavaScript 对话框

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

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

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

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

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

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

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

1$browser->acceptDialog();

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

1$browser->dismissDialog();

与内联框架交互

如果您需要与 iframe 中的元素进行交互,您可以使用 withinFrame 方法。 在提供给 withinFrame 方法的闭包中发生的所有元素交互都将限定在指定 iframe 的上下文中

1$browser->withinFrame('#credit-card-details', function ($browser) {
2 $browser->type('input[name="cardnumber"]', '4242424242424242')
3 ->type('input[name="exp-date"]', '1224')
4 ->type('input[name="cvc"]', '123')
5 ->press('Pay');
6});

作用域选择器

有时您可能希望在限定给定选择器内的所有操作时执行多个操作。 例如,您可能希望断言某些文本仅存在于表中,然后单击该表中的按钮。 您可以使用 with 方法来完成此操作。 在提供给 with 方法的闭包中执行的所有操作都将限定在原始选择器中

1$browser->with('.table', function (Browser $table) {
2 $table->assertSee('Hello World')
3 ->clickLink('Delete');
4});

您可能偶尔需要在当前作用域之外执行断言。 您可以使用 elsewhereelsewhereWhenAvailable 方法来完成此操作

1$browser->with('.table', function (Browser $table) {
2 // Current scope is `body .table`...
3 
4 $browser->elsewhere('.page-title', function (Browser $title) {
5 // Current scope is `body .page-title`...
6 $title->assertSee('Hello World');
7 });
8 
9 $browser->elsewhereWhenAvailable('.page-title', function (Browser $title) {
10 // Current scope is `body .page-title`...
11 $title->assertSee('Hello World');
12 });
13});

等待元素

当测试广泛使用 JavaScript 的应用程序时,通常有必要“等待”某些元素或数据可用,然后再继续进行测试。 Dusk 使这变得轻而易举。 使用各种方法,您可以等待元素在页面上变得可见,甚至等待给定的 JavaScript 表达式评估为 true

等待

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

1$browser->pause(1000);

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

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

同样,如果您需要除非给定条件为 true 否则暂停测试,您可以使用 pauseUnless 方法

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

等待选择器

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

1// Wait a maximum of five seconds for the selector...
2$browser->waitFor('.selector');
3 
4// Wait a maximum of one second for the selector...
5$browser->waitFor('.selector', 1);

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

1// Wait a maximum of five seconds for the selector to contain the given text...
2$browser->waitForTextIn('.selector', 'Hello World');
3 
4// Wait a maximum of one second for the selector to contain the given text...
5$browser->waitForTextIn('.selector', 'Hello World', 1);

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

1// Wait a maximum of five seconds until the selector is missing...
2$browser->waitUntilMissing('.selector');
3 
4// Wait a maximum of one second until the selector is missing...
5$browser->waitUntilMissing('.selector', 1);

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

1// Wait a maximum of five seconds until the selector is enabled...
2$browser->waitUntilEnabled('.selector');
3 
4// Wait a maximum of one second until the selector is enabled...
5$browser->waitUntilEnabled('.selector', 1);
6 
7// Wait a maximum of five seconds until the selector is disabled...
8$browser->waitUntilDisabled('.selector');
9 
10// Wait a maximum of one second until the selector is disabled...
11$browser->waitUntilDisabled('.selector', 1);

可用时作用域选择器

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

1$browser->whenAvailable('.modal', function (Browser $modal) {
2 $modal->assertSee('Hello World')
3 ->press('OK');
4});

等待文本

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

1// Wait a maximum of five seconds for the text...
2$browser->waitForText('Hello World');
3 
4// Wait a maximum of one second for the text...
5$browser->waitForText('Hello World', 1);

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

1// Wait a maximum of five seconds for the text to be removed...
2$browser->waitUntilMissingText('Hello World');
3 
4// Wait a maximum of one second for the text to be removed...
5$browser->waitUntilMissingText('Hello World', 1);

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

1// Wait a maximum of five seconds for the link...
2$browser->waitForLink('Create');
3 
4// Wait a maximum of one second for the link...
5$browser->waitForLink('Create', 1);

等待输入

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

1// Wait a maximum of five seconds for the input...
2$browser->waitForInput($field);
3 
4// Wait a maximum of one second for the input...
5$browser->waitForInput($field, 1);

等待页面位置

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

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

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

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

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

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

等待页面重新加载

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

1use Laravel\Dusk\Browser;
2 
3$browser->waitForReload(function (Browser $browser) {
4 $browser->press('Submit');
5})
6->assertSee('Success!');

由于等待页面重新加载的需求通常发生在单击按钮之后,因此您可以为方便起见使用 clickAndWaitForReload 方法

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

等待 JavaScript 表达式

有时您可能希望暂停测试的执行,直到给定的 JavaScript 表达式评估为 true。 您可以使用 waitUntil 方法轻松完成此操作。 当将表达式传递给此方法时,您无需包含 return 关键字或结尾的分号

1// Wait a maximum of five seconds for the expression to be true...
2$browser->waitUntil('App.data.servers.length > 0');
3 
4// Wait a maximum of one second for the expression to be true...
5$browser->waitUntil('App.data.servers.length > 0', 1);

等待 Vue 表达式

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

1// Wait until the component attribute contains the given value...
2$browser->waitUntilVue('user.name', 'Taylor', '@user');
3 
4// Wait until the component attribute doesn't contain the given value...
5$browser->waitUntilVueIsNot('user.name', null, '@user');

等待 JavaScript 事件

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

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

事件侦听器附加到当前作用域,默认情况下为 body 元素。 当使用作用域选择器时,事件侦听器将附加到匹配的元素

1$browser->with('iframe', function (Browser $iframe) {
2 // Wait for the iframe's load event...
3 $iframe->waitForEvent('load');
4});

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

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

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

1// Wait until the document is scrolled...
2$browser->waitForEvent('scroll', 'document');
3 
4// Wait a maximum of five seconds until the window is resized...
5$browser->waitForEvent('resize', 'window', 5);

使用回调等待

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

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

滚动元素到视图中

有时您可能无法点击某个元素,因为它位于浏览器的可视区域之外。scrollIntoView 方法将滚动浏览器窗口,直到给定选择器处的元素进入视图。

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

可用断言

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

assertTitle

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

1$browser->assertTitle($title);

assertTitleContains

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

1$browser->assertTitleContains($title);

assertUrlIs

断言当前 URL(不包括查询字符串)与给定的字符串匹配

1$browser->assertUrlIs($url);

assertSchemeIs

断言当前 URL 协议与给定的协议匹配

1$browser->assertSchemeIs($scheme);

assertSchemeIsNot

断言当前 URL 协议与给定的协议不匹配

1$browser->assertSchemeIsNot($scheme);

assertHostIs

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

1$browser->assertHostIs($host);

assertHostIsNot

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

1$browser->assertHostIsNot($host);

assertPortIs

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

1$browser->assertPortIs($port);

assertPortIsNot

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

1$browser->assertPortIsNot($port);

assertPathBeginsWith

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

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

assertPathEndsWith

断言当前 URL 路径以给定的路径结束

1$browser->assertPathEndsWith('/home');

assertPathContains

断言当前 URL 路径包含给定的路径

1$browser->assertPathContains('/home');

assertPathIs

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

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

assertPathIsNot

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

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

assertRouteIs

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

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

assertQueryStringHas

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

1$browser->assertQueryStringHas($name);

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

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

assertQueryStringMissing

断言给定的查询字符串参数缺失

1$browser->assertQueryStringMissing($name);

assertFragmentIs

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

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

assertFragmentBeginsWith

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

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

assertFragmentIsNot

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

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

断言给定的加密 Cookie 存在

1$browser->assertHasCookie($name);

断言给定的未加密 Cookie 存在

1$browser->assertHasPlainCookie($name);

断言给定的加密 Cookie 不存在

1$browser->assertCookieMissing($name);

断言给定的未加密 Cookie 不存在

1$browser->assertPlainCookieMissing($name);

断言加密 Cookie 具有给定的值

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

断言未加密 Cookie 具有给定的值

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

assertSee

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

1$browser->assertSee($text);

assertDontSee

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

1$browser->assertDontSee($text);

assertSeeIn

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

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

assertDontSeeIn

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

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

assertSeeAnythingIn

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

1$browser->assertSeeAnythingIn($selector);

assertSeeNothingIn

断言没有文本在选择器内存在

1$browser->assertSeeNothingIn($selector);

assertScript

断言给定的 JavaScript 表达式评估为给定的值

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

assertSourceHas

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

1$browser->assertSourceHas($code);

assertSourceMissing

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

1$browser->assertSourceMissing($code);

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

1$browser->assertSeeLink($linkText);

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

1$browser->assertDontSeeLink($linkText);

assertInputValue

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

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

assertInputValueIsNot

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

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

assertChecked

断言给定的复选框被选中

1$browser->assertChecked($field);

assertNotChecked

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

1$browser->assertNotChecked($field);

assertIndeterminate

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

1$browser->assertIndeterminate($field);

assertRadioSelected

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

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

assertRadioNotSelected

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

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

assertSelected

断言给定的下拉菜单选择了给定的值

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

assertNotSelected

断言给定的下拉菜单未选择给定的值

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

assertSelectHasOptions

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

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

assertSelectMissingOptions

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

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

assertSelectHasOption

断言给定的值可在给定的字段上选择

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

assertSelectMissingOption

断言给定的值不可供选择

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

assertValue

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

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

assertValueIsNot

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

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

assertAttribute

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

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

assertAttributeMissing

断言与给定选择器匹配的元素缺少提供的属性

1$browser->assertAttributeMissing($selector, $attribute);

assertAttributeContains

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

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

assertAttributeDoesntContain

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

1$browser->assertAttributeDoesntContain($selector, $attribute, $value);

assertAriaAttribute

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

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

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

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

assertDataAttribute

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

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

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

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

assertVisible

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

1$browser->assertVisible($selector);

assertPresent

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

1$browser->assertPresent($selector);

assertNotPresent

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

1$browser->assertNotPresent($selector);

assertMissing

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

1$browser->assertMissing($selector);

assertInputPresent

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

1$browser->assertInputPresent($name);

assertInputMissing

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

1$browser->assertInputMissing($name);

assertDialogOpened

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

1$browser->assertDialogOpened($message);

assertEnabled

断言给定的字段已启用

1$browser->assertEnabled($field);

assertDisabled

断言给定的字段已禁用

1$browser->assertDisabled($field);

assertButtonEnabled

断言给定的按钮已启用

1$browser->assertButtonEnabled($button);

assertButtonDisabled

断言给定的按钮已禁用

1$browser->assertButtonDisabled($button);

assertFocused

断言给定的字段已聚焦

1$browser->assertFocused($field);

assertNotFocused

断言给定的字段未聚焦

1$browser->assertNotFocused($field);

assertAuthenticated

断言用户已通过身份验证

1$browser->assertAuthenticated();

assertGuest

断言用户未通过身份验证

1$browser->assertGuest();

assertAuthenticatedAs

断言用户以给定的用户身份通过身份验证

1$browser->assertAuthenticatedAs($user);

assertVue

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

1// HTML...
2 
3<profile dusk="profile-component"></profile>
4 
5// Component Definition...
6 
7Vue.component('profile', {
8 template: '<div>{{ user.name }}</div>',
9 
10 data: function () {
11 return {
12 user: {
13 name: 'Taylor'
14 }
15 };
16 }
17});

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

1test('vue', function () {
2 $this->browse(function (Browser $browser) {
3 $browser->visit('/')
4 ->assertVue('user.name', 'Taylor', '@profile-component');
5 });
6});
1/**
2 * A basic Vue test example.
3 */
4public function test_vue(): void
5{
6 $this->browse(function (Browser $browser) {
7 $browser->visit('/')
8 ->assertVue('user.name', 'Taylor', '@profile-component');
9 });
10}

assertVueIsNot

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

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

assertVueContains

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

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

assertVueDoesntContain

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

1$browser->assertVueDoesntContain($property, $value, $componentSelector = null);

页面

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

生成页面

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

1php artisan dusk:page Login

配置页面

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

url 方法

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

1/**
2 * Get the URL for the page.
3 */
4public function url(): string
5{
6 return '/login';
7}

assert 方法

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

1/**
2 * Assert that the browser is on the page.
3 */
4public function assert(Browser $browser): void
5{
6 $browser->assertPathIs($this->url());
7}

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

1use Tests\Browser\Pages\Login;
2 
3$browser->visit(new Login);

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

1use Tests\Browser\Pages\CreatePlaylist;
2 
3$browser->visit('/dashboard')
4 ->clickLink('Create Playlist')
5 ->on(new CreatePlaylist)
6 ->assertSee('@create');

简写选择器

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

1/**
2 * Get the element shortcuts for the page.
3 *
4 * @return array<string, string>
5 */
6public function elements(): array
7{
8 return [
9 '@email' => 'input[name=email]',
10 ];
11}

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

1$browser->type('@email', '[email protected]');

全局速记选择器

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

1/**
2 * Get the global element shortcuts for the site.
3 *
4 * @return array<string, string>
5 */
6public static function siteElements(): array
7{
8 return [
9 '@element' => '#selector',
10 ];
11}

页面方法

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

1<?php
2 
3namespace Tests\Browser\Pages;
4 
5use Laravel\Dusk\Browser;
6use Laravel\Dusk\Page;
7 
8class Dashboard extends Page
9{
10 // Other page methods...
11 
12 /**
13 * Create a new playlist.
14 */
15 public function createPlaylist(Browser $browser, string $name): void
16 {
17 $browser->type('name', $name)
18 ->check('share')
19 ->press('Create Playlist');
20 }
21}

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

1use Tests\Browser\Pages\Dashboard;
2 
3$browser->visit(new Dashboard)
4 ->createPlaylist('My Playlist')
5 ->assertSee('My Playlist');

组件

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

生成组件

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

1php artisan dusk:component DatePicker

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

1<?php
2 
3namespace Tests\Browser\Components;
4 
5use Laravel\Dusk\Browser;
6use Laravel\Dusk\Component as BaseComponent;
7 
8class DatePicker extends BaseComponent
9{
10 /**
11 * Get the root selector for the component.
12 */
13 public function selector(): string
14 {
15 return '.date-picker';
16 }
17 
18 /**
19 * Assert that the browser page contains the component.
20 */
21 public function assert(Browser $browser): void
22 {
23 $browser->assertVisible($this->selector());
24 }
25 
26 /**
27 * Get the element shortcuts for the component.
28 *
29 * @return array<string, string>
30 */
31 public function elements(): array
32 {
33 return [
34 '@date-field' => 'input.datepicker-input',
35 '@year-list' => 'div > div.datepicker-years',
36 '@month-list' => 'div > div.datepicker-months',
37 '@day-list' => 'div > div.datepicker-days',
38 ];
39 }
40 
41 /**
42 * Select the given date.
43 */
44 public function selectDate(Browser $browser, int $year, int $month, int $day): void
45 {
46 $browser->click('@date-field')
47 ->within('@year-list', function (Browser $browser) use ($year) {
48 $browser->click($year);
49 })
50 ->within('@month-list', function (Browser $browser) use ($month) {
51 $browser->click($month);
52 })
53 ->within('@day-list', function (Browser $browser) use ($day) {
54 $browser->click($day);
55 });
56 }
57}

使用组件

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

1<?php
2 
3use Illuminate\Foundation\Testing\DatabaseMigrations;
4use Laravel\Dusk\Browser;
5use Tests\Browser\Components\DatePicker;
6 
7uses(DatabaseMigrations::class);
8 
9test('basic example', function () {
10 $this->browse(function (Browser $browser) {
11 $browser->visit('/')
12 ->within(new DatePicker, function (Browser $browser) {
13 $browser->selectDate(2019, 1, 30);
14 })
15 ->assertSee('January');
16 });
17});
1<?php
2 
3namespace Tests\Browser;
4 
5use Illuminate\Foundation\Testing\DatabaseMigrations;
6use Laravel\Dusk\Browser;
7use Tests\Browser\Components\DatePicker;
8use Tests\DuskTestCase;
9 
10class ExampleTest extends DuskTestCase
11{
12 /**
13 * A basic component test example.
14 */
15 public function test_basic_example(): void
16 {
17 $this->browse(function (Browser $browser) {
18 $browser->visit('/')
19 ->within(new DatePicker, function (Browser $browser) {
20 $browser->selectDate(2019, 1, 30);
21 })
22 ->assertSee('January');
23 });
24 }
25}

持续集成

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

Heroku CI

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

1{
2 "environments": {
3 "test": {
4 "buildpacks": [
5 { "url": "heroku/php" },
6 { "url": "https://github.com/heroku/heroku-buildpack-chrome-for-testing" }
7 ],
8 "scripts": {
9 "test-setup": "cp .env.testing .env",
10 "test": "nohup bash -c './vendor/laravel/dusk/bin/chromedriver-linux --port=9515 > /dev/null 2>&1 &' && nohup bash -c 'php artisan serve --no-reload > /dev/null 2>&1 &' && php artisan dusk"
11 }
12 }
13 }
14}

Travis CI

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

1language: php
2 
3php:
4 - 8.2
5 
6addons:
7 chrome: stable
8 
9install:
10 - cp .env.testing .env
11 - travis_retry composer install --no-interaction --prefer-dist
12 - php artisan key:generate
13 - php artisan dusk:chrome-driver
14 
15before_script:
16 - google-chrome-stable --headless --disable-gpu --remote-debugging-port=9222 https://127.0.0.1 &
17 - php artisan serve --no-reload &
18 
19script:
20 - php artisan dusk

GitHub Actions

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

1name: CI
2on: [push]
3jobs:
4 
5 dusk-php:
6 runs-on: ubuntu-latest
7 env:
8 APP_URL: "http://127.0.0.1:8000"
9 DB_USERNAME: root
10 DB_PASSWORD: root
11 MAIL_MAILER: log
12 steps:
13 - uses: actions/checkout@v4
14 - name: Prepare The Environment
15 run: cp .env.example .env
16 - name: Create Database
17 run: |
18 sudo systemctl start mysql
19 mysql --user="root" --password="root" -e "CREATE DATABASE \`my-database\` character set UTF8mb4 collate utf8mb4_bin;"
20 - name: Install Composer Dependencies
21 run: composer install --no-progress --prefer-dist --optimize-autoloader
22 - name: Generate Application Key
23 run: php artisan key:generate
24 - name: Upgrade Chrome Driver
25 run: php artisan dusk:chrome-driver --detect
26 - name: Start Chrome Driver
27 run: ./vendor/laravel/dusk/bin/chromedriver-linux --port=9515 &
28 - name: Run Laravel Server
29 run: php artisan serve --no-reload &
30 - name: Run Dusk Tests
31 run: php artisan dusk
32 - name: Upload Screenshots
33 if: failure()
34 uses: actions/upload-artifact@v4
35 with:
36 name: screenshots
37 path: tests/Browser/screenshots
38 - name: Upload Console Logs
39 if: failure()
40 uses: actions/upload-artifact@v4
41 with:
42 name: console
43 path: tests/Browser/console

Chipper CI

如果您使用 Chipper CI 运行 Dusk 测试,则可以使用以下配置文件作为起点。我们将使用 PHP 的内置服务器来运行 Laravel,以便我们可以监听请求

1# file .chipperci.yml
2version: 1
3 
4environment:
5 php: 8.2
6 node: 16
7 
8# Include Chrome in the build environment
9services:
10 - dusk
11 
12# Build all commits
13on:
14 push:
15 branches: .*
16 
17pipeline:
18 - name: Setup
19 cmd: |
20 cp -v .env.example .env
21 composer install --no-interaction --prefer-dist --optimize-autoloader
22 php artisan key:generate
23 
24 # Create a dusk env file, ensuring APP_URL uses BUILD_HOST
25 cp -v .env .env.dusk.ci
26 sed -i "s@APP_URL=.*@APP_URL=http://$BUILD_HOST:8000@g" .env.dusk.ci
27 
28 - name: Compile Assets
29 cmd: |
30 npm ci --no-audit
31 npm run build
32 
33 - name: Browser Tests
34 cmd: |
35 php -S [::0]:8000 -t public 2>server.log &
36 sleep 2
37 php artisan dusk:chrome-driver $CHROME_DRIVER
38 php artisan dusk --env=ci

要了解有关在 Chipper CI 上运行 Dusk 测试的更多信息,包括如何使用数据库,请查阅官方 Chipper CI 文档

Laravel 是最高效的方式来
构建、部署和监控软件。