Add property for reasons on pendingreboot

Author: Gijsreyn

reboot_pending/reboot_pending.dsc.resource.json

@@ -21,6 +21,10 @@
         "rebootPending": {
             "type": "boolean",
             "readOnly": true
+        },
+        "reasons": {
+          "type": ["array", "null"],
+          "readOnly": true
         }
       }
     }

reboot_pending/reboot_pending.resource.ps1

@@ -1,13 +1,24 @@
- # Reg keys are documented here: https://learn.microsoft.com/en-us/mem/configmgr/core/servers/deploy/install/list-of-prerequisite-checks#pending-system-restart
- if (Get-ChildItem "HKLM:\Software\Microsoft\Windows\CurrentVersion\Component Based Servicing\RebootPending" -EA Ignore) { return @{ rebootPending = $true } | ConvertTo-Json -Compress }
- if (Get-Item "HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\WindowsUpdate\Auto Update\RebootRequired" -EA Ignore) { return @{ rebootPending = $true } | ConvertTo-Json -Compress }
- if (Get-ItemProperty "HKLM:\SYSTEM\CurrentControlSet\Control\Session Manager" -Name PendingFileRenameOperations -EA Ignore) { return @{ rebootPending = $true } | ConvertTo-Json -Compress }
- try { 
-   $util = [wmiclass]"\\.\root\ccm\clientsdk:CCM_ClientUtilities"
-   $status = $util.DetermineIfRebootPending()
-   if(($status -ne $null) -and $status.RebootPending){
-     return @{ rebootPending = $true } | ConvertTo-Json -Compress
-   }
- }catch{}
- 
-return @{ rebootPending = $false } | ConvertTo-Json -Compress
+# Reg keys are documented here: https://learn.microsoft.com/en-us/mem/configmgr/core/servers/deploy/install/list-of-prerequisite-checks#pending-system-restart
+$reasons = @()
+if (Get-ChildItem "HKLM:\Software\Microsoft\Windows\CurrentVersion\Component Based Servicing\RebootPending" -EA Ignore) { 
+  $reasons += "Component Based Servicing"
+}
+if (Get-Item "HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\WindowsUpdate\Auto Update\RebootRequired" -EA Ignore) { 
+  $reasons += "Windows Update"
+}
+if (Get-ItemProperty "HKLM:\SYSTEM\CurrentControlSet\Control\Session Manager" -Name PendingFileRenameOperations -EA Ignore) { 
+  $reasons += "Pending File Rename Operations"
+}
+try { 
+  $util = [wmiclass]"\\.\root\ccm\clientsdk:CCM_ClientUtilities"
+  $status = $util.DetermineIfRebootPending()
+  if(($null -ne $status) -and $status.RebootPending){
+    $reasons += "SCCM Client"
+  }
+}catch{}
+
+$result = @{
+  rebootPending = $reasons.Count -gt 0
+  reason = if ($reasons.Count -gt 0) { $reasons } else { $null }
+}
+return $result | ConvertTo-Json -Compress

reboot_pending/tests/reboot_pending.tests.ps1

@@ -14,4 +14,23 @@ Describe 'reboot_pending resource tests' {
         $LASTEXITCODE | Should -Be 0
         $out.results.result.actualState.rebootPending | Should -Not -BeNullOrEmpty
     }
+
+    It 'reboot_pending should have a reason' -Skip:(!$IsWindows) {
+        BeforeAll {
+            # Ensure the system is in a state that requires a reboot
+            # This is just an example, actual implementation may vary
+            if (-not (Get-ItemProperty "HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\WindowsUpdate\Auto Update\RebootRequired" -ErrorAction SilentlyContinue)) {
+                New-ItemProperty -Path "HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\WindowsUpdate\Auto Update" -Name "RebootRequired" -Value 1 -PropertyType DWord -Force | Out-Null
+            }
+        }
+        
+        $out = dsc resource get -r Microsoft.Windows/RebootPending | ConvertFrom-Json
+        $LASTEXITCODE | Should -Be 0
+        $out.actualState.reason | Should -Not -BeNullOrEmpty
+
+        AfterAll {
+            # Clean up the registry key to avoid affecting other tests
+            Remove-ItemProperty -Path "HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\WindowsUpdate\Auto Update" -Name "RebootRequired" -ErrorAction SilentlyContinue
+        }
+    }
 }