This is a complete test suite for running browser tests on Laravel Dusk with docker executor runner in gitlab.
Versions: 
Laravel dusk? Find more on laravel site
Gitlab? Find more on gitlab
Gitlab Continous Integration CI ? Find more on gitlab-runner
| LARAVEL VERSION | COMPATIBLE |
|---|---|
| 5.6 | YES |
| 5.5 | YES |
| 5.4 and below | not tested |
You are encouraged to use this docker image for testing purposes in gitlab ci environments, or anywhere else. MIT license.
This is really simple to set up for your own CI testing environment.
However, you might need to update your project, according to this documentation, so please read carefully....
If this is helpful to you, you can always add star on docker hub, to make it more visible to other users.
- 2018-02-16 - New command introduced - versions - works only in chilio/laravel-dusk-ci:latest for now
- 2018-02-15 - chilio/laravel-dusk-ci:latest - tested with Laravel 5.6 and dusk 3.0
- 2017-12-20 - chilio/laravel-dusk-ci:latest uses php 7.2 from now on, as it is marked as working without issues
- 2017-12-01 - php 7.2 support added, latest tag refers still to php 7.1 for now, so if you want to use 7.2, please choose exact docker tag : chilio/laravel-dusk-ci:php-7.2
- 2017-09-10 - initial release, with php 7.1 for laravel 5.5
| FRAMEWORK | VERSION |
|---|---|
| PHP | >= 7.2.2 |
| Xdebug | >= 2.6.0 |
| NGINX | >= 1.10.3 |
| Chromedriver | >= 2.35 |
| NODEJS | >= 6.12.3 |
| NPM | >= 3.10.10 |
| YARN | >= 1.3.2 |
| BOWER | >= 1.8.2 |
| PHPUNIT | >= 7.0.0 |
| NODE-SASS | >= 4.7.2 |
| GULP | >= 3.9.1 |
configure-laravel - sets up file permissions, generates laravel key, migrates and seeds db
start-nginx-ci-project - configures and starts nginx with php-fpm
versions - shows versions of included packages and enabled php modules. You can add it, to your .gitlab_ci.yml to get more detailed info about your testing environment. Note that this command works only in chilio/laravel-dusk-ci:latest for now...
This build is tested with mysql, but also works with other docker db engines
To successfully run mysql add to your test routine:
services:
mysql:latest #or specify version you need for example mysql:5.7
And in your .env or your .env candidate file to use, mark mysql as the corresponding resource (DB_HOST=mysql)
Make sure your DuskTestCase class in /tests/DuskTestCase.php matches all attributes, like drive options, host url, and port, like in this example DuskTestCase.php # there are some modifications which you need to apply!, these changes should not affect your local dev environment, otherwise there might be something else wrong with your project.
In your .gitlab-ci.yml use this image like:
image: chilio/laravel-dusk-ci:stable# you can experiment with other images, which might address your needs.
add script lines:
- cp .env.example .env # remember to have APP_URL=http://localhost and DB_HOST=mysql
- configure-laravel # preparations to run project
- start-nginx-ci-project # Here we start webserver, so this is important before running dusk
Finally you can run all your tests served by nginx | php-fpm via:
- php artisan dusk
Laravel Dusk ships with included chromedriver for linux, mac and windows. The examples here allow you to run dusk tests with these included chromedrivers (for linux in this case).
However, if you encounter problems, especially errors, with incorrect chromedriver version on your local machine, or this docker image, you can use, this package inbuilt own chromedriver. This option brings, a little bit more compatibility to your project, since Chrome is updated much more often, then chromedriver. So in order to do that, you need to make only 2 script modifications:
- In DuskTestCase.php comment out starting chromedriver like
// static::startChromeDriver();. In that case, to make your local development working, before issuingphp artisan duskcommand, you need to install proper chromedriver version manually, and make sure your chromedriver version matches Chrome, running on your local machine. You need to make sure chromedriver is started/running also. Due to different systems and configurations, that's beyond the scope of this documentation. Just to make clear here, in this case you are responsible for updating your own chromedriver with your current installation of Chrome. Since Chrome updates are pretty often, that's the suggested way to go, to keep your local dev running, while other packages are a little behind... - In .gitlab-ci.yml add
- chromedriver &before running- php artisan dusk. This will start system inbuilt chromedriver and not the one, that is shipped with laravel dusk, cause it might be outdated and causing problems with your local development.
- yarn --network-concurrency 1 # when you have problems with slow connection
- composer install --prefer-dist --no-ansi --no-interaction --no-progress --no-scripts
- bower install --quiet
- npm run dev or if you are on yarn registry - yarn run dev
- ./vendor/phpunit/phpunit/phpunit -v --coverage-text --colors --stderr# to run phpunit with version specified in your project
- cp phpunit.xml.ci phpunit.xml # In case you don't want to interfere with your local test environment, you can apply this approach for ci tests. Make sure to create phpunit.xml.ci in your project and phpunit.dusk.xml. You can specify 2 separate files for your tests, one for phpunit and one for dusk, you can use examples from this repo or modify them to suite your needs.
DuskTestCase.php # with all modifications to successfully run php artisan dusk tests
phpunit.dusk.xml # If exists in project root, this file will be automatically injected when dusk is run, in case, you want to define any custom variables for your tests like DBs, Caches etc.
phpunit.xml.ci # in case, you want to customize phpunit tests in CI , remember to copy this to phpunit.xml by adding - cp phpunit.xml.ci phpunit.xml to your gitlab-ci.yml.
gitlab-ci.yml # with stages, cache, and artifacts, assuming you are using scripts like "dev" in package.json.
- Although you don't see it in docker hub, this is automated docker build. You can always find more information about this on docker hub, docker cloud, docker store, or on github
- In your dusk tests remember to use ->waitFor() extensively, to make sure, your pages are rendered properly, before test fails. Usually CI test environments are much slower, than production or your local dev, cause they need to build caches from scratch.
- By default, all dusk browser tests are run with resolution 1920x720 with color depth 24 (bits), if you need to change that, add/modify SCREEN_RESOLUTION in your .gitlab-ci.yml in
variables:section, like for exampleSCREEN_RESOLUTION: 1280x720x24 - if you experience /bootstrap/autoload.php errors, make sure your appropriate phpunit configs are updated, especially in line
bootstrap="vendor/autoload.php" - if you get errors, about wrong chromedriver version on your local machine, check Note on using chromedriver versions