Update php-xdebug role to latest version.

Author: geerlingguy

provisioning/requirements.yml

@@ -58,7 +58,7 @@
 - src: geerlingguy.php-versions
   version: 2.0.0
 - src: geerlingguy.php-xdebug
-  version: 2.3.1
+  version: 2.4.0
 - src: geerlingguy.php-xhprof
   version: 2.2.2
 - src: geerlingguy.pimpmylog

provisioning/roles/geerlingguy.php-xdebug/.gitignore

@@ -1 +1,2 @@
-.DS_Store
+*.retry
+tests/test.sh

provisioning/roles/geerlingguy.php-xdebug/.travis.yml

@@ -3,44 +3,23 @@ services: docker
 
 env:
   - distro: centos7
-    init: /usr/lib/systemd/systemd
-    run_opts: "--privileged --volume=/sys/fs/cgroup:/sys/fs/cgroup:ro"
   - distro: ubuntu1604
-    init: /lib/systemd/systemd
-    run_opts: "--privileged --volume=/sys/fs/cgroup:/sys/fs/cgroup:ro"
   - distro: debian8
-    init: /lib/systemd/systemd
-    run_opts: "--privileged --volume=/sys/fs/cgroup:/sys/fs/cgroup:ro"
-
-before_install:
-  # Pull container.
-  - 'docker pull geerlingguy/docker-${distro}-ansible:latest'
 
 script:
-  - container_id=$(mktemp)
-  # Run container in detached state.
-  - 'docker run --detach --volume="${PWD}":/etc/ansible/roles/role_under_test:ro ${run_opts} geerlingguy/docker-${distro}-ansible:latest "${init}" > "${container_id}"'
-
-  # Install dependencies.
-  - 'docker exec "$(cat ${container_id})" ansible-galaxy install -r /etc/ansible/roles/role_under_test/tests/requirements.yml'
-
-  # Ansible syntax check.
-  - 'docker exec --tty "$(cat ${container_id})" env TERM=xterm ansible-playbook /etc/ansible/roles/role_under_test/tests/test.yml --syntax-check'
+  # Configure test script so we can run extra tests after playbook is run.
+  - export container_id=$(date +%s)
+  - export cleanup=false
 
-  # Test role.
-  - 'docker exec --tty "$(cat ${container_id})" env TERM=xterm ansible-playbook /etc/ansible/roles/role_under_test/tests/test.yml'
+  # Download test shim.
+  - wget -O ${PWD}/tests/test.sh https://gist.githubusercontent.com/geerlingguy/73ef1e5ee45d8694570f334be385e181/raw/
+  - chmod +x ${PWD}/tests/test.sh
 
-  # Test role idempotence.
-  - idempotence=$(mktemp)
-  - docker exec "$(cat ${container_id})" ansible-playbook /etc/ansible/roles/role_under_test/tests/test.yml | tee -a ${idempotence}
-  - >
-    tail ${idempotence}
-    | grep -q 'changed=0.*failed=0'
-    && (echo 'Idempotence test: pass' && exit 0)
-    || (echo 'Idempotence test: fail' && exit 1)
+  # Run tests.
+  - ${PWD}/tests/test.sh
 
   # Run script to test if Xdebug is available and working.
-  - 'docker exec "$(cat ${container_id})" env TERM=xterm php /etc/ansible/roles/role_under_test/tests/xdebug-test.php'
+  - 'docker exec ${container_id} env TERM=xterm php /etc/ansible/roles/role_under_test/tests/xdebug-test.php'
 
 notifications:
   webhooks: https://galaxy.ansible.com/api/v1/notifications/

provisioning/roles/geerlingguy.php-xdebug/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jeff Geerling
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

provisioning/roles/geerlingguy.php-xdebug/README.md

@@ -16,7 +16,7 @@ Available variables are listed below, along with default values (see `defaults/m
 
 Where Xdebug setup files will be downloaded and built.
 
-    php_xdebug_version: 2.4.1
+    php_xdebug_version: 2.5.0
 
 The version of Xdebug to be installed (see [Updates](https://xdebug.org/updates.php) for a current listing).
 
@@ -25,10 +25,6 @@ The version of Xdebug to be installed (see [Updates](https://xdebug.org/updates.
 
 Whether to enable XDebug coverage and default exception handling or not. Disable these for slightly improved PHP performance, enable these to use XDebug to the fullest extent.
 
-    php_xdebug_cli_enable: 1
-
-Whether xdebug is enabled for the CLI.
-
     php_xdebug_module_path: /usr/lib64/php/modules
 
 The path where `xdebug.so` will be installed.
@@ -54,10 +50,14 @@ The location of the xdebug log (useful if you're having trouble connecting).
 
 The IDE key to use in the URL when making Xdebug requests (e.g. `http://example.local/?XDEBUG_SESSION_START=sublime.xdebug`).
 
-    php_xdebug_max_nesting_level: 100
+    php_xdebug_max_nesting_level: 256
 
 The maximimum function nesting level before Xdebug bails and throws a fatal exception.
 
+    php_xdebug_cli_disable: no
+
+(Debian/Ubuntu ONLY) Disable xdebug for the CLI SAPI.
+
 ## Dependencies
 
   - geerlingguy.php

provisioning/roles/geerlingguy.php-xdebug/defaults/main.yml

@@ -5,7 +5,6 @@ php_xdebug_version: 2.5.0
 
 php_xdebug_coverage_enable: 1
 php_xdebug_default_enable: 1
-php_xdebug_cli_enable: 1
 
 php_xdebug_remote_enable: "false"
 php_xdebug_remote_connect_back: "false"
@@ -18,3 +17,5 @@ php_xdebug_idekey: sublime.xdebug
 
 php_xdebug_max_nesting_level: 256
 
+# Only used on Debian/Ubuntu.
+php_xdebug_cli_disable: no

provisioning/roles/geerlingguy.php-xdebug/meta/main.yml

@@ -1,5 +1,6 @@
 ---
-dependencies: []
+dependencies:
+  - geerlingguy.php
 
 galaxy_info:
   author: geerlingguy

provisioning/roles/geerlingguy.php-xdebug/tasks/configure.yml

@@ -6,7 +6,17 @@
     owner: root
     group: root
     mode: 0644
+  when: "'cli' not in item or ('cli' in item and not php_xdebug_cli_disable)"
   with_items: "{{ php_extension_conf_paths }}"
   notify:
     - restart webserver
     - restart php-fpm
+
+- name: Disable xdebug for PHP CLI.
+  file:
+    path: "/etc/php/{{ php_version }}/cli/conf.d/{{ php_xdebug_config_filename }}"
+    state: absent
+  when: ansible_os_family == 'Debian' and php_xdebug_cli_disable
+  notify:
+    - restart webserver
+    - restart php-fpm

provisioning/roles/geerlingguy.php-xdebug/templates/xdebug.ini.j2

@@ -8,7 +8,6 @@ xdebug.remote_enable={{ php_xdebug_remote_enable }}
 xdebug.remote_connect_back={{ php_xdebug_remote_connect_back }}
 xdebug.remote_host={{ php_xdebug_remote_host }}
 xdebug.remote_port={{ php_xdebug_remote_port }}
-xdebug.remote_handler=dbgp
 xdebug.remote_log={{ php_xdebug_remote_log }}
 xdebug.remote_autostart={{ php_xdebug_remote_autostart }}
 

provisioning/roles/geerlingguy.php-xdebug/tests/README.md

@@ -0,0 +1,11 @@
+# Ansible Role tests
+
+To run the test playbook(s) in this directory:
+
+  1. Install and start Docker.
+  1. Download the test shim (see .travis.yml file for the URL) into `tests/test.sh`:
+    - `wget -O tests/test.sh https://gist.githubusercontent.com/geerlingguy/73ef1e5ee45d8694570f334be385e181/raw/`
+  1. Make the test shim executable: `chmod +x tests/test.sh`.
+  1. Run (from the role root directory) `distro=[distro] playbook=[playbook] ./tests/test.sh`
+
+If you don't want the container to be automatically deleted after the test playbook is run, add the following environment variables: `cleanup=false container_id=$(date +%s)`