Laravel Dusk & GitHub Actions:在 CI 管道中运行 Dusk

发布时间 作者

Laravel Dusk & GitHub Actions: Running Dusk in CI Pipelines image

我们为我们的 测试管理工具 Testmo 拥有一个广泛的 Laravel Dusk 测试套件。除了我们的后端和单元测试之外,我们基于 Dusk 的(Selenium)浏览器测试使我们能够端到端地验证产品的全部功能,这意味着我们可以像用户一样测试应用程序:自动执行浏览器以导航到页面、打开对话框、填写表单,甚至测试复杂的交互,例如拖放或粘贴图像。

从我们的开发机器(或开发 Docker 环境)本地运行这些测试非常容易。您可以使用开发机器的浏览器(例如 Chrome)运行测试,也可以在开发容器中使用 chromium。Laravel Dusk 默认情况下也附带了用于 Windows 和 Mac 的 chromedriver 二进制文件,以便轻松地自动化 Chrome。或者,如果您使用 Docker 并想使用官方 Selenium 浏览器镜像,这也很容易(请参阅我们的 Selenium 测试自动化 指南)。

但是如何从我们的 CI 管道(如 GitHub Actions、GitLab CI/CD 或 CircleCI)运行我们的 Laravel Dusk 测试?这很重要,这样我们就可以在构建和部署新应用程序版本时运行所有测试。在本文中,我们将介绍让它运行的确切步骤。

使用 GitHub Actions 运行 Laravel Dusk

为了将我们的 Laravel Dusk 测试作为 CI 管道的一部分运行,我们需要能够在管道运行期间自动化的浏览器。通常是 Chrome(即 chromium),但我们也可以轻松使用 Firefox 或 Edge。无论您使用的是 GitHub Actions、GitLab CI/CD、CircleCI、Bibucket、Jenkins 还是其他服务,方法都一样。

为了从我们的 CI 管道中使用浏览器,您可以简单地直接从管道配置中安装浏览器。但有一种更好的方法。我们可以使用预先配置了浏览器和匹配驱动程序的官方 Selenium Docker 镜像之一,这样 Laravel Dusk 就可以连接到它。在以下示例中,我们将重点关注 GitHub Actions,但您可以在 GitLab CI/CD、CircleCI 等中使用相同的 Docker 容器。

# .github/workflows/test-single.yml
name: Test
 
on:
workflow_dispatch:
inputs:
browser:
type: choice
description: Which browser to test
required: true
default: chrome
options:
- chrome
- firefox
- edge
 
jobs:
test:
name: Test
runs-on: ubuntu-latest
 
services:
selenium:
image: selenium/standalone-${{ github.event.inputs.browser }}
 
steps:
- uses: actions/checkout@v2
 
- run: # Your Laravel Dusk test execution goes here
env:
BROWSER: ${{ github.event.inputs.browser }}
 
- uses: actions/upload-artifact@v2
if: always()
with:
name: screenshots
path: screenshots/

上面的 GitHub Actions 工作流使用官方 Selenium 镜像之一启动一个独立的服务容器。当我们通过 GitHub 的 Web 界面启动管道时,它会询问我们使用哪个浏览器(Chrome、Firefox、Edge),因此我们可以在不同的浏览器上运行测试。

我们还为我们的 Laravel Dusk 环境提供了一个环境变量(BROWSER),这样我们就可以根据需要微调测试以适应特定浏览器的行为。在我们的 Laravel Dusk 测试中,我们只需使用主机和端口 selenium:4444 连接到 Selenium。您还需要在 Laravel Dusk 基类中设置 Selenium 功能浏览器名称,以确保您请求正确的浏览器(您也可以为此使用 BROWSER 环境变量)。注意:对于 Edge,这需要为 MicrosoftEdge

并行运行多个浏览器会话

上面的工作流针对单个浏览器执行我们的测试。但使用 GitHub Actions 和其他 CI 服务,也易于并行运行多个测试作业。在我们的例子中,为什么不同时针对多个浏览器运行我们的测试呢?

这很容易做到。我们可以使用 GitHub Actions 的 matrix 功能来告诉它用不同的设置多次运行我们的 test 作业。在我们的例子中,我们告诉 GitHub 三次运行我们的测试,一次用于 Chrome,一次用于 Firefox,一次用于 Edge。我们不需要为其大幅更改测试作业。我们唯一需要更改的是,这次将我们的 matrix.browser 设置传递给 Laravel Dusk 测试,而不是输入设置。

# .github/workflows/test-parallel.yml
name: Test (parallel)
 
on: [workflow_dispatch]
 
jobs:
test:
name: Test
runs-on: ubuntu-latest
 
strategy:
fail-fast: false
matrix:
browser: ['chrome', 'firefox', 'edge']
 
services:
selenium:
image: selenium/standalone-${{ matrix.browser }}
 
steps:
- uses: actions/checkout@v2
 
- run: # Your Laravel Dusk test execution goes here
env:
BROWSER: ${{ matrix.browser }}
 
- uses: actions/upload-artifact@v2
if: always()
with:
name: ${{ matrix.browser }}
path: screenshots/

现在我们运行工作流时,GitHub Actions 将并行启动三次 test 作业。对于每个作业,它将启动一个带有正确浏览器的不同 Selenium 服务容器。在我们的 Laravel Dusk 测试中,Selenium 将始终可以在 selenium:4444 上访问。以下是 GitHub Actions 中多个并行测试作业的样子

将测试结果报告到测试管理

我们也可以将 Laravel Dusk 测试中的测试结果报告到测试工具,例如我们的 Testmo,这样我们就可以轻松地查看一段时间内浏览器测试的所有测试结果、与团队共享结果,以及轻松地识别(并修复!)不稳定、缓慢或损坏的测试。报告测试结果的另一个好处是,我们可以将自动化测试与 测试用例管理探索性测试 在一个中央工具中进行管理。以下是 Testmo 中测试自动化运行的样子

如果您的团队使用 GitHub 问题、GitLab 问题或专用问题跟踪工具(如 Jira),您也可以轻松创建和链接新问题和错误报告。您可以在此处了解有关流行集成的更多信息

将自动化测试提交到测试工具后,您还可以轻松存档和查看过去的测试结果,并将它们链接到里程碑。因此,您可以始终快速引用和查看过去的結果,而如果只将测试结果保存在 CI 服务中,这将非常困难。

这篇客座文章由 Testmo 的创始人之一 Dennis Gurock 撰写。Testmo 是使用 Laravel 构建的,并广泛使用 Laravel Dusk。如果您不熟悉 QA 工具,他最近创建了一个 最佳测试管理工具 列表供您尝试。

Eric L. Barnes photo

Eric 是 Laravel 新闻的创建者,从 2012 年开始就一直在报道 Laravel。

归档于
Cube

Laravel 时事通讯

加入 40,000 多名其他开发人员,永不错过新的提示、教程等。

Laravel Forge logo

Laravel Forge

轻松创建和管理您的服务器,并在几秒钟内部署您的 Laravel 应用程序。

Laravel Forge
Tinkerwell logo

Tinkerwell

Laravel 开发人员必备的代码运行器。使用 AI、自动完成功能和对本地和生产环境的即时反馈进行调试。

Tinkerwell
No Compromises logo

无妥协

Joel 和 Aaron,来自 No Compromises 播客的两位经验丰富的开发人员,现可为您的 Laravel 项目聘请。⬧ 固定价格为每月 7500 美元。⬧ 无冗长的销售流程。⬧ 无合同。⬧ 100% 退款保证。

无妥协
Kirschbaum logo

Kirschbaum

提供创新和稳定性,以确保您的 Web 应用程序取得成功。

Kirschbaum
Shift logo

Shift

正在运行旧版本的 Laravel?立即进行自动化的 Laravel 升级和代码现代化,以保持应用程序新鲜。

Shift
Bacancy logo

Bacancy

只需每月 2500 美元,即可为您的项目配备经验丰富的 Laravel 开发人员,拥有 4-6 年的经验。获得 160 小时的专业知识和 15 天的免费试用。立即安排通话!

Bacancy
Lucky Media logo

Lucky Media

立即获得幸运 - Laravel 开发的理想选择,拥有超过十年的经验!

Lucky Media
Lunar: Laravel E-Commerce logo

Lunar: Laravel 电子商务

Laravel 的电子商务。一个开源包,将现代无头电子商务功能的力量带到 Laravel。

Lunar: Laravel 电子商务
LaraJobs logo

LaraJobs

官方 Laravel 工作板

LaraJobs
SaaSykit: Laravel SaaS Starter Kit logo

SaaSykit: Laravel SaaS 启动工具包

SaaSykit 是一个 Laravel SaaS 启动工具包,它包含运行现代 SaaS 所需的所有功能。支付、精美结账、管理面板、用户仪表板、身份验证、预制组件、统计、博客、文档等等。

SaaSykit: Laravel SaaS 启动工具包
Rector logo

Rector

您的无缝 Laravel 升级合作伙伴,降低成本,加速创新,助力企业成功

Rector
MongoDB logo

MongoDB

通过 MongoDB 和 Laravel 的强大集成,增强您的 PHP 应用程序,使开发人员能够轻松高效地构建应用程序。支持事务、搜索、分析和移动用例,同时使用熟悉的 Eloquent API。探索灵活、现代的 MongoDB 数据库如何改变您的 Laravel 应用程序。

MongoDB
Maska is a Simple Zero-dependency Input Mask Library image

Maska 是一个简单无依赖的输入掩码库

阅读文章
Add Swagger UI to Your Laravel Application image

将 Swagger UI 添加到您的 Laravel 应用程序

阅读文章
Assert the Exact JSON Structure of a Response in Laravel 11.19 image

在 Laravel 11.19 中断言响应的精确 JSON 结构

阅读文章
Build SSH Apps with PHP and Laravel Prompts image

使用 PHP 和 Laravel Prompts 构建 SSH 应用程序

阅读文章
Building fast, fuzzy site search with Laravel and Typesense image

使用 Laravel 和 Typesense 构建快速模糊网站搜索

阅读文章
Add Comments to your Laravel Application with the Commenter Package image

使用 Commenter 包向您的 Laravel 应用程序添加评论

阅读文章