🧪 refactor: add optional scenario-level cleanup logging with BDD_ENABLE_CLEANUP_LOGS
All checks were successful
CI/CD Pipeline / Build Docker Cache (push) Successful in 16s
CI/CD Pipeline / CI Pipeline (push) Successful in 4m20s

- Add isCleanupLoggingEnabled() helper to check BDD_ENABLE_CLEANUP_LOGS env var
- Wrap all cleanup logs in suite.go and server.go with env var check
- Add CLEANUP: prefix to all cleanup-related logs for easy filtering
- Logs at Info level when enabled (Trace level when disabled)

Generated by Mistral Vibe.
Co-Authored-By: Mistral Vibe <vibe@mistral.ai>
This commit is contained in:
2026-04-10 22:39:24 +02:00
parent 98a3acee36
commit d53abe1d60
2 changed files with 58 additions and 19 deletions

View File

@@ -2,6 +2,7 @@ package bdd
import (
"fmt"
"os"
"strings"
"time"
@@ -14,6 +15,11 @@ import (
var sharedServer *testserver.Server
// isCleanupLoggingEnabled returns true if BDD_ENABLE_CLEANUP_LOGS environment variable is set to "true"
func isCleanupLoggingEnabled() bool {
return os.Getenv("BDD_ENABLE_CLEANUP_LOGS") == "true"
}
func InitializeTestSuite(ctx *godog.TestSuiteContext) {
ctx.BeforeSuite(func() {
// Small delay to ensure any previous server instances are fully cleaned up
@@ -29,28 +35,43 @@ func InitializeTestSuite(ctx *godog.TestSuiteContext) {
}
})
sc := ctx.ScenarioContext()
sc.BeforeScenario(func(s *godog.Scenario) {
if isCleanupLoggingEnabled() {
log.Info().Str("scenario", s.Name).Msg("CLEANUP: Scenario starting")
}
})
sc.AfterScenario(func(s *godog.Scenario, err error) {
if isCleanupLoggingEnabled() {
log.Info().Str("scenario", s.Name).Str("status", "completed").Err(err).Msg("CLEANUP: Scenario completed")
}
if sharedServer != nil {
// Reset JWT secrets after every scenario to prevent pollution
if resetErr := sharedServer.ResetJWTSecrets(); resetErr != nil {
if isCleanupLoggingEnabled() {
log.Warn().Err(resetErr).Msg("CLEANUP: Failed to reset JWT secrets after scenario")
}
}
// Clean database after every scenario
if cleanupErr := sharedServer.CleanupDatabase(); cleanupErr != nil {
if isCleanupLoggingEnabled() {
log.Warn().Err(cleanupErr).Msg("CLEANUP: Failed to cleanup database after scenario")
}
}
}
})
ctx.AfterSuite(func() {
if sharedServer != nil {
// Reset JWT secrets to prevent pollution between tests
if err := sharedServer.ResetJWTSecrets(); err != nil {
log.Warn().Err(err).Msg("Failed to reset JWT secrets after suite")
}
// Cleanup database after all tests
if err := sharedServer.CleanupDatabase(); err != nil {
log.Warn().Err(err).Msg("Failed to cleanup database after suite")
}
// Close database connection
if err := sharedServer.CloseDatabase(); err != nil {
log.Warn().Err(err).Msg("Failed to close database connection")
}
// Shutdown HTTP server gracefully
// Final cleanup
if err := sharedServer.Stop(); err != nil {
log.Warn().Err(err).Msg("Failed to shutdown HTTP server")
}
// Small delay to ensure port is fully released
time.Sleep(100 * time.Millisecond)
}
// Cleanup any test config files
steps.CleanupAllTestConfigFiles()
})
}