Improve error reporting & handling (#741)

2026-10-08 06:26:45 +00:00 · 2026-08-24 20:34:50 +02:00
parent fff1fcd0b2
commit ef8811d28d
27 changed files with 1426 additions and 450 deletions
@@ -2,6 +2,7 @@ BeforeAll {
    . (Join-Path $PSScriptRoot '..\Scripts\FileIO\Import-JsonFile.ps1')
    . (Join-Path $PSScriptRoot '..\Scripts\Helpers\Add-Parameter.ps1')
    . (Join-Path $PSScriptRoot '..\Scripts\Helpers\Import-ConfigToParams.ps1')
+    . (Join-Path $PSScriptRoot '..\Scripts\Helpers\Test-ConfigConsistency.ps1')
    $script:ConfigFixturePath = Join-Path $PSScriptRoot 'TestData\JsonFileLoading\ExportedConfig.WithSettings.json'
    $script:SkipRegistryBackupFixturePath = Join-Path $PSScriptRoot 'TestData\JsonFileLoading\ExportedConfig.SkipRegistryBackup.json'
 }
@@ -44,3 +45,123 @@ Describe 'Import-ConfigToParams' {
        $script:Params['SkipRegistryBackup'] | Should -BeTrue
    }
 }
+
+Describe 'Test-ConfigConsistency' {
+    It 'reports an error for an empty config' {
+        Test-ConfigConsistency -Config $null | Should -Match 'empty or could not be read'
+    }
+
+    It 'reports an error for a config missing a Version' {
+        $config = [PSCustomObject]@{ Tweaks = @( @{ Name = 'DisableTelemetry'; Value = $true } ) }
+        Test-ConfigConsistency -Config $config | Should -Match 'missing a Version'
+    }
+
+    It 'reports an error for a config with no importable data' {
+        $config = [PSCustomObject]@{ Version = '1.0' }
+        Test-ConfigConsistency -Config $config | Should -Match 'no importable data'
+    }
+
+    It 'reports an error for invalid app entries' {
+        $config = [PSCustomObject]@{ Version = '1.0'; Apps = 42 }
+
+        Test-ConfigConsistency -Config $config | Should -Match 'Apps entries must be strings'
+    }
+
+    It 'reports an error for malformed tweak entries' {
+        $config = [PSCustomObject]@{ Version = '1.0'; Tweaks = @(@{ Value = $true }) }
+
+        Test-ConfigConsistency -Config $config | Should -Match 'Tweaks entries must contain Name and Value properties'
+    }
+
+    It 'reports an error for deployment entries missing a required property' {
+        $config = [PSCustomObject]@{ Version = '1.0'; Deployment = @(@{ Name = 'CreateRestorePoint' }) }
+
+        Test-ConfigConsistency -Config $config | Should -Match 'Deployment entries must contain Name and Value properties'
+    }
+
+    It 'reports an error for nonnumeric deployment indexes' {
+        $config = [PSCustomObject]@{
+            Version = '1.0'
+            Deployment = @(@{ Name = 'AppRemovalScopeIndex'; Value = 'all' })
+        }
+
+        Test-ConfigConsistency -Config $config | Should -Match 'AppRemovalScopeIndex must be a supported numeric value'
+    }
+
+    It 'reports an error for out-of-range deployment indexes' {
+        $config = [PSCustomObject]@{
+            Version = '1.0'
+            Deployment = @(@{ Name = 'UserSelectionIndex'; Value = 3 })
+        }
+
+        Test-ConfigConsistency -Config $config | Should -Match 'UserSelectionIndex must be a supported numeric value'
+    }
+
+    It 'returns null for a consistent all-users scope' {
+        $config = [PSCustomObject]@{
+            Version = '1.0'
+            Deployment = @(
+                @{ Name = 'UserSelectionIndex'; Value = 0 }
+                @{ Name = 'AppRemovalScopeIndex'; Value = 0 }
+            )
+        }
+        Test-ConfigConsistency -Config $config | Should -BeNullOrEmpty
+    }
+
+    It 'returns null for target-user scope combined with Other User and a username' {
+        $config = [PSCustomObject]@{
+            Version = '1.0'
+            Deployment = @(
+                @{ Name = 'UserSelectionIndex'; Value = 1 }
+                @{ Name = 'OtherUsername'; Value = 'jdoe' }
+                @{ Name = 'AppRemovalScopeIndex'; Value = 2 }
+            )
+        }
+        Test-ConfigConsistency -Config $config | Should -BeNullOrEmpty
+    }
+
+    It 'returns null for current-user-only scope combined with Current User' {
+        $config = [PSCustomObject]@{
+            Version = '1.0'
+            Deployment = @(
+                @{ Name = 'UserSelectionIndex'; Value = 0 }
+                @{ Name = 'AppRemovalScopeIndex'; Value = 1 }
+            )
+        }
+        Test-ConfigConsistency -Config $config | Should -BeNullOrEmpty
+    }
+
+    It 'reports an error for current-user-only scope without Current User selected' {
+        $config = [PSCustomObject]@{
+            Version = '1.0'
+            Deployment = @(
+                @{ Name = 'UserSelectionIndex'; Value = 1 }
+                @{ Name = 'AppRemovalScopeIndex'; Value = 1 }
+            )
+        }
+        Test-ConfigConsistency -Config $config | Should -Match "requires the deployment target 'Current User'"
+    }
+
+    It 'reports an error for target-user scope without Other User selected' {
+        $config = [PSCustomObject]@{
+            Version = '1.0'
+            Deployment = @(
+                @{ Name = 'UserSelectionIndex'; Value = 0 }
+                @{ Name = 'AppRemovalScopeIndex'; Value = 2 }
+            )
+        }
+        Test-ConfigConsistency -Config $config | Should -Match "requires the deployment target 'Other User'"
+    }
+
+    It 'reports an error for target-user scope with a blank username' {
+        $config = [PSCustomObject]@{
+            Version = '1.0'
+            Deployment = @(
+                @{ Name = 'UserSelectionIndex'; Value = 1 }
+                @{ Name = 'OtherUsername'; Value = '   ' }
+                @{ Name = 'AppRemovalScopeIndex'; Value = 2 }
+            )
+        }
+        Test-ConfigConsistency -Config $config | Should -Match "requires an 'OtherUsername' value"
+    }
+}