INFO PROJET

App Spring Boot : Flashcards - readme CI

Docker Image Hub

Qualité/couverture: SonarQube Cloud

Présentation générale de l'application

Ce projet a été conçu pour explorer concrètement le fonctionnement de Java et de Spring Boot à travers une application réelle. Il sert de socle technique stable permettant de mettre en place et de tester des pipelines CI/CD sur différentes plateformes, tout en expérimentant des outils dédiés à la qualité et à la sécurité du code.

Au fil de la série, cette application devient un véritable fil conducteur pour aborder progressivement des problématiques essentielles du développement moderne. Les sujets traités couvrent les tests unitaires et d'intégration, la gestion des profils Spring dans un contexte multi-branches, ainsi que la mise en place de stratégies de qualité incluant tests API et tests de charge. Le projet intègre également des aspects liés au monitoring et à la sécurité, notamment à travers l'utilisation d'Actuator.

Stack technique

Crée à partir d'un squelette, via: https://start.spring.io/

src/
 ├─ main/
 │   ├─ java/com/example/flashcards/
 │   │   ├─ controller/       # REST controllers
 │   │   ├─ service/          # Business services
 │   │   ├─ Entities/         # Entities
 │   │   ├─ dto/              # DTO for API exchanges
 │   │   └─ repository/       # JPA interfaces
 │   └─ resources/
 │       └─ application.properties
 └─ test/
     ├─ controller/           # Unit tests for controllers
     ├─ service/              # Unit tests for services
     └─ integration/          # Integration tests

Choix d'utilisation du bootstrapper de maven

./mvnw clean package

Base de données

La base de données Postgres (16) est la base de données principales, les test (ut-it) utilisent la base H2 en mémoire

Création de la base (optionnel)

psql --version

psql -h localhost -U postgres
Mot de passe pour l'utilisateur postgres :

#une x connecté:
postgres=# CREATE DATABASE flashcardsdb;
CREATE DATABASE
postgres=# \q

Fichier de données initiales:

Les fichiers init-data.sql sont fournis pour chaque branche afin de créer les tables, et d'insérer des catégories et flashcards de test

Profils Spring et environnements

Configuration des fichiers de profils et configuration de la base de données

Les fichiers sont localisé dans: src/main/resources/
→ Le fichier application.properties défini la base de données, le user et le mot de passe utilisé.
→ L'utilisateur postgres étant l'utilisateur admin par défaut de Postgres, le mot de passe: pswd

L'Application REST

La liste complète est disponible dans le README du projet

Web API

Plus "user-friendly", une interface Web simple est fournie via: src/main/resources/static,
     Elle permet d'effectuer le CRUD complet de manière fluide tout en visualisant les catégories ainsi que les flashcards (question/réponse) associées

Endpoints Actuator

Pour voir ce qui à été mis en place dans l'application et comment utiliser les accès restreints, voir l'article: Ajout d'Actuator en 3 étapes
     ou, le readme dans le repository Github

Stratégie de tests et seuil de couverture (vue d'ensemble)

/mvnw clean test
./mvnw clean verify

./mvnw -Dspring.profiles.active=it test 
./mvnw checkstyle:check 
./mvnw spotbugs:check
./mvnw jacoco:report   

/mvnw clean test
./mvnw clean verify -Djacoco.minimum.coverage=0.70

./mvnw spotless:apply
./mvnw clean verify  

Pour + d'informations concernant l'Intégration Continue, explorez les articles correspondant ou rv dans le readme_ci du repository Flashcards

Conclusion

Cette première brique pose volontairement des bases solides.
L'objectif n'est pas la complexité fonctionnelle, mais la maîtrise réaliste et progressive de l'écosystème CI/CD autour d'une application Spring Boot.

Dans l'article suivant, nous verrons comment ajouter les tests unitaires, en prévision de gérer la couverte de code