added staging environment, GitlabCI integration, refactoring, updated docs

Author: dmitriy

.env.prod

@@ -2,3 +2,11 @@
 APP_ENV=prod
 APP_SECRET=42f011ec3a7bde0bec87364b1d967194
 APP_DEBUG=0
+
+###> doctrine/doctrine-bundle ###
+DATABASE_URL=mysql://root:secret@mysql:3306/symfony
+###< doctrine/doctrine-bundle ###
+
+###> symfony/messenger ###
+MESSENGER_TRANSPORT_DSN=amqp://guest:guest@rabbitmq:5672/%2f/messages
+###< symfony/messenger ###

.env.staging

@@ -0,0 +1,4 @@
+# define your env variables for the staging env here
+APP_ENV=staging
+APP_SECRET=42f011ec3a7bde0bec87364b1d967194
+APP_DEBUG=0

.gitlab-ci.yml

@@ -0,0 +1,66 @@
+image: docker:latest
+
+variables:
+  DOCKER_DRIVER: overlay2
+  DOCKER_TLS_CERTDIR: ""
+  GITLAB_CI: 1
+
+services:
+  - docker:dind
+
+before_script:
+  - apk update
+  - apk upgrade
+  - apk add --no-cache make bash docker-compose && rm -rf /var/cache/apk/*
+
+stages:
+  - build
+  - deploy
+
+.general_scripts: &general_scripts
+  - make info
+
+build:
+  stage: build
+  script:
+    - docker-compose -f docker-compose-test-ci.yml build
+    - make start-test
+    - docker ps -a
+    - make wait-for-db
+    - make drop-migrate
+    - make messenger-setup-transports
+    - *general_scripts
+    - make phpunit
+    - make ecs
+    - make phpcs
+    - make stop-test
+  artifacts:
+    paths:
+      - reports/
+  only:
+    - merge_requests
+    - tags
+    - master
+    - develop
+
+push_staging_images:
+  stage: deploy
+  script:
+    - docker-compose -f docker-compose-staging.yml build
+    # TODO: set necessary image name in docker-compose-staging.yml according to your registry and edit lines bellow
+    #- docker login -u gitlab-ci-token -p $CI_JOB_TOKEN $CI_REGISTRY
+    #- docker-compose -f docker-compose-staging.yml push
+  only:
+    - master
+    - develop
+
+push_prod_images:
+  stage: deploy
+  script:
+    - docker-compose -f docker-compose-prod.yml build
+    # TODO: set necessary image name in docker-compose-prod.yml according to your registry and edit lines bellow
+    #- docker login -u gitlab-ci-token -p $CI_JOB_TOKEN $CI_REGISTRY
+    #- docker-compose -f docker-compose-prod.yml push
+  only:
+    - master
+    - /^release.*$/

Dockerfile

@@ -11,8 +11,9 @@ ENV APP_HOME /var/www/html
 RUN if [ "$BUILD_ARGUMENT_ENV" = "default" ]; then echo "Set BUILD_ARGUMENT_ENV in docker build-args like --build-arg BUILD_ARGUMENT_ENV=dev" && exit 2; \
     elif [ "$BUILD_ARGUMENT_ENV" = "dev" ]; then echo "Building development environment."; \
     elif [ "$BUILD_ARGUMENT_ENV" = "test" ]; then echo "Building test environment."; \
+    elif [ "$BUILD_ARGUMENT_ENV" = "staging" ]; then echo "Building staging environment."; \
     elif [ "$BUILD_ARGUMENT_ENV" = "prod" ]; then echo "Building production environment."; \
-    else echo "Set correct BUILD_ARGUMENT_ENV in docker build-args like --build-arg BUILD_ARGUMENT_ENV=dev. Available choices are dev,test,prod." && exit 2; \
+    else echo "Set correct BUILD_ARGUMENT_ENV in docker build-args like --build-arg BUILD_ARGUMENT_ENV=dev. Available choices are dev,test,staging,prod." && exit 2; \
     fi
 
 # install all the dependencies and enable PHP modules
@@ -87,8 +88,8 @@ RUN if [ "$BUILD_ARGUMENT_ENV" = "dev" ] || [ "$BUILD_ARGUMENT_ENV" = "test" ];
     else export APP_ENV=$BUILD_ARGUMENT_ENV && COMPOSER_MEMORY_LIMIT=-1 composer install --optimize-autoloader --no-interaction --no-progress --no-dev; \
     fi
 
-# create cached config file .env.local.php in case prod environment
-RUN if [ "$BUILD_ARGUMENT_ENV" = "prod" ]; then composer dump-env $BUILD_ARGUMENT_ENV; \
+# create cached config file .env.local.php in case staging/prod environment
+RUN if [ "$BUILD_ARGUMENT_ENV" = "staging" ] || [ "$BUILD_ARGUMENT_ENV" = "prod" ]; then composer dump-env $BUILD_ARGUMENT_ENV; \
     fi
 
 USER root

Makefile

@@ -6,13 +6,16 @@ interactive:=$(shell [ -t 0 ] && echo 1)
 ifneq ($(interactive),1)
 	optionT=-T
 endif
+ifeq ($(GITLAB_CI),1)
+	# Determine additional params for phpunit in order to generate coverage badge on GitLabCI side
+	phpunitOptions=--coverage-text --colors=never
+endif
 
 ifndef APP_ENV
-	# Determine which .env file to use
+	include .env
+	# Determine if .env.local file exist
 	ifneq ("$(wildcard .env.local)","")
 		include .env.local
-	else
-		include .env
 	endif
 endif
 
@@ -22,6 +25,9 @@ start:
 start-test:
 	@docker-compose -f docker-compose-test-ci.yml $(project) up -d
 
+start-staging:
+	@docker-compose -f docker-compose-staging.yml $(project) up -d
+
 start-prod:
 	@docker-compose -f docker-compose-prod.yml $(project) up -d
 
@@ -31,16 +37,23 @@ stop:
 stop-test:
 	@docker-compose -f docker-compose-test-ci.yml $(project) down
 
+stop-staging:
+	@docker-compose -f docker-compose-staging.yml $(project) down
+
 stop-prod:
 	@docker-compose -f docker-compose-prod.yml $(project) down
 
 restart: stop start
 restart-test: stop-test start-test
+restart-staging: stop-staging start-staging
 restart-prod: stop-prod start-prod
 
 env-prod:
 	@make exec cmd="composer dump-env prod"
 
+env-staging:
+	@make exec cmd="composer dump-env staging"
+
 ssh:
 	@docker-compose $(project) exec $(optionT) symfony bash
 
@@ -71,7 +84,7 @@ report-clean:
 wait-for-db:
 	@make exec cmd="php bin/console db:wait"
 
-composer-install-prod:
+composer-install-no-dev:
 	@make exec-bash cmd="COMPOSER_MEMORY_LIMIT=-1 composer install --optimize-autoloader --no-dev"
 
 composer-install:
@@ -104,7 +117,7 @@ drop-migrate:
 	@make exec cmd="php bin/console doctrine:schema:drop --full-database --force --env=test"
 	@make migrate
 
-migrate-prod:
+migrate-no-test:
 	@make exec cmd="php bin/console doctrine:migrations:migrate --no-interaction --all-or-nothing"
 
 migrate:
@@ -118,7 +131,7 @@ messenger-setup-transports:
 	@make exec cmd="php bin/console messenger:setup-transports"
 
 phpunit:
-	@make exec-bash cmd="rm -rf ./var/cache/test* && bin/console cache:warmup --env=test && ./vendor/bin/phpunit -c phpunit.xml.dist --coverage-html reports/coverage --coverage-clover reports/clover.xml --log-junit reports/junit.xml"
+	@make exec-bash cmd="rm -rf ./var/cache/test* && bin/console cache:warmup --env=test && ./vendor/bin/phpunit -c phpunit.xml.dist --coverage-html reports/coverage $(phpunitOptions) --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.

composer.json

@@ -78,7 +78,7 @@
 		"ergebnis/composer-normalize": "^2.3",
 		"roave/security-advisories": "dev-master",
 		"symfony/debug-pack": "*",
-		"symfony/maker-bundle": "^1.15",
+		"symfony/maker-bundle": "^1.17",
 		"symfony/requirements-checker": "^1.1"
 	},
 	"config": {