Base Dockerfile and scripts to generate PHP images with xdebug.

Author: pszalko

Makefile

@@ -0,0 +1,21 @@
+.DEFAULT_GOAL = help
+
+.PHONY: help
+help:
+	@echo "Usage: make [option]"
+	@echo "Available options:"
+	@echo "* generate - generates Dockerfiles for all defined versions of PHP in all variants"
+	@echo "* build    - builds all generated Dockerfiles available in ./build directory"
+	@echo "* clean    - cleans ./build directory"
+	
+	
+.PHONY: clean
+clean:
+	@rm -rf ./build/*
+	@echo "Removed all files from ./build directory."
+	
+generate:
+	@./bin/generate.sh
+	
+build: generate
+	@./bin/build-all.sh mobtitude/php-xdebug

bin/build-all.sh

@@ -0,0 +1,63 @@
+#!/usr/bin/env bash
+
+#
+# Script builds all Dockerfiles defined in build directory
+# Prints summary after all images have been built (successfully or not)
+#
+
+image_name="$1"
+
+# Checks if image name was provided by user
+if [ -z "${image_name}" ]; then
+	echo "Usage: $0 [docker_image_name]" >&2
+	exit -1
+fi
+
+# Change current path to project root
+script_path=$(dirname "$0")
+cd "${script_path}/../" || exit -1
+
+# Text formatting
+text_bold=$(tput bold)
+text_red=$(tput setaf 1)
+text_normal=$(tput sgr0)
+
+# Summary arrays
+build_failed=()
+build_done=()
+
+# Loop through all available directories in ./build
+for i in ./build/*/; do
+	version=$(basename "$i");
+	image="${image_name}:${version}"
+	
+	echo "${text_bold}* Building ${image} ${text_normal}"
+	
+	# Builds image and check for return code
+	if docker build --pull -t "${image}" "./build/${version}"; then
+		build_done+=( "${image}" )
+	else
+		echo "${text_bold}${text_red}* ERROR when building ${image} ${text_normal}"
+		build_failed+=( "${image}" )
+	fi
+done
+
+
+# Prints summary for successful builds
+if [ "${#build_done[@]}" -gt 0 ]; then
+	echo "${text_bold}"
+	echo "Docker has successfully built the following images:${text_normal}"
+	for img in "${build_done[@]}"; do
+		echo "* ${img}"
+	done
+	echo -n "${text_normal}"
+fi
+
+# Prints summary for failed builds
+if [ "${#build_failed[@]}" -gt 0 ]; then
+	echo "${text_red}"
+	echo "Docker failed when building the following images:"
+	for img in "${build_failed[@]}"; do
+		echo "${text_red}* ${img}${text_normal}"
+	done
+fi

bin/generate.sh

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+#
+# Generates Dockerfiles for specified PHP versions
+#
+
+# PHP Versions that will be generated 
+php_versions=( "7.2" "7.1" "7.0" "5.6")
+
+# PHP variants that will be generated for each PHP version
+# final source image will be generated as follow: php:7.2-cli, php:7-2-apache and php:7.2-fpm
+php_docker_suffix=( "cli" "apache" "fpm" )
+
+# Map of xdebug versions for PHP images
+# PHP_VERSION => XDEBUG_VERSION
+declare -A xdebug_versions
+xdebug_versions=( 
+	["7.2"]="xdebug-2.6.0"
+	["7.1"]="xdebug-2.6.0"
+	["7.0"]="xdebug-2.6.0"
+	["5.6"]="xdebug-2.5.5"
+)
+
+
+# Changes current path to project root
+script_path=$(dirname "$0")
+cd "${script_path}/../" || exit -1
+
+# Generates Dockerfiles for each PHP version and variant
+for php_version in "${php_versions[@]}"; do	
+	for php_suffix in "${php_docker_suffix[@]}"; do
+		target_dir="./build/${php_version}-${php_suffix}"
+		target_dockerfile="${target_dir}/Dockerfile"
+		
+		base_image="php:${php_version}-${php_suffix}"
+		xdebug_version="${xdebug_versions[${php_version}]}"
+		
+		mkdir -p "${target_dir}"
+		cp ./src/xdebug.ini "${target_dir}/xdebug.ini"
+		
+		# shellcheck disable=SC2002
+		cat ./src/Dockerfile \
+			| sed "s/#BASE_IMAGE#/${base_image}/g" \
+			| sed "s/#XDEBUG_VERSION#/${xdebug_version}/g" \
+			> "${target_dockerfile}"
+		echo "Generated ${target_dockerfile}"
+	done
+done

src/Dockerfile

@@ -0,0 +1,8 @@
+FROM #BASE_IMAGE#
+MAINTAINER Przemek Szalko <[email protected]>
+
+RUN pecl channel-update pecl.php.net \
+	&& pecl install #XDEBUG_VERSION# \
+	&& curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
+
+COPY xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini

src/xdebug.ini

@@ -0,0 +1,13 @@
+[xdebug]
+zend_extension=xdebug.so
+
+xdebug.cli_color=1
+xdebug.profiler_enable=0
+xdebug.profiler_enable_trigger=1
+
+xdebug.profiler_output_dir="/tmp"
+xdebug.profiler_output_name="cachegrind.out.%H.%t.%p"
+
+xdebug.remote_enable=1
+xdebug.remote_connect_back=1
+xdebug.remote_port=9000