improved environment

Author: dmitriy

.env.dev

@@ -1,3 +1,7 @@
+###> docker-compose configuration ###
+COMPOSE_PROJECT_NAME=environment3
+###< docker-compose configuration ###
+
 APP_NAME=Laravel
 APP_ENV=dev
 APP_KEY=base64:KgeWah2LwOk5HLjCYuIZjaQQwX59ASqUjCKZMD6H4Ew=

.env.prod

@@ -1,3 +1,7 @@
+###> docker-compose configuration ###
+COMPOSE_PROJECT_NAME=environment3
+###< docker-compose configuration ###
+
 APP_NAME=Laravel
 APP_ENV=prod
 APP_KEY=

.env.staging

@@ -0,0 +1,50 @@
+###> docker-compose configuration ###
+COMPOSE_PROJECT_NAME=environment3
+###< docker-compose configuration ###
+
+APP_NAME=Laravel
+APP_ENV=staging
+APP_KEY=
+APP_DEBUG=false
+APP_URL=http://localhost
+
+LOG_CHANNEL=stack
+
+DB_CONNECTION=mysql
+DB_HOST=mysql
+DB_PORT=3306
+DB_DATABASE=laravel
+DB_USERNAME=root
+DB_PASSWORD=secret
+
+BROADCAST_DRIVER=log
+CACHE_DRIVER=file
+QUEUE_CONNECTION=sync
+SESSION_DRIVER=file
+SESSION_LIFETIME=120
+
+REDIS_HOST=127.0.0.1
+REDIS_PASSWORD=null
+REDIS_PORT=6379
+
+MAIL_DRIVER=smtp
+MAIL_HOST=smtp.mailtrap.io
+MAIL_PORT=2525
+MAIL_USERNAME=null
+MAIL_PASSWORD=null
+MAIL_ENCRYPTION=null
+MAIL_FROM_ADDRESS=null
+MAIL_FROM_NAME="${APP_NAME}"
+
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+AWS_DEFAULT_REGION=us-east-1
+AWS_BUCKET=
+
+PUSHER_APP_ID=
+PUSHER_APP_KEY=
+PUSHER_APP_SECRET=
+PUSHER_APP_CLUSTER=mt1
+
+MIX_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
+MIX_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"

.env.test

@@ -1,3 +1,7 @@
+###> docker-compose configuration ###
+COMPOSE_PROJECT_NAME=environment3
+###< docker-compose configuration ###
+
 APP_NAME=Laravel
 APP_ENV=test
 APP_KEY=base64:KgeWah2LwOk5HLjCYuIZjaQQwX59ASqUjCKZMD6H4Ew=

.env.test-ci

@@ -1,4 +1,8 @@
 # by default test environment using .env.test. So all tests will use the same database. If you need to separate it, just use make env-test-ci command and then run migrations and seed.
+###> docker-compose configuration ###
+COMPOSE_PROJECT_NAME=environment3
+###< docker-compose configuration ###
+
 APP_NAME=Laravel
 APP_ENV=test
 APP_KEY=base64:KgeWah2LwOk5HLjCYuIZjaQQwX59ASqUjCKZMD6H4Ew=

.github/workflows/ci.yml

@@ -21,7 +21,7 @@ jobs:
         steps:
             - uses: actions/checkout@v1
             - name: Build the docker images
-              run: docker-compose -f docker-compose-test-ci.yml build
+              run: make build-test
             - name: Start the docker images
               run: make start-test
             - name: Check running containers

.gitlab-ci.yml

@@ -0,0 +1,67 @@
+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:
+    - make build-test
+    - make start-test
+    - docker ps -a
+    - make wait-for-db
+    - make drop-migrate
+    - make seed
+    - *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:
+    - make build-staging
+    # 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
+    - /^release.*$/
+
+push_prod_images:
+  stage: deploy
+  script:
+    - make build-prod
+    # 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

Makefile

@@ -1,17 +1,41 @@
 dir=${CURDIR}
-project=-p laravel
-service=laravel:latest
+
+ifndef APP_ENV
+	include .env
+endif
+
+project=-p ${COMPOSE_PROJECT_NAME}
+service=${COMPOSE_PROJECT_NAME}:latest
 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
+
+build:
+	@docker-compose -f docker-compose.yml build
+
+build-test:
+	@docker-compose -f docker-compose-test-ci.yml build
+
+build-staging:
+	@docker-compose -f docker-compose-staging.yml build
+
+build-prod:
+	@docker-compose -f docker-compose-prod.yml build
 
 start:
 	@docker-compose -f docker-compose.yml $(project) up -d
 
 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
 
@@ -21,11 +45,15 @@ 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-dev:
@@ -61,7 +89,7 @@ report-clean:
 wait-for-db:
 	@make exec cmd="php artisan 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:
@@ -70,27 +98,31 @@ composer-install:
 composer-update:
 	@make exec-bash cmd="COMPOSER_MEMORY_LIMIT=-1 composer update"
 
+key-generate:
+	@make exec cmd="php artisan key:generate"
+
 info:
 	@make exec cmd="php artisan --version"
+	@make exec cmd="php artisan env"
 	@make exec cmd="php --version"
 
 logs:
-	@docker logs -f laravel
+	@docker logs -f ${COMPOSE_PROJECT_NAME}_laravel
 
 logs-nginx:
-	@docker logs -f nginx
+	@docker logs -f ${COMPOSE_PROJECT_NAME}_nginx
 
 logs-supervisord:
-	@docker logs -f supervisord
+	@docker logs -f ${COMPOSE_PROJECT_NAME}_supervisord
 
 logs-mysql:
-	@docker logs -f mysql
+	@docker logs -f ${COMPOSE_PROJECT_NAME}_mysql
 
 drop-migrate:
 	@make exec cmd="php artisan migrate:fresh"
 	@make exec cmd="php artisan migrate:fresh --env=test"
 
-migrate-prod:
+migrate-no-test:
 	@make exec cmd="php artisan migrate --force"
 
 migrate:
@@ -101,7 +133,7 @@ seed:
 	@make exec cmd="php artisan db:seed --force"
 
 phpunit:
-	@make exec cmd="./vendor/bin/phpunit -c phpunit.xml --coverage-html reports/coverage --coverage-clover reports/clover.xml --log-junit reports/junit.xml"
+	@make exec cmd="./vendor/bin/phpunit -c phpunit.xml --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.

bitbucket-pipelines.yml

@@ -9,12 +9,13 @@ pipelines:
         script:
           - chmod +x .bitbucket/dependencies.sh
           - .bitbucket/dependencies.sh
-          - docker-compose -f docker-compose-test-ci.yml build
+          - make build-test
           - make start-test
           - docker ps -a
           - make wait-for-db
           - make drop-migrate
           - make seed
+          - make info
           - make phpunit
           - make ecs
           - make phpcs