Lib/ConfigurationData.ps1
|
function ConvertToConfigurationData { <# .SYNOPSIS Converts a file path string to a hashtable. This mimics the -ConfigurationData parameter of the Start-DscConfiguration cmdlet. #> [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory, ValueFromPipeline)] [System.String] $ConfigurationData ) process { $configurationDataPath = Resolve-Path -Path $ConfigurationData -ErrorAction Stop; if (-not (Test-Path -Path $configurationDataPath -PathType Leaf)) { throw ($localized.InvalidConfigurationDataFileError -f $ConfigurationData); } elseif ([System.IO.Path]::GetExtension($configurationDataPath) -ne '.psd1') { throw ($localized.InvalidConfigurationDataFileError -f $ConfigurationData); } $configurationDataContent = Get-Content -Path $configurationDataPath -Raw; $configData = Invoke-Command -ScriptBlock ([System.Management.Automation.ScriptBlock]::Create($configurationDataContent)); if ($configData -isnot [System.Collections.Hashtable]) { throw ($localized.InvalidConfigurationDataType -f $configData.GetType()); } return $configData; } #end process } #end function ConvertToConfigurationData function ResolveConfigurationDataPath { <# .SYNOPSIS Resolves the lab configuration data path. .NOTES When -IncludeDefaultPath is specified, if the configuration data file is not found, the default module configuration path is returned. #> [CmdletBinding()] [OutputType([System.Management.Automation.PSCustomObject])] param ( [Parameter(Mandatory)] [ValidateSet('Host','VM','Media','CustomMedia')] [System.String] $Configuration, [Parameter()] [System.Management.Automation.SwitchParameter] $IncludeDefaultPath ) process { switch ($Configuration) { 'Host' { $configPath = $labDefaults.HostConfigFilename; } 'VM' { $configPath = $labDefaults.VMConfigFilename; } 'Media' { $configPath = $labDefaults.MediaConfigFilename; } 'CustomMedia' { $configPath = $labDefaults.CustomMediaConfigFilename; } } $configPath = Join-Path -Path $labDefaults.ConfigurationData -ChildPath $configPath; $resolvedPath = Join-Path -Path "$env:ALLUSERSPROFILE\$($labDefaults.ModuleName)" -ChildPath $configPath; if ($IncludeDefaultPath) { if (-not (Test-Path -Path $resolvedPath)) { $resolvedPath = Join-Path -Path $labDefaults.ModuleRoot -ChildPath $configPath; } } $resolvedPath = ResolvePathEx -Path $resolvedPath; Write-Debug -Message ('Resolved ''{0}'' configuration file to ''{1}''.' -f $Configuration, $resolvedPath); return $resolvedPath; } #end process } #end function ReolveConfigurationPath function GetConfigurationData { <# .SYNOPSIS Gets lab configuration data. #> [CmdletBinding()] [OutputType([System.Management.Automation.PSCustomObject])] param ( [Parameter(Mandatory)] [ValidateSet('Host','VM','Media','CustomMedia')] [System.String] $Configuration ) process { $configurationPath = ResolveConfigurationDataPath -Configuration $Configuration -IncludeDefaultPath; if (Test-Path -Path $configurationPath) { $configurationData = Get-Content -Path $configurationPath -Raw | ConvertFrom-Json; switch ($Configuration) { 'VM' { ## This property may not be present in the original VM default file TODO: Could be deprecated in the future if ($configurationData.PSObject.Properties.Name -notcontains 'CustomBootstrapOrder') { [ref] $null = Add-Member -InputObject $configurationData -MemberType NoteProperty -Name 'CustomBootstrapOrder' -Value 'MediaFirst'; } ## This property may not be present in the original VM default file TODO: Could be deprecated in the future if ($configurationData.PSObject.Properties.Name -notcontains 'SecureBoot') { [ref] $null = Add-Member -InputObject $configurationData -MemberType NoteProperty -Name 'SecureBoot' -Value $true; } ## This property may not be present in the original VM default file TODO: Could be deprecated in the future if ($configurationData.PSObject.Properties.Name -notcontains 'GuestIntegrationServices') { [ref] $null = Add-Member -InputObject $configurationData -MemberType NoteProperty -Name 'GuestIntegrationServices' -Value $false; } } 'CustomMedia' { foreach ($mediaItem in $configurationData) { ## Add missing OperatingSystem property if ($mediaItem.PSObject.Properties.Name -notcontains 'OperatingSystem') { [ref] $null = Add-Member -InputObject $mediaItem -MemberType NoteProperty -Name 'OperatingSystem' -Value 'Windows'; } } #end foreach media item } 'Host' { ## This property may not be present in the original machine configuration file if ($configurationData.PSObject.Properties.Name -notcontains 'DisableLocalFileCaching') { [ref] $null = Add-Member -InputObject $configurationData -MemberType NoteProperty -Name 'DisableLocalFileCaching' -Value $false; } ## This property may not be present in the original machine configuration file if ($configurationData.PSObject.Properties.Name -notcontains 'EnableCallStackLogging') { [ref] $null = Add-Member -InputObject $configurationData -MemberType NoteProperty -Name 'EnableCallStackLogging' -Value $false; } ## This property may not be present in the original machine configuration file if ($configurationData.PSObject.Properties.Name -notcontains 'ModuleCachePath') { [ref] $null = Add-Member -InputObject $configurationData -MemberType NoteProperty -Name 'ModuleCachePath' -Value '%ALLUSERSPROFILE%\Lability\Modules'; } if ($configurationData.PSObject.Properties.Name -notcontains 'DismPath') { $dismDllName = 'Microsoft.Dism.PowerShell.dll'; $dismDllPath = Join-Path -Path "$env:SystemRoot\System32\WindowsPowerShell\v1.0\Modules\Dism" -ChildPath $dismDllName -Resolve; [ref] $null = Add-Member -InputObject $configurationData -MemberType NoteProperty -Name 'DismPath' -Value $dismDllPath; } ## Remove deprecated UpdatePath, if present (Issue #77) $configurationData.PSObject.Properties.Remove('UpdatePath'); } } #end switch # Expand any environment variables in configuration data $configurationData.PSObject.Members | Where-Object { ($_.MemberType -eq 'NoteProperty') -and ($_.IsSettable) -and ($_.TypeNameOfValue -eq 'System.String') } | ForEach-Object { $_.Value = [System.Environment]::ExpandEnvironmentVariables($_.Value); } return $configurationData; } } #end process } #end function GetConfigurationData function SetConfigurationData { <# .SYNOPSIS Saves lab configuration data. #> [CmdletBinding(SupportsShouldProcess)] [OutputType([System.Management.Automation.PSCustomObject])] [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSShouldProcess','')] param ( [Parameter(Mandatory)] [ValidateSet('Host','VM','Media','CustomMedia')] [System.String] $Configuration, [Parameter(Mandatory, ValueFromPipeline)] [System.Object] $InputObject ) process { $configurationPath = ResolveConfigurationDataPath -Configuration $Configuration; [ref] $null = NewDirectory -Path (Split-Path -Path $configurationPath -Parent) -Verbose:$false; Set-Content -Path $configurationPath -Value (ConvertTo-Json -InputObject $InputObject -Depth 5) -Force -Confirm:$false; } #end process } #end function SetConfigurationData function RemoveConfigurationData { <# .SYNOPSIS Removes custom lab configuration data file. #> [CmdletBinding(SupportsShouldProcess)] [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSShouldProcess','')] param ( [Parameter(Mandatory)] [ValidateSet('Host','VM','Media','CustomMedia')] [System.String] $Configuration ) process { $configurationPath = ResolveConfigurationDataPath -Configuration $Configuration; if (Test-Path -Path $configurationPath) { WriteVerbose ($localized.ResettingConfigurationDefaults -f $Configuration); Remove-Item -Path $configurationPath -Force; } } #end process } # end function RemoveConfigurationData |