Merge branch 'develop'

Author: andrewholgate

.gitignore

@@ -1,2 +1,4 @@
 build.log
 docker-compose.yml
+local/*
+!local/*.dist

Dockerfile

@@ -1,4 +1,4 @@
-FROM andrewholgate/drupal-php70:0.3.0
+FROM andrewholgate/drupal-php70:0.4.0
 MAINTAINER Andrew Holgate <[email protected]>
 
 RUN DEBIAN_FRONTEND=noninteractive apt-get update && \
@@ -8,46 +8,39 @@ RUN DEBIAN_FRONTEND=noninteractive apt-get update && \
 RUN DEBIAN_FRONTEND=noninteractive apt-get -y install python-sphinx python-pip doxygen && \
     DEBIAN_FRONTEND=noninteractive pip install sphinx_rtd_theme breathe
 
-# Install XDebug 2.4.0 RC3
-RUN wget https://github.com/xdebug/xdebug/archive/XDEBUG_2_4_0RC3.tar.gz && \
-    tar zxvf XDEBUG_2_4_0RC3.tar.gz && \
-    rm -f XDEBUG_2_4_0RC3.tar.gz && \
-    cd xdebug-XDEBUG_2_4_0RC3 && \
+# XML needed by PHPCodeSniffer 2.3+ and other developer tools.
+RUN DEBIAN_FRONTEND=noninteractive apt-get -y install php7.0-xml
+
+# Install XDebug 2.4.0
+RUN wget https://github.com/xdebug/xdebug/archive/XDEBUG_2_4_0RC4.tar.gz && \
+    tar zxvf XDEBUG_2_4_0RC4.tar.gz && \
+    rm -f XDEBUG_2_4_0RC4.tar.gz && \
+    cd xdebug-XDEBUG_2_4_0RC4 && \
     phpize && \
     ./configure --enable-xdebug && \
     make && \
     cp modules/xdebug.so /usr/lib/php/20151012/ && \
-    rm -Rf ../xdebug-XDEBUG_2_4_0RC3
+    rm -Rf ../xdebug-XDEBUG_2_4_0RC4
 
 COPY xdebug.ini /etc/php/mods-available/xdebug.ini
-RUN ln -s /etc/php/mods-available/xdebug.ini /etc/php/7.0/cli/conf.d/20-xdebug.ini
 RUN ln -s /etc/php/mods-available/xdebug.ini /etc/php/7.0/fpm/conf.d/20-xdebug.ini
+COPY xdebug /usr/local/bin/xdebug
+RUN chmod +x /usr/local/bin/xdebug
+
 # Symlink log files.
 RUN ln -s /var/log/xdebug/xdebug.log /var/www/log/
 
-# Install XHProf
-#RUN wget https://github.com/phacility/xhprof/archive/master.tar.gz && \
-#    tar zxvf master.tar.gz && \
-#    rm -f master.tar.gz
-#    cd xhprof-master/extension/ && \
-#    phpize && \
-#    ./configure --with-php-config=/usr/bin/php-config7.0 && \
-#    make && \
-#    make install && \
-#    make test && \
-#    rm -Rf ../xhprof-master
-
 # Install JRE (needed for some testing tools like sitespeed.io) and libs for PhantomJS.
 RUN DEBIAN_FRONTEND=noninteractive apt-get -y install default-jre libfreetype6 libfontconfig
 
-# Install Node 4.2.4 LTS
+# Install Node 4.3.1 LTS
 RUN cd /opt && \
-  wget https://nodejs.org/dist/v4.2.4/node-v4.2.4-linux-x64.tar.gz && \
-  tar -xzf node-v4.2.4-linux-x64.tar.gz && \
-  mv node-v4.2.4-linux-x64 node && \
+  wget https://nodejs.org/dist/v4.3.1/node-v4.3.1-linux-x64.tar.gz && \
+  tar -xzf node-v4.3.1-linux-x64.tar.gz && \
+  mv node-v4.3.1-linux-x64 node && \
   cd /usr/local/bin && \
   ln -s /opt/node/bin/* . && \
-  rm -f /opt/node-v4.2.4-linux-x64.tar.gz
+  rm -f /opt/node-v4.3.1-linux-x64.tar.gz
 
 USER ubuntu
 RUN echo 'export PATH="$PATH:$HOME/.npm-packages/bin"' >> ~/.bashrc && \
@@ -66,6 +59,19 @@ RUN DEBIAN_FRONTEND=noninteractive apt-get -y install imagemagick && \
 # Front-end tools
 RUN npm install -g phantomjs
 
+# Install XHProf
+RUN wget https://github.com/RustJason/xhprof/archive/php7.tar.gz && \
+    tar zxvf php7.tar.gz && \
+    rm -f php7.tar.gz && \
+    cd xhprof-php7/extension/ && \
+    phpize && \
+    ./configure --with-php-config=/usr/bin/php-config7.0 && \
+    make && \
+    sudo make install && \
+    rm -Rf ../xhprof-php7
+# Tests fail:
+# make test && \
+
 # Turn on PHP error reporting
 RUN sed -ri 's/^display_errors\s*=\s*Off/display_errors = On/g' /etc/php/7.0/fpm/php.ini && \
     sed -ri 's/^display_errors\s*=\s*Off/display_errors = On/g' /etc/php/7.0/cli/php.ini  && \
@@ -76,7 +82,9 @@ RUN sed -ri 's/^display_errors\s*=\s*Off/display_errors = On/g' /etc/php/7.0/fpm
     sed -ri 's/^track_errors\s*=\s*Off/track_errors = On/g' /etc/php/7.0/fpm/php.ini && \
     sed -ri 's/^track_errors\s*=\s*Off/track_errors = On/g' /etc/php/7.0/cli/php.ini && \
     sed -ri 's/^;xmlrpc_errors\s*=\s*0/xmlrpc_errors = 1/g' /etc/php/7.0/fpm/php.ini && \
-    sed -ri 's/^;xmlrpc_errors\s*=\s*0/xmlrpc_errors = 1/g' /etc/php/7.0/cli/php.ini
+    sed -ri 's/^;xmlrpc_errors\s*=\s*0/xmlrpc_errors = 1/g' /etc/php/7.0/cli/php.ini && \
+    sed -ri 's/^zend.assertions\s*=\s*-1/zend.assertions = 1/g' /etc/php/7.0/fpm/php.ini && \
+    sed -ri 's/^zend.assertions\s*=\s*-1/zend.assertions = 1/g' /etc/php/7.0/cli/php.ini
 
 # Disable Google Pagespeed
 RUN sed -ri 's/\s*ModPagespeed on/    ModPagespeed off/g' /etc/apache2/mods-available/pagespeed.conf
@@ -86,10 +94,18 @@ RUN apt-get -y install sudo && \
     echo "ubuntu ALL=(ALL) NOPASSWD: ALL" >> /etc/sudoers && \
     usermod -a -G sudo ubuntu
 
+# Load custom .bashrc settings if available.
+USER ubuntu
+RUN echo 'LOCAL_BASHRC="$HOME/.local/bashrc"; test -f "${LOCAL_BASHRC}" && source "${LOCAL_BASHRC}"' >> ~/.bashrc
+USER root
+
 # Clean-up installation.
 RUN DEBIAN_FRONTEND=noninteractive apt-get -y autoclean && \
     DEBIAN_FRONTEND=noninteractive apt-get -y autoremove
 
+# Apache does not like PID files pre-existing
+RUN rm -f /var/run/apache2/apache2.pid
+
 RUN service apache2 restart
 RUN service php7.0-fpm start
 

README.md

@@ -5,6 +5,7 @@ Dockerised Drupal 8 development environment using PHP 7.0 on Ubuntu 14.04 with H
 ## Debugging Tools
 
 - [XDebug](http://www.xdebug.org/) - PHP debugging and profiling.
+- [XHProf](http://pecl.php.net/package/xhprof) - function-level hierarchical profiler.
 
 ## Front-end Tools
 
@@ -37,7 +38,7 @@ cp docker-compose.yml.dist docker-compose.yml
 vim docker-compose.yml
 
 # Build docker containers using Docker Composer.
-sudo docker-compose build
+sudo docker-compose build --no-cache
 sudo docker-compose up -d
 ```
 
@@ -47,7 +48,7 @@ From the host server, add the web container IP address to the hosts file.
 
 ```bash
 # Add IP address to hosts file.
-./hosts.sh
+./host.sh
 ```
 
 ## Logging into Web Front-end
@@ -57,6 +58,24 @@ From the host server, add the web container IP address to the hosts file.
 sudo docker exec -it dockerdrupalphp70dev_drupalphp70devweb_1 su - ubuntu
 ```
 
-# TODO
+## Local customisations
 
-- [XHProf](http://pecl.php.net/package/xhprof) - function-level hierarchical profiler.
+```bash
+# Customize scripts in local folders.
+cp local/bashrc.dist local/bashrc
+vim local/bashrc
+```
+
+## XDebug enable and disable
+
+Note that XDebug CLI is disabled by default.
+
+```bash
+# Turn XDebug on / off in Apache.
+xdebug on
+xdebug off
+
+# Turn XDebug on / off fopr both Apache and CLI.
+xdebug on-all
+xdebug off-all
+```

local/bashrc.dist

@@ -0,0 +1,18 @@
+find_git_branch() {
+  # Based on: https://github.com/jimeh/git-aware-prompt http://stackoverflow.com/a/13003854/170413
+  local branch
+  if branch=$(git rev-parse --abbrev-ref HEAD 2> /dev/null); then
+    if [[ "$branch" == "HEAD" ]]; then
+      branch='detached'
+    fi
+    git_branch="($branch)"
+  else
+    git_branch=""
+  fi
+  echo $git_branch;
+}
+
+PS1='\[\e]0;\u@\h: \w\a\]${debian_chroot:+($debian_chroot)}\u@\h:`find_git_branch`\w\$ '
+
+# XDebug config to work with CLI.
+export XDEBUG_CONFIG="remote_host=$(/sbin/ip route|awk '/default/ { print $3 }')"

xdebug

@@ -0,0 +1,59 @@
+#!/bin/bash
+# Turn XDebug on and off for Apache and CLI.
+
+XDEBUG_CLI=/etc/php/7.0/cli/conf.d/20-xdebug.ini
+XDEBUG_FPM=/etc/php/7.0/fpm/conf.d/20-xdebug.ini
+
+function on_cli {
+  if [ ! -f $XDEBUG_CLI ]; then
+    sudo ln -s /etc/php/mods-available/xdebug.ini $XDEBUG_CLI
+  fi
+}
+
+function on_fpm {
+  if [ ! -f $XDEBUG_FPM ]; then
+    sudo ln -s /etc/php/mods-available/xdebug.ini $XDEBUG_FPM
+  fi
+}
+
+function off_cli {
+  if [ -f $XDEBUG_CLI ]; then
+    sudo rm $XDEBUG_CLI
+  fi
+}
+
+function off_fpm {
+  if [ -f $XDEBUG_FPM ]; then
+    sudo rm $XDEBUG_FPM
+  fi
+}
+
+case "$1" in
+  on)
+    on_fpm
+    ;;
+  off)
+    off_fpm
+    ;;
+  on-all)
+    on_cli
+    on_fpm
+    ;;
+  off-all)
+    off_cli
+    off_fpm
+    ;;
+  *)
+    echo
+    php -v
+    exit 1
+esac
+
+echo
+
+if [ ! $2 ]; then
+  sudo service apache2 restart
+  sudo service php7.0-fpm restart
+  echo
+  php -v
+fi

xdebug.ini

@@ -2,11 +2,11 @@ zend_extension=xdebug.so
 xdebug.remote_log="/var/log/xdebug/xdebug.log"
 xdebug.remote_enable=1
 xdebug.remote_connect_back=1
+xdebug.remote_autostart=1
 ;xdebug.remote_handler="dbgp"
 ;xdebug.remote_mode="req"
 ;xdebug.remote_host=172.17.0.40
 ;xdebug.remote_port=9000
 ;xdebug.profiler_enable=1
 ;xdebug.profiler_output_dir="/tmp/xdebug"
 ;xdebug.idekey="sublime.xdebug"
-;xdebug.remote_autostart=0