Merge pull request #1176 from taufek/tj-chrome-driver-var

Move Chrome Driver Version to Env

DOCUMENTATION/content/guides/index.md

@@ -565,6 +565,187 @@ Assuming that you are in laradock folder, type:
 <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
+
+- [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)
+
+<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.
+
+<a name="option1-workspace-setup"></a>
+### Workspace Setup
+
+Update your .env with following entries:
+
+```
+...
+# 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
+...
+```
+
+Then run below to build your workspace.
+
+```
+docker-compose build workspace
+```
+
+<a name="option1-application-setup"></a>
+### Application Setup
+
+Run a `workspace` container and you will be inside the container at `/var/www` directory.
+
+```
+docker-compose run workspace bash
+
+/var/www#> _
+```
+
+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
+```
+
+Create `.env.dusk.local` by copying from `.env` file.
+
+```
+/var/www/dusk-test> cp .env .env.dusk.local
+```
+
+Update the `APP_URL` entry in `.env.dusk.local` to local Laravel server.
+
+```
+APP_URL=http://localhost:8000
+```
+
+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. 
+
+
+```
+<?php
+
+...
+
+abstract class DuskTestCase extends BaseTestCase
+{
+    ...
+
+    /**
+    * 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
+            )
+        );
+    }
+}
+```
+
+<a name="option1-choose-chrome-driver-version"></a>
+### Choose Chrome Driver Version (Optional)
+
+You could choose to use either:
+
+1. Chrome Driver shipped with Laravel Dusk. (Default)
+2. Chrome Driver installed in `workspace` container. (Required tweak on DuskTestCase class)
+
+For Laravel 2.x, you need to update `DuskTestCase#prepare` method if you wish to go with option #2.
+
+```
+
+<?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();
+    }
+```
+
+For Laravel 1.x, you need to add `DuskTestCase#buildChromeProcess` method if you wish to go with option #2.
+
+```
+<?php
+
+...
+use Symfony\Component\Process\ProcessBuilder;
+
+abstract class DuskTestCase extends BaseTestCase
+{
+    ...
+
+    /**
+    * 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());
+    }
+
+    ...
+}
+```
+
+<a name="option1-run-dusk-tests"></a>
+### Run Dusk Tests
+
+Run local server in `workspace` container and run Dusk tests.
+
+```
+# 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
+
+PHPUnit 6.4.0 by Sebastian Bergmann and contributors.
+
+.                                                                   1 / 1 (100%)
+
+Time: 837 ms, Memory: 6.00MB
+```
+
+<a name="option2-dusk"></a>
+## Option 2: With Selenium
+
 - [Intro](#dusk-intro)
 - [DNS Setup](#dns-setup)
 - [Docker Compose Setup](#docker-compose)
@@ -572,7 +753,7 @@ Assuming that you are in laradock folder, type:
 - [Running Laravel Dusk Tests](#running-tests)
 
 <a name="dusk-intro"></a>
-## Intro
+### 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,
@@ -583,7 +764,7 @@ This guide assumes you know how to use a DNS forwarder such as `dnsmasq` or are
 with editing the `/etc/hosts` file for one-off DNS changes.
 
 <a name="dns-setup"></a>
-## DNS Setup
+### DNS Setup
 According to RFC-2606, only four TLDs are reserved for local testing[^1]:
 
 - `.test`
@@ -617,7 +798,7 @@ 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
+### 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:
@@ -640,7 +821,7 @@ necessary for running Dusk tests. These changes also link the `nginx` environmen
 variable to the domain you wired up in your hosts file.
 
 <a name="laravel-dusk-setup"></a>
-## Laravel Dusk Setup
+### 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
@@ -650,13 +831,13 @@ Remote Web Driver attempts to use to set up the Selenium session.
 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.
 
-### .env.dusk.local
+#### .env.dusk.local
 ```
 ...
 USE_SELENIUM=true
 ```
 
-### DuskTestCase.php
+#### DuskTestCase.php
 ```php
 abstract class DuskTestCase extends BaseTestCase
 {
@@ -677,7 +858,7 @@ abstract class DuskTestCase extends BaseTestCase
 ```
 
 <a name="running-tests"></a>
-## Running Laravel Dusk Tests
+### Running Laravel Dusk Tests
 
 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.yml

@@ -18,6 +18,7 @@ services:
           - INSTALL_XDEBUG=${WORKSPACE_INSTALL_XDEBUG}
           - INSTALL_BLACKFIRE=${INSTALL_BLACKFIRE}
           - INSTALL_SOAP=${WORKSPACE_INSTALL_SOAP}
+          - INSTALL_LDAP=${WORKSPACE_INSTALL_LDAP}
           - INSTALL_MONGO=${WORKSPACE_INSTALL_MONGO}
           - INSTALL_PHPREDIS=${WORKSPACE_INSTALL_PHPREDIS}
           - INSTALL_MSSQL=${WORKSPACE_INSTALL_MSSQL}
@@ -39,8 +40,10 @@ services:
           - INSTALL_IMAGE_OPTIMIZERS=${WORKSPACE_INSTALL_IMAGE_OPTIMIZERS}
           - INSTALL_IMAGEMAGICK=${WORKSPACE_INSTALL_IMAGEMAGICK}
           - INSTALL_TERRAFORM=${WORKSPACE_INSTALL_TERRAFORM}
+          - INSTALL_DUSK_DEPS=${WORKSPACE_INSTALL_DUSK_DEPS}
           - PUID=${WORKSPACE_PUID}
           - PGID=${WORKSPACE_PGID}
+          - CHROME_DRIVER_VERSION=${WORKSPACE_CHROME_DRIVER_VERSION}
           - NODE_VERSION=${WORKSPACE_NODE_VERSION}
           - YARN_VERSION=${WORKSPACE_YARN_VERSION}
           - TZ=${WORKSPACE_TIMEZONE}

env-example

@@ -30,6 +30,7 @@ PHP_INTERPRETER=php-fpm
 ### WORKSPACE ##########################################################################################################
 
 WORKSPACE_INSTALL_XDEBUG=false
+WORKSPACE_INSTALL_LDAP=false
 WORKSPACE_INSTALL_SOAP=false
 WORKSPACE_INSTALL_MONGO=false
 WORKSPACE_INSTALL_PHPREDIS=false
@@ -52,8 +53,10 @@ WORKSPACE_INSTALL_PYTHON=false
 WORKSPACE_INSTALL_IMAGE_OPTIMIZERS=false
 WORKSPACE_INSTALL_IMAGEMAGICK=false
 WORKSPACE_INSTALL_TERRAFORM=false
+WORKSPACE_INSTALL_DUSK_DEPS=false
 WORKSPACE_PUID=1000
 WORKSPACE_PGID=1000
+WORKSPACE_CHROME_DRIVER_VERSION=2.32
 WORKSPACE_NODE_VERSION=stable
 WORKSPACE_YARN_VERSION=latest
 WORKSPACE_TIMEZONE=UTC

php-fpm/Dockerfile-70

@@ -173,11 +173,11 @@ ENV INSTALL_AEROSPIKE ${INSTALL_AEROSPIKE}
 COPY ./aerospike.ini /usr/local/etc/php/conf.d/aerospike.ini
 RUN if [ ${INSTALL_AEROSPIKE} = true ]; then \
     # Install the php aerospike extension
-    curl -L -o /tmp/aerospike-client-php.tar.gz "https://github.com/aerospike/aerospike-client-php/archive/3.4.14.tar.gz" \
+    curl -L -o /tmp/aerospike-client-php.tar.gz "https://github.com/aerospike/aerospike-client-php/archive/master.tar.gz" \
     && mkdir -p aerospike-client-php \
     && tar -C aerospike-client-php -zxvf /tmp/aerospike-client-php.tar.gz --strip 1 \
     && ( \
-        cd aerospike-client-php/src/aerospike \
+        cd aerospike-client-php/src \
         && phpize \
         && ./build.sh \
         && make install \

php-fpm/Dockerfile-71

@@ -61,7 +61,7 @@ RUN if [ ${INSTALL_XDEBUG} = true ]; then \
     docker-php-ext-enable xdebug \
 ;fi
 
-# Copy xdebug configration for remote debugging
+# Copy xdebug configuration for remote debugging
 COPY ./xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
 
 #####################################
@@ -179,11 +179,11 @@ RUN if [ ${INSTALL_AEROSPIKE} = true ]; then \
     apt-get -y install sudo wget && \
 
     # Install the php aerospike extension
-    curl -L -o /tmp/aerospike-client-php.tar.gz "https://github.com/aerospike/aerospike-client-php/archive/3.4.14.tar.gz" \
+    curl -L -o /tmp/aerospike-client-php.tar.gz "https://github.com/aerospike/aerospike-client-php/archive/master.tar.gz" \
     && mkdir -p aerospike-client-php \
     && tar -C aerospike-client-php -zxvf /tmp/aerospike-client-php.tar.gz --strip 1 \
     && ( \
-        cd aerospike-client-php/src/aerospike \
+        cd aerospike-client-php/src \
         && phpize \
         && ./build.sh \
         && make install \

workspace/Dockerfile-56

@@ -189,6 +189,7 @@ ARG INSTALL_MONGO=false
 ENV INSTALL_MONGO ${INSTALL_MONGO}
 RUN if [ ${INSTALL_MONGO} = true ]; then \
     # Install the mongodb extension
+    pecl channel-update pecl.php.net && \
     pecl install mongodb && \
     echo "extension=mongodb.so" >> /etc/php/5.6/mods-available/mongodb.ini && \
     ln -s /etc/php/5.6/mods-available/mongodb.ini /etc/php/5.6/cli/conf.d/30-mongodb.ini \
@@ -524,6 +525,35 @@ RUN if [ ${INSTALL_TERRAFORM} = true ]; then \
     && rm terraform_0.10.6_linux_amd64.zip \
 ;fi
 
+#####################################
+# Dusk Dependencies:
+#####################################
+USER root
+ARG INSTALL_DUSK_DEPS=false
+ENV INSTALL_DUSK_DEPS ${INSTALL_DUSK_DEPS}
+RUN if [ ${INSTALL_DUSK_DEPS} = true ]; then \
+  # Install required packages
+  add-apt-repository ppa:ondrej/php \
+  && apt-get update \
+  && apt-get -y install zip wget unzip xdg-utils \
+    libxpm4 libxrender1 libgtk2.0-0 libnss3 libgconf-2-4 xvfb \
+    gtk2-engines-pixbuf xfonts-cyrillic xfonts-100dpi xfonts-75dpi \
+    xfonts-base xfonts-scalable x11-apps \
+
+  # Install Google Chrome
+  && wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb \
+  && dpkg -i --force-depends google-chrome-stable_current_amd64.deb \
+  && apt-get -y -f install \
+  && dpkg -i --force-depends google-chrome-stable_current_amd64.deb \
+  && rm google-chrome-stable_current_amd64.deb \
+
+  # Install Chrome Driver
+  && wget https://chromedriver.storage.googleapis.com/2.31/chromedriver_linux64.zip \
+  && unzip chromedriver_linux64.zip \
+  && mv chromedriver /usr/local/bin/ \
+  && rm chromedriver_linux64.zip \
+;fi
+
 #
 #--------------------------------------------------------------------------
 # Final Touch

workspace/Dockerfile-70

@@ -69,6 +69,19 @@ RUN if [ ${INSTALL_SOAP} = true ]; then \
   apt-get -y install libxml2-dev php7.0-soap \
 ;fi
 
+#####################################
+# LDAP:
+#####################################
+
+ARG INSTALL_LDAP=false
+ENV INSTALL_LDAP ${INSTALL_LDAP}
+
+RUN if [ ${INSTALL_LDAP} = true ]; then \
+    apt-get update -yqq && \
+    apt-get install -y libldap2-dev && \
+    apt-get install -y php7.0-ldap \
+;fi
+
 #####################################
 # Set Timezone
 #####################################
@@ -323,11 +336,11 @@ COPY ./aerospike.ini /etc/php/7.0/cli/conf.d/aerospike.ini
 
 RUN if [ ${INSTALL_AEROSPIKE} = true ]; then \
     # Install the php aerospike extension
-    curl -L -o /tmp/aerospike-client-php.tar.gz "https://github.com/aerospike/aerospike-client-php/archive/3.4.14.tar.gz" \
+    curl -L -o /tmp/aerospike-client-php.tar.gz "https://github.com/aerospike/aerospike-client-php/archive/master.tar.gz" \
     && mkdir -p aerospike-client-php \
     && tar -C aerospike-client-php -zxvf /tmp/aerospike-client-php.tar.gz --strip 1 \
     && ( \
-        cd aerospike-client-php/src/aerospike \
+        cd aerospike-client-php/src \
         && phpize \
         && ./build.sh \
         && make install \
@@ -605,6 +618,35 @@ RUN if [ ${INSTALL_TERRAFORM} = true ]; then \
     && rm terraform_0.10.6_linux_amd64.zip \
 ;fi
 
+#####################################
+# Dusk Dependencies:
+#####################################
+USER root
+ARG INSTALL_DUSK_DEPS=false
+ENV INSTALL_DUSK_DEPS ${INSTALL_DUSK_DEPS}
+RUN if [ ${INSTALL_DUSK_DEPS} = true ]; then \
+  # Install required packages
+  add-apt-repository ppa:ondrej/php \
+  && apt-get update \
+  && apt-get -y install zip wget unzip xdg-utils \
+    libxpm4 libxrender1 libgtk2.0-0 libnss3 libgconf-2-4 xvfb \
+    gtk2-engines-pixbuf xfonts-cyrillic xfonts-100dpi xfonts-75dpi \
+    xfonts-base xfonts-scalable x11-apps \
+
+  # Install Google Chrome
+  && wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb \
+  && dpkg -i --force-depends google-chrome-stable_current_amd64.deb \
+  && apt-get -y -f install \
+  && dpkg -i --force-depends google-chrome-stable_current_amd64.deb \
+  && rm google-chrome-stable_current_amd64.deb \
+
+  # Install Chrome Driver
+  && wget https://chromedriver.storage.googleapis.com/2.31/chromedriver_linux64.zip \
+  && unzip chromedriver_linux64.zip \
+  && mv chromedriver /usr/local/bin/ \
+  && rm chromedriver_linux64.zip \
+;fi
+
 #
 #--------------------------------------------------------------------------
 # Final Touch

workspace/Dockerfile-71

@@ -69,6 +69,19 @@ RUN if [ ${INSTALL_SOAP} = true ]; then \
   apt-get -y install libxml2-dev php7.1-soap \
 ;fi
 
+#####################################
+# LDAP:
+#####################################
+
+ARG INSTALL_LDAP=false
+ENV INSTALL_LDAP ${INSTALL_LDAP}
+
+RUN if [ ${INSTALL_LDAP} = true ]; then \
+    apt-get update -yqq && \
+    apt-get install -y libldap2-dev && \
+    apt-get install -y php7.1-ldap \
+;fi
+
 #####################################
 # Set Timezone
 #####################################
@@ -325,11 +338,11 @@ RUN if [ ${INSTALL_AEROSPIKE} = true ]; then \
     apt-get -y install sudo wget && \
 
     # Install the php aerospike extension
-    curl -L -o /tmp/aerospike-client-php.tar.gz "https://github.com/aerospike/aerospike-client-php/archive/3.4.14.tar.gz" \
+    curl -L -o /tmp/aerospike-client-php.tar.gz "https://github.com/aerospike/aerospike-client-php/archive/master.tar.gz" \
     && mkdir -p aerospike-client-php \
     && tar -C aerospike-client-php -zxvf /tmp/aerospike-client-php.tar.gz --strip 1 \
     && ( \
-        cd aerospike-client-php/src/aerospike \
+        cd aerospike-client-php/src \
         && phpize \
         && ./build.sh \
         && make install \
@@ -611,6 +624,32 @@ RUN if [ ${INSTALL_TERRAFORM} = true ]; then \
     && rm terraform_0.10.6_linux_amd64.zip \
 ;fi
 
+#####################################
+# Dusk Dependencies:
+#####################################
+USER root
+ARG CHROME_DRIVER_VERSION=stable
+ENV CHROME_DRIVER_VERSION ${CHROME_DRIVER_VERSION}
+ARG INSTALL_DUSK_DEPS=false
+ENV INSTALL_DUSK_DEPS ${INSTALL_DUSK_DEPS}
+RUN if [ ${INSTALL_DUSK_DEPS} = true ]; then \
+  add-apt-repository ppa:ondrej/php \
+  && apt-get update \
+  && apt-get -y install zip wget unzip xdg-utils \
+    libxpm4 libxrender1 libgtk2.0-0 libnss3 libgconf-2-4 xvfb \
+    gtk2-engines-pixbuf xfonts-cyrillic xfonts-100dpi xfonts-75dpi \
+    xfonts-base xfonts-scalable x11-apps \
+  && wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb \
+  && dpkg -i --force-depends google-chrome-stable_current_amd64.deb \
+  && apt-get -y -f install \
+  && dpkg -i --force-depends google-chrome-stable_current_amd64.deb \
+  && rm google-chrome-stable_current_amd64.deb \
+  && wget https://chromedriver.storage.googleapis.com/${CHROME_DRIVER_VERSION}/chromedriver_linux64.zip \
+  && unzip chromedriver_linux64.zip \
+  && mv chromedriver /usr/local/bin/ \
+  && rm chromedriver_linux64.zip \
+;fi
+
 #
 #--------------------------------------------------------------------------
 # Final Touch

workspace/aliases.sh

@@ -63,8 +63,13 @@ alias artisan="php artisan"
 alias cdump="composer dump-autoload -o"
 alias composer:dump="composer dump-autoload -o"
 alias db:reset="php artisan migrate:reset && php artisan migrate --seed"
+alias dusk="php artisan dusk"
+alias fresh="php artisan migrate:fresh"
 alias migrate="php artisan migrate"
+alias refresh="php artisan migrate:refresh"
+alias rollback="php artisan migrate:rollback"
 alias seed="php artisan:seed"
+alias serve="php artisan serve --quiet &"
 
 alias phpunit="./vendor/bin/phpunit"
 alias pu="phpunit"
@@ -84,6 +89,9 @@ alias reload="source ~/.aliases && echo \"$COL_GREEN ==> Aliases Reloaded... $CO
 alias run="npm run"
 alias tree="xtree"
 
+# Xvfb
+alias xvfb="Xvfb -ac :0 -screen 0 1024x768x16 &"
+
 # requires installation of 'https://www.npmjs.com/package/npms-cli'
 alias npms="npms search"
 # requires installation of 'https://www.npmjs.com/package/package-menu-cli'