#Requires -Modules @{ ModuleName = 'Pester'; ModuleVersion = '5.0.0' } <# SC-011: every engine exit code 0-6 is reachable and returned for its documented condition. An exit code is what a scheduler, a pipeline, or an on-call runbook reacts to. A code that cannot be produced is a promise the contract makes and the engine does not keep, and it is invisible until the day someone builds an alert on it. Codes 0, 3, 4, and 5 are reachable inside the run loop and are tested by fault injection here. Codes 1, 2, and 6 are owned by the entry script, which decides them before or around the loop; those are asserted against the script's own control flow. #> BeforeAll { $repoRoot = Split-Path (Split-Path $PSScriptRoot -Parent) -Parent . (Join-Path $repoRoot 'tests/TestHelpers.ps1') foreach ($file in (Get-PersonaSourceFile -RepoRoot $repoRoot)) { . $file } $script:target = 'extension__' $script:entryScript = Join-Path $repoRoot 'Invoke-PersonaEngine.ps1' } Describe 'Exit codes produced by the run loop' { BeforeEach { Mock Write-Host { } Mock Write-Verbose { } } It 'returns 0 for a clean run' { Mock Get-PersonaUsers { @(New-TestPopulation -Count 10 -TargetAttribute $script:target) } $outcome = Invoke-PersonaEngineRun -Configuration (New-TestRuntimeConfiguration -TargetAttribute $script:target) ` -TargetAttribute $script:target -Context (New-TestAuditContext) $outcome.ExitCode | Should -Be 0 } It 'returns 3 when user enumeration fails' { Mock Get-PersonaUsers { throw 'User enumeration returned an unexpected response shape on page 4.' } $outcome = Invoke-PersonaEngineRun -Configuration (New-TestRuntimeConfiguration -TargetAttribute $script:target) ` -TargetAttribute $script:target -Context (New-TestAuditContext) $outcome.ExitCode | Should -Be 3 $outcome.FailureReason | Should -Not -BeNullOrEmpty } It 'processes nobody when enumeration fails, rather than reporting a partial run' { Mock Get-PersonaUsers { throw 'truncated' } $outcome = Invoke-PersonaEngineRun -Configuration (New-TestRuntimeConfiguration -TargetAttribute $script:target) ` -TargetAttribute $script:target -Context (New-TestAuditContext) $outcome.Counters.Processed | Should -Be 0 } It 'returns 4 when the EvaluationError count exceeds the configured threshold' { Mock Get-PersonaUsers { @(New-TestPopulation -Count 10 -TargetAttribute $script:target) } Mock Get-PersonaGroupMembership { New-PersonaMembershipRecord -DirectFailureReason 'Graph 503 after 5 attempts' } $config = New-TestRuntimeConfiguration -TargetAttribute $script:target -EvaluationErrorThreshold 3 -Rules @( (New-TestMembershipRule) [pscustomobject]@{ id = 'RULE-0900-EMPLOYEE'; name = 'Employees'; enabled = $true; priority = 900; persona = 'Employee' match = [pscustomobject]@{ operator = 'all'; conditions = @([pscustomobject]@{ type = 'property'; property = 'Department'; operator = 'isNotNull' }) } }) $outcome = Invoke-PersonaEngineRun -Configuration $config -TargetAttribute $script:target -Context (New-TestAuditContext) $outcome.Counters.EvaluationError | Should -BeGreaterThan 3 $outcome.ExitCode | Should -Be 4 } It 'returns 0 when the EvaluationError count is at or below the threshold' { Mock Get-PersonaUsers { @(New-TestPopulation -Count 10 -TargetAttribute $script:target) } Mock Get-PersonaGroupMembership { New-PersonaMembershipRecord -DirectFailureReason 'Graph 503' } $config = New-TestRuntimeConfiguration -TargetAttribute $script:target -EvaluationErrorThreshold 100 -Rules @( (New-TestMembershipRule) [pscustomobject]@{ id = 'RULE-0900-EMPLOYEE'; name = 'Employees'; enabled = $true; priority = 900; persona = 'Employee' match = [pscustomobject]@{ operator = 'all'; conditions = @([pscustomobject]@{ type = 'property'; property = 'Department'; operator = 'isNotNull' }) } }) $outcome = Invoke-PersonaEngineRun -Configuration $config -TargetAttribute $script:target -Context (New-TestAuditContext) $outcome.Counters.EvaluationError | Should -BeGreaterThan 0 $outcome.ExitCode | Should -Be 0 } It 'leaves the threshold inactive when it is not configured' { # An unset threshold means "report, do not fail". Defaulting it to 0 would turn # a single transient lookup failure into a failed run. Mock Get-PersonaUsers { @(New-TestPopulation -Count 10 -TargetAttribute $script:target) } Mock Get-PersonaGroupMembership { New-PersonaMembershipRecord -DirectFailureReason 'Graph 503' } $config = New-TestRuntimeConfiguration -TargetAttribute $script:target -Rules @( (New-TestMembershipRule) [pscustomobject]@{ id = 'RULE-0900-EMPLOYEE'; name = 'Employees'; enabled = $true; priority = 900; persona = 'Employee' match = [pscustomobject]@{ operator = 'all'; conditions = @([pscustomobject]@{ type = 'property'; property = 'Department'; operator = 'isNotNull' }) } }) $outcome = Invoke-PersonaEngineRun -Configuration $config -TargetAttribute $script:target -Context (New-TestAuditContext) $outcome.Counters.EvaluationError | Should -BeGreaterThan 0 $outcome.ExitCode | Should -Be 0 } It 'returns 5 when reconciliation fails' { Mock Get-PersonaUsers { @(New-TestPopulation -Count 6 -TargetAttribute $script:target) } Mock Add-PersonaRunResult { $Counters.Processed++ } $outcome = Invoke-PersonaEngineRun -Configuration (New-TestRuntimeConfiguration -TargetAttribute $script:target) ` -TargetAttribute $script:target -Context (New-TestAuditContext) $outcome.ExitCode | Should -Be 5 } It 'prefers 5 over 4 when both conditions hold' { # A reconciliation failure means the counters cannot be trusted, so the # threshold check is reading numbers that may be wrong. The engine defect is # the more serious and more actionable report. Mock Get-PersonaUsers { @(New-TestPopulation -Count 6 -TargetAttribute $script:target) } Mock Get-PersonaGroupMembership { New-PersonaMembershipRecord -DirectFailureReason 'Graph 503' } # Processed advances twice per user while only one outcome is tallied: the # buckets no longer add up AND the error count clears the threshold, so both # conditions are genuinely true at once. Mock Add-PersonaRunResult { $Counters.Processed += 2; $Counters.EvaluationError++ } $config = New-TestRuntimeConfiguration -TargetAttribute $script:target -EvaluationErrorThreshold 1 -Rules @( (New-TestMembershipRule) ) $outcome = Invoke-PersonaEngineRun -Configuration $config -TargetAttribute $script:target -Context (New-TestAuditContext) $outcome.ExitCode | Should -Be 5 } } Describe 'Target attribute unavailable - dev tenants without an app registration' { BeforeAll { # Mirrors what Graph actually sends for a bad $select property: a 400 with # an empty body. Invoke-MgGraphRequest's message then names no property and # carries no digits at all ("BadRequest", not "400") - the status is only # recoverable from the structured Response.StatusCode, never from text. A # fixture that embedded "400" or the property name in the message text would # test a shape Graph does not actually produce. function New-PersonaGraphBadRequestError { $ex = [System.Exception]::new('Response status code does not indicate success: BadRequest (Bad Request).') $ex | Add-Member -MemberType NoteProperty -Name Response -Value ([pscustomobject]@{ StatusCode = 400 }) -Force [System.Management.Automation.ErrorRecord]::new($ex, 'GraphError', [System.Management.Automation.ErrorCategory]::InvalidResult, $null) } } BeforeEach { Mock Write-Host { } Mock Write-Verbose { } Mock Write-Warning { } } It 'continues in What-If mode, treating the attribute as null, when it is not registered' { Mock Get-PersonaUsers { param($SelectProperties, $UserObjectId, $PageSize) if ($SelectProperties -ccontains $script:target) { throw (New-PersonaGraphBadRequestError) } @(New-TestPopulation -Count 5 -TargetAttribute $script:target) } $outcome = Invoke-PersonaEngineRun -Configuration (New-TestRuntimeConfiguration -TargetAttribute $script:target) ` -TargetAttribute $script:target -Context (New-TestAuditContext) -IsEnforcing:$false $outcome.ExitCode | Should -Be 0 $outcome.Counters.Processed | Should -Be 5 Should -Invoke Get-PersonaUsers -Times 2 -Exactly Should -Invoke Write-Warning -Times 1 -Exactly } It 'requests everything except the target attribute on the retry' { Mock Get-PersonaUsers { param($SelectProperties, $UserObjectId, $PageSize) if ($SelectProperties -ccontains $script:target) { throw (New-PersonaGraphBadRequestError) } @(New-TestPopulation -Count 5 -TargetAttribute $script:target) } $null = Invoke-PersonaEngineRun -Configuration (New-TestRuntimeConfiguration -TargetAttribute $script:target) ` -TargetAttribute $script:target -Context (New-TestAuditContext) -IsEnforcing:$false Should -Invoke Get-PersonaUsers -Times 1 -Exactly -ParameterFilter { $SelectProperties -cnotcontains $script:target } } It 'also recovers for a single-user run (-UserObjectId)' { Mock Get-PersonaUsers { param($SelectProperties, $UserObjectId, $PageSize) if ($SelectProperties -ccontains $script:target) { throw (New-PersonaGraphBadRequestError) } @(New-TestPopulation -Count 1 -TargetAttribute $script:target) } $outcome = Invoke-PersonaEngineRun -Configuration (New-TestRuntimeConfiguration -TargetAttribute $script:target) ` -TargetAttribute $script:target -Context (New-TestAuditContext) -IsEnforcing:$false ` -UserObjectId '00000000-0000-0000-0000-000000000001' $outcome.ExitCode | Should -Be 0 $outcome.Counters.Processed | Should -Be 1 Should -Invoke Get-PersonaUsers -Times 2 -Exactly -ParameterFilter { $UserObjectId -eq '00000000-0000-0000-0000-000000000001' } } It 'still fails enumeration in enforcement mode - the fallback never applies to a real write run' { Mock Get-PersonaUsers { throw (New-PersonaGraphBadRequestError) } $outcome = Invoke-PersonaEngineRun -Configuration (New-TestRuntimeConfiguration -TargetAttribute $script:target) ` -TargetAttribute $script:target -Context (New-TestAuditContext -Mode 'Enforce') -IsEnforcing $outcome.ExitCode | Should -Be 3 Should -Invoke Get-PersonaUsers -Times 1 -Exactly } It 'does not swallow an unrelated enumeration failure even in What-If mode' { Mock Get-PersonaUsers { throw 'Graph request failed after 5 attempt(s) (last status: 503): service unavailable' } $outcome = Invoke-PersonaEngineRun -Configuration (New-TestRuntimeConfiguration -TargetAttribute $script:target) ` -TargetAttribute $script:target -Context (New-TestAuditContext) -IsEnforcing:$false $outcome.ExitCode | Should -Be 3 Should -Invoke Get-PersonaUsers -Times 1 -Exactly } } Describe 'Exit codes owned by the entry script' { BeforeAll { $script:entryText = Get-Content -LiteralPath $script:entryScript -Raw } It 'declares all seven documented codes' { foreach ($name in @('EXIT_OK', 'EXIT_CONFIG', 'EXIT_AUTH', 'EXIT_ENUMERATION', 'EXIT_DATA', 'EXIT_RECONCILIATION', 'EXIT_UNEXPECTED')) { $script:entryText | Should -Match "\`$$name\s*=\s*\d" } } It 'assigns each code the value the contract documents' { $expected = @{ 'EXIT_OK' = 0; 'EXIT_CONFIG' = 1; 'EXIT_AUTH' = 2; 'EXIT_ENUMERATION' = 3 'EXIT_DATA' = 4; 'EXIT_RECONCILIATION' = 5; 'EXIT_UNEXPECTED' = 6 } foreach ($name in $expected.Keys) { $script:entryText | Should -Match "\`$$name\s*=\s*$($expected[$name])\b" } } It 'returns exit code 1 without connecting when validation fails' { # The ordering matters as much as the code: FR-002 requires validation to # complete before any connection is attempted. $configIndex = $script:entryText.IndexOf('exit $EXIT_CONFIG') $connectIndex = $script:entryText.IndexOf('Connect-PersonaGraphInteractive') $configIndex | Should -BeGreaterThan 0 $connectIndex | Should -BeGreaterThan $configIndex } It 'maps an authentication failure to code 2' { $script:entryText | Should -Match '(?s)Connect-PersonaGraphInteractive.*?\$exitCode = \$EXIT_AUTH' } It 'falls back to code 6 for an unexpected error' { $script:entryText | Should -Match '\$exitCode = \$EXIT_UNEXPECTED' } It 'writes a RunComplete record even on a fatal error' { # A run that died at user 400 of 5000 has to leave evidence saying so. $script:entryText | Should -Match '(?s)finally\s*\{.*Export-PersonaRunReport' } }