Public/Sync-TCMDriftToMaester.ps1
|
function Sync-TCMDriftToMaester { <# .SYNOPSIS Bridge TCM drift detection to Maester's built-in drift tests (MT.1060). .DESCRIPTION Generates the drift folder structure that Maester's MT.1060 natively discovers. No Maester modifications needed — MT.1060 (shipped in Maester v2.0+) auto-discovers drift suites as subfolders containing baseline.json and current.json. TCM provides server-side baseline storage and automatic 6-hour monitoring, so there's no local state to manage. This cmdlet simply materializes the TCM drift state into files that Maester already knows how to test. Generated structure: <OutputPath>/ TCM-<MonitorName>/ baseline.json # Desired state (from TCM monitor baseline) current.json # Actual state (baseline + drift deltas) settings.json # Optional MT.1060 settings Then just run: Invoke-Maester MT.1060 picks up the TCM drift suites automatically. .PARAMETER OutputPath The folder where drift suites will be written. Should be under or alongside your Maester test root so MT.1060 discovers them. Default: ./tests/Maester/Drift .PARAMETER MonitorId Sync drifts from a specific monitor. If omitted, syncs all active drifts. .PARAMETER IncludeFixed Also include recently fixed drifts (for audit trail). .PARAMETER PassThru Also return the drift summary objects. .EXAMPLE # Sync all TCM drifts — then run Maester normally Sync-TCMDriftToMaester Invoke-Maester .EXAMPLE # Sync to a custom path and get summary $summary = Sync-TCMDriftToMaester -OutputPath "./my-tests/drift" -PassThru $summary | Where-Object { $_.DriftCount -gt 0 } #> [CmdletBinding()] param( [string]$OutputPath = './tests/Maester/Drift', [string]$MonitorId, [switch]$IncludeFixed, [switch]$PassThru ) Write-Host '🔗 Syncing TCM drifts to Maester format...' -ForegroundColor Cyan # Step 1: Get monitors and their baselines $monitors = if ($MonitorId) { @(Get-TCMMonitor -Id $MonitorId -IncludeBaseline) } else { $allMonitors = Get-TCMMonitor if (-not $allMonitors) { Write-Warning 'No TCM monitors found. Create monitors first with New-TCMMonitor.' return } foreach ($m in $allMonitors) { Get-TCMMonitor -Id $m.id -IncludeBaseline } } # Step 2: Get active drifts $driftParams = @{ Status = 'active' } if ($MonitorId) { $driftParams.MonitorId = $MonitorId } $drifts = Get-TCMDrift @driftParams if ($IncludeFixed) { $fixedDrifts = Get-TCMDrift -Status fixed if ($MonitorId) { $fixedDrifts = $fixedDrifts | Where-Object { $_.MonitorId -eq $MonitorId } } $drifts = @($drifts) + @($fixedDrifts) } # Step 3: Create output directory if (-not (Test-Path $OutputPath)) { New-Item -Path $OutputPath -ItemType Directory -Force | Out-Null } # Step 4: Generate per-monitor drift suites $summaries = [System.Collections.Generic.List[object]]::new() foreach ($monitor in $monitors) { $monDisplayName = if ($monitor -is [System.Collections.IDictionary]) { $monitor['displayName'] } else { $monitor.displayName } $monId = if ($monitor -is [System.Collections.IDictionary]) { $monitor['id'] } else { $monitor.id } $monBaseline = if ($monitor -is [System.Collections.IDictionary]) { $monitor['baseline'] } else { $monitor.baseline } $monitorName = ($monDisplayName -replace '[^\w\-]', '_') $suitePath = Join-Path $OutputPath "TCM-$monitorName" if (-not (Test-Path $suitePath)) { New-Item -Path $suitePath -ItemType Directory -Force | Out-Null } # Build "baseline" from monitor's baseline $baselineData = @{} $baselineResources = if ($monBaseline -is [System.Collections.IDictionary]) { $monBaseline['resources'] } elseif ($monBaseline) { $monBaseline.resources } else { $null } if ($baselineResources) { foreach ($res in $baselineResources) { $resType = if ($res -is [System.Collections.IDictionary]) { $res['resourceType'] } else { $res.resourceType } $resDn = if ($res -is [System.Collections.IDictionary]) { $res['displayName'] } else { $res.displayName } $resProps = if ($res -is [System.Collections.IDictionary]) { $res['properties'] } else { $res.properties } $key = "$resType|$resDn" $baselineData[$key] = @{ resourceType = $resType displayName = $resDn properties = $resProps } } } # Build "current" by deep-copying baseline and applying drift deltas # NOTE: .Clone() is shallow — nested properties would be shared references. # Deep copy via JSON roundtrip to avoid mutating baselineData. $currentData = @{} foreach ($k in $baselineData.Keys) { $currentData[$k] = $baselineData[$k] | ConvertTo-Json -Depth 20 | ConvertFrom-Json -AsHashtable } $monitorDrifts = @($drifts | Where-Object { $_.MonitorId -eq $monId }) foreach ($drift in $monitorDrifts) { $key = "$($drift.ResourceType)|$($drift.ResourceDisplay)" if ($currentData.ContainsKey($key)) { $current = $currentData[$key] # Override drifted properties with current (actual) values foreach ($dp in $drift.DriftedProperties) { $current.properties[$dp.propertyName] = $dp.currentValue } } else { # Drift on a resource not in our baseline copy — create entry from drift data $props = @{} foreach ($dp in $drift.DriftedProperties) { $props[$dp.propertyName] = $dp.currentValue } $currentData[$key] = @{ resourceType = $drift.ResourceType displayName = $drift.ResourceDisplay properties = $props } } } # Write baseline.json and current.json $baselineFile = Join-Path $suitePath 'baseline.json' $currentFile = Join-Path $suitePath 'current.json' $baselineData | ConvertTo-Json -Depth 20 | Set-Content -Path $baselineFile -Encoding utf8 $currentData | ConvertTo-Json -Depth 20 | Set-Content -Path $currentFile -Encoding utf8 # Write settings.json for MT.1060 (optional metadata) $settingsFile = Join-Path $suitePath 'settings.json' @{ Source = 'EasyTCM' MonitorId = $monitor.id SyncedAt = (Get-Date -Format 'o') } | ConvertTo-Json | Set-Content -Path $settingsFile -Encoding utf8 $summary = [PSCustomObject]@{ MonitorName = $monDisplayName MonitorId = $monId SuitePath = $suitePath BaselineFile = $baselineFile CurrentFile = $currentFile ResourceCount = $baselineData.Count DriftCount = $monitorDrifts.Count DriftedProps = ($monitorDrifts | ForEach-Object { $_.DriftedPropertyCount } | Measure-Object -Sum).Sum } $summaries.Add($summary) $driftIcon = if ($monitorDrifts.Count -gt 0) { '⚠️' } else { '✅' } Write-Host " $driftIcon $monDisplayName`: $($monitorDrifts.Count) drifts across $($baselineData.Count) resources" -ForegroundColor $(if ($monitorDrifts.Count -gt 0) { 'Yellow' } else { 'Green' }) } # Set the environment variable that MT.1060 uses for drift folder discovery. # Note: Maester v2.0.0 MT1060Drift.tests.ps1 reads $env:MEASTER_FOLDER_DRIFT (typo). # We set both spellings for forward-compatibility. $resolvedOutput = (Resolve-Path $OutputPath).Path $env:MEASTER_FOLDER_DRIFT = $resolvedOutput $env:MAESTER_FOLDER_DRIFT = $resolvedOutput # Summary $totalDrifts = ($summaries | Measure-Object -Property DriftCount -Sum).Sum Write-Host '' if ($totalDrifts -gt 0) { Write-Host "⚠️ $totalDrifts active drifts synced across $($summaries.Count) monitors." -ForegroundColor Yellow Write-Host " Run: Invoke-Maester -Path '$OutputPath'" -ForegroundColor DarkGray } else { Write-Host "✅ No active drifts. All $($summaries.Count) monitors are clean." -ForegroundColor Green Write-Host " Run: Invoke-Maester -Path '$OutputPath'" -ForegroundColor DarkGray } if ($PassThru) { $summaries } } |