PHPackages                             winter/wn-dusk-plugin - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Testing & Quality](/categories/testing)
4. /
5. winter/wn-dusk-plugin

ActiveWinter-plugin[Testing & Quality](/categories/testing)

winter/wn-dusk-plugin
=====================

Integrates Laravel Dusk browser testing into Winter CMS.

v2.1.0(2y ago)22902[1 PRs](https://github.com/wintercms/wn-dusk-plugin/pulls)MITPHPPHP ^8.0

Since Nov 30Pushed 9mo ago4 watchersCompare

[ Source](https://github.com/wintercms/wn-dusk-plugin)[ Packagist](https://packagist.org/packages/winter/wn-dusk-plugin)[ Docs](https://github.com/wintercms/wn-dusk-plugin)[ GitHub Sponsors](https://github.com/wintercms)[ Fund](https://opencollective.com/wintercms)[ RSS](/packages/winter-wn-dusk-plugin/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (2)Dependencies (2)Versions (4)Used By (0)Security (1)

Dusk Plugin
===========

[](#dusk-plugin)

Integrates Laravel Dusk browser testing into Winter CMS, providing Winter CMS and plugin developers with the tools to run automated tests on a fully functional Winter CMS instance through a virtual browser.

> **Note:** This plugin is intended to be used for development purposes only. Configured improperly, it can allow users to circumvent authentication and sign in as any user. This plugin should be specified as a **development dependency** (ie. `require-dev`) only.

Getting started
---------------

[](#getting-started)

To install the plugin, you may install it through the [Winter CMS Marketplace](https://wintercms.com/plugin/winter-dusk), or you may install it using Composer:

```
composer require --dev winter/wn-dusk-plugin
```

Then, run the migrations to ensure the plugin is enabled:

```
php artisan winter:up
```

To run the browser tests, you must install the Chrome web-driver and have the Google Chrome browser installed on the machine running the tests. The web-driver can be installed by running the following command:

```
php artisan dusk:chrome-driver
```

Running the tests
-----------------

[](#running-the-tests)

By default, the browser tests are configured to run the tests against a website served by the in-built Laravel web server. You may start this server by running the following:

```
php artisan serve
```

To start the browser tests, run:

```
php artisan dusk
```

This will execute all available browser tests in all enabled plugins on your Winter CMS installation. If you would like to run the tests for one plugin only, you may add the plugin code as an argument:

```
php artisan dusk Acme.Blog
```

As a shortcut after running the tests, you may re-run the failed tests by executing the following command:

```
php artisan dusk:fails
```

---

Creating browser tests for your plugin
--------------------------------------

[](#creating-browser-tests-for-your-plugin)

The Dusk plugin makes it a breeze to create browser tests for your own plugin.

Browser test classes should reside in the **tests/browser** folder of your plugin. Each test class file should ended with `Test.php` to indicate it is a class of test cases, and should extend the `Winter\Dusk\Classes\BrowserTestCase` class.

For example, a blog plugin may wish to create a **BlogTest.php** file with the following content:

```