https://github.com/chilio/laravel-dusk-ci
Docker Test suite for Laravel Dusk in gitlab CI
https://github.com/chilio/laravel-dusk-ci
browser-testing browser-tests chromedriver chromedriver-versions ci-test ci-tests docker docker-image dusk dusk-tests gitlab-ci laravel-dusk laravel-dusk-ci laravel-gitlab-ci laravel-test laravel-test-driven-development laravel-testing php phpunit vue
Last synced: 26 days ago
JSON representation
Docker Test suite for Laravel Dusk in gitlab CI
- Host: GitHub
- URL: https://github.com/chilio/laravel-dusk-ci
- Owner: chilio
- License: mit
- Created: 2017-09-28T16:31:36.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-03-21T03:21:58.000Z (about 1 month ago)
- Last Synced: 2025-03-28T06:08:55.909Z (about 1 month ago)
- Topics: browser-testing, browser-tests, chromedriver, chromedriver-versions, ci-test, ci-tests, docker, docker-image, dusk, dusk-tests, gitlab-ci, laravel-dusk, laravel-dusk-ci, laravel-gitlab-ci, laravel-test, laravel-test-driven-development, laravel-testing, php, phpunit, vue
- Language: Dockerfile
- Homepage:
- Size: 377 KB
- Stars: 162
- Watchers: 7
- Forks: 54
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Running Browser Tests with Laravel Dusk in Gitlab CI/CD Pipelines.
[](https://hub.docker.com/r/chilio/laravel-dusk-ci)
[](https://github.com/chilio/laravel-dusk-ci/issues)
[](https://github.com/chilio/laravel-dusk-ci)
[](https://github.com/chilio/laravel-dusk-ci/blob/master/LICENSE)
This is a **complete test suite** for running (**Unit**, **Functional**, **Feature**, **Browser**) tests on your Laravel based system.
It uses **Laravel Dusk** for browser tests via a Docker executor runner in **GitLab**.
With this package, you don't need to worry, about **Chrome** or **chromedriver** compatibility. This is done automatically, to make your **Browser Testing** with **Laravel Dusk**, as easy, as possible.
Versions: [](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/)
[](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/)
[](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/)
[](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/)
[](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/)
[](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/)
Deprecated versions:
[](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/)
[](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/)
[](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/)
[](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/)
[](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/)
[](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/)
**Laravel dusk**? Find more in Laravel Dusk Docs [12.x](https://laravel.com/docs/12.x/dusk) | [11.x](https://laravel.com/docs/11.x/dusk) | [10.x](https://laravel.com/docs/10.x/dusk) | [9.x](https://laravel.com/docs/9.x/dusk) | [8.x](https://laravel.com/docs/8.x/dusk) | [7.x](https://laravel.com/docs/7.x/dusk) | [6.x](https://laravel.com/docs/6.x/dusk) | [5.8](https://laravel.com/docs/5.8/dusk)
**Gitlab**? Find more on [gitlab](https://about.gitlab.com/)
**Gitlab Continous Integration CI** ? Find more on [gitlab-runner](https://hub.docker.com/r/gitlab/gitlab-runner/)
You may be wondering why deprecated versions are still available. The main reason is to allow for browser testing of your older Laravel applications while you're transitioning to newer versions.
This **plug-and-play** package is designed for your **CI** testing environment in GitLab.
All you need to do is to select the appropriate version of your **PHP interpreter** (based on your **Laravel version**), and you should be ready to go.
Current state of supported versions of Laravel and PHP is presented below.
### **Compatibility**
| LARAVEL VERSION | COMPATIBLE | PHP VERSIONS |
|-----------------| ---------- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 12.x | YES | [](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/) [](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/) [](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/) |
| 11.x | YES | [](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/) [](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/) [](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/) |
| 10.x | YES | [](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/) [](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/) [](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/) |
| 9.x | YES | [](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/) [](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/) [](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/) |
| 8.x | YES | [](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/) [](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/) [](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/) [](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/) |
| 7.x | YES | [](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/) [](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/) [](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/) [](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/) |
| 6.x | YES | [](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/) [](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/) [](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/) [](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/) |
| 5.8 | YES | [](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/) [](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/) |
| 5.7 | YES | [](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/) |
| 5.6 | YES | [](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/) |
| 5.5 | YES | [](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/) |
| 5.4 | Reported working | [](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/) |
| 5.3 and below | Not tested | |
You should be up and running in seconds. However, please carefully read the following notes.
For now **DuskTestCase.php** needs to be modified in **all cases**. **THIS package** is not going to work **without `-no-sandbox` directive in this file.**. You should also disable starting of `# static::startChromeDriver();`, to have more control of which chromedriver will run. Please read more about it, under **Usage**...
In case of any issues, please read the current documentation thoroughly, check existing issues (including closed ones) and finally, report a new issue on GitHub.
If this package proves to be useful to you, please star it on Docker Hub or GitHub to increase its visibility to other users.
### **Changelog**
- 2025-03-15 - `stable` tag refers `php-8.3` from now on
- 2025-03-15 - `latest` tag refers `php-8.4` from now on
- 2025-03-15 - `start-system-chromedriver`, `start-project-chromedriver`, `stop-chromedriver` commands introduced
- 2025-03-14 - new images built on ubuntu 24.04 noble. If you experience any problems you can use legacy images with tag `php-x.y-legacy` where x is the php x.y version you need.
- 2025-02-25 - `php-8.4` tag introduced
- 2023-12-30 - `stable` tag refers `php-8.2` from now on
- 2023-12-30 - `latest` tag refers `php-8.3` from now on
- 2023-12-20 - `php-8.3` tag released with latest versions of chrome and chromedriver
- 2023-04-29 - `latest` tag refers `php-8.2` from now on
- 2022-12-16 - `php-8.2` tag added with thanks to @pepijnolivier
- 2022-12-16 - Latest chromedriver compatibility updated up to v.109
- 2022-09-01 - `latest` tag refers `php-8.1` from now on
- 2022-09-01 - Latest chromedriver compatibility updated up to v.105 with thanks to @Velzeboer
- 2022-04-16 - Laravel 9 compatibility confirmed
- 2022-04-16 - `php-8.1` tag added
- 2022-04-16 - Latest chromedriver compatibility updated up to v.101
- 2021-11-03 - Latest chromedriver compatibility updated up to v.96
- 2021-11-03 - `stable` tag refers `php-7.4` from now on
- 2021-10-28 - `latest` tag refers `php-8.0` from now on and `stable` tag refers to `php-7.2`
- 2021-10-28 - php imagick extension added to all images except deprecated `php-7.1`
- 2021-10-12 - Latest chromedriver compatibility updated up to v.95
- 2021-01-29 - Latest chromedriver compatibility updated up to v.89
- 2020-12-03 - **PHP 8.0** version released in `php-8.0` tag + latest chromedriver compatibility updated
- 2020-10-23 - PHP 8.0 RC in `php-8.rc` tag tested with Laravel 8
- 2020-10-20 - Latest chromedriver compatibility updated up to v.87
- 2020-09-15 - Laravel 8 compatibility confirmed in **php-7.3**, **php-7.4** and **latest** tags
- 2020-08-17 - Latest chromedriver compatibility updated v.85
- 2020-05-15 - latest PHP versions, Laravel 7 compatibility confirmed
- 2020-02-17 - Node updated to 12.x LTS
- 2019-12-12 - Latest for now refers to PHP 7.4
- 2019-12-12 - PHP 7.4 in `php-7.4` tag
- 2019-12-12 - Latest chromedriver compatibility updated v.78 & v.79
- 2019-09-27 - Latest chromedriver compatibility updated v.77
- 2019-09-24 - **chilio/laravel-dusk-ci:old-stable** is deprecated for now. Use it only with old Laravel versions (before 5.5)
- 2019-05-06 - Latest chromedriver compatibility updated v.75
- 2019-04-04 - Latest chromedriver compatibility updated v.74
- 2018-12-20 - PHP 7.3 in `php-7.3` tag
- 2018-10-24 - Update to ubuntu:bionic (18.04), Install php-geos and link default `php` command to `php7.2` in **latest tag**
- 2018-10-09 - Updated to nodejs v8
- 2018-10-06 - Latest chromedriver compatibility updated
- 2018-07-24 - **mysql 8.0** and **mysql:latest** are now supported, but you need to make some modifications to your `.gitlab-ci.yml`. Unfortunately for now you cannot simply run mysql in services, as it was before.
Simple workaround, is to change in services: (everywhere you call mysql service) to:
```
services:
- name: mysql:latest
command: ["--default-authentication-plugin=mysql_native_password"]
```
You need to make sure your Laravel `config/database.php` has these **modes** array also:
```
'mysql' => [
...
'prefix' => '',
'strict' => true,
'engine' => null,
'modes' => [
'ONLY_FULL_GROUP_BY',
'STRICT_TRANS_TABLES',
'NO_ZERO_IN_DATE',
'NO_ZERO_DATE',
'ERROR_FOR_DIVISION_BY_ZERO',
'NO_ENGINE_SUBSTITUTION',
],
],
```
- 2018-05-14 - **chilio/laravel-dusk-ci:stable** ships now with php 7.2 and chrome versions check enabled
- 2018-05-14 - **chilio/laravel-dusk-ci:stable** moved to **chilio/laravel-dusk-ci:old-stable**. If you encounter any problems use the old one, or post issues...
- 2018-05-08 - Automatic **Chrome** and **chromedriver** versions check and fix - works only in **chilio/laravel-dusk-ci:latest** for now, if you experience errors with this please use **chilio/laravel-dusk-ci:stable** or **chilio/laravel-dusk-ci:php-7.2**
- 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
## **Documentation**
### **What's included? (versions depend on image/tag)**
| Libs included|
|--------------|
| PHP |
| Xdebug |
| NGINX |
| Chromedriver |
| Chrome |
| NODEJS |
| NPM |
| YARN |
| BOWER |
| PHPUNIT |
| NODE-SASS |
| GULP |
To see exact versions of installed packages, please run `versions` command in your `script` declaration in `.gitlab-ci.yml`, as in examples.
### **Available additional commands:**
`configure-laravel` - sets up file permissions, generates laravel key, migrates and seeds db, checks and enforces chromedriver compatibility
`start-nginx-ci-project` - configures and starts nginx with php-fpm
`start-project-chromedriver` - starts project embedded chromedriver on port 9515
`start-system-chromedriver` - starts system embedded chromedriver on port 9515
`stop-chromedriver` - stops running chromedriver
`versions` - shows versions of included packages and enabled php modules.
### **Databases:**
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:5.7` #or specify any downwards version of mysql. **mysql:latest** will not work out of the box, therefore please check changelog
And in your .env or your .env candidate file to use, mark mysql as the corresponding resource (**DB_HOST=mysql**)
If you receive errors like
```
SQLSTATE[HY000] [2002] php_network_getaddresses: getaddrinfo failed: Name or service not known
```
probably you have other mysql instance running in your host system with that name. In this case you may need to provide db-alias for your test. More info [here](https://github.com/chilio/laravel-dusk-ci/issues/21#issuecomment-444836027)
### **Usage:**
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](https://github.com/chilio/laravel-dusk-ci/blob/master/examples/DuskTestCase.php)** # there are some modifications which **you need to apply (especially --no-sandbox in $options for driver)!**, 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:latest`# 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`
#### Note on using chromedriver versions:
**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).
As of **2018-05-08** this package automatically fixes eventual problems with chrome or chromedriver. Therefore following changes to your app **should not be necessary**.
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. In order to do that, you need to make only 2 script modifications:
1. In DuskTestCase.php comment out starting chromedriver like`// static::startChromeDriver();`. In that case, to make your local development working, before issuing `php artisan dusk` command, 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...
2. After running `configure-laravel` Chromedriver should be started already. If you want to use other version, in .gitlab-ci.yml add `- stop-chromedriver` and one of (`- start-project-chromedriver` or `- start-system-chromedriver`) before running `- php artisan dusk`. This will give you more control of which Chromedriver will be processing your Dusk tests.
------
#### Further example script commands (if needed in your case):
`- 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...
`- 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
### **Examples:**
**[DuskTestCase.php](https://github.com/chilio/laravel-dusk-ci/blob/master/examples/DuskTestCase.php)** # with all modifications to successfully run php artisan dusk tests
**[DuskTestCase.php](https://github.com/chilio/laravel-dusk-ci/blob/master/examples/old-laravel-6-and-below/DuskTestCase.php)** # (OLD for Laravel 6 and below) with all modifications to successfully run php artisan dusk tests
**[phpunit.dusk.xml](https://github.com/chilio/laravel-dusk-ci/blob/master/examples/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](https://github.com/chilio/laravel-dusk-ci/blob/master/examples/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](https://github.com/chilio/laravel-dusk-ci/blob/master/examples/.gitlab-ci.yml)** # with stages, cache, and artifacts, assuming you are using scripts like "dev" in package.json.
### **Troubleshooting:**
- Please check contents of **[DuskTestCase.php](https://github.com/chilio/laravel-dusk-ci/blob/master/examples/DuskTestCase.php)**, you should have it updated accordingly.
- If you get errors, about wrong chromedriver version, or errors about **Laravel dusk** not able to connect on port 9515, please consider stopping chromedriver via `stop-chromedriver` and starting proper version of your choosing ('system' or 'project'). Check **Note on using chromedriver versions**
- If your Laravel chromedriver version is not recognized properly you can issue `- php artisan dusk:install`
- Try different tag versions compatible with your project.
- You can always try older legacy version like for example **chilio/laravel-dusk-ci:php-8.2-legacy** instead of a current version **chilio/laravel-dusk-ci:php-8.2**
- 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 a **resolution** 1920x720 and color depth 24 (bits), if you need to change that, add/modify SCREEN_RESOLUTION in your .gitlab-ci.yml in `variables:` section, like for example `SCREEN_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 warning about mysql `Service runner probably didn't start properly` or other strange behaviours make sure to remove all cache and artifacts routines. Depending on your workflow, they might introduce problems to your tests. You should also check, if your gitlab-runner is working in a privileged mode.
### **Disclaimer**
Images mentioned above are intended for testing purposes in CI environments only.
Production usage is not recommended.