Feature/testing (#26)

* [Feature] [testing] Add user facade and start page tests, add github test ci

* [Feature] [testing] Move tools to global composer file

* [Feature] [testing] Optimize CI, add PHPStan dev dependency

* [Feature] [testing] Cache composer and npm

Author: Timothylul

.env.test

@@ -1,6 +1,7 @@
 # define your env variables for the test env here
 KERNEL_CLASS='App\Kernel'
 APP_SECRET='$ecretf0rt3st'
-SYMFONY_DEPRECATIONS_HELPER=999999
+SYMFONY_DEPRECATIONS_HELPER=disabled
 PANTHER_APP_ENV=panther
 PANTHER_ERROR_SCREENSHOT_DIR=./var/error-screenshots
+DATABASE_URL="mysql://modular-symfony-template:modular-symfony-template@mysql_test:3306/modular-symfony-template?serverVersion=5.7"

.github/workflows/ci.yml

@@ -9,45 +9,103 @@ on:
   workflow_dispatch:
 
 jobs:
-  ci:
+  build:
     runs-on: ubuntu-latest
     steps:
 
       - uses: actions/checkout@v2
 
-      - name: Setup PHP
-        uses: shivammathur/setup-php@v2
+      - name: Start docker compose stack
+        run: docker-compose up -d
+
+      - name: Cache composer dependencies
+        uses: actions/cache@v3
+        id: composer-dependencies
         with:
-          php-version: '8.0'
-          tools: composer, phpstan, phpcs
-          extensions: mbstring, xml, ctype, iconv, intl, pdo_sqlite
+          path: ./vendor
+          key: ${{ runner.os }}-${{ hashFiles('composer.lock') }}
 
-      - name: Get composer cache directory
-        id: composer-cache
-        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+      - name: Install composer dependencies
+        run: docker-compose exec -T php-fpm composer install --no-progress --prefer-dist --optimize-autoloader
 
-      - name: Cache composer dependencies
-        uses: actions/cache@v2
+      - name: Cache npm packages
+        uses: actions/cache@v3
+        id: npm-packages
+        with:
+          path: ./node_modules
+          key: ${{ runner.os }}-${{ hashFiles('package-lock.json') }}
+
+      - name: Install npm packages
+        run: docker-compose run npm npm install
+
+      - name: Build frontends
+        run: docker-compose run npm npm run build
+
+      - uses: actions/upload-artifact@v3
+        with:
+          name: frontend-build
+          path: ./public/build/*
+
+      - name: Stop docker compose stack
+        run: docker-compose down
+
+  quality:
+    runs-on: ubuntu-latest
+    needs: [build]
+    steps:
+
+      - uses: actions/checkout@v2
+
+      - uses: actions/cache@v3
+        id: composer-dependencies
         with:
-          path: ${{ steps.composer-cache.outputs.dir }}
-          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
-          restore-keys: ${{ runner.os }}-composer-
+          path: ./vendor
+          key: ${{ runner.os }}-${{ hashFiles('composer.lock') }}
+
+      - name: Start docker compose stack
+        run: docker-compose up -d
+
+      - name: Run PHPCS
+        run: docker-compose exec -T php-fpm vendor/bin/phpcs src
+
+      - name: Run PHPStan
+        run: docker-compose exec -T php-fpm vendor/bin/phpstan analyse --level 5 src tests
+
+      - name: Stop docker compose stack
+        run: docker-compose down
+
+  test:
+    runs-on: ubuntu-latest
+    needs: [build]
+    steps:
 
-      - name: Install Composer dependencies
-        run: composer install --no-progress --prefer-dist --optimize-autoloader
+      - uses: actions/checkout@v2
 
-      - name: PHPCS
-        run: phpcs src/
+      - uses: actions/cache@v3
+        id: composer-dependencies
+        with:
+          path: ./vendor
+          key: ${{ runner.os }}-${{ hashFiles('composer.lock') }}
 
-      - name: PHPStan
-        run: phpstan analyse --level 5 --no-progress src/
+      - uses: actions/cache@v3
+        id: npm-packages
+        with:
+          path: ./node_modules
+          key: ${{ runner.os }}-${{ hashFiles('package-lock.json') }}
 
-      - name: Codesniffer
-        uses: pipeline-components/php-codesniffer@v0.12.3
+      - uses: actions/download-artifact@v3
         with:
-          directory: src/
+          name: frontend-build
+          path: ./public/build
+
+      - name: Start docker compose stack
+        run: docker-compose up -d
+
+      - name: Migrate test database
+        run: sleep 10 && docker-compose exec -T php-fpm php bin/console --env=test d:m:m --no-interaction
+
+      - name: Run tests
+        run: docker-compose exec -T php-fpm php bin/phpunit
 
-      #- name: Deptrac
-      #  uses: docker://smoench/deptrac-action:latest
-      #  with:
-      #    args: analyse depfile.yaml
+      - name: Stop docker compose stack
+        run: docker-compose down

.gitignore

@@ -43,3 +43,8 @@
 npm-debug.log
 yarn-error.log
 ###< symfony/webpack-encore-bundle ###
+
+###> squizlabs/php_codesniffer ###
+/.phpcs-cache
+/phpcs.xml
+###< squizlabs/php_codesniffer ###

composer.json

@@ -50,7 +50,10 @@
         "twig/twig": "^2.12|^3.0"
     },
     "require-dev": {
+        "dama/doctrine-test-bundle": "^7.1",
+        "phpstan/phpstan": "^1.7",
         "phpunit/phpunit": "^9.5",
+        "squizlabs/php_codesniffer": "^3.6",
         "symfony/browser-kit": "6.0.*",
         "symfony/css-selector": "6.0.*",
         "symfony/debug-bundle": "6.0.*",

composer.lock

@@ -15,4 +15,5 @@
     EasyCorp\Bundle\EasyAdminBundle\EasyAdminBundle::class => ['all' => true],
     Symfony\UX\Chartjs\ChartjsBundle::class => ['all' => true],
     Symfony\WebpackEncoreBundle\WebpackEncoreBundle::class => ['all' => true],
+    DAMA\DoctrineTestBundle\DAMADoctrineTestBundle::class => ['test' => true],
 ];

config/bundles.php

@@ -0,0 +1,4 @@
+dama_doctrine_test:
+    enable_static_connection: true
+    enable_static_meta_data_cache: true
+    enable_static_query_cache: true