Skip to content
This repository has been archived by the owner on Dec 11, 2020. It is now read-only.

Latest commit

 

History

History
105 lines (77 loc) · 2.95 KB

DEVELOPMENT.md

File metadata and controls

105 lines (77 loc) · 2.95 KB
Raw

Développement

Installation

Prérequis :

Il faut d'abord installer les dépendances.

dep ensure

Puis démarrer la base de données.

docker-compose up -d

Enfin lancer l'application.

go run main.go

Organisation

  • app/ : config et bootstrap application
  • authentication/ : gestion des sessions et de l'authentification via SSO
  • cron/ : cron qui définit les tâches périodiques
  • database/ : couche d'accès à la base de données
  • domain/ : services métier
  • emails/ : envoi d'emails par SMTP
  • errors/ : erreurs applicatives
  • events/ : gestion des événements pour mettre à jour les données automatiquement chez les clients via WebSocket
  • httpserver/ : serveur HTTP
  • models/ : entités métier
  • redis/ : client Redis
  • storage/ : gestion des documents (pièces-jointes et rapports) via Minio
  • templates/ : gestion et rendu des templates (documents ODT et emails)
  • tests/benchmark/ : tests de benchmark
  • tests/e2e/ : tests end-to-end (HTTP)
  • tests/integration/ : tests d'intégration (services)
  • util/ : fonctions utilitaires
  • vendor/ : contient les dépendances
  • main.go : point d'entrée
  • gopkg.toml : fichier descripteur des dépendances

Lint

golangci-lint permet de linter le code.

golangci-lint run

Mise à jour des mocks

go generate ./...

Tests

Lancement d'un test :

go test -p 1 -v tests/e2e/inspections_test.go

Lancement de tous les tests :

go test -p 1 -v ./...
  • DEBUG_HTTP=1 permet d'afficher les requêtes et réponses HTTP et leur body (JSON).
  • FILHARMONIC_DATABASE_LOGSQL=1 permet d'afficher les requêtes SQL.

Benchmarks

On utilise k6, qui permet d'écrire des scénarios en javascript.

Pour lancer un test pendant 10 secondes avec 4 utilisateurs en parallèle.

docker run -it --rm -v $PWD/tests/benchmark/:/benchmark --network host loadimpact/k6 run -u 4 -d 10s /benchmark/creation_inspection.js

Pour afficher les requêtes HTTP et leur contenu :

docker run -it --rm -v $PWD/tests/benchmark/:/benchmark --network host loadimpact/k6 run --http-debug=full /benchmark/creation_inspection.js

Modifications du modèle

Pour vérifier que le schéma des migrations correpond bien à celui des structures, lancer le script suivant :

./database/scripts/check_migrations.sh

Afin que le script de vérification fonctionne, il faut veiller à ce que chaque nouveau champ ajouté à un modèle soit défini après tous les autres champs car PostgreSQL ne permet pas de changer la position des colonne sans recréer la table.