Add new docker setup with PHP 8.2, Apache 2.4, Cron and Supervisord

Author: bjoern-hempel

.env

@@ -36,13 +36,11 @@ IMAGE_APP=ixnode/php-api-version/${IMAGE_ADD}app
 # Namespace of app image (development)
 IMAGE_PHP=ixnode/php-api-version/${IMAGE_ADD}php
 
-# Namespace of nginx image
-IMAGE_NGINX=ixnode/php-api-version/${IMAGE_ADD}nginx
+# Namesapce of PostgreSQL image
+IMAGE_POSTGRESQL=postgres:14.7-alpine
 
-# Namespace of mysql image
-IMAGE_MYSQL=${IMAGE_ADD}mysql:8.0.31
-
-IMAGE_ADMINER=${IMAGE_ADD}adminer:4.8.1
+# Namespace of adminer image (development)
+IMAGE_ADMINER=ixnode/php-api-version/${IMAGE_ADD}adminer
 
 # The general URL of this project
 URL_PRODUCTION=php-api-version-bundle.ixnode.de
@@ -75,105 +73,117 @@ NETWORK_NAME_TRAEFIK_PUBLIC_LOCAL=traefik
 # Traefik network name (public)
 NETWORK_NAME_TRAEFIK_PUBLIC_PRODUCTION=traefik-public
 
-# https port (is usually not changed)
+# HTTP ports
 PORT_HTTP=80
-
-# https port (is usually not changed)
-PORT_HTTPS=443
-
-# Internal docker adminer http port (is usually not changed)
-PORT_MYSQL_INTERNAL=3306
-
-# Internal docker adminer http port (is usually not changed)
-PORT_HTTP_ADMINER_INTERNAL=8080
-
-# Internal docker mailhog http port (is usually not changed)
-PORT_HTTP_MAILHOG_INTERNAL=8025
-
-# Internal docker mailhog smtp port (is usually not changed)
-PORT_SMTP_MAILHOG_INTERNAL=1025
-
-# Expose api https port (To bypass the Traefik proxy or if it is not installed)
 PORT_HTTP_APP_EXPOSE=5080
 
-# Expose api https port (To bypass the Traefik proxy or if it is not installed)
+# HTTPS ports
+PORT_HTTPS=443
 PORT_HTTPS_APP_EXPOSE=5043
 
-# Expose db (mysql) port (External db app)
-# Attention for PORT_DB_MAIN_EXPOSE: Please also make changes to the DOCTRINE_DB_PORT variable.
-PORT_DB_MAIN_EXPOSE=5006
+# Adminer HTTP ports
+PORT_HTTP_ADMINER_INTERNAL=8080
+PORT_HTTP_ADMINER_EXPOSE=5081
 
-# Expose db (mysql) port (External db app)
-PORT_DB_TEST_EXPOSE=5007
+# Maildev HTTP ports
+PORT_HTTP_MAILDEV_INTERNAL=1080
+PORT_HTTP_MAILDEV_EXPOSE=5082
 
-# Expose adminer http port (To bypass the Traefik proxy or if it is not installed)
-PORT_HTTP_ADMINER_EXPOSE=5081
+# Maildev SMTP ports
+PORT_SMTP_MAILDEV_INTERNAL=1025
+PORT_SMTP_MAILDEV_EXPOSE=5025
 
-# Expose mailhog http port (To bypass the Traefik proxy or if it is not installed)
-PORT_HTTP_MAILHOG_EXPOSE=5082
+# PostgreSQL ports
+PORT_POSTGRESQL_INTERNAL=5432
+PORT_POSTGRESQL_EXPOSE=5032
 
-# Expose mailhog smtp port (To bypass the Traefik proxy or if it is not installed)
-PORT_SMTP_MAILHOG_EXPOSE=5025
+# Supervisord ports
+PORT_SUPERVISORD_INTERNAL=9001
+PORT_SUPERVISORD_EXPOSE=5001
 
 ###< General Config / Docker Compose Settings ###
 
 ###> symfony/framework-bundle ###
 APP_ENV=prod
 APP_DEBUG=0
 APP_SECRET=3b337448a0100c94f60efc26437e0a57
+APP_PATH_MIGRATION=migrations/postgresql
+# see config/packages/doctrine.yaml: postgresql, sqlite
+DEFAULT_DB_DRIVER=postgresql
+DEFAULT_DB_TEST_DRIVER=sqlite
 ###< symfony/framework-bundle ###
 
-###> PHP Configuration ###
-DOCKERFILE_PHP_FPM=php-fpm.dockerfile
-DOCKERFILE_NGINX=nginx.dockerfile
-PHP_VERSION=8.1.11
-PHP_VERSION_HOSTNAME=8-1-11
-###< PHP Configuration ###
-
-###> Docker Configuration: MySQL secrets and configurations
-MYSQL_SERVER_HOST=127.0.0.1
-MYSQL_SERVER_ROOT_USER=root
-MYSQL_SERVER_ROOT_PASSWORD=secret-pass
-MYSQL_SERVER_DB=pavb
-MYSQL_SERVER_DB_TEST=pavb-test
-MYSQL_SERVER_PORT=${PORT_MYSQL_INTERNAL}
-MYSQL_SERVER_VERSION=8.0
-MYSQL_SERVER_DRIVER=pdo_mysql
-###< Docker Configuration: MySQL secrets and configurations
-
-###> Docker Configuration: Mail secrets and configurations
-MAIL_SERVER_TRANSPORT=smtp
-MAIL_SERVER_HOST=localhost
-#MAIL_SERVER_HOST=${NAMESPACE_HOSTNAME_DEVELOPMENT}-mailhog
-MAIL_SERVER_PORT=1025
-###< Docker Configuration: Mail secrets and configurations
-
-##> doctrine/doctrine-bundle (mysql) ###
-# Format described at https://www.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/configuration.html#connecting-using-a-url
-# IMPORTANT: You MUST configure your server version, either here or in config/packages/doctrine.yaml
-DOCTRINE_DB_DRIVER=${MYSQL_SERVER_DRIVER}
-DOCTRINE_DB_VERSION=${MYSQL_SERVER_VERSION}
-DOCTRINE_DB_PATH=
-DOCTRINE_DB_NAME=${MYSQL_SERVER_DB}
-DOCTRINE_DB_HOST=${ENV_DB_HOST:-127.0.0.1}
-# Workaround for default port for DOCTRINE_DB_PORT: Because ${ENV_DB_PORT:-${PORT_DB_MAIN_EXPOSE}} does not work
-DOCTRINE_DB_PORT=${ENV_DB_PORT:-5006}
-DOCTRINE_DB_USER=${MYSQL_SERVER_ROOT_USER}
-DOCTRINE_DB_PASS=${MYSQL_SERVER_ROOT_PASSWORD}
-DOCTRINE_DB_SSL_CA=
-DOCTRINE_DB_SSL_VERIFY_SERVER_CERT=false
-DOCTRINE_DB_INIT_COMMAND="SET NAMES utf8"
-###< doctrine/doctrine-bundle (mysql) ###
-
 ###> own variables ###
 PROJECT_NAME="PHP Api Version Bundle"
 PROJECT_DESCRIPTION="Provides the base API plattform functionality."
 API_BASE_URL=/api/v1
 API_COUNTRY_CODE=de_DE
 ###< own variables ###
 
+###> Dockerfile Configuration ###
+DOCKERFILE_BUILD_APP=build-app.dockerfile
+DOCKERFILE_PHP_FPM=php-fpm.dockerfile
+DOCKERFILE_ADMINER=adminer.dockerfile
+###< Dockerfile Configuration ###
+
+###> PHP Configuration ###
+PHP_VERSION=8.2.1
+PHP_VERSION_HOSTNAME=8-2-1
+###< PHP Configuration ###
+
+###> Docker Configuration: PostgreSQL secrets and configurations (used to set the docker-compose configuration)
+POSTGRESQL_SERVER_ROOT_USER=root
+POSTGRESQL_SERVER_ROOT_PASSWORD=secret-pass
+POSTGRESQL_SERVER_HOST=${NAMESPACE_HOSTNAME_DEVELOPMENT}-postgresql
+POSTGRESQL_SERVER_DB=pavb
+POSTGRESQL_SERVER_PORT=${PORT_POSTGRESQL_INTERNAL}
+POSTGRESQL_SERVER_VERSION=14.7
+POSTGRESQL_SERVER_DRIVER=pdo_pgsql
+###< Docker Configuration: PostgreSQL secrets and configurations
+
+##> doctrine/doctrine-bundle (postgresql - used from doctrine) ###
+DOCTRINE_DB_USER_POSTGRESQL=${ENV_DB_USER:-root}
+DOCTRINE_DB_PASS_POSTGRESQL=${ENV_DB_PASS:-secret-pass}
+DOCTRINE_DB_HOST_POSTGRESQL=${ENV_DB_HOST:-127.0.0.1}
+DOCTRINE_DB_PORT_POSTGRESQL=${ENV_DB_PORT:-5032}
+DOCTRINE_DB_NAME_POSTGRESQL=${ENV_DB_NAME:-pavb}
+DOCTRINE_DB_VERSION_POSTGRESQL=${ENV_DB_VERSION:-14.7}
+DOCTRINE_DB_DRIVER_POSTGRESQL=${ENV_DB_DRIVER:-pdo_pgsql}
+DOCTRINE_DB_PATH_POSTGRESQL=
+DOCTRINE_DB_SSL_CA_POSTGRESQL=
+DOCTRINE_DB_SSL_VERIFY_SERVER_CERT_POSTGRESQL=false
+DOCTRINE_DB_INIT_COMMAND_POSTGRESQL="SET NAMES utf8"
+###< doctrine/doctrine-bundle (postgresql) ###
+
+##> doctrine/doctrine-bundle (sqlite - used from doctrine) ###
+DOCTRINE_DB_USER_SQLITE=root
+DOCTRINE_DB_PASS_SQLITE=secret-pass
+DOCTRINE_DB_HOST_SQLITE=
+DOCTRINE_DB_PORT_SQLITE=
+DOCTRINE_DB_NAME_SQLITE=opa
+DOCTRINE_DB_VERSION_SQLITE=8.0
+DOCTRINE_DB_DRIVER_SQLITE=pdo_sqlite
+DOCTRINE_DB_PATH_SQLITE="%kernel.project_dir%/var/app.db"
+DOCTRINE_DB_SSL_CA_SQLITE=
+DOCTRINE_DB_SSL_VERIFY_SERVER_CERT_SQLITE=false
+DOCTRINE_DB_INIT_COMMAND_SQLITE="SET NAMES utf8"
+###< doctrine/doctrine-bundle (sqlite) ###
+
+###> Docker Configuration: Mail secrets and configurations (used to set the docker-compose configuration)
+MAIL_SERVER_TRANSPORT_DOCKER=smtp
+MAIL_SERVER_HOST_DOCKER=${NAMESPACE_HOSTNAME_DEVELOPMENT}-maildev
+MAIL_SERVER_PORT_DOCKER=${PORT_SMTP_MAILDEV_INTERNAL}
+###< Docker Configuration: Mail secrets and configurations (used to set the docker-compose configuration)
+
+###> symfony/mailer ###
+MAIL_SERVER_TRANSPORT=${ENV_MAIL_SERVER_TRANSPORT:-smtp}
+MAIL_SERVER_HOST=${ENV_MAIL_SERVER_HOST:-localhost}
+MAIL_SERVER_PORT=${ENV_MAIL_SERVER_PORT:-5025}
+MAILER_DSN=${MAIL_SERVER_TRANSPORT}://${MAIL_SERVER_HOST}:${MAIL_SERVER_PORT}
+###< symfony/mailer ###
+
 ###> table-dumper (local docker settings) ###
-MYSQLDUMP_DATABASE_URL=mysql://${MYSQL_SERVER_ROOT_USER}:${MYSQL_SERVER_ROOT_PASSWORD}@${MYSQL_SERVER_HOST}:${MYSQL_SERVER_PORT}/${MYSQL_SERVER_DB}?serverVersion=${MYSQL_SERVER_VERSION}
+MYSQLDUMP_DATABASE_URL=mysql://${POSTGRESQL_SERVER_ROOT_USER}:${POSTGRESQL_SERVER_ROOT_PASSWORD}@localhost:5032/pavb?serverVersion=14.7
 MYSQLDUMP_IGNORED_TABLES=
 #MYSQLDUMP_FILTERED_TABLES=
 #MYSQLDUMP_TABLES_NO_DATA=
@@ -184,6 +194,6 @@ MYSQLDUMP_IGNORED_TABLES=
 CORS_ALLOW_ORIGIN='^https?://(php-api-version-bundle.ixnode.de|api-version.localhost|localhost|127\.0\.0\.1)(:[0-9]+)?$'
 ###< nelmio/cors-bundle ###
 
-###> symfony/mailer ###
-MAILER_DSN=smtp://${MAIL_SERVER_PORT}:${MAIL_SERVER_PORT}
-###< symfony/mailer ###
+###> symfony/messenger ###
+MESSENGER_TRANSPORT_DSN=doctrine://postgresql?auto_setup=1
+###< symfony/messenger ###

.env.test

@@ -5,20 +5,3 @@ SYMFONY_DEPRECATIONS_HELPER=999999
 PANTHER_APP_ENV=panther
 PANTHER_ERROR_SCREENSHOT_DIR=./var/error-screenshots
 ###< symfony/framework-bundle ###
-
-###> doctrine/doctrine-bundle (sqlite) ###
-# Format described at https://www.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/configuration.html#connecting-using-a-url
-# IMPORTANT: You MUST configure your server version, either here or in config/packages/doctrine.yaml
-DOCTRINE_DB_DRIVER=pdo_sqlite
-DOCTRINE_DB_VERSION=${MYSQL_SERVER_VERSION}
-DOCTRINE_DB_PATH="%kernel.project_dir%/var/app.db"
-DOCTRINE_DB_NAME=${MYSQL_SERVER_DB}
-DOCTRINE_DB_HOST=${ENV_DB_HOST:-127.0.0.1}
-# Workaround for default port for DOCTRINE_DB_PORT: Because ${ENV_DB_PORT:-${PORT_DB_MAIN_EXPOSE}} does not work
-DOCTRINE_DB_PORT=${ENV_DB_PORT:-5007}
-DOCTRINE_DB_USER=${MYSQL_SERVER_ROOT_USER}
-DOCTRINE_DB_PASS=${MYSQL_SERVER_ROOT_PASSWORD}
-DOCTRINE_DB_SSL_CA=
-DOCTRINE_DB_SSL_VERIFY_SERVER_CERT=false
-DOCTRINE_DB_INIT_COMMAND="SET NAMES utf8"
-###< doctrine/doctrine-bundle (sqlite) ###

bin/header/cache

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+
+# ------------
+# This script prints the header for cache commands
+#
+# @author    Björn Hempel <bjoern@hempel.li>
+# @version   0.1.0 (2023-06-24)
+# ------------
+
+HEADER="Caching"
+COMMAND="$1"
+DESCRIPTION="$2"
+
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+
+eval "$SCRIPT_DIR/global \"$HEADER\" \"$COMMAND\" \"$DESCRIPTION\" \"$DESCRIPTION\""
+RETURN_CODE=$?
+
+exit $RETURN_CODE
+

composer.json

@@ -25,7 +25,7 @@
         "ixnode/php-array-to-object": "^0.1.1",
         "ixnode/php-checker": "^0.1.3",
         "ixnode/php-container": "^0.1.2",
-        "ixnode/php-exception": "^0.1.13",
+        "ixnode/php-exception": "^0.1.19",
         "ixnode/php-json-schema-validator": "^0.1.2",
         "ixnode/php-naming-conventions": "^0.1.1",
         "nelmio/cors-bundle": "^2.2",
@@ -47,7 +47,9 @@
         "symfony/validator": "6.3.*",
         "symfony/yaml": "6.3.*",
         "monolog/monolog": "^3.4",
-        "symfony/monolog-bundle": "^3.8"
+        "symfony/monolog-bundle": "^3.8",
+        "symfony/messenger": "6.3.*",
+        "symfony/doctrine-messenger": "6.3.*"
     },
     "require-dev": {
         "doctrine/doctrine-fixtures-bundle": "^3.4",
@@ -98,6 +100,9 @@
 
         "ixno:header": "bin/header/ixno",
 
+        "cache:clear": "bin/header/cache 'bin/console cache:clear' 'Clear Cache'",
+        "cache:delete": "bin/header/cache 'rm -rf var/cache/*' 'Delete Cache'",
+
         "db:initialize:test:fixture": "bin/header/dbinit 'bin/console db:reinitialize --format=text --env=test' 'Test-DB Initialization'",
         "db:initialize:main:fixture": "bin/header/dbinit 'bin/console db:reinitialize --format=text --env=dev' 'Test-DB Initialization'",
         "db:initialize:main:sql": "for dump in fixtures/db/*.sql; do mysql -h127.0.0.1 -P3336 -uroot -psecret-pass --default-character-set=utf8 opa < \"$dump\"; done",
@@ -129,18 +134,21 @@
         "phpunit:functional:debug": "bin/header/phpunit 'PHPUNIT_DEBUG=1 vendor/bin/phpunit -d memory_limit=512M --configuration .phpunit/phpunit.functional.xml' 'Functional'",
         "phpunit:unit:debug": "bin/header/phpunit 'PHPUNIT_DEBUG=1 vendor/bin/phpunit -d memory_limit=512M --configuration .phpunit/phpunit.unit.xml' 'Unit'",
         "phpunit:all": [
+            "@cache:delete",
             "@db:initialize:test:fixture",
             "@phpunit:unit",
             "@phpunit:functional",
             "@phpunit:api"
         ],
         "phpunit:all:coverage": [
+            "@cache:delete",
             "@db:initialize:test:fixture",
             "@phpunit:unit:coverage",
             "@phpunit:functional:coverage",
             "@phpunit:api:coverage"
         ],
         "phpunit:all:debug": [
+            "@cache:delete",
             "@db:initialize:test:fixture",
             "@phpunit:unit:debug",
             "@phpunit:functional:debug",
@@ -203,15 +211,15 @@
         ],
 
         ".test:basic": [
-            "@rsm:header",
+            "@ixno:header",
             "@phpstan",
             "@phpunit"
         ],
         "test:basic": [
             "composer .test:basic && bin/header/success || bin/header/error"
         ],
         ".test:most": [
-            "@rsm:header",
+            "@ixno:header",
             "@phpmnd",
             "@phpstan",
             "@phpunit",
@@ -221,7 +229,7 @@
             "composer .test:most && bin/header/success || bin/header/error"
         ],
         ".test:all": [
-            "@rsm:header",
+            "@ixno:header",
             "@phpmnd",
             "@phpstan",
             "@phpunit",
@@ -232,7 +240,7 @@
             "composer .test:all && bin/header/success || bin/header/error"
         ],
         ".test:hardcore": [
-            "@rsm:header",
+            "@ixno:header",
             "@phpmnd",
             "@phpstan",
             "@phpunit",
@@ -244,7 +252,7 @@
             "composer .test:hardcore && bin/header/success || bin/header/error"
         ],
         ".test:static": [
-            "@rsm:header",
+            "@ixno:header",
             "@phpmnd",
             "@phpstan",
             "@phpcs",