fix pool.conf template in case some VARs are not defined (#20)

vars not defined in defaults should be processed only if they are defined (avoid AnsibleUndefinedVariable errors)

Co-authored-by: Klaus Zerwes <Klaus.Zerwes@rosalux.org>

.travis.yml

@@ -4,8 +4,6 @@ env:
   global:
     - VAGRANT_VERSION='2.2.18'
   jobs:
-    - PLATFORM='docker-debian-stretch-php70'  ANSIBLE_VERSION='>=2.11,<2.12'
-    - PLATFORM='docker-debian-stretch-php74'  ANSIBLE_VERSION='>=2.11,<2.12'
     - PLATFORM='docker-debian-buster-php73'   ANSIBLE_VERSION='>=2.11,<2.12'
     - PLATFORM='docker-debian-bullseye-php74' ANSIBLE_VERSION='>=2.11,<2.12'
     - PLATFORM='docker-debian-bullseye-php80' ANSIBLE_VERSION='>=2.11,<2.12'

README.md

@@ -1,14 +1,14 @@
 Ansible PHP (+FPM) role for Debian / Ubuntu / FreeBSD
 =====================================================
 
-[![Ansible Galaxy](http://img.shields.io/badge/ansible--galaxy-HanXHX.php-blue.svg)](https://galaxy.ansible.com/HanXHX/php) [![Build Status](https://app.travis-ci.com/HanXHX/ansible-php.svg?branch=master)](https://app.travis-ci.com/HanXHX/ansible-php)
+[![Ansible Galaxy](http://img.shields.io/badge/ansible--galaxy-hanxhx.php-blue.svg)](https://galaxy.ansible.com/hanxhx.php) [![Build Status](https://app.travis-ci.com/HanXHX/ansible-php.svg?branch=master)](https://app.travis-ci.com/HanXHX/ansible-php)
 
 Install PHP on Debian / Ubuntu / FreeBSD. Manage PHP-FPM, APCu, Opcache and Xdebug.
 
 Managed OS / Versions
 ---------------------
 
-On all Debian versions, you can install all PHP versions (from PHP 5.6 to 8.1 beta) by using [Sury's APT repository](https://deb.sury.org/).
+On all Debian versions, you can install all PHP versions by using [Sury's APT repository](https://deb.sury.org/).
 
 Other cases:
 
@@ -161,14 +161,14 @@ Example Playbook
 
     - hosts: servers
       roles:
-         - { role: HanXHX.php }
+         - { role: hanxhx.php }
 
 ### Debian Bullseye with PHP 8.0 CLI (no FPM)
 
     - hosts: servers
       roles:
          - { role: HanXHX.sury }
-         - { role: HanXHX.php, php_version: '8.0', php_install_fpm: false }
+         - { role: hanxhx.php, php_version: '8.0', php_install_fpm: false }
 
 License
 -------

Vagrantfile

@@ -6,8 +6,6 @@
 Vagrant.configure("2") do |config|
 
   vms_debian = [
-    { :name => "debian-stretch-php70",  :box => "debian/stretch64",  :vars => { }},
-    { :name => "debian-stretch-php74",  :box => "debian/stretch64",  :vars => { "php_version": '7.4' }},
     { :name => "debian-buster-php73",   :box => "debian/buster64",   :vars => { }},
     { :name => "debian-buster-php74",   :box => "debian/buster64",   :vars => { "php_version": '7.4' }},
     { :name => "debian-bullseye-php74", :box => "debian/bullseye64", :vars => { }},
@@ -21,8 +19,6 @@ Vagrant.configure("2") do |config|
   ]
 
   conts = [
-    { :name => "docker-debian-stretch-php70",  :docker => "hanxhx/vagrant-ansible:debian9",     :vars => { }},
-    { :name => "docker-debian-stretch-php74",  :docker => "hanxhx/vagrant-ansible:debian9",     :vars => { "php_version": '7.4' }},
     { :name => "docker-debian-buster-php73",   :docker => "hanxhx/vagrant-ansible:debian10",    :vars => { }},
     { :name => "docker-debian-buster-php74",   :docker => "hanxhx/vagrant-ansible:debian10",    :vars => { "php_version": '7.4' }},
     { :name => "docker-debian-bullseye-php74", :docker => "hanxhx/vagrant-ansible:debian11",    :vars => { }},
@@ -40,10 +36,6 @@ Vagrant.configure("2") do |config|
         d.has_ssh = true
       end
 
-      if opts[:name].include? "bullseye"
-        m.vm.provision "shell", inline: "[ -f '/root/first_provision' ] || (apt-get update -qq && apt-get -y dist-upgrade && touch /root/first_provision)"
-      end
-
       #m.vm.provision "shell", inline: "apt-get update && apt-get install -y python python-apt"
       m.vm.provision "ansible" do |ansible|
         ansible.playbook = "tests/test.yml"
@@ -63,10 +55,6 @@ Vagrant.configure("2") do |config|
       end
       m.vm.provision "shell", inline: "apt-get update && apt-get install -y ifupdown python"
 
-      if opts[:name].include? "bullseye"
-        m.vm.provision "shell", inline: "[ -f '/root/first_provision' ] || (apt-get update -qq && apt-get -y dist-upgrade && touch /root/first_provision)"
-      end
-
       m.vm.provision "ansible" do |ansible|
         ansible.playbook = "tests/test.yml"
         ansible.verbose = 'vv'

handlers/main.yml

@@ -1,13 +1,13 @@
 ---
 
-- name: restart php-fpm
+- name: Restart php-fpm
   ansible.builtin.service:
     name: '{{ php_fpm_service }}'
     state: restarted
   when: php_install_fpm
-  notify: docker restart php-fpm
+  notify: Docker restart php-fpm
 
-- name: docker restart php-fpm
+- name: Docker restart php-fpm
   ansible.builtin.command: 'service {{ php_fpm_service }} restart'
   args:
     warn: false

meta/argument_specs.yml

@@ -0,0 +1,6 @@
+---
+
+argument_specs:
+  main:
+    short_description: Main entry point
+    options: {}

meta/main.yml

@@ -1,14 +1,15 @@
 ---
 galaxy_info:
   author: Emilien Mantel
-  description: Install and configure PHP 7.0/7.1/7.2/7.3/7.4/8.0
-  company:
+  role_name: php
+  namespace: hanxhx
+  description: Install and configure PHP 7.x/8.x
+  company: TripleStack
   license: GPLv2
-  min_ansible_version: 2.11
+  min_ansible_version: '2.11'
   platforms:
     - name: Debian
       versions:
-        - stretch
         - buster
         - bullseye
     - name: Ubuntu
@@ -16,9 +17,9 @@ galaxy_info:
         - bionic
     - name: FreeBSD
       versions:
-        - 11.0
-        - 11.1
-        - 12.0
+        - '11.0'
+        - '11.1'
+        - '12.0'
   galaxy_tags:
     - development
     - web
@@ -29,4 +30,5 @@ galaxy_info:
     - debian
     - ubuntu
     - freebsd
+
 dependencies: []

tasks/fpm.yml

@@ -22,7 +22,8 @@
     group: root
     mode: 0644
   loop: "{{ php_ini | combine(php_ini_fpm) | dict2items }}"
-  notify: restart php-fpm
+  when: php_install_fpm | bool
+  notify: Restart php-fpm
 
 - name: TEMPLATE | Deploy pool configuration
   ansible.builtin.template:
@@ -32,11 +33,14 @@
     group: root
     mode: 0644
   loop: "{{ ansible_local.hanxhx_php.fpm_pool }}"
-  notify: restart php-fpm
+  when: php_install_fpm | bool
+  notify: Restart php-fpm
 
 - name: FILE | Delete default pool if necessary
   ansible.builtin.file:
     path: "{{ php_fpm_pool_dir }}/www.conf"
     state: absent
-  when: '"www" not in (ansible_local.hanxhx_php.fpm_pool | map(attribute="name") | list) and php_autoremove_default_pool'
-  notify: restart php-fpm
+  when:
+    - '"www" not in (ansible_local.hanxhx_php.fpm_pool | map(attribute="name") | list) and php_autoremove_default_pool'
+    - php_install_fpm | bool
+  notify: Restart php-fpm

tasks/main.yml

@@ -1,5 +1,14 @@
 ---
 
+- name: SHELL | Check if we are in multiple PHP distribution
+  ansible.builtin.shell: set -o pipefail && apt-cache search php xdebug | grep 'php[[:digit:]].[[:digit:]]'
+  args:
+    executable: /bin/bash
+  failed_when: false
+  changed_when: false
+  register: multiple_php
+  when: ansible_os_family == 'Debian'
+
 - name: INCLUDE_VARS | Related to OS family
   ansible.builtin.include_vars: "OS_Family_{{ ansible_os_family }}.yml"
 
@@ -20,10 +29,11 @@
           listen: "{{ p.listen | default(php_version | php_socket(p.name | default(p.pool_name))) }}",
           user: "{{ p.user | default(php_default_user_group) }}",
           group: "{% if p.user is defined %}{{ p.group | default(p.user) }}{% else %}{{ p.group | default(php_default_user_group) }}{% endif %}",
+          php_env: {% if p.php_env is defined %}{{ p.php_env | to_nice_json }}{% else %}{}{% endif %},
           php_value: {% if p.php_value is defined %}{{ p.php_value | to_nice_json }}{% else %}{}{% endif %},
           php_admin_value: {% if p.php_admin_value is defined %}{{ p.php_admin_value | to_nice_json }}{% else %}{}{% endif %},
           {% for k, v in p.items() | list %}
-          {% if k not in ['name', 'pool_name', 'listen', 'user', 'group', 'php_value', 'php_admin_value'] %}
+          {% if k not in ['name', 'pool_name', 'listen', 'user', 'group', 'php_env', 'php_value', 'php_admin_value'] %}
           {{ k }}: "{{ v }}"{% if not loop.last %},{% endif %}
           {% endif %}
           {% endfor %}
@@ -51,6 +61,8 @@
     group: root
     mode: 0644
   register: f
+  tags:
+    - skip_ansible_lint
 
 - name: SETUP | Gathers new facts
   ansible.builtin.setup:
@@ -64,15 +76,16 @@
     state: present
     update_cache: true
     cache_valid_time: 3600
+    install_recommends: false
   vars:
     pkgs: "{{ php_packages + php_extra_packages | flatten }}"
-  notify: restart php-fpm
+  notify: Restart php-fpm
   when: ansible_os_family == 'Debian'
 
 - name: PKGNG | Install PHP packages
   community.general.pkgng:
     name: "{{ php_packages + php_extra_packages | flatten | join(',') }}"
-  notify: restart php-fpm
+  notify: Restart php-fpm
   when: ansible_os_family == 'FreeBSD'
 
 - name: IMPORT_TASKS | PHP-FPM
@@ -97,7 +110,9 @@
     state: started
   when: php_install_fpm and ansible_virtualization_type != 'docker'
 
-- block:
+- name: BLOCK | Ensure PHP-FPM is started if running on Docker
+  when: php_install_fpm and ansible_virtualization_type == 'docker'
+  block:
 
     - name: COMMAND | Check if PHP-FPM is started (Docker)
       ansible.builtin.command: 'service {{ php_fpm_service }} status'
@@ -112,5 +127,3 @@
       args:
         warn: false
       when: dps.stdout.find('is not running') != -1
-
-  when: php_install_fpm and ansible_virtualization_type == 'docker'

tasks/opcache.yml

@@ -1,18 +1,23 @@
 ---
 
-- block:
+- name: Install opcache/apcu on Debian
+  when: ansible_os_family == 'Debian'
+  block:
 
     - name: APT | Install APCu
       ansible.builtin.apt:
-        pkg: "php-apcu"
+        pkg: "{{ php_apcu_package }}"
+        install_recommends: false
 
     - name: APT | Install Opcache
       ansible.builtin.apt:
         pkg: "{{ php_package_prefix }}opcache"
+        install_recommends: false
 
-  when: ansible_os_family == 'Debian'
 
-- block:
+- name: Install opcache/apcu on FreeBSD
+  when: ansible_os_family == 'FreeBSD'
+  block:
 
     - name: PKGNG | Install APCu
       community.general.pkgng:
@@ -22,8 +27,6 @@
       community.general.pkgng:
         name: "{{ php_package_prefix }}opcache"
 
-  when: ansible_os_family == 'FreeBSD'
-
 - name: TEMPLATE | Configure Opcache
   ansible.builtin.template:
     src: "etc/__php__/mods-available/opcache.ini.j2"
@@ -31,7 +34,7 @@
     owner: root
     group: root
     mode: 0644
-  notify: restart php-fpm
+  notify: Restart php-fpm
 
 - name: TEMPLATE | Configure APCu
   ansible.builtin.template:
@@ -40,4 +43,4 @@
     owner: root
     group: root
     mode: 0644
-  notify: restart php-fpm
+  notify: Restart php-fpm

tasks/xdebug.yml

@@ -1,6 +1,8 @@
 ---
 
-- block:
+- name: BLOCK | Uninstall xdebug
+  when: php_install_xdebug
+  block:
 
     - name: APT | Install xdebug
       ansible.builtin.apt:
@@ -8,6 +10,7 @@
         state: present
         update_cache: true
         cache_valid_time: 3600
+        install_recommends: false
       when: ansible_os_family == 'Debian'
 
     - name: PKGNG | Install xdebug
@@ -21,11 +24,12 @@
         dest: "{{ php_mods_dir }}/xdebug.ini"
         owner: root
         mode: 0644
-      notify: restart php-fpm
+      notify: Restart php-fpm
 
-  when: php_install_xdebug
 
-- block:
+- name: BLOCK | Uninstall xdebug
+  when: not php_install_xdebug
+  block:
 
     - name: APT | Uninstall xdebug
       ansible.builtin.apt:
@@ -38,5 +42,3 @@
         name: "{{ php_xdebug_package }}"
         state: absent
       when: ansible_os_family == 'FreeBSD'
-
-  when: not php_install_xdebug

templates/etc/__php__/fpm/pool.d/pool.conf.j2

@@ -421,10 +421,19 @@ catch_workers_output = {{ item.catch_workers_output | default('no') }}
 ;php_admin_value[error_log] = /var/log/fpm-php.www.log
 ;php_admin_flag[log_errors] = on
 ;php_admin_value[memory_limit] = 32M
+{% if item.php_env is defined %}
+{% for k, v in item.php_env.items() | list %}
+env[{{ k }}] = {{ v }}
+{% endfor %}
+{% endif %}
+{% if item.php_value is defined %}
 {% for k, v in item.php_value.items() | list %}
 php_value[{{ k }}] = {{ v }}
 {% endfor %}
+{% endif %}
+{% if item.php_admin_value is defined %}
 {% for k, v in item.php_admin_value.items() | list %}
 php_admin_value[{{ k }}] = {{ v }}
 {% endfor %}
+{% endif %}
 ; vim:filetype=dosini

tests/test.yml

@@ -1,6 +1,7 @@
 ---
 
 - hosts: all
+  name: Test all
   vars:
     vhost: 'test.local'
     php_extra_packages:
@@ -24,6 +25,8 @@
         ping_response: 'ok'
       - name: 'test_ansible2'
         user: 'foo'
+        php_env:
+          foo: bar
         php_value:
           display_errors: 'Off'
         php_admin_value:
@@ -46,24 +49,24 @@
     - name: TEMPLATE | Nginx site config
       ansible.builtin.template:
         src: "templates/nginx.conf.j2"
-        dest: "{{ __nginx_conf  }}"
+        dest: "{{ __nginx_conf }}"
         mode: 0644
         owner: root
         group: root
-      notify: reload nginx
+      notify: Reload nginx
 
     - name: COMMAND | Fix nginx config
       ansible.builtin.command: "cp {{ __nginx_conf | dirname }}/fastcgi_params {{ __nginx_conf | dirname }}/fastcgi.conf"
       args:
         creates: "{{ __nginx_conf | dirname }}/fastcgi.conf"
-      notify: reload nginx
+      notify: Reload nginx
 
     - name: LINEINFILE | Fix nginx config (second step)
       ansible.builtin.lineinfile:
         regexp: '^fastcgi_param\s+SCRIPT_FILENAME'
         line: "fastcgi_param  SCRIPT_FILENAME    $realpath_root$fastcgi_script_name;"
         dest: "{{ __nginx_conf | dirname }}/fastcgi.conf"
-      notify: reload nginx
+      notify: Reload nginx
 
     - name: SERVICE | Ensure nginx is started
       ansible.builtin.service:
@@ -71,7 +74,9 @@
         state: started
       when: ansible_virtualization_type != 'docker'
 
-    - block:
+    - name: Start nginx if testing with Docker
+      when: ansible_virtualization_type == 'docker'
+      block:
 
         - name: COMMAND | Docker nginx status
           ansible.builtin.command: service nginx status
@@ -87,21 +92,19 @@
             warn: false
           when: ngs.stdout.find('nginx is not running') != -1
 
-      when: ansible_virtualization_type == 'docker'
-
   handlers:
 
-    - name: reload nginx
+    - name: Reload nginx
       ansible.builtin.service:
         name: nginx
         state: reloaded
-      notify: docker reload nginx
+      notify: Docker reload nginx
 
-    - name: docker reload nginx
+    - name: Docker reload nginx
       ansible.builtin.command: service nginx reload
       args:
         warn: false
-      notify: docker reload nginx
+      notify: Docker reload nginx
       when: ansible_virtualization_type == 'docker'
 
   roles:
@@ -167,3 +170,21 @@
       ansible.builtin.uri:
         url: "http://localhost{{ php_fpm_poold.0.status_path }}"
       when: php_fpm_poold.0.status_path is defined
+
+    - name: Debian extra checks
+      when: ansible_os_family == 'Debian'
+      block:
+
+        - name: SHELL | Check if we installed multiple PHP versions
+          ansible.builtin.shell: set -o pipefail && (dpkg -l | grep 'php[[:digit:]].*common' | wc -l)
+          args:
+            executable: /bin/bash
+          failed_when: false
+          changed_when: false
+          register: check_multiple_php
+
+
+        - name: FAIL | If we have multiple PHP version
+          ansible.builtin.fail:
+            msg: "Multiple PHP versions detected"
+          when: check_multiple_php.stdout != '1'

vars/Debian-stretch.yml

@@ -1,3 +0,0 @@
----
-
-php_default_version: '7.0'

vars/OS_Family_Debian.yml

@@ -7,7 +7,8 @@ php_packages:
   - '{{ php_package_prefix }}mysql'
   - '{{ php_package_prefix }}intl'
 
-php_xdebug_package: 'php-xdebug'
+php_xdebug_package: '{% if multiple_php.rc == 0 %}{{ php_package_prefix }}{% else %}php-{% endif %}xdebug'
+php_apcu_package: '{% if multiple_php.rc == 0 %}{{ php_package_prefix }}{% else %}php-{% endif %}apcu'
 
 php_package_prefix: 'php{{ php_version }}-'