Laravel Dusk is a powerful browser testing tool for Laravel applications, allowing developers to automate the testing of their web applications using a simple and expressive API. With Dusk, you can write tests that simulate user interactions in a browser, making it easy to ensure that your application works as expected from the user’s perspective.
Key Features of Laravel Dusk:
- Browser Automation: Simulate user actions in a real browser, including clicking links, filling out forms, and navigating between pages.
- Headless Testing: Run tests in a headless browser, making it suitable for continuous integration environments without a graphical interface.
- Fluent API: Use a simple, expressive syntax to write tests that are easy to read and understand.
- Browser Screenshots: Capture screenshots of the browser at any point during the test, which can be useful for debugging.
- JavaScript Support: Test applications that rely heavily on JavaScript and dynamic content.
Installation
To get started with Laravel Dusk, follow these steps:
- Require Dusk in Your Laravel Project: Use Composer to install Dusk:
1composer require --dev laravel/dusk - Install Dusk: After requiring Dusk, install it by running:
1php artisan dusk:install - Set Up Browser Driver: Dusk uses the ChromeDriver for browser automation. Ensure you have Google Chrome installed on your machine, as well as the ChromeDriver corresponding to your Chrome version. Dusk comes with a built-in driver manager that will help you with this.
Writing Tests
Dusk tests are stored in the tests/Browser
directory. Each test should extend the DuskTestCase
class.
Example Test
Here’s a simple example of a Dusk test that checks if a user can visit the homepage and see the expected text:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
namespace Tests\Browser; use Laravel\Dusk\Browser; use Tests\DuskTestCase; class ExampleTest extends DuskTestCase { /** @test */ public function user_can_visit_homepage() { $this->browse(function (Browser $browser) { $browser->visit('/') ->assertSee('Welcome to Laravel'); }); } } |
Running Dusk Tests
To run your Dusk tests, use the following Artisan command:
1 |
php artisan dusk |
This command will launch a browser and execute the tests defined in your Dusk test files.
Additional Testing Features
1. Form Interaction:
You can simulate filling out forms and submitting them:
1 2 3 4 5 6 |
$browser->visit('/register') ->type('name', 'John Doe') ->type('email', 'john@example.com') ->type('password', 'secret') ->press('Register') ->assertSee('Registration successful'); |
2. Navigation:
You can navigate through your application:
1 2 3 |
$browser->visit('/') ->clickLink('Login') ->assertPathIs('/login'); |
3. Assertions:
Dusk provides various assertions to validate the state of the application:
assertSee()
: Checks if the text is present on the page.assertPathIs()
: Verifies the current URL path.assertPresent()
: Checks if an element is present on the page.
4. Taking Screenshots:
You can capture screenshots during your tests to aid in debugging:
1 |
$browser->screenshot('homepage-test'); |
Headless Testing
You can run Dusk tests in a headless mode by modifying the DuskTestCase
setup:
1 2 3 4 5 6 |
protected function driver() { return RemoteWebDriver::create( 'http://localhost:9515', DesiredCapabilities::chrome()->setCapability('headless', true) ); } |
Continuous Integration
Dusk can be easily integrated into your CI/CD pipeline. Just ensure that the appropriate browser driver is available in your CI environment and that the tests can run without a graphical interface (using headless mode).
Conclusion
Laravel Dusk is an invaluable tool for automating browser testing in Laravel applications. Its expressive syntax and powerful features make it easy to write tests that simulate user interactions, ensuring your application is functioning as expected.
Additional Considerations
- Database Transactions: Use database transactions to ensure your tests do not interfere with your database state.
- Testing Environment: Configure a separate testing environment to avoid affecting your production data.
- Parallel Testing: Consider running tests in parallel to speed up your test suite, especially for larger applications.
- Laravel Breeze – Simple authentication starter kit
- Laravel Jetstream – Scaffolding for Laravel apps
- Laravel Passport – API authentication via OAuth2
- Laravel Sanctum – Simple API authentication
- Spatie Laravel Permission – Role and permission management
- Laravel Cashier – Subscription billing with Stripe
- Laravel Scout – Full-text search using Algolia
- Laravel Socialite – OAuth authentication (Google, Facebook, etc.)
- Laravel Excel – Excel import and export for Laravel
- Laravel Horizon – Redis queues monitoring
- Laravel Nova – Admin panel for Laravel
- Laravel Fortify – Backend authentication for Laravel
- Laravel Vapor – Serverless deployment on AWS
- Laravel Telescope – Debugging assistant for Laravel
- Laravel Dusk – Browser testing
- Laravel Mix – API for compiling assets
- Spatie Laravel Backup – Backup management
- Laravel Livewire – Building dynamic UIs
- Spatie Laravel Media Library – Manage media uploads
- Laravel Excel – Excel spreadsheet handling
- Laravel Debugbar – Debug tool for Laravel
- Laravel WebSockets – Real-time communication
- Spatie Laravel Sitemap – Generate sitemaps
- Laravel Spark – SaaS scaffolding
- Laravel Envoy – Task runner for deployment
- Spatie Laravel Translatable – Multilingual model support
- Laravel Backpack – Admin panel
- Laravel AdminLTE – Admin interface template
- Laravel Collective Forms & HTML – Simplified form and HTML generation
- Spatie Laravel Analytics – Google Analytics integration
- Laravel Eloquent Sluggable – Automatically create slugs
- Laravel Charts – Chart integration
- Laravel Auditing – Track changes in models
- Laravel JWT Auth – JSON Web Token authentication
- Laravel Queue Monitor – Monitor job queues
- Spatie Laravel Query Builder – Filter, sort, and include relationships in Eloquent queries
- Laravel Datatables – jQuery Datatables API
- Laravel Localization – Multilingual support for views and routes
- Laravel Acl Manager – Access control list manager
- Laravel Activity Log – Record activity in your app
- Laravel Roles – Role-based access control
- Spatie Laravel Tags – Tagging models
- Laravel Installer – CLI installer for Laravel
- Laravel Breadcrumbs – Generate breadcrumbs in Laravel
- Laravel Mailgun – Mailgun integration for Laravel
- Laravel Trustup Model History – Store model change history
- Laravel Deployer – Deployment automation tool
- Laravel Auth – Custom authentication guards
- Laravel CORS – Cross-Origin Resource Sharing (CORS) support
- Laravel Notifications – Send notifications through multiple channels
- Spatie Laravel Http Logger – Log HTTP requests
- Laravel Permission Manager – Manage permissions easily
- Laravel Stubs – Customize default stubs in Laravel
- Laravel Fast Excel – Speed up Excel exports
- Laravel Image – Image processing
- Spatie Laravel Backup Server – Centralize backups for Laravel apps
- Laravel Forge API – Manage servers through the Forge API
- Laravel Blade SVG – Use SVGs in Blade templates
- Laravel Ban – Ban/unban users from your application
- Laravel API Response – Standardize API responses
- Laravel SEO – Manage SEO meta tags
- Laravel Settings – Store and retrieve settings
- Laravel DOMPDF – Generate PDFs
- Laravel Turbo – Full-stack framework for building modern web apps
- Spatie Laravel Event Sourcing – Event sourcing implementation
- Laravel Jetstream Inertia – Jetstream’s Inertia.js integration
- Laravel Envoy Tasks – Task automation
- Laravel Likeable – Like/dislike functionality
- Laravel GeoIP – Determine visitor’s geographic location
- Laravel Country State City – Dropdowns for country, state, and city
- Laravel Hashids – Generate short unique hashes
- Laravel Repository – Repository pattern for Laravel
- Laravel UUID – UUID generation for models
- Spatie Laravel Medialibrary Pro – Enhanced media management
- Laravel Queue Monitor – Monitor Laravel job queues
- Laravel User Activity – Monitor user activity
- Laravel DB Snapshots – Create database snapshots
- Laravel Twilio – Twilio integration
- Laravel Roles – Role-based permission handling
- Laravel Translatable – Add translations to Eloquent models
- Laravel Teamwork – Manage teams in multi-tenant apps
- Laravel Full Text Search – Add full-text search to Laravel models
- Laravel File Manager – File and media management
- Laravel User Timezones – Automatically detect user time zones
- Laravel ChartsJS – Render charts with ChartsJS
- Laravel Stripe – Stripe API integration
- Laravel PDF Generator – PDF generation
- Laravel Elasticsearch – Elasticsearch integration
- Laravel Simple Qrcode – Generate QR codes
- Laravel Timezone – Manage timezones and conversions
- Laravel Collective API – API management for Laravel
- Laravel Rest API Boilerplate – REST API starter kit
- Laravel Multi Auth – Multi-authentication functionality
- Laravel Voyager – Admin panel for Laravel
- Laravel Voyager Database – Database manager for Voyager
- Laravel Categories – Handle categories for models
- Laravel Multitenancy – Multi-tenancy implementation
- Laravel Access Control – Advanced access control for users
- Laravel Menus – Menu management
- Laravel Translatable Routes – Multilingual route handling