the-tip-top-backend/Jenkinsfile
soufiane fa0f2579ba feat: add email notifications to CI/CD pipeline
- Send success/failure notifications to soufiane.baali99@gmail.com
- Include build details: project, build number, environment, duration
- HTML formatted emails with links to build logs

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-28 09:39:07 +01:00

343 lines
17 KiB
Groovy

/**
* ============================================================================
* PIPELINE CI/CD - THÉ TIP TOP BACKEND
* ============================================================================
*
* Ce pipeline automatise le processus de déploiement continu du backend.
*
* ÉTAPES DU PIPELINE :
* 1. Init - Détection de l'environnement (dev/preprod/prod)
* 2. Checkout - Récupération du code source depuis Git
* 3. Install - Installation des dépendances Node.js
* 4. Quality - Vérification qualité (ESLint + Jest + SonarQube)
* 5. Build - Construction de l'image Docker
* 6. Push - Envoi de l'image vers le registre Docker privé
* 7. Backup - Sauvegarde de la base de données (prod uniquement)
* 8. Deploy - Déploiement sur le serveur cible
*
* ENVIRONNEMENTS :
* - dev : Développement (branche dev)
* - preprod : Pré-production (branche preprod)
* - prod : Production (branche main)
*
* ============================================================================
*/
pipeline {
agent any
// =========================================================================
// DÉCLENCHEUR : Vérifie les changements Git chaque minute
// =========================================================================
triggers {
pollSCM('* * * * *')
}
// =========================================================================
// PARAMÈTRES : Permet de choisir manuellement l'environnement
// =========================================================================
parameters {
choice(
name: 'ENV',
choices: ['dev', 'preprod', 'prod'],
description: 'Choisir l environnement de deploiement'
)
}
// =========================================================================
// VARIABLES D'ENVIRONNEMENT GLOBALES
// =========================================================================
environment {
REGISTRY_URL = "registry.wk-archi-o24a-15m-g3.fr"
IMAGE_NAME = "the-tip-top-backend"
NPM_CACHE = "/var/jenkins_home/npm-cache"
}
stages {
// =====================================================================
// ÉTAPE 1 : INITIALISATION
// ---------------------------------------------------------------------
// But : Détecter automatiquement l'environnement selon la branche Git
// - Branche 'dev' → Environnement dev
// - Branche 'preprod' → Environnement preprod
// - Branche 'main' → Environnement prod
// =====================================================================
stage('🧭 Init - Détection environnement') {
steps {
script {
def currentBranch = sh(script: "git rev-parse --abbrev-ref HEAD", returnStdout: true).trim()
echo "🧭 Branche détectée : ${currentBranch}"
if (["dev", "preprod", "main"].contains(currentBranch)) {
env.ENV = (currentBranch == "main") ? "prod" : currentBranch
} else {
env.ENV = params.ENV ?: "dev"
}
env.TAG = "${env.ENV}-latest"
env.DEPLOY_PATH = "/srv/devops/the-tip-top/${env.ENV}"
echo """
╔══════════════════════════════════════════╗
║ CONFIGURATION PIPELINE ║
╠══════════════════════════════════════════╣
║ 🌍 Environnement : ${env.ENV.padRight(18)} ║
║ 🏷️ Tag Docker : ${env.TAG.padRight(18)} ║
║ 📂 Chemin déploie. : ${env.DEPLOY_PATH.take(18).padRight(18)} ║
╚══════════════════════════════════════════╝
"""
}
}
}
// =====================================================================
// ÉTAPE 2 : CHECKOUT
// ---------------------------------------------------------------------
// But : Récupérer le code source depuis le dépôt Gitea
// Action : Clone ou pull du code selon l'état du workspace
// =====================================================================
stage('📦 Checkout - Récupération code source') {
steps {
echo "📦 Récupération du code source depuis Gitea..."
checkout scm
echo "✅ Code source récupéré avec succès"
}
}
// =====================================================================
// ÉTAPE 3 : INSTALLATION DES DÉPENDANCES
// ---------------------------------------------------------------------
// But : Installer les packages Node.js nécessaires
// Container : node:18-alpine (léger et rapide)
// Commande : npm ci (installation propre depuis package-lock.json)
// Cache : Utilise un cache NPM partagé pour accélérer les builds
// =====================================================================
stage('📦 Install - Dépendances Node.js') {
agent {
docker {
image 'node:18-alpine'
args "-u root -v ${NPM_CACHE}:/root/.npm"
}
}
steps {
echo "📦 Installation des dépendances Node.js..."
sh 'npm ci --prefer-offline'
stash includes: 'node_modules/**', name: 'node_modules'
echo "✅ Dépendances installées avec succès"
}
}
// =====================================================================
// ÉTAPE 4 : CONTRÔLES QUALITÉ (Exécution parallèle)
// ---------------------------------------------------------------------
// Exécute en parallèle :
// - Lint & Tests : ESLint + Jest avec couverture de code
// - SonarQube : Analyse statique de la qualité du code
// =====================================================================
stage('🔍 Quality - Contrôles qualité') {
parallel {
// -------------------------------------------------------------
// 4a. LINT & TESTS
// -------------------------------------------------------------
// ESLint : Vérifie le style et les erreurs de code
// Jest : Exécute les tests unitaires et d'intégration
// Couverture : Génère un rapport de couverture (lcov)
// -------------------------------------------------------------
stage('🧪 Lint & Tests') {
agent {
docker {
image 'node:18-alpine'
args "-u root -v ${NPM_CACHE}:/root/.npm"
}
}
steps {
unstash 'node_modules'
echo "🧪 Lancement ESLint et Jest..."
script {
def lintStatus = sh(script: 'npm run lint', returnStatus: true)
def testStatus = sh(script: 'npm test', returnStatus: true)
if (lintStatus != 0) {
error "❌ ESLint a échoué - Corrigez les erreurs de style"
}
if (testStatus != 0) {
error "❌ Les tests ont échoué - Vérifiez les tests unitaires"
}
echo "✅ Lint et tests passés avec succès"
}
}
}
// -------------------------------------------------------------
// 4b. SONARQUBE
// -------------------------------------------------------------
// Analyse statique du code pour détecter :
// - Bugs potentiels
// - Vulnérabilités de sécurité
// - Code smells (mauvaises pratiques)
// - Couverture de code insuffisante
// -------------------------------------------------------------
stage('📊 SonarQube Analysis') {
agent {
docker {
image 'sonarsource/sonar-scanner-cli:latest'
args '-u root'
}
}
steps {
echo "📊 Analyse SonarQube en cours..."
withSonarQubeEnv('SonarQube') {
sh """
sonar-scanner
"""
}
echo "✅ Analyse SonarQube terminée"
}
}
}
}
// =====================================================================
// ÉTAPE 5 : BUILD IMAGE DOCKER
// ---------------------------------------------------------------------
// But : Construire l'image Docker du backend
// Tags créés :
// - {env}-latest (ex: dev-latest, prod-latest)
// - latest
// =====================================================================
stage('🐳 Build - Image Docker') {
steps {
echo "🐳 Construction de l'image Docker backend..."
sh """
docker build -t ${REGISTRY_URL}/${IMAGE_NAME}:${TAG} .
docker tag ${REGISTRY_URL}/${IMAGE_NAME}:${TAG} ${REGISTRY_URL}/${IMAGE_NAME}:latest
"""
echo "✅ Image Docker construite : ${REGISTRY_URL}/${IMAGE_NAME}:${TAG}"
}
}
// =====================================================================
// ÉTAPE 6 : PUSH VERS LE REGISTRE
// ---------------------------------------------------------------------
// But : Envoyer l'image Docker vers le registre privé
// Registre : registry.wk-archi-o24a-15m-g3.fr
// Authentification : Credentials Jenkins sécurisés
// =====================================================================
stage('📤 Push - Registre Docker') {
steps {
echo "📤 Envoi de l'image vers le registre Docker privé..."
withCredentials([usernamePassword(credentialsId: 'registry-credentials', usernameVariable: 'REG_USER', passwordVariable: 'REG_PASS')]) {
sh """
echo "$REG_PASS" | docker login ${REGISTRY_URL} -u "$REG_USER" --password-stdin
docker push ${REGISTRY_URL}/${IMAGE_NAME}:${TAG}
docker push ${REGISTRY_URL}/${IMAGE_NAME}:latest
"""
}
echo "✅ Image envoyée avec succès vers ${REGISTRY_URL}"
}
}
// =====================================================================
// ÉTAPE 7 : BACKUP BASE DE DONNÉES (Production uniquement)
// ---------------------------------------------------------------------
// But : Sauvegarder la base de données avant le déploiement
// Condition : Seulement en environnement de production
// Script : /srv/devops/the-tip-top/backup.sh
// Sécurité : Continue même si le backup échoue (warning)
// =====================================================================
stage('💾 Backup - Base de données') {
when {
expression { env.ENV == 'prod' }
}
steps {
echo "💾 Sauvegarde de la base de données PostgreSQL..."
sh """
/srv/devops/the-tip-top/backup.sh || echo "⚠️ Backup échoué mais on continue"
"""
echo "✅ Backup de la base de données terminé"
}
}
// =====================================================================
// ÉTAPE 8 : DÉPLOIEMENT
// ---------------------------------------------------------------------
// But : Déployer le backend sur le serveur cible
// Actions :
// 1. Pull de la nouvelle image depuis le registre
// 2. Recréation du container avec la nouvelle image
// Chemins : /srv/devops/the-tip-top/{dev|preprod|prod}
// =====================================================================
stage('🚀 Deploy - Mise en production') {
steps {
echo "🚀 Déploiement du backend sur l'environnement ${env.ENV}..."
sh """
cd "${DEPLOY_PATH}"
docker compose pull backend
docker compose up -d --force-recreate backend
"""
echo "✅ Backend déployé avec succès sur ${env.ENV}"
}
}
}
// =========================================================================
// ACTIONS POST-PIPELINE
// =========================================================================
post {
success {
echo """
╔══════════════════════════════════════════╗
║ ✅ PIPELINE TERMINÉ AVEC SUCCÈS ║
╠══════════════════════════════════════════╣
║ Environnement : ${env.ENV.padRight(23)} ║
║ Image : ${IMAGE_NAME.padRight(23)} ║
║ Tag : ${env.TAG.padRight(23)} ║
╚══════════════════════════════════════════╝
"""
emailext(
to: 'soufiane.baali99@gmail.com',
subject: "✅ Pipeline Backend SUCCÈS - ${env.ENV}",
body: """
<h2 style="color: green;">✅ Pipeline Backend terminé avec succès</h2>
<table border="1" cellpadding="10" style="border-collapse: collapse;">
<tr><td><strong>Projet</strong></td><td>${env.JOB_NAME}</td></tr>
<tr><td><strong>Build</strong></td><td>#${env.BUILD_NUMBER}</td></tr>
<tr><td><strong>Environnement</strong></td><td>${env.ENV}</td></tr>
<tr><td><strong>Image</strong></td><td>${IMAGE_NAME}:${env.TAG}</td></tr>
<tr><td><strong>Durée</strong></td><td>${currentBuild.durationString}</td></tr>
</table>
<p>🔗 <a href="${env.BUILD_URL}">Voir les détails du build</a></p>
""",
mimeType: 'text/html'
)
}
failure {
echo """
╔══════════════════════════════════════════╗
║ ❌ ÉCHEC DU PIPELINE ║
╠══════════════════════════════════════════╣
║ Environnement : ${env.ENV.padRight(23)} ║
║ Vérifiez les logs pour plus de détails ║
╚══════════════════════════════════════════╝
"""
emailext(
to: 'soufiane.baali99@gmail.com',
subject: "❌ Pipeline Backend ÉCHEC - ${env.ENV}",
body: """
<h2 style="color: red;">❌ Pipeline Backend a échoué</h2>
<table border="1" cellpadding="10" style="border-collapse: collapse;">
<tr><td><strong>Projet</strong></td><td>${env.JOB_NAME}</td></tr>
<tr><td><strong>Build</strong></td><td>#${env.BUILD_NUMBER}</td></tr>
<tr><td><strong>Environnement</strong></td><td>${env.ENV}</td></tr>
<tr><td><strong>Durée</strong></td><td>${currentBuild.durationString}</td></tr>
</table>
<p>🔗 <a href="${env.BUILD_URL}">Voir les logs du build</a></p>
<p>🔗 <a href="${env.BUILD_URL}console">Console Output</a></p>
""",
mimeType: 'text/html'
)
}
}
}