Merge pull request #873 from Gijsreyn/add-pending-reboot-reason

Add pending reboot reason

Author: SteveL-MSFT

reboot_pending/reboot_pending.dsc.resource.json

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

reboot_pending/reboot_pending.resource.ps1

@@ -1,13 +1,28 @@
- # 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
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
+# 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 = [System.Collections.Generic.List[string[]]]::new()
+if (Get-ChildItem "HKLM:\Software\Microsoft\Windows\CurrentVersion\Component Based Servicing\RebootPending" -EA Ignore) { 
+  $reasons.Add("Component Based Servicing")
+}
+if (Get-Item "HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\WindowsUpdate\Auto Update\RebootRequired" -EA Ignore) { 
+  $reasons.Add("Windows Update")
+}
+if (Get-ItemProperty "HKLM:\SYSTEM\CurrentControlSet\Control\Session Manager" -Name PendingFileRenameOperations -EA Ignore) { 
+  $reasons.Add("Pending File Rename Operations")
+}
+try { 
+  $util = [wmiclass]"\\.\root\ccm\clientsdk:CCM_ClientUtilities"
+  $status = $util.DetermineIfRebootPending()
+  if(($null -ne $status) -and $status.RebootPending){
+    $reasons.Add("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,20 @@ 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) {
+        $keyPath = "HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\WindowsUpdate\Auto Update"
+        $keyName = "RebootRequired"
+        try {
+            if (-not (Get-ItemProperty "$keyPath\$keyName" -ErrorAction SilentlyContinue)) {
+                New-ItemProperty -Path $keyPath -Name $keyName -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
+        } finally {
+            Remove-ItemProperty -Path $keyPath -Name $keyName -ErrorAction Ignore
+        }
+    }
 }