Add template for blackfire profiling

Author: piggito

README.md

@@ -117,6 +117,7 @@ networks:
 * `make front` - Builds frontend tasks.
 * `make lint` - Runs frontend linters.
 * `make storybook` - Runs storybook in current theme.
+* `make blackfire` - Adds and enables blackfire.io php extension, needs [configuration](https://blackfire.io/docs/configuration/php) in docker-composer override.yml.
 
 #### Additional goals
 

docker/docker-compose.override.yml.default

@@ -6,6 +6,8 @@ services:
   php:
     environment:
       COMPOSER_MEMORY_LIMIT: "-1"
+#      BLACKFIRE_CLIENT_ID: x
+#      BLACKFIRE_CLIENT_TOKEN: x
     volumes:
       - "./90-mail.ini:/etc/php7/conf.d/90-mail.ini:z"
 #    depends_on:
@@ -14,6 +16,19 @@ services:
 # Uncomment next line if you need PHP XDebug.
 #    command: php-fpm7 -F -d zend_extension=xdebug.so
 
+# Get access keys from https://blackfire.io/my/profiles
+# Then download extension using "make blackfire"
+
+#  blackfire:
+#    image: blackfire/blackfire
+#    container_name: "${COMPOSE_PROJECT_NAME}_blackfire"
+#    environment:
+#      BLACKFIRE_SERVER_ID: x
+#      BLACKFIRE_SERVER_TOKEN: x
+#      BLACKFIRE_LOG_LEVEL: 1
+#    networks:
+#      - front
+
 #  adminer:
 #    image: dockette/adminer:mysql-php7
 #    container_name: "${COMPOSE_PROJECT_NAME}_adminer"

scripts/makefile/blackfire.sh

@@ -0,0 +1,26 @@
+#!/usr/bin/env sh
+
+# installs backfire/io probe extension
+
+# use `php -i | grep "additional .ini"` to get it
+PHP_INI_DIR=/etc/php7/conf.d
+
+set -e
+
+env_vars='BLACKFIRE_CLIENT_ID BLACKFIRE_CLIENT_TOKEN'
+
+for var in $env_vars; do
+	eval "val=\${$var}"
+	if [ -z "${val}" -o "${val}" = 'x' ]; then
+		echo "Configure ${var} in docker-compose.override.yml"
+		echo "Visit https://blackfire.io/my/settings/credentials to get credentials"; exit 1
+	fi
+done
+
+version=$(php -r "echo PHP_MAJOR_VERSION.PHP_MINOR_VERSION;") \
+	&& curl -A "Docker" -o /tmp/blackfire-probe.tar.gz -D - -L -s https://blackfire.io/api/v1/releases/probe/php/alpine/amd64/$version \
+	&& mkdir -p /tmp/blackfire \
+	&& tar zxpf /tmp/blackfire-probe.tar.gz -C /tmp/blackfire \
+	&& mv /tmp/blackfire/blackfire-*.so $(php -r "echo ini_get ('extension_dir');")/blackfire.so \
+	&& printf "extension=blackfire.so\nblackfire.agent_socket=tcp://blackfire:8707\n" > $PHP_INI_DIR/blackfire.ini \
+	&& rm -rf /tmp/blackfire /tmp/blackfire-probe.tar.gz

scripts/makefile/tests.mk

@@ -187,3 +187,12 @@ sniffers: | clang compval phpcs newlineeof
 ## Run all tests & validations (including sniffers)
 tests: | sniffers cinsp drupalrectorval upgradestatusval behat watchdogval statusreportval
 
+blackfire:
+ifneq ("$(wildcard scripts/makefile/blackfire.sh)","")
+	$(call php-0, /bin/sh ./scripts/makefile/blackfire.sh)
+	$(call php-0, kill -USR2 1)
+	@echo "Blackfire extension enabled"
+else
+	@echo "scripts/makefile/blackfire.sh file does not exist"
+	@exit 1
+endif