Skip to content

Commit b36bd38

Browse files
committed
Readme updated
1 parent 778d726 commit b36bd38

File tree

1 file changed

+33
-23
lines changed

1 file changed

+33
-23
lines changed

README.md

Lines changed: 33 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
This is **complete** test suite for **Laravel 5.5** with **Dusk browser tests** enabled on **docker executor runner** in **gitlab**.
77

8-
Versions: [![](https://images.microbadger.com/badges/version/chilio/laravel-dusk-ci.svg)](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/ ) [![](https://images.microbadger.com/badges/version/chilio/laravel-dusk-ci:stable.svg)](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/) [![](https://images.microbadger.com/badges/version/chilio/laravel-dusk-ci:php-7.1.svg)](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/)
8+
Versions: [![](https://images.microbadger.com/badges/version/chilio/laravel-dusk-ci.svg)](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/ ) [![](https://images.microbadger.com/badges/version/chilio/laravel-dusk-ci:stable.svg)](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/) [![](https://images.microbadger.com/badges/version/chilio/laravel-dusk-ci:php-7.1.svg)](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/) [![](https://images.microbadger.com/badges/version/chilio/laravel-dusk-ci:php-7.2.svg)](https://hub.docker.com/r/chilio/laravel-dusk-ci/tags/)
99

1010
**Laravel dusk**? Find more on [laravel site](https://laravel.com/docs/5.5/dusk)
1111

@@ -24,22 +24,31 @@ However, **you might need to update your project**, according to this documentat
2424
If this is helpful to you, you can always add **star** on docker hub, to make it more visible to other users. [![Docker stars](https://img.shields.io/docker/stars/chilio/laravel-dusk-ci.svg)](https://hub.docker.com/r/chilio/laravel-dusk-ci/)
2525

2626

27+
### **Updates:**
2728

28-
### **What's included?**
29+
- 2017-12-20 - **chilio/laravel-dusk-ci:latest** uses php 7.2 from now on, as it is marked as working without issues
30+
- 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**
31+
- 2017-09-10 - initial release, with **php 7.1** for laravel 5.5
2932

30-
| FRAMEWORK | VERSION |
31-
| ------------ | ------- |
32-
| PHP | 7.1.10 |
33-
| Xdebug | 2.5.5 |
34-
| NGINX | 1.10.3 |
35-
| Chromedriver | 2.32 |
36-
| NODEJS | 6.11.4 |
37-
| NPM | 3.10.10 |
38-
| YARN | 1.2.1 |
39-
| BOWER | 1.8.2 |
40-
| PHPUNIT | 6.4.1 |
41-
| NODE-SASS | 4.5.3 |
42-
| GULP | 3.9.1 |
33+
34+
## **Documentation**
35+
36+
37+
### **What's included? (depends on image/tag)**
38+
39+
| FRAMEWORK | VERSION |
40+
| ------------ | ---------- |
41+
| PHP | >= 7.1.10 |
42+
| Xdebug | >= 2.5.5 |
43+
| NGINX | >= 1.10.3 |
44+
| Chromedriver | >= 2.32 |
45+
| NODEJS | >= 6.11.4 |
46+
| NPM | >= 3.10.10 |
47+
| YARN | >= 1.2.1 |
48+
| BOWER | >= 1.8.2 |
49+
| PHPUNIT | >= 6.4.1 |
50+
| NODE-SASS | >= 4.5.3 |
51+
| GULP | >= 3.9.1 |
4352

4453
### **Available additional commands:**
4554

@@ -81,12 +90,12 @@ Finally you can run all your tests served by nginx | php-fpm via:
8190

8291
#### Note on using chromedriver versions:
8392

84-
Laravel Dusk ships with included chromedriver for linux, mac and windows. The examples here enable you to run dusk tests with this chromedriver.
93+
**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).
8594

86-
However if you encounter problems, especially errors with incorrect chromedriver version, you can use this package inbuilt own chromedriver. To do that you need to make 2 script modifications:
95+
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:
8796

88-
1. In DuskTestCase.php comment out starting chromedriver like`// static::startChromeDriver();`
89-
2. In .gitlab-ci.yml add `- chromedriver &` before running `- php artisan dusk`
97+
1. In DuskTestCase.php comment out starting chromedriver like`// static::startChromeDriver();`. In that case, to make your local development working , you need to install proper chromedriver version manually, and make sure your chromedriver version matches Chrome running on your local machine, before issuing `php artisan dusk` command. And what's more important you need to make sure chromedriver is started/running. 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 for 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 little behind...
98+
2. 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.
9099

91100
------
92101

@@ -120,15 +129,16 @@ However if you encounter problems, especially errors with incorrect chromedriver
120129

121130
### **Caveats:**
122131

123-
- This docker has been tested with **gitlab-multi-runner** 9.5.0 and **gitlab-runner** 10.0.1.
124-
- in my scenario using `yarn run dev` instead of `npm run dev` was **really faster**, but this might not work out of the box and you may need to adapt your project.
125132
- This is automated docker build, although you don't see it in docker hub. You can always find more information regarding this repo on [docker hub](https://hub.docker.com/r/chilio/laravel-dusk-ci/), [docker cloud](https://cloud.docker.com/swarm/chilio/repository/registry-1.docker.io/chilio/laravel-dusk-ci/general), [docker store](https://store.docker.com/community/images/chilio/laravel-dusk-ci), or on [github](https://github.com/chilio/laravel-dusk-ci)
126133

127134

128135

129136

130137
### **Troubleshooting:**
131-
- In your dusk tests remember to use -**>waitFor()** extensively, to make sure pages are rendered properly, before test fails. CI test environments are much slower than production or your local dev, cause they need to build caches from scratch.
138+
- In your dusk tests remember to use -**>waitFor()** extensively, to make sure 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.
132139
- 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 example `SCREEN_RESOLUTION: 1280x720x24`
133140
- if you experience **/bootstrap/autoload.php** errors, make sure your appropriate **phpunit configs** are updated, especially in line `bootstrap="vendor/autoload.php"`
134-
- if you get errors about wrong chromedriver version check **Note on using chromedriver versions**
141+
- if you get errors, about wrong chromedriver version on your local machine, check **Note on using chromedriver versions**
142+
143+
144+

0 commit comments

Comments
 (0)