updated to php 7.4 and symfony 4.4 + refactoring

Author: dmitriy

.bitbucket/dependencies.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env sh
+
+set -eu
+
+# Add python pip and bash
+apk add --no-cache py-pip bash make
+
+# Install docker-compose via pip
+pip install --no-cache-dir docker-compose~=1.23.0
+docker-compose -v

.circleci/config.yml

@@ -19,13 +19,17 @@ jobs:
           command: |
             make wait-for-db
             make drop-migrate
-            make fixtures
 
       - run:
           name: Run unit/functional tests
           command: |
             make phpunit
 
+      - run:
+          name: Report code coverage
+          command: |
+            make report-code-coverage
+
       - store_artifacts:
           path: reports
 

.dockerignore

@@ -1,13 +1,18 @@
 /.git*
 /.idea*
-var/mysql-data
-var/rabbitmq
-vendor/
 .dockerignore
 .editorconfig
+
+/.env.local
+/.env.*.local
 .env.local.php
+/public/bundles/
+/var/mysql-data
+/var/rabbitmq
+/vendor/
+/tools/*/vendor/
+
 Dockerfile
 docker-compose.yml
 docker-compose-test-ci.yml
 docker-compose-prod.yml
-Makefile

.editorconfig

@@ -13,3 +13,6 @@ trim_trailing_whitespace = false
 
 [*.yml]
 indent_size = 2
+
+[{composer.json,Makefile}]
+indent_style = tab

.env

@@ -1,5 +1,5 @@
 # In all environments, the following files are loaded if they exist,
-# the later taking precedence over the former:
+# the latter taking precedence over the former:
 #
 #  * .env                contains default values for the environment variables needed by the app
 #  * .env.local          uncommitted file with local overrides
@@ -11,28 +11,27 @@
 # DO NOT DEFINE PRODUCTION SECRETS IN THIS FILE NOR IN ANY OTHER COMMITTED FILES.
 #
 # Run "composer dump-env prod" to compile .env files for production use (requires symfony/flex >=1.2).
-# https://symfony.com/doc/current/best_practices/configuration.html#infrastructure-related-configuration
+# https://symfony.com/doc/current/best_practices.html#use-environment-variables-for-infrastructure-configuration
 
 ###> symfony/framework-bundle ###
 APP_ENV=dev
+APP_DEBUG=1
 APP_SECRET=42f011ec3a7bde0bec87364b1d967193
-#TRUSTED_PROXIES=127.0.0.1,127.0.0.2
+#TRUSTED_PROXIES=127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16
 #TRUSTED_HOSTS='^localhost|example\.com$'
 ###< symfony/framework-bundle ###
 
 ###> doctrine/doctrine-bundle ###
 # Format described at https://www.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/configuration.html#connecting-using-a-url
 # For an SQLite database, use: "sqlite:///%kernel.project_dir%/var/data.db"
-# Configure your db driver and server_version in config/packages/doctrine.yaml
+# For a PostgreSQL database, use: "postgresql://db_user:db_password@127.0.0.1:5432/db_name?serverVersion=11&charset=utf8"
+# IMPORTANT: You MUST configure your server version, either here or in config/packages/doctrine.yaml
 DATABASE_URL=mysql://root:secret@mysql:3306/symfony
 ###< doctrine/doctrine-bundle ###
 
-###> symfony/swiftmailer-bundle ###
-# For Gmail as a transport, use: "gmail://username:password@localhost"
-# For a generic SMTP server, use: "smtp://localhost:25?encryption=&auth_mode="
-# Delivery is disabled by default via "null://localhost"
-MAILER_URL=null://localhost
-###< symfony/swiftmailer-bundle ###
+###> symfony/mailer ###
+# MAILER_DSN=smtp://localhost
+###< symfony/mailer ###
 
 ###> symfony/messenger ###
 MESSENGER_TRANSPORT_DSN=amqp://guest:guest@rabbitmq:5672/%2f/messages

.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: Symfony App
+
+on:
+    push:
+        branches:
+            - master
+            - develop
+    pull_request:
+        branches:
+            - master
+            - develop
+    release:
+        types: [published]
+
+jobs:
+
+    build:
+
+        runs-on: ubuntu-latest
+
+        steps:
+            - uses: actions/checkout@v1
+            - name: Build the docker images
+              run: docker-compose -f docker-compose-test-ci.yml build
+            - name: Start the docker images
+              run: make start-test
+            - name: Check running containers
+              run: docker ps -a
+            - name: Wait for database connection
+              run: make wait-for-db
+            - name: Run migrations
+              run: make drop-migrate
+            - name: Run test suite
+              run: make phpunit
+            - name: Stop the docker images
+              run: make stop-test

.gitignore

@@ -1,22 +1,19 @@
 /.idea
 reports/*
 !reports/.gitkeep
-.phpunit.result.cache
 
 ###> symfony/framework-bundle ###
 /.env.local
 /.env.local.php
 /.env.*.local
+/config/secrets/prod/prod.decrypt.private.php
 /public/bundles/
 /var/
 /vendor/
 ###< symfony/framework-bundle ###
 
 ###> symfony/phpunit-bridge ###
 .phpunit
+.phpunit.result.cache
 /phpunit.xml
 ###< symfony/phpunit-bridge ###
-
-###> symfony/web-server-bundle ###
-/.web-server-pid
-###< symfony/web-server-bundle ###

Dockerfile

@@ -1,4 +1,4 @@
-FROM php:7.3-fpm
+FROM php:7.4-fpm
 
 # set main params
 ARG BUILD_ARGUMENT_DEBUG_ENABLED=false
@@ -53,8 +53,8 @@ RUN chown -R www-data:www-data $APP_HOME
 COPY ./docker/$BUILD_ARGUMENT_ENV/www.conf /usr/local/etc/php-fpm.d/www.conf
 COPY ./docker/$BUILD_ARGUMENT_ENV/php.ini /usr/local/etc/php/php.ini
 
-# install Xdebug in case development environment
-COPY ./docker/other/do_we_need_xdebug.sh /tmp/
+# install Xdebug in case dev/test environment
+COPY ./docker/general/do_we_need_xdebug.sh /tmp/
 COPY ./docker/dev/xdebug.ini /tmp/
 RUN chmod u+x /tmp/do_we_need_xdebug.sh && /tmp/do_we_need_xdebug.sh
 
@@ -63,8 +63,8 @@ RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/bin/
 
 # add supervisor
 RUN mkdir -p /var/log/supervisor
-COPY --chown=root:root ./docker/other/supervisord.conf /etc/supervisor/conf.d/supervisord.conf
-COPY --chown=root:root ./docker/other/cron /var/spool/cron/crontabs/root
+COPY --chown=root:root ./docker/general/supervisord.conf /etc/supervisor/conf.d/supervisord.conf
+COPY --chown=root:root ./docker/general/cron /var/spool/cron/crontabs/root
 RUN chmod 0600 /var/spool/cron/crontabs/root
 
 # set working directory

Makefile

@@ -1,6 +1,10 @@
 dir=${CURDIR}
 project=-p symfony
 service=symfony:latest
+interactive:=$(shell [ -t 0 ] && echo 1)
+ifneq ($(interactive),1)
+	optionT=-T
+endif
 
 start:
 	@docker-compose -f docker-compose.yml $(project) up -d
@@ -28,20 +32,32 @@ env-prod:
 	@make exec cmd="composer dump-env prod"
 
 ssh:
-	@docker-compose $(project) exec symfony bash
+	@docker-compose $(project) exec $(optionT) symfony bash
+
+ssh-nginx:
+	@docker-compose $(project) exec nginx /bin/sh
 
 ssh-supervisord:
 	@docker-compose $(project) exec supervisord bash
 
+ssh-mysql:
+	@docker-compose $(project) exec mysql bash
+
+ssh-rabbitmq:
+	@docker-compose $(project) exec rabbitmq /bin/sh
+
 exec:
-	@docker-compose $(project) exec symfony $$cmd
+	@docker-compose $(project) exec $(optionT) symfony $$cmd
 
-clean:
-	rm -rf $(dir)/reports/*
+exec-bash:
+	@docker-compose $(project) exec $(optionT) symfony bash -c "$(cmd)"
 
-prepare:
+report-prepare:
 	mkdir -p $(dir)/reports/coverage
 
+report-clean:
+	rm -rf $(dir)/reports/*
+
 wait-for-db:
 	@make exec cmd="php bin/console db:wait"
 
@@ -58,8 +74,20 @@ info:
 	@make exec cmd="bin/console --version"
 	@make exec cmd="php --version"
 
+logs:
+	@docker logs -f symfony
+
+logs-nginx:
+	@docker logs -f nginx
+
 logs-supervisord:
-	@docker logs supervisord
+	@docker logs -f supervisord
+
+logs-mysql:
+	@docker logs -f mysql
+
+logs-rabbitmq:
+	@docker logs -f rabbitmq
 
 drop-migrate:
 	@make exec cmd="php bin/console doctrine:schema:drop --full-database --force"
@@ -74,7 +102,40 @@ migrate:
 	@make exec cmd="php bin/console doctrine:migrations:migrate --no-interaction --env=test"
 
 fixtures:
-	@make exec cmd="php bin/console doctrine:fixtures:load --append"
+	@make exec cmd="php bin/console doctrine:fixtures:load --env=test"
 
 phpunit:
-	@make exec cmd="./vendor/bin/simple-phpunit -c phpunit.xml.dist --log-junit reports/phpunit.xml --coverage-html reports/coverage --coverage-clover reports/coverage.xml"
+	@make exec cmd="./vendor/bin/phpunit -c phpunit.xml.dist --coverage-html reports/coverage --coverage-clover reports/clover.xml --log-junit reports/junit.xml"
+
+###> php-coveralls ###
+report-code-coverage: ## update code coverage on coveralls.io. Note: COVERALLS_REPO_TOKEN should be set on CI side.
+	@make exec-bash cmd="export COVERALLS_REPO_TOKEN=${COVERALLS_REPO_TOKEN} && php ./vendor/bin/php-coveralls -v --coverage_clover reports/clover.xml --json_path reports/coverals.json"
+###< php-coveralls ###
+
+###> phpcs ###
+phpcs: ## Run PHP CodeSniffer
+	@make exec-bash cmd="./vendor/bin/phpcs --version && ./vendor/bin/phpcs --standard=PSR2 --colors -p src"
+###< phpcs ###
+
+###> ecs ###
+ecs: ## Run Easy Coding Standard
+	@make exec-bash cmd="error_reporting=0 ./vendor/bin/ecs --clear-cache check src"
+
+ecs-fix: ## Run The Easy Coding Standard to fix issues
+	@make exec-bash cmd="error_reporting=0 ./vendor/bin/ecs --clear-cache --fix check src"
+###< ecs ###
+
+###> phpmetrics ###
+phpmetrics:
+	@make exec cmd="make phpmetrics-process"
+
+phpmetrics-process: ## Generates PhpMetrics static analysis, should be run inside symfony container
+	@mkdir -p reports/phpmetrics
+	@if [ ! -f reports/junit.xml ] ; then \
+		printf "\033[32;49mjunit.xml not found, running tests...\033[39m\n" ; \
+		./vendor/bin/phpunit -c phpunit.xml.dist --coverage-html reports/coverage --coverage-clover reports/clover.xml --log-junit reports/junit.xml ; \
+	fi;
+	@echo "\033[32mRunning PhpMetrics\033[39m"
+	@php ./vendor/bin/phpmetrics --version
+	@./vendor/bin/phpmetrics --junit=reports/junit.xml --report-html=reports/phpmetrics .
+###< phpmetrics ###

bin/console

@@ -1,21 +1,22 @@
 #!/usr/bin/env php
 <?php
+declare(strict_types = 1);
 
 use App\Kernel;
 use Symfony\Bundle\FrameworkBundle\Console\Application;
 use Symfony\Component\Console\Input\ArgvInput;
-use Symfony\Component\Debug\Debug;
+use Symfony\Component\ErrorHandler\Debug;
 
-if (false === in_array(\PHP_SAPI, ['cli', 'phpdbg', 'embed'], true)) {
-    echo 'Warning: The console should be invoked via the CLI version of PHP, not the '.\PHP_SAPI.' SAPI'.\PHP_EOL;
+if (!in_array(PHP_SAPI, ['cli', 'phpdbg', 'embed'], true)) {
+    echo 'Warning: The console should be invoked via the CLI version of PHP, not the '.PHP_SAPI.' SAPI'.PHP_EOL;
 }
 
 set_time_limit(0);
 
 require dirname(__DIR__).'/vendor/autoload.php';
 
 if (!class_exists(Application::class)) {
-    throw new RuntimeException('You need to add "symfony/framework-bundle" as a Composer dependency.');
+    throw new LogicException('You need to add "symfony/framework-bundle" as a Composer dependency.');
 }
 
 $input = new ArgvInput();