ci: clean windows disk space in background

Author: marcoieni

.github/workflows/ci.yml

@@ -223,6 +223,11 @@ jobs:
           cd src/ci/citool
           CARGO_INCREMENTAL=0 CARGO_TARGET_DIR=../../../build/citool cargo build
 
+      - name: wait for Windows disk cleanup to finish
+        if: ${{ matrix.free_disk && startsWith(matrix.os, 'windows-') }}
+        run: |
+          python3 src/ci/scripts/free-disk-space-windows-wait.py
+
       - name: run the build
         run: |
           set +e

src/ci/scripts/free-disk-space-windows-start.py

@@ -0,0 +1,67 @@
+"""
+Start freeing disk space on Windows in the background by launching
+the existing PowerShell cleanup script, while recording a PID file
+and redirecting logs, so later steps can wait for completion.
+"""
+
+import os
+import sys
+import subprocess
+from pathlib import Path
+
+
+# Get the temporary directory set by GitHub Actions
+def get_temp_dir() -> Path:
+    return Path(os.environ.get("RUNNER_TEMP"))
+
+
+def main() -> int:
+    script_dir = Path(__file__).resolve().parent
+    cleanup_script = script_dir / "free-disk-space-windows.ps1"
+    if not cleanup_script.exists():
+        print(f"::error file={__file__}::Cleanup script '{cleanup_script}' not found")
+        return 1
+
+    temp_dir = get_temp_dir()
+    pid_file = temp_dir / "free-disk-space.pid"
+    log_file_path = temp_dir / "free-disk-space.log"
+
+    if pid_file.exists():
+        print(f"::error file={__file__}::Pid file '{pid_file}' already exists")
+        return 1
+
+    # Launch the PowerShell cleanup in the background and redirect logs
+    try:
+        with open(log_file_path, "w", encoding="utf-8") as log_file:
+            proc = subprocess.Popen(
+                [
+                    "pwsh",
+                    # Suppress PowerShell startup banner/logo for cleaner logs.
+                    "-NoLogo",
+                    # Don't load user/system profiles. Ensures a clean, predictable environment.
+                    "-NoProfile",
+                    # Disable interactive prompts. Required for CI to avoid hangs.
+                    "-NonInteractive",
+                    # Execute the specified script file (next argument).
+                    "-File",
+                    str(cleanup_script),
+                ],
+                # Write child stdout to the log file
+                stdout=log_file,
+                # Merge stderr into stdout for a single, ordered log stream
+                stderr=subprocess.STDOUT,
+            )
+    except FileNotFoundError:
+        print("::error::pwsh not found on PATH; cannot start disk cleanup.")
+        return 1
+
+    pid_file.write_text(str(proc.pid))
+    print(
+        f"::notice file={__file__}::Started free-disk-space cleanup in background. "
+        f"pid={proc.pid}; log_file: {log_file_path}; pid_file: {pid_file}"
+    )
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())

src/ci/scripts/free-disk-space-windows-wait.py

@@ -0,0 +1,66 @@
+"""
+Wait for the background Windows disk cleanup process started by
+free-disk-space-windows-start.py, then print the full log.
+"""
+
+import os
+import sys
+import time
+import ctypes
+from pathlib import Path
+
+
+# Get the temporary directory set by GitHub Actions
+def get_temp_dir() -> Path:
+    return Path(os.environ.get("RUNNER_TEMP"))
+
+
+def is_process_running(pid: int) -> bool:
+    PROCESS_QUERY_LIMITED_INFORMATION = 0x1000  # Sufficient for GetExitCodeProcess
+    processHandle = ctypes.windll.kernel32.OpenProcess(
+        PROCESS_QUERY_LIMITED_INFORMATION, 0, pid
+    )
+    if processHandle == 0:
+        # Could be not running or we don't have sufficient rights to check
+        return False
+    else:
+        ctypes.windll.kernel32.CloseHandle(processHandle)
+    return True
+
+
+def main() -> int:
+    temp_dir = get_temp_dir()
+    pid_file = temp_dir / "free-disk-space.pid"
+    log_file = temp_dir / "free-disk-space.log"
+
+    if not pid_file.exists():
+        print("::notice::No background free-disk-space process to wait for.")
+        return 0
+
+    try:
+        pid = int(pid_file.read_text().strip().splitlines()[0])
+    except Exception:
+        # Delete the file if it exists
+        pid_file.unlink(missing_ok=True)
+        return 0
+
+    # Poll until process exits
+    while is_process_running(pid):
+        time.sleep(3)
+
+    # Delete the file if it exists
+    pid_file.unlink(missing_ok=True)
+
+    if log_file.exists():
+        print("free-disk-space logs:")
+        # Print entire log; replace undecodable bytes to avoid exceptions.
+        try:
+            with open(log_file, "r", encoding="utf-8", errors="replace") as f:
+                print(f.read())
+        except Exception as e:
+            print(f"::warning::Failed to read log file '{log_file}': {e}")
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())

src/ci/scripts/free-disk-space.sh

@@ -4,7 +4,7 @@ set -euo pipefail
 script_dir=$(dirname "$0")
 
 if [[ "${RUNNER_OS:-}" == "Windows" ]]; then
-    pwsh $script_dir/free-disk-space-windows.ps1
+    python3 "$script_dir/free-disk-space-windows-start.py"
 else
     $script_dir/free-disk-space-linux.sh
 fi