Rotate logs and backup database on deployed gateways

Sets up a Windows schedule to backup databases and rotate logs every
Sunday at 3am.

Author: steventux

scripts/bash/package_release.sh

@@ -61,7 +61,7 @@ echo ""
 
 # ── Validate required files ───────────────────────────────────────────────────
 
-REQUIRED_FILES=("src/" "sample_images/" "scripts/python/" "pyproject.toml" "uv.lock" "README.md" "LICENCE.md")
+REQUIRED_FILES=("src/" "sample_images/" "scripts/python/" "scripts/powershell/maintenance.ps1" "pyproject.toml" "uv.lock" "README.md" "LICENCE.md")
 
 for item in "${REQUIRED_FILES[@]}"; do
     if [[ ! -e "${REPO_ROOT}/${item}" ]]; then

scripts/powershell/deploy.ps1

@@ -560,6 +560,39 @@ if (-not $cutoverFailed) {
     }
 }
 
+# -- Maintenance schedule -------------------------------------------------------------
+
+if (-not $cutoverFailed) {
+    $maintenanceScriptPath = Join-Path $BaseInstallPath "current\scripts\powershell\maintenance.ps1"
+    $backupAction = New-ScheduledTaskAction `
+        -Execute "powershell.exe" `
+        -Argument "-ExecutionPolicy Bypass -File `"$maintenanceScriptPath`" -Action StopBackupRotate"
+
+    $backupTrigger = New-ScheduledTaskTrigger -Weekly -DaysOfWeek Sunday -At 3AM
+
+    Register-ScheduledTask `
+        -TaskName "Gateway-Daily-Maintenance" `
+        -Action $backupAction `
+        -Trigger $backupTrigger `
+        -User "SYSTEM" `
+        -RunLevel Highest `
+        -Force
+
+    $startAction = New-ScheduledTaskAction `
+        -Execute "powershell.exe" `
+        -Argument "-ExecutionPolicy Bypass -File `"$maintenanceScriptPath`" -Action StartServices"
+
+    $startTrigger = New-ScheduledTaskTrigger -Weekly -DaysOfWeek Sunday -At 3:15AM
+
+    Register-ScheduledTask `
+        -TaskName "Gateway-Daily-Service-Start" `
+        -Action $startAction `
+        -Trigger $startTrigger `
+        -User "SYSTEM" `
+        -RunLevel Highest `
+        -Force
+}
+
 # -- Rollback on Failure ------------------------------------------------------
 
 if ($cutoverFailed) {

scripts/powershell/maintenance.ps1

@@ -0,0 +1,167 @@
+param(
+    [ValidateSet("StopBackupRotate","StartServices")]
+    [string]$BaseInstallPath = "C:\Program Files\NHS\ManageBreastScreeningGateway",
+    [string]$Action
+)
+
+
+# -- Service control helpers -------------------------------------------------------
+
+function Stop-AllServices {
+    param([array]$Services, [int]$TimeoutSeconds)
+    foreach ($svc in $Services) {
+        $status = Get-Service -Name $svc.Name -ErrorAction SilentlyContinue
+        if (-not $status -or $status.Status -eq 'Stopped') { continue }
+
+        Write-Log "Stopping $($svc.Name) (timeout: ${TimeoutSeconds}s)..." "INFO"
+        Stop-Service -Name $svc.Name -Force
+
+        $stopwatch = [System.Diagnostics.Stopwatch]::StartNew()
+        while ($stopwatch.Elapsed.TotalSeconds -lt $TimeoutSeconds) {
+            $current = Get-Service -Name $svc.Name -ErrorAction SilentlyContinue
+            if (-not $current -or $current.Status -eq 'Stopped') { break }
+            Start-Sleep -Milliseconds 500
+        }
+        $stopwatch.Stop()
+
+        $finalStatus = Get-Service -Name $svc.Name -ErrorAction SilentlyContinue
+        if ($finalStatus -and $finalStatus.Status -ne 'Stopped') {
+            throw "Service $($svc.Name) did not stop within ${TimeoutSeconds}s (state: $($finalStatus.Status))."
+        }
+        Write-Log "$($svc.Name) stopped in $([math]::Round($stopwatch.Elapsed.TotalSeconds, 1))s." "INFO"
+    }
+}
+
+function Start-AllServices {
+    param(
+        [array]$Services, [int]$TimeoutSeconds
+    )
+
+    foreach ($svc in $Services) {
+        Write-Log "Starting $($svc.Name)..." "INFO"
+
+        Start-Service -Name $svc.Name
+
+        $stopwatch = [System.Diagnostics.Stopwatch]::StartNew()
+        while ($stopwatch.Elapsed.TotalSeconds -lt $TimeoutSeconds) {
+            $status = Get-Service -Name $svc.Name -ErrorAction SilentlyContinue
+            if ($status -and $status.Status -eq 'Running') { break }
+            Start-Sleep -Milliseconds 500
+        }
+
+        if ($status.Status -ne 'Running') {
+            throw "Failed to start $($svc.Name)"
+        }
+
+        Write-Log "$($svc.Name) started." "SUCCESS"
+    }
+}
+
+# -- Database backup ----------------------------------------------------------
+
+function Invoke-DatabaseBackup {
+    param(
+        [string]$BaseInstallPath
+    )
+
+    $batPath = Join-Path $versionDir "backup_database.bat"
+
+    if (-not (Test-Path $batPath)) {
+      $batContent = @(
+          '@echo off',
+          "cd /d `"$BaseInstallPath`"",
+          'set "PYTHONPATH=current\src"',
+          ('"current\.venv\Scripts\python.exe" "-c import scripts.python.database; scripts.python.database.backup_databases()"')
+      ) -join "`r`n"
+      [System.IO.File]::WriteAllText($batPath, $batContent, [System.Text.Encoding]::ASCII)
+    }
+
+    Write-Log "Starting database backup..." "INFO"
+
+    & cmd.exe /c "`"$batPath`""
+
+    if ($LASTEXITCODE -ne 0) {
+        throw "Database backup failed with exit code $LASTEXITCODE"
+    }
+
+    Write-Log "Database backup completed successfully." "SUCCESS"
+}
+
+# -- Log Rotation -------------------------------------------------------------
+
+function Rotate-LogFile {
+    param(
+        [Parameter(Mandatory)]
+        [string]$LogFile,
+
+        [int]$RetainCount = 5
+    )
+
+    if (-not (Test-Path $LogFile)) {
+        return
+    }
+
+    # Remove oldest
+    $oldest = "$LogFile.$RetainCount"
+    if (Test-Path $oldest) {
+        Remove-Item $oldest -Force
+    }
+
+    # Shift existing rotations
+    for ($i = $RetainCount - 1; $i -ge 1; $i--) {
+        $src = "$LogFile.$i"
+        $dst = "$LogFile." + ($i + 1)
+
+        if (Test-Path $src) {
+            Move-Item $src $dst -Force
+        }
+    }
+
+    Move-Item $LogFile "$LogFile.1" -Force
+}
+
+function Rotate-ServiceLogs {
+    param(
+        [array]$Services,
+        [string]$LogsDir
+    )
+
+    foreach ($svc in $Services) {
+        $logFile = Join-Path $LogsDir "$($svc.Name).log"
+        Rotate-LogFile -LogFile $logFile -RetainCount 5
+    }
+}
+
+# -- Main ----------------------------------------------------------------------
+
+$logsDir = Join-Path $BaseInstallPath "logs"
+
+$services = Get-Service |
+    Where-Object { $_.Name -like "Gateway-*" } |
+    ForEach-Object {
+        @{ Name = $_.Name }
+    }
+
+switch ($Action) {
+
+    "StopBackupRotate" {
+
+        Stop-AllServices `
+            -Services $services `
+            -TimeoutSeconds 30
+
+        Invoke-DatabaseBackup `
+            -BaseInstallPath $BaseInstallPath
+
+        Rotate-ServiceLogs `
+            -Services $services `
+            -LogsDir $logsDir
+    }
+
+    "StartServices" {
+
+        Start-AllServices `
+            -Services $services
+            -TimeoutSeconds 30
+    }
+}