Validateur de Configuration
Valide les fichiers de configuration et les variables d'environnement pour éviter les erreurs d'exécution et les paramètres manquants.
Quand l'utiliser
- Travailler avec des variables d'environnement ou des fichiers de configuration
- Problèmes de déploiement ou de configuration
- L'utilisateur mentionne ".env", "config", "variables d'environnement" ou "paramètres"
Instructions
1. Trouver les fichiers de configuration
Recherchez :
.env,.env.example,.env.localconfig/,config.js,config.jsonsettings.py,application.ymlappsettings.json,.env.production
2. Détecter les variables manquantes
Comparer .env.example vs .env :
# Variables dans l'exemple mais pas dans .env
comm -23 <(grep -o '^[A-Z_]*' .env.example | sort) <(grep -o '^[A-Z_]*' .env | sort)
Variables requises courantes :
DATABASE_URL
API_KEY
SECRET_KEY
NODE_ENV
PORT
3. Valider le format des variables
Vérifier les problèmes courants :
// Guillemets manquants pour les valeurs avec espaces
DATABASE_URL=postgres://localhost/db name // Mauvais
DATABASE_URL="postgres://localhost/db name" // Bon
// Protocole manquant
API_URL=example.com // Mauvais
API_URL=https://example.com // Bon
// Booléen comme chaîne
DEBUG=true // Peut être interprété comme une chaîne
DEBUG=1 // Plus explicite
4. Valider les variables requises à l'exécution
Exemple Node.js :
const requiredEnvVars = [
'DATABASE_URL',
'API_KEY',
'JWT_SECRET'
];
const missing = requiredEnvVars.filter(v => !process.env[v]);
if (missing.length > 0) {
throw new Error(`Variables d'env manquantes : ${missing.join(', ')}`);
}
Exemple Python :
import os
REQUIRED_ENV_VARS = [
'DATABASE_URL',
'SECRET_KEY',
'ALLOWED_HOSTS'
]
missing = [var for var in REQUIRED_ENV_VARS if not os.getenv(var)]
if missing:
raise EnvironmentError(f"Variables d'env manquantes : {', '.join(missing)}")
5. Validation des types
Valider les types :
const config = {
port: parseInt(process.env.PORT || '3000', 10),
debug: process.env.DEBUG === 'true',
apiUrl: new URL(process.env.API_URL), // Lance une exception si invalide
maxConnections: Number(process.env.MAX_CONNECTIONS),
};
// Valider
if (isNaN(config.port) || config.port < 1 || config.port > 65535) {
throw new Error('PORT doit être un numéro de port valide');
}
6. Générer .env.example
Créer un modèle à partir du .env réel :
# Supprimer les valeurs, garder les clés
sed 's/=.*/=/' .env > .env.example
Ou avec des placeholders :
DATABASE_URL=postgres://utilisateur:motdepasse@localhost:5432/nombdd
API_KEY=votre_cle_api_ici
SECRET_KEY=generer_secret_aleatoire
PORT=3000
NODE_ENV=development
7. Schéma de configuration
Définir un schéma (exemple avec Joi) :
const Joi = require('joi');
const envSchema = Joi.object({
NODE_ENV: Joi.string()
.valid('development', 'production', 'test')
.required(),
PORT: Joi.number()
.port()
.default(3000),
DATABASE_URL: Joi.string()
.uri()
.required(),
API_KEY: Joi.string()
.min(32)
.required(),
DEBUG: Joi.boolean()
.default(false),
}).unknown();
const { error, value } = envSchema.validate(process.env);
if (error) {
throw new Error(`Erreur de validation de config : ${error.message}`);
}
module.exports = value;
8. Vérifications de sécurité
Ne pas commit les secrets :
# Vérifier si .env est dans .gitignore
if ! grep -q "^\.env$" .gitignore; then
echo "Attention : .env n'est pas dans .gitignore"
fi
# Vérifier les secrets codés en dur dans le code
grep -r "api_key.*=.*['\"]" --exclude-dir=node_modules
Problèmes de sécurité courants :
- Mots de passe/clés codés en dur
- Secrets par défaut en production
- Configurations sensibles exposées
- Secrets non chiffrés
9. Configurations spécifiques à l'environnement
Organiser par environnement :
.env.development
.env.staging
.env.production
.env.test
Charger de manière appropriée :
require('dotenv').config({
path: `.env.${process.env.NODE_ENV || 'development'}`
});
10. Documenter toutes les variables
Créer CONFIG.md :
# Configuration
## Variables d'environnement
### Requises
- `DATABASE_URL`: Chaîne de connexion PostgreSQL
- Format : `postgres://utilisateur:mdp@hôte:port/bdd`
- Exemple : `postgres://app:secret@localhost:5432/monapp`
- `API_KEY`: Clé API tierce
- Obtenir depuis : https://dashboard.example.com
- Périmètres requis : lecture, écriture
### Optionnelles
- `PORT`: Port du serveur (par défaut : 3000)
- `DEBUG`: Activer les logs de débogage (par défaut : false)
- `MAX_CONNECTIONS`: Taille du pool de connexions BDD (par défaut : 10)
## Configuration
1. Copier `.env.example` vers `.env`
2. Remplir toutes les valeurs requises
3. Exécuter `npm run validate-config` pour vérifier
11. Script de validation
Créer scripts/validate-config.js :
const fs = require('fs');
function validateConfig() {
const required = ['DATABASE_URL', 'API_KEY'];
const missing = required.filter(v => !process.env[v]);
if (missing.length > 0) {
console.error(`❌ Manquant : ${missing.join(', ')}`);
process.exit(1);
}
console.log('✓ Toutes les variables de configuration requises sont présentes');
}
validateConfig();
12. Bonnes pratiques
- Ne jamais commit .env : Toujours dans .gitignore
- Maintenir .env.example : Le tenir à jour
- Valider au démarrage : Échouer rapidement si mal configuré
- Utiliser des valeurs par défaut robustes : Solutions de repli sensées
- Tout documenter : Expliquer chaque variable
- Rotation des secrets : Mettre à jour régulièrement les clés
- Utiliser des gestionnaires de secrets : Vault, AWS Secrets Manager en production
- Vérifier les types : Valider les types, pas seulement la présence
Fichiers supports
templates/config-validator.jstemplates/.env.examplescripts/generate-env-example.sh