|
|
@@ -1,21 +1,14 @@
|
|
|
---
|
|
|
-title: Guides
|
|
|
+title: 4. Guides
|
|
|
type: index
|
|
|
weight: 4
|
|
|
---
|
|
|
|
|
|
|
|
|
-
|
|
|
-* [Production Setup on Digital Ocean](#Digital-Ocean)
|
|
|
-* [PHPStorm XDebug Setup](#PHPStorm-Debugging)
|
|
|
-* [Running Laravel Dusk Test](#Laravel-Dusk)
|
|
|
-
|
|
|
-
|
|
|
-
|
|
|
<a name="Digital-Ocean"></a>
|
|
|
-# Production Setup on Digital Ocean
|
|
|
+## Production Setup on Digital Ocean
|
|
|
|
|
|
-## Install Docker
|
|
|
+### Install Docker
|
|
|
|
|
|
- Visit [DigitalOcean](https://cloud.digitalocean.com/login) and login.
|
|
|
- Click the `Create Droplet` button.
|
|
|
@@ -24,7 +17,7 @@ weight: 4
|
|
|
- Continue creating the droplet as you normally would.
|
|
|
- If needed, check your e-mail for the droplet root password.
|
|
|
|
|
|
-## SSH to your Server
|
|
|
+### SSH to your Server
|
|
|
|
|
|
Find the IP address of the droplet in the DigitalOcean interface. Use it to connect to the server.
|
|
|
|
|
|
@@ -40,7 +33,7 @@ You can now check if Docker is available:
|
|
|
$root@server:~# docker
|
|
|
```
|
|
|
|
|
|
-## Set Up Your Laravel Project
|
|
|
+### Set Up Your Laravel Project
|
|
|
|
|
|
```
|
|
|
$root@server:~# apt-get install git
|
|
|
@@ -50,12 +43,12 @@ $root@server:~/laravel/ git submodule add https://github.com/Laradock/laradock.g
|
|
|
$root@server:~/laravel/ cd laradock
|
|
|
```
|
|
|
|
|
|
-## Enter the laradock folder and rename env-example to .env.
|
|
|
+### Enter the laradock folder and rename env-example to .env.
|
|
|
```
|
|
|
$root@server:~/laravel/laradock# cp env-example .env
|
|
|
```
|
|
|
|
|
|
-## Create Your Laradock Containers
|
|
|
+### Create Your Laradock Containers
|
|
|
|
|
|
```
|
|
|
$root@server:~/laravel/laradock# docker-compose up -d nginx mysql
|
|
|
@@ -63,13 +56,13 @@ $root@server:~/laravel/laradock# docker-compose up -d nginx mysql
|
|
|
|
|
|
Note that more containers are available, find them in the [docs](http://laradock.io/introduction/#supported-software-containers) or the `docker-compose.yml` file.
|
|
|
|
|
|
-## Go to Your Workspace
|
|
|
+### Go to Your Workspace
|
|
|
|
|
|
```
|
|
|
docker-compose exec workspace bash
|
|
|
```
|
|
|
|
|
|
-## Execute commands
|
|
|
+### Execute commands
|
|
|
|
|
|
If you want to only execute some command and don't want to enter bash, you can execute `docker-compose run workspace <command>`.
|
|
|
|
|
|
@@ -77,7 +70,17 @@ If you want to only execute some command and don't want to enter bash, you can e
|
|
|
docker-compose run workspace php artisan migrate
|
|
|
```
|
|
|
|
|
|
-## Install and configure Laravel
|
|
|
+### Prepare for Visual Studio Code remote development
|
|
|
+
|
|
|
+If you want to use Visual Studio Code for [remote development](https://code.visualstudio.com/docs/remote/containers) directly on your `workspace` container, copy file `devcontainer.example.json` to `devcontainer.json` and customize it (see [devcontainer.json reference](https://code.visualstudio.com/docs/remote/containers#_devcontainerjson-reference) for more options):
|
|
|
+```
|
|
|
+cd .devcontainer
|
|
|
+cp devcontainer.example.json devcontainer.json
|
|
|
+```
|
|
|
+
|
|
|
+Then open your `laradock` folder in Visual Studio Code and click on popup button **Reopen in Container**.
|
|
|
+
|
|
|
+### Install and configure Laravel
|
|
|
|
|
|
Let's install Laravel's dependencies, add the `.env` file, generate the key and give proper permissions to the cache folder.
|
|
|
|
|
|
@@ -100,7 +103,7 @@ It should show you the Laravel default welcome page.
|
|
|
|
|
|
However, we want it to show up using your custom domain name, as well.
|
|
|
|
|
|
-## Using Your Own Domain Name
|
|
|
+### Using Your Own Domain Name
|
|
|
|
|
|
Login to your DNS provider, such as Godaddy, Namecheap.
|
|
|
|
|
|
@@ -118,7 +121,7 @@ Visit: https://cloud.digitalocean.com/networking/domains
|
|
|
|
|
|
Add your domain name and choose the server IP you'd provision earlier.
|
|
|
|
|
|
-## Serving Site With NGINX (HTTP ONLY)
|
|
|
+### Serving Site With NGINX (HTTP ONLY)
|
|
|
|
|
|
Go back to command line.
|
|
|
|
|
|
@@ -142,14 +145,14 @@ And add `server_name` (your custom domain)
|
|
|
server_name yourdomain.com;
|
|
|
```
|
|
|
|
|
|
-## Rebuild Your Nginx
|
|
|
+### Rebuild Your Nginx
|
|
|
|
|
|
```
|
|
|
$root@server:~/laravel/laradock# docker-compose down
|
|
|
$root@server:~/laravel/laradock# docker-compose build nginx
|
|
|
```
|
|
|
|
|
|
-## Re Run Your Containers MYSQL and NGINX
|
|
|
+### Re Run Your Containers MYSQL and NGINX
|
|
|
|
|
|
```
|
|
|
$root@server:~/laravel/laradock/nginx# docker-compose up -d nginx mysql
|
|
|
@@ -157,7 +160,7 @@ $root@server:~/laravel/laradock/nginx# docker-compose up -d nginx mysql
|
|
|
|
|
|
**View Your Site with HTTP ONLY (http://yourdomain.com)**
|
|
|
|
|
|
-## Run Site on SSL with Let's Encrypt Certificate
|
|
|
+### Run Site on SSL with Let's Encrypt Certificate
|
|
|
|
|
|
**Note: You need to Use Caddy here Instead of Nginx**
|
|
|
|
|
|
@@ -196,7 +199,7 @@ tls serverbreaker@gmai.com
|
|
|
|
|
|
This is needed Prior to Creating Let's Encypt
|
|
|
|
|
|
-## Run Your Caddy Container without the -d flag and Generate SSL with Let's Encrypt
|
|
|
+### Run Your Caddy Container without the -d flag and Generate SSL with Let's Encrypt
|
|
|
|
|
|
```
|
|
|
$root@server:~/laravel/laradock# docker-compose up caddy
|
|
|
@@ -217,7 +220,7 @@ caddy_1 | http://yourdomain.com
|
|
|
|
|
|
After it finishes, press `Ctrl` + `C` to exit.
|
|
|
|
|
|
-## Stop All Containers and ReRun Caddy and Other Containers on Background
|
|
|
+### Stop All Containers and ReRun Caddy and Other Containers on Background
|
|
|
|
|
|
```
|
|
|
$root@server:~/laravel/laradock# docker-compose down
|
|
|
@@ -238,325 +241,319 @@ View your Site in the Browser Securely Using HTTPS (https://yourdomain.com)
|
|
|
- [https://caddyserver.com/docs/tls](https://caddyserver.com/docs/tls)
|
|
|
- [https://caddyserver.com/docs/caddyfile](https://caddyserver.com/docs/caddyfile)
|
|
|
|
|
|
-
|
|
|
-
|
|
|
-
|
|
|
-
|
|
|
<br>
|
|
|
<br>
|
|
|
<br>
|
|
|
<br>
|
|
|
<br>
|
|
|
|
|
|
-<a name="PHPStorm-Debugging"></a>
|
|
|
-# PHPStorm XDebug Setup
|
|
|
-
|
|
|
-- [Intro](#Intro)
|
|
|
-- [Installation](#Installation)
|
|
|
- - [Customize laradock/docker-compose.yml](#CustomizeDockerCompose)
|
|
|
- - [Clean House](#InstallCleanHouse)
|
|
|
- - [Laradock Dial Tone](#InstallLaradockDialTone)
|
|
|
- - [hosts](#AddToHosts)
|
|
|
- - [Firewall](#FireWall)
|
|
|
- - [Enable xDebug on php-fpm](#enablePhpXdebug)
|
|
|
- - [PHPStorm Settings](#InstallPHPStorm)
|
|
|
- - [Configs](#InstallPHPStormConfigs)
|
|
|
-- [Usage](#Usage)
|
|
|
- - [Laravel](#UsageLaravel)
|
|
|
- - [Run ExampleTest](#UsagePHPStormRunExampleTest)
|
|
|
- - [Debug ExampleTest](#UsagePHPStormDebugExampleTest)
|
|
|
- - [Debug Web Site](#UsagePHPStormDebugSite)
|
|
|
-- [SSH into workspace](#SSHintoWorkspace)
|
|
|
- - [KiTTY](#InstallKiTTY)
|
|
|
-
|
|
|
-<a name="Intro"></a>
|
|
|
-## Intro
|
|
|
-
|
|
|
-Wiring up [Laravel](https://laravel.com/), [Laradock](https://github.com/Laradock/laradock) [Laravel+Docker] and [PHPStorm](https://www.jetbrains.com/phpstorm/) to play nice together complete with remote xdebug'ing as icing on top! Although this guide is based on `PHPStorm Windows`,
|
|
|
-you should be able to adjust accordingly. This guide was written based on Docker for Windows Native.
|
|
|
-
|
|
|
-<a name="Installation"></a>
|
|
|
-## Installation
|
|
|
+<a name="Laravel-Dusk"></a>
|
|
|
+## Running Laravel Dusk Tests
|
|
|
|
|
|
-- This guide assumes the following:
|
|
|
- - you have already installed and are familiar with Laravel, Laradock and PHPStorm.
|
|
|
- - you have installed Laravel as a parent of `laradock`. This guide assumes `/c/_dk/laravel`.
|
|
|
+### Option 1: Without Selenium
|
|
|
|
|
|
-<a name="AddToHosts"></a>
|
|
|
-## hosts
|
|
|
-- Add `laravel` to your hosts file located on Windows 10 at `C:\Windows\System32\drivers\etc\hosts`. It should be set to the IP of your running container. Mine is: `10.0.75.2`
|
|
|
-On Windows you can find it by opening Windows `Hyper-V Manager`.
|
|
|
- - 
|
|
|
+- [Intro](#option1-dusk-intro)
|
|
|
+- [Workspace Setup](#option1-workspace-setup)
|
|
|
+- [Application Setup](#option1-application-setup)
|
|
|
+- [Choose Chrome Driver Version (Optional)](#option1-choose-chrome-driver-version)
|
|
|
+- [Run Dusk Tests](#option1-run-dusk-tests)
|
|
|
|
|
|
-- [Hosts File Editor](https://github.com/scottlerch/HostsFileEditor) makes it easy to change your hosts file.
|
|
|
- - Set `laravel` to your docker host IP. See [Example](images/photos/SimpleHostsEditor/AddHost_laravel.png).
|
|
|
+#### Intro
|
|
|
|
|
|
+This is a guide to run Dusk tests in your `workspace` container with headless
|
|
|
+google-chrome and chromedriver. It has been tested with Laravel 5.4 and 5.5.
|
|
|
|
|
|
-<a name="FireWall"></a>
|
|
|
-## Firewall
|
|
|
-Your PHPStorm will need to be able to receive a connection from PHP xdebug either your running workspace or php-fpm containers on port 9000. This means that your Windows Firewall should either enable connections from the Application PHPStorm OR the port.
|
|
|
+#### Workspace Setup
|
|
|
|
|
|
-- It is important to note that if the Application PHPStorm is NOT enabled in the firewall, you will not be able to recreate a rule to override that.
|
|
|
-- Also be aware that if you are installing/upgrade different versions of PHPStorm, you MAY have orphaned references to PHPStorm in your Firewall! You may decide to remove orphaned references however in either case, make sure that they are set to receive public TCP traffic.
|
|
|
+Update your .env with following entries:
|
|
|
|
|
|
-### Edit laradock/docker-compose.yml
|
|
|
-Set the following variables:
|
|
|
```
|
|
|
-### Workspace Utilities Container ###############
|
|
|
+...
|
|
|
+# Install Laravel installer bin to setup demo app
|
|
|
+WORKSPACE_INSTALL_LARAVEL_INSTALLER=true
|
|
|
+...
|
|
|
+# Install all the necessary dependencies for running Dusk tests
|
|
|
+WORKSPACE_INSTALL_DUSK_DEPS=true
|
|
|
+...
|
|
|
+```
|
|
|
|
|
|
- workspace:
|
|
|
- build:
|
|
|
- context: ./workspace
|
|
|
- args:
|
|
|
- - INSTALL_XDEBUG=true
|
|
|
- - INSTALL_WORKSPACE_SSH=true
|
|
|
- ...
|
|
|
+Then run below to build your workspace.
|
|
|
|
|
|
+```
|
|
|
+docker-compose build workspace
|
|
|
+```
|
|
|
|
|
|
-### PHP-FPM Container #####################
|
|
|
+#### Application Setup
|
|
|
|
|
|
- php-fpm:
|
|
|
- build:
|
|
|
- context: ./php-fpm
|
|
|
- args:
|
|
|
- - INSTALL_XDEBUG=true
|
|
|
- ...
|
|
|
+Run a `workspace` container and you will be inside the container at `/var/www` directory.
|
|
|
|
|
|
```
|
|
|
+docker-compose run workspace bash
|
|
|
|
|
|
-### Edit xdebug.ini files
|
|
|
-- `laradock/workspace/xdebug.ini`
|
|
|
-- `laradock/php-fpm/xdebug.ini`
|
|
|
+/var/www#> _
|
|
|
+```
|
|
|
|
|
|
-Set the following variables:
|
|
|
+Create new Laravel application named `dusk-test` and install Laravel Dusk package.
|
|
|
|
|
|
```
|
|
|
-xdebug.remote_autostart=1
|
|
|
-xdebug.remote_enable=1
|
|
|
-xdebug.remote_connect_back=1
|
|
|
-xdebug.cli_color=1
|
|
|
+/var/www> laravel new dusk-test
|
|
|
+/var/www> cd dusk-test
|
|
|
+/var/www/dusk-test> composer require --dev laravel/dusk
|
|
|
+/var/www/dusk-test> php artisan dusk:install
|
|
|
```
|
|
|
|
|
|
+Create `.env.dusk.local` by copying from `.env` file.
|
|
|
|
|
|
-<a name="InstallCleanHouse"></a>
|
|
|
-### Need to clean house first?
|
|
|
+```
|
|
|
+/var/www/dusk-test> cp .env .env.dusk.local
|
|
|
+```
|
|
|
|
|
|
-Make sure you are starting with a clean state. For example, do you have other Laradock containers and images?
|
|
|
-Here are a few things I use to clean things up.
|
|
|
+Update the `APP_URL` entry in `.env.dusk.local` to local Laravel server.
|
|
|
|
|
|
-- Delete all containers using `grep laradock_` on the names, see: [Remove all containers based on docker image name](https://linuxconfig.org/remove-all-containners-based-on-docker-image-name).
|
|
|
+```
|
|
|
+APP_URL=http://localhost:8000
|
|
|
+```
|
|
|
|
|
|
-`docker ps -a | awk '{ print $1,$2 }' | grep laradock_ | awk '{print $1}' | xargs -I {} docker rm {}`
|
|
|
+You will need to run chromedriver with `headless` and `no-sandbox` flag. In Laravel Dusk 2.x it is
|
|
|
+already set `headless` so you just need to add `no-sandbox` flag. If you on previous version 1.x,
|
|
|
+you will need to update your `DustTestCase#driver` as shown below.
|
|
|
|
|
|
-- Delete all images containing `laradock`.
|
|
|
|
|
|
-`docker images | awk '{print $1,$2,$3}' | grep laradock_ | awk '{print $3}' | xargs -I {} docker rmi {}`
|
|
|
-**Note:** This will only delete images that were built with `Laradock`, **NOT** `laradock/*` which are pulled down by `Laradock` such as `laradock/workspace`, etc.
|
|
|
-**Note:** Some may fail with:
|
|
|
-`Error response from daemon: conflict: unable to delete 3f38eaed93df (cannot be forced) - image has dependent child images`
|
|
|
+```
|
|
|
+<?php
|
|
|
|
|
|
-- I added this to my `.bashrc` to remove orphaned images.
|
|
|
+...
|
|
|
|
|
|
-```
|
|
|
-dclean() {
|
|
|
- processes=`docker ps -q -f status=exited`
|
|
|
- if [ -n "$processes" ]; then
|
|
|
- docker rm $processes
|
|
|
- fi
|
|
|
+abstract class DuskTestCase extends BaseTestCase
|
|
|
+{
|
|
|
+ ...
|
|
|
|
|
|
- images=`docker images -q -f dangling=true`
|
|
|
- if [ -n "$images" ]; then
|
|
|
- docker rmi $images
|
|
|
- fi
|
|
|
+ /**
|
|
|
+ * Update chrome driver with below flags
|
|
|
+ */
|
|
|
+ protected function driver()
|
|
|
+ {
|
|
|
+ $options = (new ChromeOptions)->addArguments([
|
|
|
+ '--disable-gpu',
|
|
|
+ '--headless',
|
|
|
+ '--no-sandbox'
|
|
|
+ ]);
|
|
|
+
|
|
|
+ return RemoteWebDriver::create(
|
|
|
+ 'http://localhost:9515', DesiredCapabilities::chrome()->setCapability(
|
|
|
+ ChromeOptions::CAPABILITY, $options
|
|
|
+ )
|
|
|
+ );
|
|
|
+ }
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-- If you frequently switch configurations for Laradock, you may find that adding the following and added to your `.bashrc` or equivalent useful:
|
|
|
+#### Choose Chrome Driver Version (Optional)
|
|
|
|
|
|
-```
|
|
|
-# remove laravel* containers
|
|
|
-# remove laravel_* images
|
|
|
-dcleanlaradockfunction()
|
|
|
-{
|
|
|
- echo 'Removing ALL containers associated with laradock'
|
|
|
- docker ps -a | awk '{ print $1,$2 }' | grep laradock | awk '{print $1}' | xargs -I {} docker rm {}
|
|
|
+You could choose to use either:
|
|
|
|
|
|
- # remove ALL images associated with laradock_
|
|
|
- # does NOT delete laradock/* which are hub images
|
|
|
- echo 'Removing ALL images associated with laradock_'
|
|
|
- docker images | awk '{print $1,$2,$3}' | grep laradock_ | awk '{print $3}' | xargs -I {} docker rmi {}
|
|
|
+1. Chrome Driver shipped with Laravel Dusk. (Default)
|
|
|
+2. Chrome Driver installed in `workspace` container. (Required tweak on DuskTestCase class)
|
|
|
|
|
|
- echo 'Listing all laradock docker hub images...'
|
|
|
- docker images | grep laradock
|
|
|
+For Laravel Dusk 2.x, you need to update `DuskTestCase#prepare` method if you wish to go with option #2.
|
|
|
|
|
|
- echo 'dcleanlaradock completed'
|
|
|
-}
|
|
|
-# associate the above function with an alias
|
|
|
-# so can recall/lookup by typing 'alias'
|
|
|
-alias dcleanlaradock=dcleanlaradockfunction
|
|
|
```
|
|
|
|
|
|
-<a name="InstallLaradockDialTone"></a>
|
|
|
-## Let's get a dial-tone with Laravel
|
|
|
+<?php
|
|
|
+
|
|
|
+...
|
|
|
+abstract class DuskTestCase extends BaseTestCase
|
|
|
+{
|
|
|
+ ...
|
|
|
+ public static function prepare()
|
|
|
+ {
|
|
|
+ // Only add this line if you wish to use chrome driver installed in workspace container.
|
|
|
+ // You might want to read the file path from env file.
|
|
|
+ static::useChromedriver('/usr/local/bin/chromedriver');
|
|
|
|
|
|
+ static::startChromeDriver();
|
|
|
+ }
|
|
|
```
|
|
|
-# barebones at this point
|
|
|
-docker-compose up -d nginx mysql
|
|
|
|
|
|
-# run
|
|
|
-docker-compose ps
|
|
|
+For Laravel Dusk 1.x, you need to add `DuskTestCase#buildChromeProcess` method if you wish to go with option #2.
|
|
|
|
|
|
-# Should see:
|
|
|
- Name Command State Ports
|
|
|
------------------------------------------------------------------------------------------------------------
|
|
|
-laradock_mysql_1 docker-entrypoint.sh mysqld Up 0.0.0.0:3306->3306/tcp
|
|
|
-laradock_nginx_1 nginx Up 0.0.0.0:443->443/tcp, 0.0.0.0:80->80/tcp
|
|
|
-laradock_php-fpm_1 php-fpm Up 9000/tcp
|
|
|
-laradock_volumes_data_1 true Exit 0
|
|
|
-laradock_volumes_source_1 true Exit 0
|
|
|
-laradock_workspace_1 /sbin/my_init Up 0.0.0.0:2222->22/tcp
|
|
|
```
|
|
|
+<?php
|
|
|
|
|
|
-<a name="enablePhpXdebug"></a>
|
|
|
-## Enable xDebug on php-fpm
|
|
|
+...
|
|
|
+use Symfony\Component\Process\ProcessBuilder;
|
|
|
|
|
|
-In a host terminal sitting in the laradock folder, run: `./php-fpm/xdebug status`
|
|
|
-You should see something like the following:
|
|
|
+abstract class DuskTestCase extends BaseTestCase
|
|
|
+{
|
|
|
+ ...
|
|
|
|
|
|
-```
|
|
|
-xDebug status
|
|
|
-laradock_php-fpm_1
|
|
|
-PHP 7.0.9 (cli) (built: Aug 10 2016 19:45:48) ( NTS )
|
|
|
-Copyright (c) 1997-2016 The PHP Group
|
|
|
-Zend Engine v3.0.0, Copyright (c) 1998-2016 Zend Technologies
|
|
|
- with Xdebug v2.4.1, Copyright (c) 2002-2016, by Derick Rethans
|
|
|
-```
|
|
|
+ /**
|
|
|
+ * Only add this method if you wish to use chrome driver installed in workspace container
|
|
|
+ */
|
|
|
+ protected static function buildChromeProcess()
|
|
|
+ {
|
|
|
+ return (new ProcessBuilder())
|
|
|
+ ->setPrefix('chromedriver')
|
|
|
+ ->getProcess()
|
|
|
+ ->setEnv(static::chromeEnvironment());
|
|
|
+ }
|
|
|
|
|
|
-Other commands include `./php-fpm/xdebug start | stop`.
|
|
|
+ ...
|
|
|
+}
|
|
|
+```
|
|
|
|
|
|
-If you have enabled `xdebug=true` in `docker-compose.yml/php-fpm`, `xdebug` will already be running when
|
|
|
-`php-fpm` is started and listening for debug info on port 9000.
|
|
|
+#### Run Dusk Tests
|
|
|
|
|
|
+Run local server in `workspace` container and run Dusk tests.
|
|
|
|
|
|
-<a name="InstallPHPStormConfigs"></a>
|
|
|
-## PHPStorm Settings
|
|
|
+```
|
|
|
+# alias to run Laravel server in the background (php artisan serve --quiet &)
|
|
|
+/var/www/dusk-test> serve
|
|
|
+# alias to run Dusk tests (php artisan dusk)
|
|
|
+/var/www/dusk-test> dusk
|
|
|
|
|
|
-- Here are some settings that are known to work:
|
|
|
- - `Settings/BuildDeploymentConnection`
|
|
|
- - 
|
|
|
+PHPUnit 6.4.0 by Sebastian Bergmann and contributors.
|
|
|
|
|
|
- - `Settings/BuildDeploymentConnectionMappings`
|
|
|
- - 
|
|
|
+. 1 / 1 (100%)
|
|
|
|
|
|
- - `Settings/BuildDeploymentDebugger`
|
|
|
- - 
|
|
|
+Time: 837 ms, Memory: 6.00MB
|
|
|
+```
|
|
|
|
|
|
- - `Settings/EditRunConfigurationRemoteWebDebug`
|
|
|
- - 
|
|
|
+### Option 2: With Selenium
|
|
|
|
|
|
- - `Settings/EditRunConfigurationRemoteExampleTestDebug`
|
|
|
- - 
|
|
|
+- [Intro](#dusk-intro)
|
|
|
+- [DNS Setup](#dns-setup)
|
|
|
+- [Docker Compose Setup](#docker-compose)
|
|
|
+- [Laravel Dusk Setup](#laravel-dusk-setup)
|
|
|
+- [Running Laravel Dusk Tests](#running-tests)
|
|
|
|
|
|
- - `Settings/LangsPHPDebug`
|
|
|
- - 
|
|
|
+#### Intro
|
|
|
+Setting up Laravel Dusk tests to run with Laradock appears be something that
|
|
|
+eludes most Laradock users. This guide is designed to show you how to wire them
|
|
|
+up to work together. This guide is written with macOS and Linux in mind. As such,
|
|
|
+it's only been tested on macOS. Feel free to create pull requests to update the guide
|
|
|
+for Windows-specific instructions.
|
|
|
|
|
|
- - `Settings/LangsPHPInterpreters`
|
|
|
- - 
|
|
|
+This guide assumes you know how to use a DNS forwarder such as `dnsmasq` or are comfortable
|
|
|
+with editing the `/etc/hosts` file for one-off DNS changes.
|
|
|
|
|
|
- - `Settings/LangsPHPPHPUnit`
|
|
|
- - 
|
|
|
+#### DNS Setup
|
|
|
+According to RFC-2606, only four TLDs are reserved for local testing[^1]:
|
|
|
|
|
|
- - `Settings/LangsPHPServers`
|
|
|
- - 
|
|
|
+- `.test`
|
|
|
+- `.example`
|
|
|
+- `.invalid`
|
|
|
+- `.localhost`
|
|
|
|
|
|
- - `RemoteHost`
|
|
|
- To switch on this view, go to: `Menu/Tools/Deployment/Browse Remote Host`.
|
|
|
- - 
|
|
|
+A common TLD used for local development is `.dev`, but newer versions of Google
|
|
|
+Chrome (such as the one bundled with the Selenium Docker image), will fail to
|
|
|
+resolve that DNS as there will appear to be a name collision.
|
|
|
|
|
|
- - `RemoteWebDebug`
|
|
|
- - 
|
|
|
+The recommended extension is `.test` for your Laravel web apps because you're
|
|
|
+running tests. Using a DNS forwarder such as `dnsmasq` or by editing the `/etc/hosts`
|
|
|
+file, configure the host to point to `localhost`.
|
|
|
|
|
|
- - `EditRunConfigurationRemoteWebDebug`
|
|
|
- Go to: `Menu/Run/Edit Configurations`.
|
|
|
- - 
|
|
|
+For example, in your `/etc/hosts` file:
|
|
|
+```
|
|
|
+##
|
|
|
+# Host Database
|
|
|
+#
|
|
|
+# localhost is used to configure the loopback interface
|
|
|
+# when the system is booting. Do not change this entry.
|
|
|
+##
|
|
|
+127.0.0.1 localhost
|
|
|
+255.255.255.255 broadcasthost
|
|
|
+::1 localhost
|
|
|
+127.0.0.1 myapp.test
|
|
|
+```
|
|
|
|
|
|
- - `EditRunConfigurationRemoteExampleTestDebug`
|
|
|
- Go to: `Menu/Run/Edit Configurations`.
|
|
|
- - 
|
|
|
+This will ensure that when navigating to `myapp.test`, it will route the
|
|
|
+request to `127.0.0.1` which will be handled by Nginx in Laradock.
|
|
|
|
|
|
- - `WindowsFirewallAllowedApps`
|
|
|
- Go to: `Control Panel\All Control Panel Items\Windows Firewall\Allowed apps`.
|
|
|
- - 
|
|
|
+#### Docker Compose setup
|
|
|
+In order to make the Selenium container talk to the Nginx container appropriately,
|
|
|
+the `docker-compose.yml` needs to be edited to accommodate this. Make the following
|
|
|
+changes:
|
|
|
|
|
|
- - `hosts`
|
|
|
- Edit: `C:\Windows\System32\drivers\etc\hosts`.
|
|
|
- - 
|
|
|
+```yaml
|
|
|
+...
|
|
|
+selenium:
|
|
|
+ ...
|
|
|
+ depends_on:
|
|
|
+ - nginx
|
|
|
+ links:
|
|
|
+ - nginx:<your_domain>
|
|
|
+```
|
|
|
|
|
|
- - [Enable xDebug on php-fpm](#enablePhpXdebug)
|
|
|
+This allows network communication between the Nginx and Selenium containers
|
|
|
+and it also ensures that when starting the Selenium container, the Nginx
|
|
|
+container starts up first unless it's already running. This allows
|
|
|
+the Selenium container to make requests to the Nginx container, which is
|
|
|
+necessary for running Dusk tests. These changes also link the `nginx` environment
|
|
|
+variable to the domain you wired up in your hosts file.
|
|
|
|
|
|
+#### Laravel Dusk Setup
|
|
|
|
|
|
+In order to make Laravel Dusk make the proper request to the Selenium container,
|
|
|
+you have to edit the `DuskTestCase.php` file that's provided on the initial
|
|
|
+installation of Laravel Dusk. The change you have to make deals with the URL the
|
|
|
+Remote Web Driver attempts to use to set up the Selenium session.
|
|
|
|
|
|
-<a name="Usage"></a>
|
|
|
-## Usage
|
|
|
+One recommendation for this is to add a separate config option in your `.env.dusk.local`
|
|
|
+so it's still possible to run your Dusk tests locally should you want to.
|
|
|
|
|
|
-<a name="UsagePHPStormRunExampleTest"></a>
|
|
|
-### Run ExampleTest
|
|
|
-- right-click on `tests/ExampleTest.php`
|
|
|
- - Select: `Run 'ExampleTest.php'` or `Ctrl+Shift+F10`.
|
|
|
- - Should pass!! You just ran a remote test via SSH!
|
|
|
+##### .env.dusk.local
|
|
|
+```
|
|
|
+...
|
|
|
+USE_SELENIUM=true
|
|
|
+```
|
|
|
|
|
|
-<a name="UsagePHPStormDebugExampleTest"></a>
|
|
|
-### Debug ExampleTest
|
|
|
-- Open to edit: `tests/ExampleTest.php`
|
|
|
-- Add a BreakPoint on line 16: `$this->visit('/')`
|
|
|
-- right-click on `tests/ExampleTest.php`
|
|
|
- - Select: `Debug 'ExampleTest.php'`.
|
|
|
- - Should have stopped at the BreakPoint!! You are now debugging locally against a remote Laravel project via SSH!
|
|
|
- - 
|
|
|
+##### DuskTestCase.php
|
|
|
+```php
|
|
|
+abstract class DuskTestCase extends BaseTestCase
|
|
|
+{
|
|
|
+...
|
|
|
+ protected function driver()
|
|
|
+ {
|
|
|
+ if (env('USE_SELENIUM', 'false') == 'true') {
|
|
|
+ return RemoteWebDriver::create(
|
|
|
+ 'http://selenium:4444/wd/hub', DesiredCapabilities::chrome()
|
|
|
+ );
|
|
|
+ } else {
|
|
|
+ return RemoteWebDriver::create(
|
|
|
+ 'http://localhost:9515', DesiredCapabilities::chrome()
|
|
|
+ );
|
|
|
+ }
|
|
|
+ }
|
|
|
+}
|
|
|
+```
|
|
|
|
|
|
+#### Running Laravel Dusk Tests
|
|
|
|
|
|
-<a name="UsagePHPStormDebugSite"></a>
|
|
|
-### Debug WebSite
|
|
|
-- In case xDebug is disabled, from the `laradock` folder run:
|
|
|
-`./php-fpm/xdebug start`.
|
|
|
- - To switch xdebug off, run:
|
|
|
-`./php-fpm/xdebug stop`
|
|
|
+Now that you have everything set up, to run your Dusk tests, you have to SSH
|
|
|
+into the workspace container as you normally would:
|
|
|
+```docker-compose exec --user=laradock workspace bash```
|
|
|
|
|
|
-- Start Remote Debugging
|
|
|
- - 
|
|
|
+Once inside, you can change directory to your application and run:
|
|
|
|
|
|
-- Open to edit: `bootstrap/app.php`
|
|
|
-- Add a BreakPoint on line 14: `$app = new Illuminate\Foundation\Application(`
|
|
|
-- Reload [Laravel Site](http://laravel/)
|
|
|
- - Should have stopped at the BreakPoint!! You are now debugging locally against a remote Laravel project via SSH!
|
|
|
- - 
|
|
|
+```php artisan dusk```
|
|
|
|
|
|
+One way to make this easier from your project is to create a helper script. Here's one such example:
|
|
|
+```bash
|
|
|
+#!/usr/bin/env sh
|
|
|
|
|
|
-<a name="SSHintoWorkspace"></a>
|
|
|
-## Let's shell into workspace
|
|
|
-Assuming that you are in laradock folder, type:
|
|
|
-`ssh -i workspace/insecure_id_rsa -p2222 root@laravel`
|
|
|
-**Cha Ching!!!!**
|
|
|
-- `workspace/insecure_id_rsa.ppk` may become corrupted. In which case:
|
|
|
- - fire up `puttygen`
|
|
|
- - import `workspace/insecure_id_rsa`
|
|
|
- - save private key to `workspace/insecure_id_rsa.ppk`
|
|
|
+LARADOCK_HOME="path/to/laradock"
|
|
|
|
|
|
-<a name="InstallKiTTY"></a>
|
|
|
+pushd ${LARADOCK_HOME}
|
|
|
|
|
|
-### KiTTY
|
|
|
-[Kitty](http://www.9bis.net/kitty/) KiTTY is a fork from version 0.67 of PuTTY.
|
|
|
+docker-compose exec --user=laradock workspace bash -c "cd my-project && php artisan dusk && exit"
|
|
|
+```
|
|
|
+
|
|
|
+This invokes the Dusk command from inside the workspace container but when the script completes
|
|
|
+execution, it returns your session to your project directory.
|
|
|
+
|
|
|
+[^1]: [Don't Use .dev for Development](https://iyware.com/dont-use-dev-for-development/)
|
|
|
|
|
|
-- Here are some settings that are working for me:
|
|
|
- - 
|
|
|
- - 
|
|
|
- - 
|
|
|
- - 
|
|
|
- - 
|
|
|
- - 
|
|
|
- - 
|
|
|
- - 
|
|
|
- - 
|
|
|
|
|
|
<br>
|
|
|
<br>
|
|
|
@@ -564,324 +561,318 @@ Assuming that you are in laradock folder, type:
|
|
|
<br>
|
|
|
<br>
|
|
|
|
|
|
-<a name="Laravel-Dusk"></a>
|
|
|
-# Running Laravel Dusk Tests
|
|
|
-
|
|
|
-- [Option 1: Without Selenium](#option1-dusk)
|
|
|
-- [Option 2: With Selenium](#option2-dusk)
|
|
|
-
|
|
|
-<a name="option1-dusk"></a>
|
|
|
-## Option 1: Without Selenium
|
|
|
+<a name="PHPStorm-Debugging"></a>
|
|
|
+## PHPStorm XDebug Setup
|
|
|
|
|
|
-- [Intro](#option1-dusk-intro)
|
|
|
-- [Workspace Setup](#option1-workspace-setup)
|
|
|
-- [Application Setup](#option1-application-setup)
|
|
|
-- [Choose Chrome Driver Version (Optional)](#option1-choose-chrome-driver-version)
|
|
|
-- [Run Dusk Tests](#option1-run-dusk-tests)
|
|
|
+- [Intro](#Intro)
|
|
|
+- [Installation](#Installation)
|
|
|
+ - [Customize laradock/docker-compose.yml](#CustomizeDockerCompose)
|
|
|
+ - [Clean House](#InstallCleanHouse)
|
|
|
+ - [Laradock Dial Tone](#InstallLaradockDialTone)
|
|
|
+ - [hosts](#AddToHosts)
|
|
|
+ - [Firewall](#FireWall)
|
|
|
+ - [Enable xDebug on php-fpm](#enablePhpXdebug)
|
|
|
+ - [PHPStorm Settings](#InstallPHPStorm)
|
|
|
+ - [Configs](#InstallPHPStormConfigs)
|
|
|
+- [Usage](#Usage)
|
|
|
+ - [Laravel](#UsageLaravel)
|
|
|
+ - [Run ExampleTest](#UsagePHPStormRunExampleTest)
|
|
|
+ - [Debug ExampleTest](#UsagePHPStormDebugExampleTest)
|
|
|
+ - [Debug Web Site](#UsagePHPStormDebugSite)
|
|
|
+- [SSH into workspace](#SSHintoWorkspace)
|
|
|
+ - [KiTTY](#InstallKiTTY)
|
|
|
|
|
|
-<a name="option1-dusk-intro"></a>
|
|
|
### Intro
|
|
|
|
|
|
-This is a guide to run Dusk tests in your `workspace` container with headless
|
|
|
-google-chrome and chromedriver. It has been tested with Laravel 5.4 and 5.5.
|
|
|
+Wiring up [Laravel](https://laravel.com/), [Laradock](https://github.com/Laradock/laradock) [Laravel+Docker] and [PHPStorm](https://www.jetbrains.com/phpstorm/) to play nice together complete with remote xdebug'ing as icing on top! Although this guide is based on `PHPStorm Windows`,
|
|
|
+you should be able to adjust accordingly. This guide was written based on Docker for Windows Native.
|
|
|
|
|
|
-<a name="option1-workspace-setup"></a>
|
|
|
-### Workspace Setup
|
|
|
+### Installation
|
|
|
|
|
|
-Update your .env with following entries:
|
|
|
+- This guide assumes the following:
|
|
|
+ - you have already installed and are familiar with Laravel, Laradock and PHPStorm.
|
|
|
+ - you have installed Laravel as a parent of `laradock`. This guide assumes `/c/_dk/laravel`.
|
|
|
|
|
|
-```
|
|
|
-...
|
|
|
-# Install Laravel installer bin to setup demo app
|
|
|
-WORKSPACE_INSTALL_LARAVEL_INSTALLER=true
|
|
|
-...
|
|
|
-# Install all the necessary dependencies for running Dusk tests
|
|
|
-WORKSPACE_INSTALL_DUSK_DEPS=true
|
|
|
-...
|
|
|
-```
|
|
|
+### hosts
|
|
|
+- Add `laravel` to your hosts file located on Windows 10 at `C:\Windows\System32\drivers\etc\hosts`. It should be set to the IP of your running container. Mine is: `10.0.75.2`
|
|
|
+On Windows you can find it by opening Windows `Hyper-V Manager`.
|
|
|
+ - 
|
|
|
|
|
|
-Then run below to build your workspace.
|
|
|
+- [Hosts File Editor](https://github.com/scottlerch/HostsFileEditor) makes it easy to change your hosts file.
|
|
|
+ - Set `laravel` to your docker host IP. See [Example](images/photos/SimpleHostsEditor/AddHost_laravel.png).
|
|
|
|
|
|
-```
|
|
|
-docker-compose build workspace
|
|
|
-```
|
|
|
|
|
|
-<a name="option1-application-setup"></a>
|
|
|
-### Application Setup
|
|
|
+### Firewall
|
|
|
+Your PHPStorm will need to be able to receive a connection from PHP xdebug either your running workspace or php-fpm containers on port 9000. This means that your Windows Firewall should either enable connections from the Application PHPStorm OR the port.
|
|
|
|
|
|
-Run a `workspace` container and you will be inside the container at `/var/www` directory.
|
|
|
+- It is important to note that if the Application PHPStorm is NOT enabled in the firewall, you will not be able to recreate a rule to override that.
|
|
|
+- Also be aware that if you are installing/upgrade different versions of PHPStorm, you MAY have orphaned references to PHPStorm in your Firewall! You may decide to remove orphaned references however in either case, make sure that they are set to receive public TCP traffic.
|
|
|
|
|
|
+#### Edit laradock/docker-compose.yml
|
|
|
+Set the following variables:
|
|
|
```
|
|
|
-docker-compose run workspace bash
|
|
|
+### Workspace Utilities Container ###############
|
|
|
|
|
|
-/var/www#> _
|
|
|
-```
|
|
|
+ workspace:
|
|
|
+ build:
|
|
|
+ context: ./workspace
|
|
|
+ args:
|
|
|
+ - INSTALL_XDEBUG=true
|
|
|
+ - INSTALL_WORKSPACE_SSH=true
|
|
|
+ ...
|
|
|
|
|
|
-Create new Laravel application named `dusk-test` and install Laravel Dusk package.
|
|
|
|
|
|
-```
|
|
|
-/var/www> laravel new dusk-test
|
|
|
-/var/www> cd dusk-test
|
|
|
-/var/www/dusk-test> composer require --dev laravel/dusk
|
|
|
-/var/www/dusk-test> php artisan dusk:install
|
|
|
-```
|
|
|
+### PHP-FPM Container #####################
|
|
|
|
|
|
-Create `.env.dusk.local` by copying from `.env` file.
|
|
|
+ php-fpm:
|
|
|
+ build:
|
|
|
+ context: ./php-fpm
|
|
|
+ args:
|
|
|
+ - INSTALL_XDEBUG=true
|
|
|
+ ...
|
|
|
|
|
|
-```
|
|
|
-/var/www/dusk-test> cp .env .env.dusk.local
|
|
|
```
|
|
|
|
|
|
-Update the `APP_URL` entry in `.env.dusk.local` to local Laravel server.
|
|
|
+#### Edit xdebug.ini files
|
|
|
+- `laradock/workspace/xdebug.ini`
|
|
|
+- `laradock/php-fpm/xdebug.ini`
|
|
|
+
|
|
|
+Set the following variables:
|
|
|
|
|
|
```
|
|
|
-APP_URL=http://localhost:8000
|
|
|
+xdebug.remote_autostart=1
|
|
|
+xdebug.remote_enable=1
|
|
|
+xdebug.remote_connect_back=1
|
|
|
+xdebug.cli_color=1
|
|
|
```
|
|
|
|
|
|
-You will need to run chromedriver with `headless` and `no-sandbox` flag. In Laravel Dusk 2.x it is
|
|
|
-already set `headless` so you just need to add `no-sandbox` flag. If you on previous version 1.x,
|
|
|
-you will need to update your `DustTestCase#driver` as shown below.
|
|
|
|
|
|
+#### Need to clean house first?
|
|
|
+
|
|
|
+Make sure you are starting with a clean state. For example, do you have other Laradock containers and images?
|
|
|
+Here are a few things I use to clean things up.
|
|
|
+
|
|
|
+- Delete all containers using `grep laradock_` on the names, see: [Remove all containers based on docker image name](https://linuxconfig.org/remove-all-containners-based-on-docker-image-name).
|
|
|
+
|
|
|
+`docker ps -a | awk '{ print $1,$2 }' | grep laradock_ | awk '{print $1}' | xargs -I {} docker rm {}`
|
|
|
+
|
|
|
+- Delete all images containing `laradock`.
|
|
|
+
|
|
|
+`docker images | awk '{print $1,$2,$3}' | grep laradock_ | awk '{print $3}' | xargs -I {} docker rmi {}`
|
|
|
+**Note:** This will only delete images that were built with `Laradock`, **NOT** `laradock/*` which are pulled down by `Laradock` such as `laradock/workspace`, etc.
|
|
|
+**Note:** Some may fail with:
|
|
|
+`Error response from daemon: conflict: unable to delete 3f38eaed93df (cannot be forced) - image has dependent child images`
|
|
|
+
|
|
|
+- I added this to my `.bashrc` to remove orphaned images.
|
|
|
|
|
|
```
|
|
|
-<?php
|
|
|
+dclean() {
|
|
|
+ processes=`docker ps -q -f status=exited`
|
|
|
+ if [ -n "$processes" ]; then
|
|
|
+ docker rm $processes
|
|
|
+ fi
|
|
|
|
|
|
-...
|
|
|
+ images=`docker images -q -f dangling=true`
|
|
|
+ if [ -n "$images" ]; then
|
|
|
+ docker rmi $images
|
|
|
+ fi
|
|
|
+}
|
|
|
+```
|
|
|
|
|
|
-abstract class DuskTestCase extends BaseTestCase
|
|
|
+- If you frequently switch configurations for Laradock, you may find that adding the following and added to your `.bashrc` or equivalent useful:
|
|
|
+
|
|
|
+```
|
|
|
+# remove laravel* containers
|
|
|
+# remove laravel_* images
|
|
|
+dcleanlaradockfunction()
|
|
|
{
|
|
|
- ...
|
|
|
+ echo 'Removing ALL containers associated with laradock'
|
|
|
+ docker ps -a | awk '{ print $1,$2 }' | grep laradock | awk '{print $1}' | xargs -I {} docker rm {}
|
|
|
|
|
|
- /**
|
|
|
- * Update chrome driver with below flags
|
|
|
- */
|
|
|
- protected function driver()
|
|
|
- {
|
|
|
- $options = (new ChromeOptions)->addArguments([
|
|
|
- '--disable-gpu',
|
|
|
- '--headless',
|
|
|
- '--no-sandbox'
|
|
|
- ]);
|
|
|
+ # remove ALL images associated with laradock_
|
|
|
+ # does NOT delete laradock/* which are hub images
|
|
|
+ echo 'Removing ALL images associated with laradock_'
|
|
|
+ docker images | awk '{print $1,$2,$3}' | grep laradock_ | awk '{print $3}' | xargs -I {} docker rmi {}
|
|
|
|
|
|
- return RemoteWebDriver::create(
|
|
|
- 'http://localhost:9515', DesiredCapabilities::chrome()->setCapability(
|
|
|
- ChromeOptions::CAPABILITY, $options
|
|
|
- )
|
|
|
- );
|
|
|
- }
|
|
|
+ echo 'Listing all laradock docker hub images...'
|
|
|
+ docker images | grep laradock
|
|
|
+
|
|
|
+ echo 'dcleanlaradock completed'
|
|
|
}
|
|
|
+# associate the above function with an alias
|
|
|
+# so can recall/lookup by typing 'alias'
|
|
|
+alias dcleanlaradock=dcleanlaradockfunction
|
|
|
```
|
|
|
|
|
|
-<a name="option1-choose-chrome-driver-version"></a>
|
|
|
-### Choose Chrome Driver Version (Optional)
|
|
|
|
|
|
-You could choose to use either:
|
|
|
+### Let's get a dial-tone with Laravel
|
|
|
|
|
|
-1. Chrome Driver shipped with Laravel Dusk. (Default)
|
|
|
-2. Chrome Driver installed in `workspace` container. (Required tweak on DuskTestCase class)
|
|
|
+```
|
|
|
+# barebones at this point
|
|
|
+docker-compose up -d nginx mysql
|
|
|
|
|
|
-For Laravel 2.x, you need to update `DuskTestCase#prepare` method if you wish to go with option #2.
|
|
|
+# run
|
|
|
+docker-compose ps
|
|
|
|
|
|
+# Should see:
|
|
|
+ Name Command State Ports
|
|
|
+-----------------------------------------------------------------------------------------------------------
|
|
|
+laradock_mysql_1 docker-entrypoint.sh mysqld Up 0.0.0.0:3306->3306/tcp
|
|
|
+laradock_nginx_1 nginx Up 0.0.0.0:443->443/tcp, 0.0.0.0:80->80/tcp
|
|
|
+laradock_php-fpm_1 php-fpm Up 9000/tcp
|
|
|
+laradock_volumes_data_1 true Exit 0
|
|
|
+laradock_volumes_source_1 true Exit 0
|
|
|
+laradock_workspace_1 /sbin/my_init Up 0.0.0.0:2222->22/tcp
|
|
|
```
|
|
|
|
|
|
-<?php
|
|
|
+### Enable xDebug on php-fpm
|
|
|
|
|
|
-...
|
|
|
-abstract class DuskTestCase extends BaseTestCase
|
|
|
-{
|
|
|
- ...
|
|
|
- public static function prepare()
|
|
|
- {
|
|
|
- // Only add this line if you wish to use chrome driver installed in workspace container.
|
|
|
- // You might want to read the file path from env file.
|
|
|
- static::useChromedriver('/usr/local/bin/chromedriver');
|
|
|
+In a host terminal sitting in the laradock folder, run: `./php-fpm/xdebug status`
|
|
|
+You should see something like the following:
|
|
|
|
|
|
- static::startChromeDriver();
|
|
|
- }
|
|
|
+```
|
|
|
+xDebug status
|
|
|
+laradock_php-fpm_1
|
|
|
+PHP 7.0.9 (cli) (built: Aug 10 2016 19:45:48) ( NTS )
|
|
|
+Copyright (c) 1997-2016 The PHP Group
|
|
|
+Zend Engine v3.0.0, Copyright (c) 1998-2016 Zend Technologies
|
|
|
+ with Xdebug v2.4.1, Copyright (c) 2002-2016, by Derick Rethans
|
|
|
```
|
|
|
|
|
|
-For Laravel 1.x, you need to add `DuskTestCase#buildChromeProcess` method if you wish to go with option #2.
|
|
|
+Other commands include `./php-fpm/xdebug start | stop`.
|
|
|
|
|
|
-```
|
|
|
-<?php
|
|
|
+If you have enabled `xdebug=true` in `docker-compose.yml/php-fpm`, `xdebug` will already be running when
|
|
|
+`php-fpm` is started and listening for debug info on port 9000.
|
|
|
|
|
|
-...
|
|
|
-use Symfony\Component\Process\ProcessBuilder;
|
|
|
|
|
|
-abstract class DuskTestCase extends BaseTestCase
|
|
|
-{
|
|
|
- ...
|
|
|
+### PHPStorm Settings
|
|
|
|
|
|
- /**
|
|
|
- * Only add this method if you wish to use chrome driver installed in workspace container
|
|
|
- */
|
|
|
- protected static function buildChromeProcess()
|
|
|
- {
|
|
|
- return (new ProcessBuilder())
|
|
|
- ->setPrefix('chromedriver')
|
|
|
- ->getProcess()
|
|
|
- ->setEnv(static::chromeEnvironment());
|
|
|
- }
|
|
|
+- Here are some settings that are known to work:
|
|
|
+ - `Settings/BuildDeploymentConnection`
|
|
|
+ - 
|
|
|
|
|
|
- ...
|
|
|
-}
|
|
|
-```
|
|
|
+ - `Settings/BuildDeploymentConnectionMappings`
|
|
|
+ - 
|
|
|
|
|
|
-<a name="option1-run-dusk-tests"></a>
|
|
|
-### Run Dusk Tests
|
|
|
+ - `Settings/BuildDeploymentDebugger`
|
|
|
+ - 
|
|
|
|
|
|
-Run local server in `workspace` container and run Dusk tests.
|
|
|
+ - `Settings/EditRunConfigurationRemoteWebDebug`
|
|
|
+ - 
|
|
|
|
|
|
-```
|
|
|
-# alias to run Laravel server in the background (php artisan serve --quiet &)
|
|
|
-/var/www/dusk-test> serve
|
|
|
-# alias to run Dusk tests (php artisan dusk)
|
|
|
-/var/www/dusk-test> dusk
|
|
|
+ - `Settings/EditRunConfigurationRemoteExampleTestDebug`
|
|
|
+ - 
|
|
|
|
|
|
-PHPUnit 6.4.0 by Sebastian Bergmann and contributors.
|
|
|
+ - `Settings/LangsPHPDebug`
|
|
|
+ - 
|
|
|
|
|
|
-. 1 / 1 (100%)
|
|
|
+ - `Settings/LangsPHPInterpreters`
|
|
|
+ - 
|
|
|
|
|
|
-Time: 837 ms, Memory: 6.00MB
|
|
|
-```
|
|
|
+ - `Settings/LangsPHPPHPUnit`
|
|
|
+ - 
|
|
|
|
|
|
-<a name="option2-dusk"></a>
|
|
|
-## Option 2: With Selenium
|
|
|
+ - `Settings/LangsPHPServers`
|
|
|
+ - 
|
|
|
|
|
|
-- [Intro](#dusk-intro)
|
|
|
-- [DNS Setup](#dns-setup)
|
|
|
-- [Docker Compose Setup](#docker-compose)
|
|
|
-- [Laravel Dusk Setup](#laravel-dusk-setup)
|
|
|
-- [Running Laravel Dusk Tests](#running-tests)
|
|
|
+ - `RemoteHost`
|
|
|
+ To switch on this view, go to: `Menu/Tools/Deployment/Browse Remote Host`.
|
|
|
+ - 
|
|
|
|
|
|
-<a name="dusk-intro"></a>
|
|
|
-### Intro
|
|
|
-Setting up Laravel Dusk tests to run with Laradock appears be something that
|
|
|
-eludes most Laradock users. This guide is designed to show you how to wire them
|
|
|
-up to work together. This guide is written with macOS and Linux in mind. As such,
|
|
|
-it's only been tested on macOS. Feel free to create pull requests to update the guide
|
|
|
-for Windows-specific instructions.
|
|
|
+ - `RemoteWebDebug`
|
|
|
+ - 
|
|
|
|
|
|
-This guide assumes you know how to use a DNS forwarder such as `dnsmasq` or are comfortable
|
|
|
-with editing the `/etc/hosts` file for one-off DNS changes.
|
|
|
+ - `EditRunConfigurationRemoteWebDebug`
|
|
|
+ Go to: `Menu/Run/Edit Configurations`.
|
|
|
+ - 
|
|
|
|
|
|
-<a name="dns-setup"></a>
|
|
|
-### DNS Setup
|
|
|
-According to RFC-2606, only four TLDs are reserved for local testing[^1]:
|
|
|
+ - `EditRunConfigurationRemoteExampleTestDebug`
|
|
|
+ Go to: `Menu/Run/Edit Configurations`.
|
|
|
+ - 
|
|
|
|
|
|
-- `.test`
|
|
|
-- `.example`
|
|
|
-- `.invalid`
|
|
|
-- `.localhost`
|
|
|
+ - `WindowsFirewallAllowedApps`
|
|
|
+ Go to: `Control Panel\All Control Panel Items\Windows Firewall\Allowed apps`.
|
|
|
+ - 
|
|
|
|
|
|
-A common TLD used for local development is `.dev`, but newer versions of Google
|
|
|
-Chrome (such as the one bundled with the Selenium Docker image), will fail to
|
|
|
-resolve that DNS as there will appear to be a name collision.
|
|
|
+ - `hosts`
|
|
|
+ Edit: `C:\Windows\System32\drivers\etc\hosts`.
|
|
|
+ - 
|
|
|
|
|
|
-The recommended extension is `.test` for your Laravel web apps because you're
|
|
|
-running tests. Using a DNS forwarder such as `dnsmasq` or by editing the `/etc/hosts`
|
|
|
-file, configure the host to point to `localhost`.
|
|
|
+ - [Enable xDebug on php-fpm](#enablePhpXdebug)
|
|
|
|
|
|
-For example, in your `/etc/hosts` file:
|
|
|
-```
|
|
|
-##
|
|
|
-# Host Database
|
|
|
-#
|
|
|
-# localhost is used to configure the loopback interface
|
|
|
-# when the system is booting. Do not change this entry.
|
|
|
-##
|
|
|
-127.0.0.1 localhost
|
|
|
-255.255.255.255 broadcasthost
|
|
|
-::1 localhost
|
|
|
-127.0.0.1 myapp.test
|
|
|
-```
|
|
|
|
|
|
-This will ensure that when navigating to `myapp.test`, it will route the
|
|
|
-request to `127.0.0.1` which will be handled by Nginx in Laradock.
|
|
|
|
|
|
-<a name="docker-compose"></a>
|
|
|
-### Docker Compose setup
|
|
|
-In order to make the Selenium container talk to the Nginx container appropriately,
|
|
|
-the `docker-compose.yml` needs to be edited to accommodate this. Make the following
|
|
|
-changes:
|
|
|
+### Usage
|
|
|
|
|
|
-```yaml
|
|
|
-...
|
|
|
-selenium:
|
|
|
- ...
|
|
|
- depends_on:
|
|
|
- - nginx
|
|
|
- links:
|
|
|
- - nginx:<your_domain>
|
|
|
-```
|
|
|
+#### Run ExampleTest
|
|
|
+- right-click on `tests/ExampleTest.php`
|
|
|
+ - Select: `Run 'ExampleTest.php'` or `Ctrl+Shift+F10`.
|
|
|
+ - Should pass!! You just ran a remote test via SSH!
|
|
|
|
|
|
-This allows network communication between the Nginx and Selenium containers
|
|
|
-and it also ensures that when starting the Selenium container, the Nginx
|
|
|
-container starts up first unless it's already running. This allows
|
|
|
-the Selenium container to make requests to the Nginx container, which is
|
|
|
-necessary for running Dusk tests. These changes also link the `nginx` environment
|
|
|
-variable to the domain you wired up in your hosts file.
|
|
|
+#### Debug ExampleTest
|
|
|
+- Open to edit: `tests/ExampleTest.php`
|
|
|
+- Add a BreakPoint on line 16: `$this->visit('/')`
|
|
|
+- right-click on `tests/ExampleTest.php`
|
|
|
+ - Select: `Debug 'ExampleTest.php'`.
|
|
|
+ - Should have stopped at the BreakPoint!! You are now debugging locally against a remote Laravel project via SSH!
|
|
|
+ - 
|
|
|
|
|
|
-<a name="laravel-dusk-setup"></a>
|
|
|
-### Laravel Dusk Setup
|
|
|
+#### Debug WebSite
|
|
|
+- In case xDebug is disabled, from the `laradock` folder run:
|
|
|
+`./php-fpm/xdebug start`.
|
|
|
+ - To switch xdebug off, run:
|
|
|
+`./php-fpm/xdebug stop`
|
|
|
|
|
|
-In order to make Laravel Dusk make the proper request to the Selenium container,
|
|
|
-you have to edit the `DuskTestCase.php` file that's provided on the initial
|
|
|
-installation of Laravel Dusk. The change you have to make deals with the URL the
|
|
|
-Remote Web Driver attempts to use to set up the Selenium session.
|
|
|
+- Start Remote Debugging
|
|
|
+ - 
|
|
|
|
|
|
-One recommendation for this is to add a separate config option in your `.env.dusk.local`
|
|
|
-so it's still possible to run your Dusk tests locally should you want to.
|
|
|
+- Open to edit: `bootstrap/app.php`
|
|
|
+- Add a BreakPoint on line 14: `$app = new Illuminate\Foundation\Application(`
|
|
|
+- Reload [Laravel Site](http://laravel/)
|
|
|
+ - Should have stopped at the BreakPoint!! You are now debugging locally against a remote Laravel project via SSH!
|
|
|
+ - 
|
|
|
|
|
|
-#### .env.dusk.local
|
|
|
-```
|
|
|
-...
|
|
|
-USE_SELENIUM=true
|
|
|
-```
|
|
|
|
|
|
-#### DuskTestCase.php
|
|
|
-```php
|
|
|
-abstract class DuskTestCase extends BaseTestCase
|
|
|
-{
|
|
|
-...
|
|
|
- protected function driver()
|
|
|
- {
|
|
|
- if (env('USE_SELENIUM', 'false') == 'true') {
|
|
|
- return RemoteWebDriver::create(
|
|
|
- 'http://selenium:4444/wd/hub', DesiredCapabilities::chrome()
|
|
|
- );
|
|
|
- } else {
|
|
|
- return RemoteWebDriver::create(
|
|
|
- 'http://localhost:9515', DesiredCapabilities::chrome()
|
|
|
- );
|
|
|
- }
|
|
|
- }
|
|
|
-}
|
|
|
-```
|
|
|
+### Let's shell into workspace
|
|
|
+Assuming that you are in laradock folder, type:
|
|
|
+`ssh -i workspace/insecure_id_rsa -p2222 root@laravel`
|
|
|
+**Cha Ching!!!!**
|
|
|
+- `workspace/insecure_id_rsa.ppk` may become corrupted. In which case:
|
|
|
+ - fire up `puttygen`
|
|
|
+ - import `workspace/insecure_id_rsa`
|
|
|
+ - save private key to `workspace/insecure_id_rsa.ppk`
|
|
|
|
|
|
-<a name="running-tests"></a>
|
|
|
-### Running Laravel Dusk Tests
|
|
|
+#### KiTTY
|
|
|
+[Kitty](http://www.9bis.net/kitty/) KiTTY is a fork from version 0.67 of PuTTY.
|
|
|
|
|
|
-Now that you have everything set up, to run your Dusk tests, you have to SSH
|
|
|
-into the workspace container as you normally would:
|
|
|
-```docker-compose exec --user=laradock workspace bash```
|
|
|
+- Here are some settings that are working for me:
|
|
|
+ - 
|
|
|
+ - 
|
|
|
+ - 
|
|
|
+ - 
|
|
|
+ - 
|
|
|
+ - 
|
|
|
+ - 
|
|
|
+ - 
|
|
|
+ - 
|
|
|
|
|
|
-Once inside, you can change directory to your application and run:
|
|
|
+<br>
|
|
|
+<br>
|
|
|
+<br>
|
|
|
+<br>
|
|
|
+<br>
|
|
|
|
|
|
-```php artisan dusk```
|
|
|
+<a name="Setup remote debugging (PhpStorm)"></a>
|
|
|
+## Setup remote debugging for PhpStorm on Linux
|
|
|
|
|
|
-One way to make this easier from your project is to create a helper script. Here's one such example:
|
|
|
-```bash
|
|
|
-#!/usr/bin/env sh
|
|
|
+ - Make sure you have followed the steps above in the [Install Xdebug section](#install-xdebug).
|
|
|
|
|
|
-LARADOCK_HOME="path/to/laradock"
|
|
|
+ - Make sure Xdebug accepts connections and listens on port 9000. (Should be default configuration).
|
|
|
|
|
|
-pushd ${LARADOCK_HOME}
|
|
|
+.
|
|
|
|
|
|
-docker-compose exec --user=laradock workspace bash -c "cd my-project && php artisan dusk && exit"
|
|
|
-```
|
|
|
+ - Create a server with name `laradock` (matches **PHP_IDE_CONFIG** key in environment file) and make sure to map project root path with server correctly.
|
|
|
|
|
|
-This invokes the Dusk command from inside the workspace container but when the script completes
|
|
|
-execution, it returns your session to your project directory.
|
|
|
+.
|
|
|
|
|
|
-[^1]: [Don't Use .dev for Development](https://iyware.com/dont-use-dev-for-development/)
|
|
|
+ - Start listening for debug connections, place a breakpoint and you are good to go !
|
Anton Sannikov
