4NK_env/docs/README-URL-TESTS.md

136 lines
4.1 KiB
Markdown

# Tests de Santé des URLs - LeCoffre Node
## 🎯 Objectif
Ce répertoire contient les scripts de vérification de santé des URLs pour LeCoffre Node, intégrés dans les processus de backup et de production.
## 📁 Fichiers Créés
### Scripts Principaux
- **`url-health-check.sh`** : Script principal de test d'URLs (toutes les URLs internes et externes)
- **`production-health-check.sh`** : Script de vérification complète pour la production (avec rapport Markdown)
- **`backup-data.sh`** : Script de backup modifié (intègre les tests d'URLs avant/après)
### Documentation
- **`URL-HEALTH-CHECKING.md`** : Documentation complète des tests d'URLs
- **`README-URL-TESTS.md`** : Ce fichier (synthèse)
## 🚀 Utilisation Rapide
### Test des URLs
```bash
cd /home/debian/4NK_env/scripts/lecoffre_node
./url-health-check.sh
```
### Rapport de Production
```bash
cd /home/debian/4NK_env/scripts/lecoffre_node
./production-health-check.sh
```
### Backup avec Tests
```bash
cd /home/debian/4NK_env/scripts/lecoffre_node
./backup-data.sh
```
## 📊 URLs Testées
### ✅ URLs Interne (Services Docker)
- BlindBit Oracle API (`http://localhost:8000/tweaks/1`)
- SDK Storage Health (`http://localhost:8081/health`)
- SDK Relay WebSocket (`http://localhost:8091/`)
- SDK Relay HTTP (`http://localhost:8090/`)
- LeCoffre Frontend (`http://localhost:3004/`)
- IHM Client (`http://localhost:3003/`)
- Grafana (`http://localhost:3005/`)
- Loki (`http://localhost:3100/ready`)
- Status API (`http://localhost:3006/api`)
### ✅ URLs Externes (Domaine Public)
- Site Principal (`<PUBLIC_BASE_URL>/`)
- Page de Statut (`<PUBLIC_BASE_URL>/status/`)
- Dashboard Grafana (`<PUBLIC_BASE_URL>/grafana/`)
- Application LeCoffre (`<PUBLIC_BASE_URL>/lecoffre/`)
- Login LeCoffre (`<PUBLIC_BASE_URL>/lecoffre/login`)
- Callback Auth (`<PUBLIC_BASE_URL>/lecoffre/authorized-client`)
### ✅ APIs Externes (Backend Services)
- API Backend Health (`<BACKEND_BASE_URL>/api/v1/health`)
- API Backend Status (`<BACKEND_BASE_URL>/api/v1/status`)
- IdNot State Endpoint (`<BACKEND_BASE_URL>/api/v1/idnot/state`)
### ✅ WebSockets Externes
- Bootstrap Relay (`wss://<WS_BOOTSTRAP_HOST>/ws/`)
### ✅ Services Externes (Dépendances)
- Mempool Signet (`<MEMPOOL_URL>`)
- Service IdNot (`https://qual-connexion.idnot.fr/`)
- IdNot Authorization (`https://qual-connexion.idnot.fr/IdPOAuth2/authorize/idnot_idp_v1`)
## 📈 Intégration dans les Processus
### Backup
- **Avant** : Test de l'état des URLs
- **Après** : Vérification de la cohérence
- **Logs** : Sauvegardés avec le backup
### Production
- **État complet** : Services, disque, mémoire, volumes
- **Rapport Markdown** : Généré automatiquement
- **Recommandations** : Actions suggérées
## 🔍 Codes de Retour
- **0** : Toutes les URLs sont accessibles
- **1** : Certaines URLs ne sont pas accessibles (majorité fonctionne)
- **2** : Trop d'URLs ne sont pas accessibles
## 📝 Fichiers Générés
### Backup
```
./backups/
├── lecoffre_backup_YYYYMMDD_HHMMSS.tar.gz
├── url-health-check-pre-backup-YYYYMMDD_HHMMSS.log
└── url-health-check-post-backup-YYYYMMDD_HHMMSS.log
```
### Production
```
./reports/
├── production-health-report-YYYYMMDD_HHMMSS.md
└── url-tests-production-YYYYMMDD_HHMMSS.log
```
## 🚨 Dépannage
### URLs Internes Non Accessibles
- Vérifier les services Docker : `docker ps`
- Consulter les logs : `docker logs <service_name>`
- Vérifier les ports et la configuration réseau
### URLs Externes Non Accessibles
- Vérifier la configuration nginx
- Vérifier les certificats SSL
- Vérifier la connectivité réseau externe
### APIs Non Accessibles
- Vérifier la configuration CORS
- Vérifier la connectivité vers `<BACKEND_BASE_URL>`
- Consulter les logs du backend
## 📚 Documentation Complète
Pour plus de détails, consultez :
- **`docs/scripts/URL-HEALTH-CHECKING.md`** : Documentation complète
- **`scripts/url-health-check.sh`** : Code source du script principal
- **`scripts/production-health-check.sh`** : Code source du script de production
---
**Créé le 2025-09-25**
**Version** : 1.0
**Usage** : Tests de santé LeCoffre Node