Package Data | |
---|---|
Maintainer Username: | crynobone |
Maintainer Contact: | keoghan@klever.co.uk (Keoghan Litchfield) |
Package Create Date: | 2017-10-21 |
Package Last Update: | 2024-10-26 |
Home Page: | https://packages.tools/testbench-dusk |
Language: | PHP |
License: | MIT |
Last Refreshed: | 2024-10-26 15:01:26 |
Package Statistics | |
---|---|
Total Downloads: | 501,050 |
Monthly Downloads: | 10,365 |
Daily Downloads: | 319 |
Total Stars: | 102 |
Total Watchers: | 4 |
Total Forks: | 14 |
Total Open Issues: | 1 |
The Testbench Dusk Component is a simple package that is supposed to help you write tests for your Laravel package using Laravel Dusk.
The package was developed by Konsulting Ltd and transferred to the Orchestra namespace where we will assist with supporting it in the future. It is in early development and feedback is appreciated.
Laravel | Testbench Dusk :---------|:---------- 5.4.x | 3.4.x 5.5.x | 3.5.x 5.6.x. | 3.6.x 5.7.x. | 3.7.x 5.8.x | 3.8.x 6.x | 4.x 7.x | 5.x 8.x | 6.x
Before going through the rest of this documentation, please take some time to read the following documentation:
To install through composer, run the following command from terminal:
composer require --dev "orchestra/testbench-dusk"
To use Testbench Dusk Component, all you need to do is extend Orchestra\Testbench\Dusk\TestCase
instead of Laravel\Dusk\TestCase
. The fixture app booted by Orchestra\Testbench\Dusk\TestCase
is predefined to follow the base application skeleton of Laravel 7.
<?php
class BrowserTestCase extends Orchestra\Testbench\Dusk\TestCase
{
//
}
By default, Tesbench Dusk will start its own PHP server at http://127.0.0.1:8000
.
You can customize this by replacing the $baseServeHost
and $baseServePort
such as below:
<?php
class BrowserTestCase extends Orchestra\Testbench\Dusk\TestCase
{
protected static $baseServeHost = '127.0.0.1';
protected static $baseServePort = 9000;
}
Dusk 3.5+ offers the ability to run Dusk tests without UI (the browser window), and this is the default and is normally slightly quicker.
You can switch the behaviour with the following calls:
// To show the UI during testing
\Orchestra\Testbench\Dusk\Options::withUI();
// To hide the UI during testing
\Orchestra\Testbench\Dusk\Options::withoutUI();
We recommend you place this in a tests/bootstrap.php
file, similar to this packages own test setup and use this for PHP Unit.
By default you can either use sqlite
, mysql
, pgsql
or sqlsrv
with Testbench Dusk, however do note that it is impossible to use sqlite
using :memory:
database as you would with Testbench or Tesbench BrowserKit.
If you opt to use sqlite
, you might want to set the default database connection to sqlite
either using phpunit
configuration or setting it up on getEnvironmentSetUp()
method.
/**
* Define environment setup.
*
* @param Illuminate\Foundation\Application $app
*
* @return void
*/
protected function getEnvironmentSetUp($app)
{
$this->app['config']->set('database.default', 'sqlite');
}
To create the sqlite database you just need to run the following code:
php vendor/orchestra/testbench-dusk/create-sqlite-db
We use the calling test class to build up the application to be used when serving the request.
Sometimes you will want to make a minor change to the application for a single test (e.g. changing a config item).
This is made possible by using the tweakApplication
method on the test, and passing in a closure to apply. At the end of the test, you need to call the removeApplicationTweaks
method to stop the changes being applied to the server.
An example test (can_tweak_the_application_within_a_test
) is available in the tests/Browser/RouteTest.php
test file.
Browser tests can take a while to run, so you could also separate your tests in your phpunit.xml
file by providing different testsuites, allowing you to run your Browser tests on demand.
For example:
<testsuites>
<testsuite name="Browser">
<directory suffix="Test.php">./tests/Browser</directory>
</testsuite>
<testsuite name="Feature">
<directory suffix="Test.php">./tests/Feature</directory>
</testsuite>
<testsuite name="Unit">
<directory suffix="Test.php">./tests/Unit</directory>
</testsuite>
</testsuites>
Run only your browser tests by running phpunit with the --testsuite=Browser
option.
You can optionally set the default testsuite with the option defaultTestSuite="Unit"
.
Facebook\WebDriver\Exception\SessionNotCreatedException: session not created: Chrome version must be between 70 and 73
If tests report following error, run the following command:
./vendor/bin/dusk-updater update
Alternatively you can run the following command to detect installed ChromeDriver and auto update it if neccessary:
./vendor/bin/dusk-updater detect --auto-update
You may encounter the error
PHP Fatal error: Cannot declare class CreateUsersTable, because the name is already in use in...
when using loadLaravelMigrations()
with some of your test extending the Dusk test class \Orchestra\Testbench\Dusk\TestCase
and others extend the "normal" test class \Orchestra\Testbench\TestCase
.
The problem arises because migrations are loaded from both packages' "skeletons" during the same test run, and Laravel's migration classes are not namespaced.
Make sure all integration tests in your test suite use the same Laravel skeleton (the one from testbench-dusk
),
regardless of the base class they extend by overriding getBasePath()
in your test classes.
Do the override in your base integration test class, or perhaps in a trait if you need it in multiple classes.
/**
* Make sure all integration tests use the same Laravel "skeleton" files.
* This avoids duplicate classes during migrations.
*
* Overrides \Orchestra\Testbench\Dusk\TestCase::getBasePath
* and \Orchestra\Testbench\Concerns\CreatesApplication::getBasePath
*
* @return string
*/
protected function getBasePath()
{
// Adjust this path depending on where your override is located.
return __DIR__.'/../vendor/orchestra/testbench-dusk/laravel';
}