a948eed9b6
Auto Tag Develop / tag (push) Successful in 7s
Ticket Lesstime : ERP-67 — `[Convention SQL / Backend / L]` ## Objectif Documenter toutes les colonnes BDD via `COMMENT ON COLUMN` (visible dans DBeaver / DataGrip / pgAdmin sans lire le code Doctrine) et verrouiller la convention par un garde-fou de test architecture. ## Changements ### Convention (CLAUDE.md + rules) - `CLAUDE.md` regle ABSOLUE n°12 : toute migration creant ou modifiant une colonne doit poser un `COMMENT ON COLUMN` (FR, ≤ 200 caracteres). - `.claude/rules/backend.md` § Migrations Doctrine : exemples + helper standardise pour les 4 colonnes du `TimestampableBlamableTrait`. ### Garde-fou architecture - `tests/Architecture/ColumnsHaveSqlCommentTest` : echoue si une colonne `public` n'a pas de `col_description` (hors `doctrine_migration_versions` et `fake_site_aware_entity` fixture de test). - Whitelist metier `EXCLUDED_TABLES` volontairement vide. ### Retrofit des tables existantes - Migration `Version20260528120000` : 64 `COMMENT ON TABLE/COLUMN` sur les 11 tables metier (audit_log, category, category_type, permission, role, role_permission, site, user, user_permission, user_role, user_site). - Source unique de verite : `src/Shared/Infrastructure/Database/ColumnCommentsCatalog.php`. - Commande `app:apply-column-comments` (Module/Core/Infrastructure/Console) : rejoue le catalogue apres `doctrine:schema:update --force` (sinon l'ORM drop les commentaires absents du mapping PHP). Branchee dans `makefile test-db-setup` et `.gitea/workflows/pull-request.yml`. ## Validation - `make db-reset` puis `make test` : 312 tests verts, 0 regression. - `make php-cs-fixer-allow-risky` : 0 fix. - Couverture : 53/53 colonnes documentees sur `starseed` et `starseed_test`. ## Test plan - [ ] `make db-reset` passe sans erreur. - [ ] `make test` passe ; `ColumnsHaveSqlCommentTest` vert sur DB de test. - [ ] Verifier dans DBeaver / pgAdmin que les commentaires apparaissent sur les colonnes de `category`, `user`, `audit_log`. - [ ] Verifier que le workflow CI Gitea (`pull-request.yml`) passe. ## A noter pour la suite La convention `options: ['comment' => '...']` sur chaque `#[ORM\Column]` reste recommandee pour les nouvelles entites — Doctrine genere alors automatiquement le `COMMENT ON COLUMN` dans la migration et `schema:update` le preserve sans avoir a rejouer le catalogue. A discuter si on veut en faire une regle forte. --------- Co-authored-by: admin malio <malio@yuno.malio.fr> Co-authored-by: Matthieu <contact@malio.fr> Co-authored-by: Matthieu <mtholot19@gmail.com> Reviewed-on: #24 Co-authored-by: THOLOT DECHENE Matthieu <matthieu@yuno.malio.fr> Co-committed-by: THOLOT DECHENE Matthieu <matthieu@yuno.malio.fr>
132 lines
5.1 KiB
YAML
132 lines
5.1 KiB
YAML
name: Pull Request — Quality gate
|
|
|
|
# Lance les tests + lint + build sur chaque PR ciblant develop.
|
|
# Deux jobs en parallele (backend / frontend) pour reduire le temps de feedback.
|
|
# E2E volontairement hors scope (cf. regle d'or testing.md).
|
|
|
|
on:
|
|
pull_request:
|
|
branches:
|
|
- develop
|
|
|
|
# Annule les runs obsoletes quand on repush sur la meme PR.
|
|
concurrency:
|
|
group: pr-${{ gitea.event.pull_request.number }}
|
|
cancel-in-progress: true
|
|
|
|
jobs:
|
|
backend:
|
|
name: Backend (PHP CS + PHPUnit)
|
|
runs-on: ubuntu-latest
|
|
|
|
services:
|
|
postgres:
|
|
image: postgres:16-alpine
|
|
env:
|
|
# Doivent matcher la DATABASE_URL ci-dessous. Le suffixe `_test`
|
|
# est applique automatiquement par Doctrine en APP_ENV=test.
|
|
POSTGRES_USER: app
|
|
POSTGRES_PASSWORD: '!ChangeMe!'
|
|
POSTGRES_DB: app
|
|
# Pas de `ports:` host mapping — le runner partage l'hote avec la
|
|
# prod (Postgres deja sur 5432) et les jobs Gitea Actions tournent
|
|
# en container sur un reseau Docker dedie : le service est joignable
|
|
# via son nom (`postgres`), pas via 127.0.0.1.
|
|
options: >-
|
|
--health-cmd "pg_isready -U app"
|
|
--health-interval 5s
|
|
--health-timeout 5s
|
|
--health-retries 10
|
|
|
|
env:
|
|
APP_ENV: test
|
|
APP_SECRET: ci-secret-not-used
|
|
APP_DEBUG: 0
|
|
DEFAULT_URI: http://localhost/
|
|
DATABASE_URL: postgresql://app:!ChangeMe!@postgres:5432/app?serverVersion=16&charset=utf8
|
|
JWT_SECRET_KEY: '%kernel.project_dir%/config/jwt/private.pem'
|
|
JWT_PUBLIC_KEY: '%kernel.project_dir%/config/jwt/public.pem'
|
|
JWT_PASSPHRASE: change_me_in_env_local
|
|
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v4
|
|
|
|
- name: Setup PHP 8.4
|
|
uses: shivammathur/setup-php@v2
|
|
with:
|
|
php-version: '8.4'
|
|
extensions: pdo, pdo_pgsql, intl, opcache, zip, mbstring, sodium
|
|
coverage: none
|
|
tools: composer:v2
|
|
|
|
# Cache Composer retire : meme cause que cote front — le backend de cache
|
|
# du runner Gitea est injoignable (ETIMEDOUT) et fait timeouter le step
|
|
# ~4 min 30. A re-activer si le serveur de cache du runner est repare.
|
|
- name: Install PHP dependencies
|
|
run: composer install --no-interaction --no-progress --prefer-dist
|
|
|
|
- name: Generate JWT keypair
|
|
run: php bin/console lexik:jwt:generate-keypair --skip-if-exists --no-interaction
|
|
|
|
- name: PHP CS Fixer (dry-run)
|
|
run: vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.dist.php --allow-risky=yes --dry-run --diff
|
|
|
|
- name: Bootstrap test database
|
|
# Aligne sur la cible `test-db-setup` du makefile : apres
|
|
# `schema:update --force`, on RECREE manuellement l'index unique
|
|
# partiel `uq_category_name_type_active` car Doctrine ORM ne sait
|
|
# pas exprimer les index fonctionnels partiels (LOWER(name) + WHERE
|
|
# deleted_at IS NULL) et `schema:update` les considere comme
|
|
# orphelins et les DROP — collisions non detectees, tests d'unicite
|
|
# qui attendent 409 recoivent 201.
|
|
run: |
|
|
php bin/console doctrine:database:create --env=test --if-not-exists --no-interaction
|
|
php bin/console doctrine:migrations:migrate --env=test --no-interaction
|
|
php bin/console doctrine:schema:update --env=test --force --no-interaction
|
|
# Rejoue le catalogue COMMENT ON apres schema:update (cf. ERP-67) :
|
|
# schema:update drop les commentaires des tables managees par l'ORM.
|
|
php bin/console app:apply-column-comments --env=test --no-interaction
|
|
php bin/console doctrine:fixtures:load --env=test --no-interaction
|
|
php bin/console app:sync-permissions --env=test --no-interaction
|
|
php bin/console --env=test dbal:run-sql "CREATE UNIQUE INDEX IF NOT EXISTS uq_category_name_type_active ON category (LOWER(name), category_type_id) WHERE deleted_at IS NULL"
|
|
|
|
- name: Run PHPUnit
|
|
run: php -d memory_limit=512M vendor/bin/phpunit
|
|
|
|
frontend:
|
|
name: Frontend (lint + Vitest + build)
|
|
runs-on: ubuntu-latest
|
|
defaults:
|
|
run:
|
|
working-directory: frontend
|
|
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v4
|
|
|
|
# Pas de `cache: npm` : le backend de cache du runner Gitea est injoignable
|
|
# (ETIMEDOUT) et chaque tentative de restauration attend ~4 min 30 avant de
|
|
# timeout — c'est ce qui plombait le job. Node 22 est deja dans le
|
|
# tool-cache du runner (install instantane), et `npm ci` a froid ne prend
|
|
# que ~30s. A re-activer si le serveur de cache du runner est repare.
|
|
- name: Setup Node 22
|
|
uses: actions/setup-node@v4
|
|
with:
|
|
node-version: '22'
|
|
|
|
- name: Install Node dependencies
|
|
run: npm ci
|
|
|
|
- name: ESLint
|
|
run: npm run lint
|
|
|
|
- name: Unit tests (Vitest)
|
|
run: npm run test
|
|
|
|
# `nuxt build` (et non `build:dist`/`nuxt generate`) : l'app est en SSR off
|
|
# (SPA), le prerender de generate n'apporte rien a une quality gate — on
|
|
# veut seulement valider que le bundle compile.
|
|
- name: Build production (nuxt build)
|
|
run: npm run build
|