Introduce tests with testinfra tool

Author: renatomefi

.circleci/config.yml

@@ -0,0 +1,53 @@
+version: 2
+
+default_workflow_jobs: &default_workflow_jobs
+  - lint
+  - test-latest:
+      requires:
+        - lint
+  - test-7.1:
+      requires:
+        - lint
+  - test-7.2:
+      requires:
+        - lint
+  - test-7.3:
+      requires:
+        - lint
+        
+workflows:
+  version: 2
+  lint-test:
+    jobs: *default_workflow_jobs
+
+jobs:
+  lint:
+    machine: true
+    steps:
+      - checkout
+      - run: make lint
+  test-latest:
+    machine: true
+    steps:
+      - checkout
+      - run: make test-image IMAGE="php:fpm-alpine"
+
+  test-7.1:
+    machine: true
+    steps:
+      - checkout
+      - run: make test-image IMAGE="php:7.1-fpm-alpine3.7"
+      - run: make test-image IMAGE="php:7.1-fpm-alpine3.8"
+
+  test-7.2:
+    machine: true
+    steps:
+      - checkout
+      - run: make test-image IMAGE="php:7.2-fpm-alpine3.7"
+      - run: make test-image IMAGE="php:7.2-fpm-alpine3.8"
+
+  test-7.3:
+    machine: true
+    steps:
+      - checkout
+      - run: make test-image IMAGE="php:7.3-rc-fpm-alpine3.8"

Makefile

@@ -5,8 +5,16 @@ current_dir := $(abspath $(patsubst %/,%,$(dir $(mkfile_path))))
 
 .PHONY: *
 
-lint:
-	docker run --rm -v ${current_dir}:/mnt:ro koalaman/shellcheck ./php-fpm-healthcheck
+lint: php-fpm-healthcheck
+	docker run --rm -v ${current_dir}:/mnt:ro koalaman/shellcheck ./php-fpm-healthcheck ./test/*.sh
 
 test:
-	test -f php-fpm-healthcheck
+	$(MAKE) test-image IMAGE="php:fpm-alpine"
+	$(MAKE) test-image IMAGE="php:7.1-fpm-alpine3.7"
+	$(MAKE) test-image IMAGE="php:7.1-fpm-alpine3.8"
+	$(MAKE) test-image IMAGE="php:7.2-fpm-alpine3.7"
+	$(MAKE) test-image IMAGE="php:7.2-fpm-alpine3.8"
+	$(MAKE) test-image IMAGE="php:7.3-rc-fpm-alpine3.8"
+
+test-image:
+	./test/docker.sh ${IMAGE}

php-fpm-healthcheck

@@ -103,10 +103,14 @@ check_fpm_health() {
     done
 }
 
+set +e
+
 GETOPT=$(getopt -o v --long verbose,accepted-conn:,listen-queue-len:,active-processes:,slow-requests: -n 'php-fpm-healthcheck' -- "$@")
 
 if test "$?" != 0; then >&2 echo "Invalid options, terminating." ; exit 3 ; fi
 
+set -e
+
 FCGI_CONNECT="${FCGI_CONNECT:-$FCGI_CONNECT_DEFAULT}"
 
 eval set -- "$GETOPT"

test/Dockerfile

@@ -0,0 +1,9 @@
+FROM php:7.2-fpm-alpine3.8
+
+# Required software
+RUN apk add --no-cache fcgi 
+
+# Enable php fpm status page
+RUN set -xe && echo "pm.status_path = /status" >> /usr/local/etc/php-fpm.d/zz-docker.conf
+
+COPY ./php-fpm-healthcheck /usr/local/bin/

test/docker.sh

@@ -0,0 +1,33 @@
+#!/bin/bash
+
+# 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"
+
+set -eEuo pipefail
+
+function cleanup {
+docker stop "$CONTAINER" 1> /dev/null
+    echo "container $CONTAINER: stopped"
+    docker rmi "$DOCKER_TAG_TEMPORARY"
+}
+trap cleanup EXIT
+
+declare -r DOCKER_IMAGE="$1"
+
+declare DOCKER_TAG_TEMPORARY
+DOCKER_TAG_TEMPORARY="$DOCKER_IMAGE-$(date +%s)"
+
+sed "s/FROM .*/FROM $DOCKER_IMAGE/g" ./test/Dockerfile | docker build -t "$DOCKER_TAG_TEMPORARY" -f - .
+
+declare CONTAINER
+CONTAINER=$(docker run -d --rm "$DOCKER_TAG_TEMPORARY")
+
+declare TESTS_DIR
+TESTS_DIR="$(pwd)/test"
+
+docker run --rm -t \
+    -v "$TESTS_DIR:/tests" \
+    -v /var/run/docker.sock:/var/run/docker.sock:ro \
+    renatomefi/docker-testinfra:latest --verbose --hosts="docker://$CONTAINER"

test/pytest.ini

@@ -0,0 +1,2 @@
+[pytest]
+python_files = testinfra/test_*.py

test/testinfra/test_command.py

@@ -0,0 +1,11 @@
+import pytest
+
+def test_healthcheck_script_is_available(host):
+    cmd = host.run("which php-fpm-healthcheck")
+    assert cmd.rc == 0
+
+def test_healthcheck_script_is_executable(host):
+    scriptFile = host.check_output("which php-fpm-healthcheck")
+      
+    assert host.file(scriptFile).exists is True
+    assert host.file(scriptFile).mode == 0o775

test/testinfra/test_execution.py

@@ -0,0 +1,28 @@
+import pytest
+
+def test_invalid_option_exits_properly(host):
+    cmd = host.run("php-fpm-healthcheck --invalid-option")
+    assert cmd.rc == 3
+
+    cmd = host.run("php-fpm-healthcheck --invalid-option=")
+    assert cmd.rc == 3
+
+def test_valid_with_empty_value_exits_properly(host):
+    cmd = host.run("php-fpm-healthcheck --listen-queue-len=")
+    assert cmd.rc == 3
+    assert "option value must be an integer" in cmd.stderr
+
+def test_valid_with_non_integer_value_exits_properly(host):
+    cmd = host.run("php-fpm-healthcheck --listen-queue-len=abc")
+    assert cmd.rc == 3
+    assert "option value must be an integer" in cmd.stderr
+
+def test_missing_fcgi(host):
+    host.run("apk del fcgi")
+    cmd = host.run("php-fpm-healthcheck")
+    assert cmd.rc == 4
+    assert "Make sure fcgi is installed" in cmd.stderr
+    
+    # Fail safe for other tests, maybe we could use a docker fixture
+    # to start a new container everytime
+    host.run("apk add --no-cache fcgi")

test/testinfra/test_metrics.py

@@ -0,0 +1,8 @@
+import pytest
+
+def test_metric_accepted_conn(host):
+    cmd = host.run("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

test/testinfra/test_ping.py

@@ -0,0 +1,12 @@
+import pytest
+
+def test_ping(host):
+    cmd = host.run("php-fpm-healthcheck")
+    assert cmd.rc == 0
+
+def test_ping_verbose(host):
+    cmd = host.run("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