Expand Pester coverage across install, tweaks, and UI workflows (#4792)

* Harden Pester CI and discard runspace return values * Add prioritized test backlog * Add WinUtil action logging * Add config integrity tests * Add XAML control wiring tests * Add registry and service helper tests * Add package manager tests * Add runspace behavior tests * Add tweak orchestration tests * Add install workflow tests * Add update profile tests * Add AppX removal tests * Log package installer output * Add UI state helper tests * Pin Pester test runner version * Expand Win11 Creator tests * Add preferences and theme tests * Add search filter tests * Add compile contract tests * Use single WinUtil session log * Remove installer output logging helper * Handle locked WinUtil transcript log * Avoid appending to active transcript log * Log install uninstall package identities
2026-07-18 01:40:49 +00:00 · 2026-07-01 21:49:15 -05:00
parent c3b4f85fce
commit 2cb20893fc
44 changed files with 4586 additions and 36 deletions
--- a/pester/logging.Tests.ps1
+++ b/pester/logging.Tests.ps1
@@ -0,0 +1,107 @@
+#===========================================================================
+# Tests - WinUtil Logging
+#===========================================================================
+
+BeforeAll {
+    $script:repoRoot = (Resolve-Path (Join-Path $PSScriptRoot "..")).Path
+
+    . (Join-Path $script:repoRoot "functions\private\Write-WinUtilLog.ps1")
+}
+
+Describe "Write-WinUtilLog" {
+    BeforeEach {
+        $script:testRoot = Join-Path ([System.IO.Path]::GetTempPath()) "winutil-logging-$([guid]::NewGuid())"
+        New-Item -Path $script:testRoot -ItemType Directory -Force | Out-Null
+        Remove-Variable -Name WinUtilLogPath -Scope Script -ErrorAction SilentlyContinue
+    }
+
+    AfterEach {
+        Remove-Variable -Name sync -Scope Script -ErrorAction SilentlyContinue
+        Remove-Variable -Name WinUtilLogPath -Scope Script -ErrorAction SilentlyContinue
+        Remove-Item -Path $script:testRoot -Recurse -Force -ErrorAction SilentlyContinue
+    }
+
+    It "writes to the active timestamped session log under logs" {
+        $logPath = Join-Path $script:testRoot "logs\winutil_2026-07-01_12-00-00.log"
+        $script:sync = [hashtable]::Synchronized(@{
+            winutildir = $script:testRoot
+            logPath = $logPath
+        })
+
+        Write-WinUtilLog -Component "Test" -Message "same session log"
+
+        Test-Path -Path $logPath | Should -BeTrue
+        Test-Path -Path (Join-Path $script:testRoot "winutil.log") | Should -BeFalse
+        Get-Content -Path $logPath -Raw | Should -Match "\[INFO\] \[Test\] same session log"
+    }
+
+    It "uses the transcript stream when logPath is not set" {
+        $transcriptPath = Join-Path $script:testRoot "logs\winutil_2026-07-01_12-00-00.log"
+        $script:sync = [hashtable]::Synchronized(@{
+            winutildir = $script:testRoot
+            transcriptPath = $transcriptPath
+        })
+        Mock Add-Content { }
+        Mock Write-Host { }
+
+        Write-WinUtilLog -Component "Test" -Message "transcript fallback"
+
+        Should -Invoke -CommandName Add-Content -Times 0 -Exactly
+        Should -Invoke -CommandName Write-Host -Times 1 -Exactly -ParameterFilter {
+            $Object -match "\[INFO\] \[Test\] transcript fallback"
+        }
+        Test-Path -Path (Join-Path $script:testRoot "winutil.log") | Should -BeFalse
+    }
+
+    It "creates one fallback log under logs when only winutildir is available" {
+        $script:sync = [hashtable]::Synchronized(@{
+            winutildir = $script:testRoot
+        })
+
+        Write-WinUtilLog -Component "Test" -Message "first fallback entry"
+        Write-WinUtilLog -Component "Test" -Message "second fallback entry"
+
+        $logFiles = @(Get-ChildItem -Path (Join-Path $script:testRoot "logs") -Filter "winutil_*.log")
+        $logFiles.Count | Should -Be 1
+        Test-Path -Path (Join-Path $script:testRoot "winutil.log") | Should -BeFalse
+
+        $content = Get-Content -Path $logFiles[0].FullName -Raw
+        $content | Should -Match "first fallback entry"
+        $content | Should -Match "second fallback entry"
+    }
+
+    It "does not append directly when the active log file is the transcript" {
+        $logPath = Join-Path $script:testRoot "logs\winutil_2026-07-01_12-00-00.log"
+        $script:sync = [hashtable]::Synchronized(@{
+            winutildir = $script:testRoot
+            logPath = $logPath
+            transcriptPath = $logPath
+        })
+
+        Mock Add-Content { throw [System.IO.IOException]::new("locked by transcript") } -ParameterFilter {
+            $Path -eq $logPath -and $ErrorAction -eq "Stop"
+        }
+        Mock Write-Host { }
+        Mock Write-Warning { }
+
+        Write-WinUtilLog -Component "Test" -Message "transcript stream fallback"
+
+        Should -Invoke -CommandName Add-Content -Times 0 -Exactly
+        Should -Invoke -CommandName Write-Host -Times 1 -Exactly -ParameterFilter {
+            $Object -match "\[INFO\] \[Test\] transcript stream fallback"
+        }
+        Should -Invoke -CommandName Write-Warning -Times 0 -Exactly
+    }
+
+}
+
+Describe "WinUtil startup logging path" {
+    It "uses one timestamped log file under the logs directory" {
+        $startScript = Get-Content -Path (Join-Path $script:repoRoot "scripts\start.ps1") -Raw
+
+        $startScript | Should -Match '\$sync\.logPath = "\$logdir\\winutil_\$dateTime\.log"'
+        $startScript | Should -Match '\$sync\.transcriptPath = \$sync\.logPath'
+        $startScript | Should -Match 'Start-Transcript -Path \$sync\.logPath'
+        $startScript | Should -Not -Match '\$sync\.logPath = "\$winutildir\\winutil\.log"'
+    }
+}