Don't remove acme.sh keys if acme.sh fails

Sometimes fu****** systemd don't want you to restart nginx in a loop. I
t crashes the role.

.travis.yml

@@ -1,8 +1,10 @@
 env:
   - PLATFORM='docker-debian-stretch'          ANSIBLE_VERSION='ansible>=2.6,<2.7'
   - PLATFORM='docker-debian-stretch-sury'     ANSIBLE_VERSION='ansible>=2.6,<2.7'
+  - PLATFORM='docker-debian-buster'           ANSIBLE_VERSION='ansible>=2.6,<2.7'
   - PLATFORM='docker-debian-stretch'          ANSIBLE_VERSION='ansible>=2.7,<2.8'
   - PLATFORM='docker-debian-stretch-sury'     ANSIBLE_VERSION='ansible>=2.7,<2.8'
+  - PLATFORM='docker-debian-buster'           ANSIBLE_VERSION='ansible>=2.7,<2.8'
 
 
 matrix:
@@ -13,6 +15,7 @@ sudo: required
 dist: trusty
 
 language: python
+python: 2.7
 
 services:
   - docker

README.md

@@ -24,6 +24,7 @@ Supported OS:
 | ------------------ | ------- | ----------------------- |
 | Debian Jessie (8)  | Yes     | Check latest supported version ([1.5.0](https://github.com/HanXHX/ansible-nginx/releases/tag/1.5.0)) |
 | Debian Stretch (9) | Yes     | Yes                     |
+| Debian Buster (10) | Yes     | No                      |
 | FreeBSD 11         | Yes     | No                      |
 | FreeBSD 12         | Yes     | No                      |
 

Vagrantfile

@@ -7,7 +7,8 @@ Vagrant.configure("2") do |config|
 
   vms_debian = [
     { :name => "debian-stretch", :box => "debian/stretch64", :vars => { "nginx_php": [{"version": "7.0"}] }},
-    { :name => "debian-stretch-sury", :box => "debian/stretch64", :vars => { "nginx_php": [{"version": "7.1"}], "sury": true }}
+    { :name => "debian-stretch-sury", :box => "debian/stretch64", :vars => { "nginx_php": [{"version": "7.1"}], "sury": true }},
+    { :name => "debian-buster", :box => "debian/buster64", :vars => { "nginx_php": [{"version": "7.3"}] }}
   ]
 
   vms_freebsd = [
@@ -17,7 +18,8 @@ Vagrant.configure("2") do |config|
 
   conts = [
     { :name => "docker-debian-stretch", :docker => "hanxhx/vagrant-ansible:debian9", :vars => { "nginx_php": [{"version": "7.0"}] }},
-    { :name => "docker-debian-stretch-sury", :docker => "hanxhx/vagrant-ansible:debian9", :vars => { "nginx_php": [{"version": "7.1"}], "sury": true }}
+    { :name => "docker-debian-stretch-sury", :docker => "hanxhx/vagrant-ansible:debian9", :vars => { "nginx_php": [{"version": "7.1"}], "sury": true }},
+    { :name => "docker-debian-buster", :docker => "hanxhx/vagrant-ansible:debian10", :vars => { "nginx_php": [{"version": "7.3"}] }},
   ]
 
   config.vm.network "private_network", type: "dhcp"
@@ -34,7 +36,7 @@ Vagrant.configure("2") do |config|
         ansible.playbook = "tests/test.yml"
         ansible.verbose = 'vv'
         ansible.become = true
-        ansible.extra_vars = opts[:vars].merge({ "nginx_debug_role": true })
+        ansible.extra_vars = opts[:vars].merge({ "nginx_debug_role": true, is_docker: true })
       end
     end
   end

doc/auth.md

@@ -1,11 +1,6 @@
 Auth Basic management
 =====================
 
-IMPORTANT
----------
-
-If you use this feature with Debian Stretch, you *MUST* use ansible >= 2.3.2! See: [https://github.com/HanXHX/ansible-nginx/issues/28](#28).
-
 Description
 -----------
 

filter_plugins/nginx.py

@@ -10,11 +10,29 @@ def nginx_site_name(site):
     else:
         return site['name']
 
+def nginx_ssl_dir(pair, ssl_dir):
+    return ssl_dir + '/' + nginx_site_filename(pair)
+
+def nginx_key_path(pair, ssl_dir):
+    if pair.has_key('dest_key'):
+        return pair['dest_key']
+    else:
+        return nginx_ssl_dir(pair, ssl_dir) + '/' + nginx_site_filename(pair) + '.key'
+
+def nginx_cert_path(pair, ssl_dir):
+    if pair.has_key('dest_cert'):
+        return pair['dest_cert']
+    else:
+        return nginx_ssl_dir(pair, ssl_dir) + '/' + nginx_site_filename(pair) + '.crt'
+
 class FilterModule(object):
     ''' Nginx module '''
 
     def filters(self):
         return {
             'nginx_site_filename': nginx_site_filename,
-            'nginx_site_name': nginx_site_name
+            'nginx_site_name': nginx_site_name,
+            'nginx_ssl_dir': nginx_ssl_dir,
+            'nginx_key_path': nginx_key_path,
+            'nginx_cert_path': nginx_cert_path
         }

filter_plugins/php.py

@@ -1,17 +1,11 @@
 def php_default_upstream_socket(php_version):
-    if php_version == '5.6':
+    return '/run/php/php%s-fpm.sock' % php_version
-        return '/run/php5-fpm.sock'
-    else:
-        return '/run/php/php%s-fpm.sock' % php_version
 
 def php_default_upstream_name(php_version):
     return 'default_php_%s' % php_version
 
 def php_fpm_service(php_version):
-    if php_version == '5.6':
+    return 'php%s-fpm' % php_version
-        return 'php5-fpm'
-    else:
-        return 'php%s-fpm' % php_version
 
 class FilterModule(object):
     ''' PHP module '''

meta/main.yml

@@ -9,6 +9,7 @@ galaxy_info:
   - name: Debian
     versions:
     - stretch
+    - buster
   - name: FreeBSD
     versions:
     - 11.0
@@ -25,4 +26,3 @@ galaxy_info:
   - nginx
   - cdn
 dependencies: []
-

tasks/install_Debian.yml

@@ -1,22 +1,19 @@
 ---
 
+- name: SET_FACT | Bypass https://github.com/ansible/ansible/issues/19874
+  set_fact:
+    ansible_distribution_release: 'buster'
+  when: ansible_facts.distribution_major_version == "buster/sid"
+
 - name: APT | Update cache
   apt:
     update_cache: yes
     cache_valid_time: 3600
   changed_when: false
 
-- name: APT | Force OpenSSL from backports (fix dependency break)
-  apt:
-    pkg: openssl
-    state: latest
-    default_release: "{{ ansible_distribution_release + '-backports' }}"
-  when: nginx_backports
-
 - name: APT | Install nginx and dependencies
   apt:
     pkg: "{{ nginx_apt_package }}"
-    state: present
     default_release: "{{ ansible_distribution_release + '-backports' if nginx_backports else ansible_distribution_release }}"
 
 - name: APT | Install nginx modules
@@ -45,9 +42,10 @@
       repo: 'https://github.com/Neilpang/acme.sh.git'
       dest: '{{ nginx_acmesh_git_dir }}'
       update: no
+      version: master
 
-  - name: SHELL | Install acme.sh
+  - name: COMMAND | Install acme.sh
-    shell: ./acme.sh --install --home {{ nginx_acmesh_dir }} --cert-home {{ nginx_acmesh_dir }}
+    command: ./acme.sh --install --home "{{ nginx_acmesh_dir }}"
     args:
       chdir: "{{ nginx_acmesh_git_dir }}"
       creates: "{{ nginx_acmesh_dir }}"

tasks/prepare.yml

@@ -7,14 +7,24 @@
   register: nginx_version
   changed_when: false
   check_mode: no
+  tags:
+    - skip_ansible_lint
 
 - name: SHELL | Get module list
-  shell: nginx -V 2>&1 | tr -- - '\n' | grep -A 1 with | grep _module | sed -r 's/_module//g; s/\s+//g' | sort
+  shell: |
+    nginx -V 2>&1 |
+    tr -- - '\n' |
+    grep -A 1 with |
+    grep _module |
+    sed -r 's/_module//g; s/\s+//g' |
+    sort
   args:
     executable: /bin/sh
   register: shell_modules
   changed_when: false
   check_mode: no
+  tags:
+    - skip_ansible_lint
 
 - name: SET_FACT | Save modules
   set_fact:

tasks/site.yml

@@ -75,7 +75,7 @@
 
 - name: FILE | Disable sites
   file:
-    path: "{{ nginx_etc_dir}}/sites-enabled/{{ item | nginx_site_filename }}"
+    path: "{{ nginx_etc_dir }}/sites-enabled/{{ item | nginx_site_filename }}"
     state: absent
   loop: "{{ nginx_sites }}"
   notify: ['reload nginx', 'restart nginx freebsd']

tasks/ssl/acme.yml

@@ -17,56 +17,82 @@
   loop: "{{ acme_installed_certs.results }}"
   when: item.skipped is not defined and not item.stat.exists
 
-- name: TEMPLATE | Create fake site
+- name: BLOCK | Start acme
-  template:
+  block:
-    src: "etc/nginx/conf.d/FAKESITE.conf.j2"
-    dest: "{{ nginx_etc_dir }}/conf.d/FAKESITE_{{ item | nginx_site_name }}.conf"
-  loop: "{{ acme_create }}"
-  register: fake_site
 
-- name: FILE | Delete current site if needed
+  - name: TEMPLATE | Create fake site
-  file:
+    template:
-    path: "{{ nginx_etc_dir }}/sites-enabled/{{ item | nginx_site_name }}"
+      src: "etc/nginx/conf.d/FAKESITE.conf.j2"
-    state: absent
+      dest: "{{ nginx_etc_dir }}/conf.d/FAKESITE_{{ item | nginx_site_name }}.conf"
-  loop: "{{ acme_create }}"
+    loop: "{{ acme_create }}"
-  when: fake_site.changed
+    register: fake_site
 
-- name: SERVICE | Restart nginx
+  - name: FILE | Delete current site if needed
-  service:
+    file:
-    name: nginx
+      path: "{{ nginx_etc_dir }}/sites-enabled/{{ item | nginx_site_name }}"
-    state: restarted
+      state: absent
-  when: fake_site.changed and ansible_virtualization_type != 'docker'
+    loop: "{{ acme_create }}"
+    when: fake_site.changed
 
-- name: COMMAND | Restart nginx
+  - name: SERVICE | Restart nginx
-  command: service nginx restart
+    service:
-  args:
+      name: nginx
-    warn: false
+      state: restarted
-  when: fake_site.changed and ansible_virtualization_type == 'docker'
+    when: fake_site.changed and ansible_virtualization_type != 'docker'
 
-- name: SHELL | Get certificates
+  - name: COMMAND | Restart nginx
-  shell: '{{ nginx_acmesh_bin }} --issue{% if item.name is string %} -d {{ item.name }}{% else %}{% for name in item.name %} -d {{ name }}{% endfor %}{% endif %} --nginx {% if nginx_acmesh_test %}--test{% endif %}'
+    command: service nginx restart
-  args:
+    args:
-    creates: "/root/.acme.sh/{{ item | nginx_site_name }}/{{ item | nginx_site_name }}.key"
+      warn: false
-  loop: "{{ acme_create }}"
+    when: fake_site.changed and ansible_virtualization_type == 'docker'
-  register: acme_get
-  failed_when: acme_get.rc != 0 and acme_get.rc != 2
-  no_log: not nginx_debug_role
 
-- name: FILE | Create SSL dir per site
+  - name: COMMAND | Get certificates
-  file:
+    command: |
-    path: "{{ nginx_ssl_dir }}/{{ item | nginx_site_name }}"
+      {{ nginx_acmesh_bin }}
-  loop: "{{ acme_create }}"
+        --home {{ nginx_acmesh_dir }}
+        --issue{% if item.name is string %} -d {{ item.name }}{% else %}{% for name in item.name %} -d {{ name }}{% endfor %}{% endif %}
+        --nginx
+        {% if nginx_acmesh_test %}--test{% endif %}
+    args:
+      creates: "{{ nginx_acmesh_dir }}/{{ item | nginx_site_name }}/{{ item | nginx_site_name }}.key"
+    loop: "{{ acme_create }}"
+    register: acme_get
+    failed_when: acme_get.rc != 0 and acme_get.rc != 2
+    no_log: not nginx_debug_role
 
-- name: SHELL | Install certificates
+  - name: FILE | Create SSL dir per site
-  shell: '{{ nginx_acmesh_bin }} --install-cert -d {{ item | nginx_site_name }} --fullchain-file {{ nginx_ssl_dir }}/{{ item | nginx_site_name }}/{{ item | nginx_site_name }}.crt --key-file {{ nginx_ssl_dir }}/{{ item | nginx_site_name }}/{{ item | nginx_site_name }}.key --reloadcmd "service nginx restart"'
+    file:
-  args:
+      path: "{{ nginx_ssl_dir }}/{{ item | nginx_site_name }}"
-    creates: "{{ nginx_ssl_dir }}/{{ item | nginx_site_name }}/{{ item | nginx_site_name }}.key"
+    loop: "{{ acme_create }}"
-  loop: "{{ nginx_ssl_pairs }}"
-  when: item.acme is defined and item.acme
-  notify: restart nginx
 
-- name: FILE | Delete fake sites
+  - name: COMMAND | Install certificates
-  file:
+    command: |
-    path: "{{ nginx_etc_dir }}/conf.d/FAKESITE_{{ item | nginx_site_name }}.conf"
+      {{ nginx_acmesh_bin }}
-    state: absent
+        --home {{ nginx_acmesh_dir }}
-  loop: "{{ acme_create }}"
+        --install-cert -d {{ item | nginx_site_name }}
+        --fullchain-file {{ nginx_ssl_dir }}/{{ item | nginx_site_name }}/{{ item | nginx_site_name }}.crt
+        --key-file {{ nginx_ssl_dir }}/{{ item | nginx_site_name }}/{{ item | nginx_site_name }}.key
+        --reloadcmd "service nginx reload"
+    args:
+      creates: "{{ nginx_ssl_dir }}/{{ item | nginx_site_name }}/{{ item | nginx_site_name }}.key"
+    loop: "{{ nginx_ssl_pairs }}"
+    when: item.acme is defined and item.acme
+    notify: restart nginx
+
+  rescue:
+
+  - name: FAIL | Explicit
+    fail:
+      msg: "Something is bad... Auto crash!"
+
+  always:
+
+  - name: FILE | Delete fake sites
+    file:
+      path: "{{ nginx_etc_dir }}/conf.d/FAKESITE_{{ item | nginx_site_name }}.conf"
+      state: absent
+    loop: "{{ acme_create }}"
+    notify: restart nginx
+
+  - name: META | Flush handlers
+    meta: flush_handlers

tasks/ssl/standard.yml

@@ -30,7 +30,7 @@
 
 - name: FILE | Create SSL directories
   file:
-    path: "{{ nginx_ssl_dir + '/' + item | nginx_site_name }}"
+    path: "{{ item | nginx_ssl_dir(nginx_ssl_dir) }}"
     state: directory
   loop: "{{ nginx_ssl_pairs }}"
   when: item.dest_key is not defined or item.dest_cert is not defined
@@ -39,7 +39,7 @@
 - name: COPY | Deploy SSL keys
   copy:
     content: "{{ item.key }}"
-    dest: "{{ nginx_ssl_dir + '/' + item | nginx_site_name + '/' + item | nginx_site_name + '.key' if item.dest_key is not defined else item.dest_key }}"
+    dest: "{{ item | nginx_key_path(nginx_ssl_dir) }}"
     mode: 0640
   loop: "{{ nginx_ssl_pairs }}"
   when: item.key is defined
@@ -49,7 +49,7 @@
 - name: COPY | Deploy SSL certs
   copy:
     content: "{{ item.cert }}"
-    dest: "{{ nginx_ssl_dir + '/' + item | nginx_site_name + '/' + item | nginx_site_name + '.crt' if item.dest_cert is not defined else item.dest_cert }}"
+    dest: "{{ item | nginx_cert_path(nginx_ssl_dir) }}"
     mode: 0644
   loop: "{{ nginx_ssl_pairs }}"
   when: item.cert is defined
@@ -57,10 +57,15 @@
   no_log: not nginx_debug_role
 
 - name: COMMAND | Create self-signed certificates
-  command: "openssl req -new -newkey rsa:2048 -sha256 -days 3650 -nodes -x509 -subj '/CN={{ item | nginx_site_name }}' -keyout {{ item | nginx_site_name + '.key' }} -out {{ item | nginx_site_name + '.crt' }}"
+  command: |
+    openssl req
+      -new -newkey rsa:2048 -sha256 -days 3650 -nodes -x509
+      -subj '/CN={{ item | nginx_site_name }}'
+      -keyout {{ item | nginx_key_path(nginx_ssl_dir) }}
+      -out {{ item | nginx_cert_path(nginx_ssl_dir) }}
   args:
-    chdir: "{{ nginx_ssl_dir + '/' + item | nginx_site_name }}"
+    chdir: "{{ item | nginx_ssl_dir(nginx_ssl_dir) }}"
-    creates: "{% if item.force is defined and item.force %}/tmp/dummy{% else %}{{ nginx_ssl_dir + '/' + item | nginx_site_name + '/' + item | nginx_site_name + '.crt' }}{% endif %}"
+    creates: "{{ '/tmp/dummy' if item.force is defined and item.force else item | nginx_cert_path(nginx_ssl_dir) }}"
   loop: "{{ nginx_ssl_pairs }}"
   when: item.self_signed is defined
   notify: restart nginx

templates/etc/nginx/sites-available/_base.j2

@@ -10,6 +10,9 @@
 {% set __ssl_name = item.ssl_name | default(item.name if item.name is string else item.name[0]) %}
 {% set __location_order = item.location_order | default(__location.keys()) %}
 {% set __location_order_before = item.location_order_before | default(__location_before.keys()) %}
+{% macro server_name(name) %}
+{% if name is string %}{{ name }}{% else %}{{ name | join(" ") }}{% endif %}
+{% endmacro %}
 {% macro locations(list, order) %}
 {% if order | length > 0 %}
 	# --> Custom locations
@@ -38,8 +41,8 @@
 {%- endmacro %}
 {% macro ssl(ssl_name) %}
 {% for sn in nginx_ssl_pairs if ((sn.name is string and sn.name == ssl_name) or (sn.name.0 == ssl_name)) %}
-	ssl_certificate {{ nginx_ssl_dir + '/' + ssl_name + '/' + ssl_name + '.crt' if sn.dest_cert is not defined else sn.dest_cert }};
+	ssl_certificate {{ sn | nginx_cert_path(nginx_ssl_dir) }};
-	ssl_certificate_key {{ nginx_ssl_dir + '/' + ssl_name + '/' + ssl_name + '.key' if sn.dest_key is not defined else sn.dest_key }};
+	ssl_certificate_key {{ sn | nginx_key_path(nginx_ssl_dir) }};
 {% endfor %}
 {%- endmacro %}
 {% macro httpsredirect(name) %}
@@ -47,7 +50,7 @@ server {
 {% for port in __listen %}
 	listen {{ port }}{% if port | int in __http_proxy_protocol_port %} proxy_protocol{% endif %};
 {% endfor %}
-	server_name {{ name }};
+	server_name {{ server_name(name) }};
 	location / {
 		return 301 https://{{ name }}{% if '443' not in __listen_ssl and 443 not in __listen_ssl %}:{{ __listen_ssl[0] }}{% endif %}$request_uri;
 	}
@@ -76,7 +79,7 @@ server {
 	include {{ nginx_helper_dir + '/ssl-' + item.ssl_template | default('strong') }};
 {% endif %}
 {% endif %}
-	server_name {% if item.name is string %}{{ item.name }}{% else %}{{ "\n\t\t"  }}{{ item.name | join("\n\t\t") }}{% endif %};
+	server_name {{ server_name(item.name) }};
 {% block root %}
 {% if item.root is defined %}
 	root {{ item.root }};
@@ -181,7 +184,7 @@ server {
 {% for port in __listen %}
 	listen {{ port }}{% if port | int in __http_proxy_protocol_port %} proxy_protocol{% endif %};
 {% endfor %}
-	server_name {% if item.redirect_from is string %}{{ item.redirect_from }}{% else %}{{ "\n\t\t" }}{{ item.redirect_from | join("\n\t\t") }}{% endif %};
+	server_name {{ server_name(item.redirect_from) }};
 	location / {
 		return 301 $scheme://{{ item.name if item.name is string else item.name[0] }}$request_uri;
 	}
@@ -196,7 +199,7 @@ server {
 {% if item.ssl_template is not defined or item.ssl_template != false %}
 	include {{ nginx_helper_dir + '/ssl-' + item.ssl_template | default('strong') }};
 {% endif %}
-	server_name {% if item.redirect_from is string %}{{ item.redirect_from }}{% else %}{{ "\n\t\t" }}{{ item.redirect_from | join("\n\t\t") }}{% endif %};
+	server_name {{ server_name(item.redirect_from) }};
 	location / {
 		return 301 https://{{ item.name if item.name is string else item.name[0] }}{% if '443' not in __listen_ssl and 443 not in __listen_ssl %}:{{ __listen_ssl[0] }}{% endif %}$request_uri;
 	}

tests/includes/post_Debian.yml

@@ -1,6 +1,6 @@
 ---
 
-- name: APT | Install webapps
+- name: APT | Install webapps and related tools
   apt:
     pkg: "{{ packages }}"
     state: present
@@ -8,8 +8,12 @@
   vars:
     packages:
       - backuppc
+      - samba-common-bin
+      - smbclient
 
 - name: SERVICE | Ensure backuppc is started
   service:
     name: backuppc
     state: started
+  register: b
+  failed_when: b.failed and 'Another BackupPC is running' not in b.msg

tests/test.yml

@@ -23,10 +23,20 @@
         src: "file/test.key"
         dest: "{{ int_ansible_ssl_dir }}/test.key"
 
-    - name: LINEINFILE | Add all hosts in /etc/hosts
+    - name: COPY | Add all hosts in /etc/hosts
-      lineinfile:
+      copy:
-        line: "127.0.0.1\tlocalhost {% for s in nginx_sites %}{% if s.name is string %}{{ s.name }}{% else %}{% for n in s.name %}{{ n }} {% endfor %}{% endif %} {% if s.redirect_from is defined %}{% for rf in s.redirect_from %}{{ rf }} {% endfor %}{% endif %}{% endfor %}"
+        content: |
-        regexp: '^127\.0\.0\.1'
+          127.0.0.1 localhost
+          {% for s in nginx_sites %}
+          {% if s.name is string %}
+          127.0.0.1 {{ s.name }}
+          {% else %}
+          127.0.0.1 {% for n in s.name %}{{ n }} {% endfor %}
+          {% endif %}
+          {% if s.redirect_from is defined %}
+          127.0.0.1 {% for rf in s.redirect_from %}{{ rf }} {% endfor %}
+          {% endif %}
+          {% endfor %}
         dest: "/etc/hosts"
         unsafe_writes: yes
 
@@ -355,7 +365,7 @@
 # --------------------------------
     - name: -- VERIFY PHP SITES --
       uri:
-        url: "http://{{ item.name}}/"
+        url: "http://{{ item.name }}/"
         return_content: yes
       register: p
       loop: "{{ nginx_sites }}"
@@ -510,3 +520,5 @@
         executable: /bin/sh
       changed_when: false
       when: nginx_auto_config_httpv2 and 'http_v2' in nginx_modules
+      tags:
+        - skip_ansible_lint