Merge pull request #13 from renatomefi/improvement/report-fpm-no-status-page

Report fpm no status page

Author: renatomefi

php-fpm-healthcheck

@@ -18,7 +18,8 @@
 # Ping mode with data (outputs php-fpm status text): ./php-fpm-healthcheck -v
 #
 # Exit status codes:
-# 9 - Couldn't reach PHP fpm status page, have you configured it with `pm.status_path = /status`?
+# 2,9,111 - Couldn't connect to PHP fpm, is it running?
+# 8 - Couldn't reach PHP fpm status page, have you configured it with `pm.status_path = /status`?
 # 1 - A healthcheck condition has failed
 # 3 - Invalid option given
 # 4 - One or more required softwares are missing
@@ -55,10 +56,15 @@ get_fpm_status() {
     if test "$VERBOSE" = 1; then printf "Trying to connect to php-fpm via: %s\\n" "$1"; fi;
 
     # Since I cannot use pipefail I'll just split these in two commands
-    FPM_STATUS=$(cgi-fcgi -bind -connect "$1")
+    FPM_STATUS=$(cgi-fcgi -bind -connect "$1" 2> /dev/null)
     FPM_STATUS=$(echo "$FPM_STATUS" | tail +5)
 
     if test "$VERBOSE" = 1; then printf "php-fpm status output:\\n%s\\n" "$FPM_STATUS"; fi;
+
+    if test "$FPM_STATUS" = "File not found."; then
+        >&2 printf "php-fpm status page non reachable\\n";
+        exit 8;
+    fi;
 }
 
 # $1 - fpm option

test/docker.sh

@@ -3,7 +3,8 @@
 # Author: <Renato Mefi [email protected]> https://github.com/renatomefi
 #
 # This script is suppose to be ran via Makefile, i.e.:
-# $ make test-image IMAGE="php:7.2-fpm-alpine3.7"
+# $ make test-image DOCKERFILE="alpine" IMAGE="php:7.2-fpm-alpine3.7"
+# $ make test-image DOCKERFILE="stretch" IMAGE="php:7.2-fpm-stretch"
 
 set -eEuo pipefail
 

test/testinfra/test_fpm.py

@@ -0,0 +1,57 @@
+import pytest
+
+@pytest.mark.php_fpm
+def test_exit_when_no_status_page_is_configured(host):
+    # disable fpm status page
+    host.run("sed -i /usr/local/etc/php-fpm.d/zz-docker.conf -e '/pm.status_path/ s/^;*/;/'")
+    host.run("kill -USR2 1")
+    
+    cmd = host.run("php-fpm-healthcheck -v")
+    assert cmd.rc == 8
+    assert "Trying to connect to php-fpm via:" in cmd.stdout
+    assert "status output:" in cmd.stdout
+    assert "php-fpm status page non reachable" in cmd.stderr
+
+    # enable fpm status page back
+    host.run("sed -i /usr/local/etc/php-fpm.d/zz-docker.conf -e '/;pm.status_path/ s/^;*//'")
+    host.run("kill -USR2 1")
+
+@pytest.mark.php_fpm
+def test_fpm_on_socket(host):
+    # change fpm to socket
+    host.run("sed -i /usr/local/etc/php-fpm.d/zz-docker.conf -e '/^listen/ s/.*/listen = \\/var\\/run\\/php-fpm.sock/'")
+    host.run("kill -USR2 1")
+    
+    cmd = host.run("FCGI_CONNECT=/var/run/php-fpm.sock php-fpm-healthcheck -v")
+    assert cmd.rc == 0
+    assert "Trying to connect to php-fpm via:" in cmd.stdout
+    assert "status output:" in cmd.stdout
+    assert "pool:" in cmd.stdout
+
+    # change fpm back to port 9000
+    host.run("sed -i /usr/local/etc/php-fpm.d/zz-docker.conf -e '/^listen/ s/.*/listen = 9000/'")
+    host.run("kill -USR2 1")
+
+@pytest.mark.alpine
+def test_exit_when_fpm_is_not_reachable_apk(host):
+    cmd = host.run("FCGI_CONNECT=localhost:9001 php-fpm-healthcheck -v")
+    assert cmd.rc == 9
+    assert "Trying to connect to php-fpm via: localhost:9001" in cmd.stdout
+
+@pytest.mark.alpine
+def test_exit_when_fpm_is_invalid_host_apk(host):
+    cmd = host.run("FCGI_CONNECT=abc php-fpm-healthcheck -v")
+    assert cmd.rc == 9
+    assert "Trying to connect to php-fpm via: abc" in cmd.stdout
+
+@pytest.mark.stretch
+def test_exit_when_fpm_is_not_reachable_apt(host):
+    cmd = host.run("FCGI_CONNECT=localhost:9001 php-fpm-healthcheck -v")
+    assert cmd.rc == 111
+    assert "Trying to connect to php-fpm via: localhost:9001" in cmd.stdout
+
+@pytest.mark.stretch
+def test_exit_when_fpm_is_invalid_host_apt(host):
+    cmd = host.run("FCGI_CONNECT=abc php-fpm-healthcheck -v")
+    assert cmd.rc == 2
+    assert "Trying to connect to php-fpm via: abc" in cmd.stdout