updated to php 7.4 and laravel 6.13, improved environment

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

@@ -26,6 +26,11 @@ jobs:
           command: |
             make phpunit
 
+      - run:
+          name: Report code coverage
+          command: |
+            make report-code-coverage
+
       - store_artifacts:
           path: reports
 

.env.dev

@@ -29,6 +29,8 @@ 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=

.env.prod

@@ -29,6 +29,8 @@ 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=

.env.test

@@ -29,6 +29,8 @@ 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=

.env.test-ci

@@ -30,6 +30,13 @@ 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=

.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: Laravel 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 seeds
+              run: make seed
+            - name: Run test suite
+              run: make phpunit
+            - name: Stop the docker images
+              run: make stop-test

Dockerfile

@@ -1,4 +1,4 @@
-FROM php:7.3-apache
+FROM php:7.4-apache
 
 # set main params
 ARG BUILD_ARGUMENT_DEBUG_ENABLED=false
@@ -51,17 +51,17 @@ RUN usermod -u 1000 www-data && groupmod -g 1000 www-data
 RUN chown -R www-data:www-data $APP_HOME
 
 # put apache and php config for Laravel, enable sites
-COPY ./docker/hosts/laravel.conf /etc/apache2/sites-available/laravel.conf
-COPY ./docker/hosts/laravel-ssl.conf /etc/apache2/sites-available/laravel-ssl.conf
+COPY ./docker/general/laravel.conf /etc/apache2/sites-available/laravel.conf
+COPY ./docker/general/laravel-ssl.conf /etc/apache2/sites-available/laravel-ssl.conf
 RUN a2ensite laravel.conf && a2ensite laravel-ssl
 COPY ./docker/$BUILD_ARGUMENT_ENV/php.ini /usr/local/etc/php/php.ini
 
 # enable apache modules
 RUN a2enmod rewrite
 RUN a2enmod ssl
 
-# install Xdebug in case development environment
-COPY ./docker/other/do_we_need_xdebug.sh /tmp/
+# install Xdebug in case development or 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
 
@@ -70,8 +70,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
 
 # generate certificates

Makefile

@@ -1,6 +1,10 @@
 dir=${CURDIR}
 project=-p laravel
 service=laravel:latest
+interactive:=$(shell [ -t 0 ] && echo 1)
+ifneq ($(interactive),1)
+	optionT=-T
+endif
 
 start:
 	@docker-compose -f docker-compose.yml $(project) up -d
@@ -31,7 +35,7 @@ env-test-ci:
 	@make exec cmd="cp ./.env.test-ci ./.env"
 
 ssh:
-	@docker-compose $(project) exec laravel bash
+	@docker-compose $(project) exec $(optionT) laravel bash
 
 ssh-supervisord:
 	@docker-compose $(project) exec supervisord bash
@@ -40,14 +44,17 @@ ssh-mysql:
 	@docker-compose $(project) exec mysql bash
 
 exec:
-	@docker-compose $(project) exec laravel $$cmd
+	@docker-compose $(project) exec $(optionT) laravel $$cmd
 
-clean:
-	rm -rf $(dir)/reports/*
+exec-bash:
+	@docker-compose $(project) exec $(optionT) laravel bash -c "$(cmd)"
 
-prepare:
+report-prepare:
 	mkdir -p $(dir)/reports/coverage
 
+report-clean:
+	rm -rf $(dir)/reports/*
+
 wait-for-db:
 	@make exec cmd="php artisan db:wait"
 
@@ -88,4 +95,37 @@ seed:
 	@make exec cmd="php artisan db:seed --force"
 
 phpunit:
-	@make exec cmd="vendor/bin/phpunit -c phpunit.xml --log-junit reports/phpunit.xml --coverage-html reports/coverage --coverage-clover reports/coverage.xml"
+	@make exec cmd="./vendor/bin/phpunit -c phpunit.xml --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 app"
+###< phpcs ###
+
+###> ecs ###
+ecs: ## Run Easy Coding Standard
+	@make exec-bash cmd="error_reporting=0 ./vendor/bin/ecs --clear-cache check app"
+
+ecs-fix: ## Run The Easy Coding Standard to fix issues
+	@make exec-bash cmd="error_reporting=0 ./vendor/bin/ecs --clear-cache --fix check app"
+###< 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 --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 ###

app/Console/Commands/DbWaitDatabase.php

@@ -40,7 +40,6 @@ class DbWaitDatabase extends Command
     public function handle(DB $db): int
     {
         for ($i = 0; $i < 60; $i += self::WAIT_SLEEP_TIME) {
-
             try {
                 $db::select('SHOW TABLES');
                 $this->info('Connection to the database is ok!');
@@ -52,7 +51,6 @@ public function handle(DB $db): int
 
                 continue;
             }
-
         }
 
         $this->error('Can not connect to the database');

app/Exceptions/Handler.php

@@ -31,6 +31,8 @@ class Handler extends ExceptionHandler
      *
      * @param  \Exception  $exception
      * @return void
+     *
+     * @throws \Exception
      */
     public function report(Exception $exception)
     {
@@ -42,7 +44,9 @@ public function report(Exception $exception)
      *
      * @param  \Illuminate\Http\Request  $request
      * @param  \Exception  $exception
-     * @return \Illuminate\Http\Response
+     * @return \Symfony\Component\HttpFoundation\Response
+     *
+     * @throws \Exception
      */
     public function render($request, Exception $exception)
     {

app/Http/Controllers/Auth/ConfirmPasswordController.php

@@ -3,6 +3,7 @@
 namespace App\Http\Controllers\Auth;
 
 use App\Http\Controllers\Controller;
+use App\Providers\RouteServiceProvider;
 use Illuminate\Foundation\Auth\ConfirmsPasswords;
 
 class ConfirmPasswordController extends Controller
@@ -25,7 +26,7 @@ class ConfirmPasswordController extends Controller
      *
      * @var string
      */
-    protected $redirectTo = '/home';
+    protected $redirectTo = RouteServiceProvider::HOME;
 
     /**
      * Create a new controller instance.

app/Http/Controllers/Auth/LoginController.php

@@ -3,6 +3,7 @@
 namespace App\Http\Controllers\Auth;
 
 use App\Http\Controllers\Controller;
+use App\Providers\RouteServiceProvider;
 use Illuminate\Foundation\Auth\AuthenticatesUsers;
 
 class LoginController extends Controller
@@ -25,7 +26,7 @@ class LoginController extends Controller
      *
      * @var string
      */
-    protected $redirectTo = '/home';
+    protected $redirectTo = RouteServiceProvider::HOME;
 
     /**
      * Create a new controller instance.

app/Http/Controllers/Auth/RegisterController.php

@@ -3,6 +3,7 @@
 namespace App\Http\Controllers\Auth;
 
 use App\Http\Controllers\Controller;
+use App\Providers\RouteServiceProvider;
 use App\User;
 use Illuminate\Foundation\Auth\RegistersUsers;
 use Illuminate\Support\Facades\Hash;
@@ -28,7 +29,7 @@ class RegisterController extends Controller
      *
      * @var string
      */
-    protected $redirectTo = '/home';
+    protected $redirectTo = RouteServiceProvider::HOME;
 
     /**
      * Create a new controller instance.

app/Http/Controllers/Auth/ResetPasswordController.php

@@ -3,6 +3,7 @@
 namespace App\Http\Controllers\Auth;
 
 use App\Http\Controllers\Controller;
+use App\Providers\RouteServiceProvider;
 use Illuminate\Foundation\Auth\ResetsPasswords;
 
 class ResetPasswordController extends Controller
@@ -25,5 +26,5 @@ class ResetPasswordController extends Controller
      *
      * @var string
      */
-    protected $redirectTo = '/home';
+    protected $redirectTo = RouteServiceProvider::HOME;
 }

app/Http/Controllers/Auth/VerificationController.php

@@ -3,6 +3,7 @@
 namespace App\Http\Controllers\Auth;
 
 use App\Http\Controllers\Controller;
+use App\Providers\RouteServiceProvider;
 use Illuminate\Foundation\Auth\VerifiesEmails;
 
 class VerificationController extends Controller
@@ -25,7 +26,7 @@ class VerificationController extends Controller
      *
      * @var string
      */
-    protected $redirectTo = '/home';
+    protected $redirectTo = RouteServiceProvider::HOME;
 
     /**
      * Create a new controller instance.

app/Http/Kernel.php

@@ -39,7 +39,7 @@ class Kernel extends HttpKernel
 
         'api' => [
             'throttle:60,1',
-            'bindings',
+            \Illuminate\Routing\Middleware\SubstituteBindings::class,
         ],
     ];
 

app/Http/Middleware/Authenticate.php

@@ -10,7 +10,7 @@ class Authenticate extends Middleware
      * Get the path the user should be redirected to when they are not authenticated.
      *
      * @param  \Illuminate\Http\Request  $request
-     * @return string
+     * @return string|null
      */
     protected function redirectTo($request)
     {

app/Http/Middleware/RedirectIfAuthenticated.php

@@ -2,6 +2,7 @@
 
 namespace App\Http\Middleware;
 
+use App\Providers\RouteServiceProvider;
 use Closure;
 use Illuminate\Support\Facades\Auth;
 
@@ -18,7 +19,7 @@ class RedirectIfAuthenticated
     public function handle($request, Closure $next, $guard = null)
     {
         if (Auth::guard($guard)->check()) {
-            return redirect('/home');
+            return redirect(RouteServiceProvider::HOME);
         }
 
         return $next($request);

app/Providers/RouteServiceProvider.php

@@ -16,6 +16,13 @@ class RouteServiceProvider extends ServiceProvider
      */
     protected $namespace = 'App\Http\Controllers';
 
+    /**
+     * The path to the "home" route for your application.
+     *
+     * @var string
+     */
+    public const HOME = '/home';
+
     /**
      * Define your route model bindings, pattern filters, etc.
      *