Skip to content

Add check in PS Adapter in case property is $null #769

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 1, 2025
Merged

Add check in PS Adapter in case property is $null #769

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions powershell-adapter/psDscAdapter/psDscAdapter.psm1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ function Get-DSCResourceModules {
}
}
}

return $dscModulePsd1List
}

Expand Down Expand Up @@ -83,7 +83,7 @@ function Add-AstMembers {
[DscResourcePropertyInfo]$prop = [DscResourcePropertyInfo]::new()
$prop.Name = $property.Name
$prop.PropertyType = $property.PropertyType.TypeName.Name
$prop.IsMandatory = $isKeyProperty
$prop.IsMandatory = $isKeyProperty
$Properties.Add($prop)
}
}
Expand All @@ -104,7 +104,7 @@ function FindAndParseResourceDefinitions {
if (".psm1", ".ps1" -notcontains ([System.IO.Path]::GetExtension($filePath))) {
return
}

"Loading resources from file '$filePath'" | Write-DscTrace -Operation Trace
#TODO: Ensure embedded instances in properties are working correctly
[System.Management.Automation.Language.Token[]] $tokens = $null
Expand Down Expand Up @@ -134,13 +134,13 @@ function FindAndParseResourceDefinitions {
$DscResourceInfo.Module = $filePath
$DscResourceInfo.Path = $filePath
#TODO: ModuleName, Version and ParentPath should be taken from psd1 contents
$DscResourceInfo.ModuleName = [System.IO.Path]::GetFileNameWithoutExtension($filePath)
$DscResourceInfo.ModuleName = [System.IO.Path]::GetFileNameWithoutExtension($filePath)
$DscResourceInfo.ParentPath = [System.IO.Path]::GetDirectoryName($filePath)
$DscResourceInfo.Version = $moduleVersion

$DscResourceInfo.Properties = [System.Collections.Generic.List[DscResourcePropertyInfo]]::new()
Add-AstMembers $typeDefinitions $typeDefinitionAst $DscResourceInfo.Properties

$resourceList.Add($DscResourceInfo)
}
}
Expand All @@ -157,7 +157,7 @@ function LoadPowerShellClassResourcesFromModule {
)

"Loading resources from module '$($moduleInfo.Path)'" | Write-DscTrace -Operation Trace

if ($moduleInfo.RootModule) {
if (".psm1", ".ps1" -notcontains ([System.IO.Path]::GetExtension($moduleInfo.RootModule)) -and
(-not $moduleInfo.NestedModules)) {
Expand Down Expand Up @@ -190,8 +190,8 @@ function LoadPowerShellClassResourcesFromModule {
This function caches the results of the Get-DscResource call to optimize performance.

.DESCRIPTION
This function is designed to improve the performance of DSC operations by caching the results of the Get-DscResource call.
By storing the results, subsequent calls to Get-DscResource can retrieve the cached data instead of making a new call each time.
This function is designed to improve the performance of DSC operations by caching the results of the Get-DscResource call.
By storing the results, subsequent calls to Get-DscResource can retrieve the cached data instead of making a new call each time.
This can significantly speed up operations that need to repeatedly access DSC resources.

.EXAMPLE
Expand Down Expand Up @@ -240,7 +240,7 @@ function Invoke-DscCacheRefresh {
foreach ($cacheEntry in $dscResourceCacheEntries) {

$cacheEntry.LastWriteTimes.PSObject.Properties | ForEach-Object {

if (Test-Path $_.Name) {
$file_LastWriteTime = (Get-Item $_.Name).LastWriteTime
# Truncate DateTime to seconds
Expand Down Expand Up @@ -289,7 +289,7 @@ function Invoke-DscCacheRefresh {
"Cache file not found '$cacheFilePath'" | Write-DscTrace
$refreshCache = $true
}

if ($refreshCache) {
'Constructing Get-DscResource cache' | Write-DscTrace

Expand All @@ -306,7 +306,7 @@ function Invoke-DscCacheRefresh {
$processedModuleNames.Add($mod.Name, $true)

# from several modules with the same name select the one with the highest version
$selectedMod = $modules | Where-Object Name -EQ $mod.Name
$selectedMod = $modules | Where-Object Name -EQ $mod.Name
if ($selectedMod.Count -gt 1) {
"Found $($selectedMod.Count) modules with name '$($mod.Name)'" | Write-DscTrace -Operation Trace
$selectedMod = $selectedMod | Sort-Object -Property Version -Descending | Select-Object -First 1
Expand Down Expand Up @@ -407,7 +407,7 @@ function Invoke-DscOperation {

# workaround: script based resources do not validate Get parameter consistency, so we need to remove any parameters the author chose not to include in Get-TargetResource
switch ([dscResourceType]$cachedDscResourceInfo.ImplementationDetail) {

'ClassBased' {
try {
# load powershell class from external module
Expand All @@ -424,7 +424,7 @@ function Invoke-DscOperation {
# handle input objects by converting them to a hash table
if ($_.Value -is [System.Management.Automation.PSCustomObject]) {
$validateProperty = $cachedDscResourceInfo.Properties | Where-Object -Property Name -EQ $_.Name
if ($validateProperty.PropertyType -eq 'PSCredential') {
if ($validateProperty -and $validateProperty.PropertyType -eq 'PSCredential') {
if (-not $_.Value.Username -or -not $_.Value.Password) {
"Credential object '$($_.Name)' requires both 'username' and 'password' properties" | Write-DscTrace -Operation Error
exit 1
Expand Down Expand Up @@ -453,7 +453,7 @@ function Invoke-DscOperation {
}
'Test' {
$Result = $dscResourceInstance.Test()
$addToActualState.properties = [psobject]@{'InDesiredState' = $Result }
$addToActualState.properties = [psobject]@{'InDesiredState' = $Result }
}
'Export' {
$t = $dscResourceInstance.GetType()
Expand All @@ -464,7 +464,7 @@ function Invoke-DscOperation {
break
}
}

if ($null -eq $method) {
"Export method not implemented by resource '$($DesiredState.Type)'" | Write-DscTrace -Operation Error
exit 1
Expand All @@ -481,7 +481,7 @@ function Invoke-DscOperation {
}
}
catch {

'Exception: ' + $_.Exception.Message | Write-DscTrace -Operation Error
exit 1
}
Expand Down
20 changes: 10 additions & 10 deletions powershell-adapter/psDscAdapter/win_psDscAdapter.psm1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ else {
This function caches the results of the Get-DscResource call to optimize performance.

.DESCRIPTION
This function is designed to improve the performance of DSC operations by caching the results of the Get-DscResource call.
By storing the results, subsequent calls to Get-DscResource can retrieve the cached data instead of making a new call each time.
This function is designed to improve the performance of DSC operations by caching the results of the Get-DscResource call.
By storing the results, subsequent calls to Get-DscResource can retrieve the cached data instead of making a new call each time.
This can significantly speed up operations that need to repeatedly access DSC resources.

.EXAMPLE
Expand Down Expand Up @@ -90,7 +90,7 @@ function Invoke-DscCacheRefresh {
foreach ($cacheEntry in $dscResourceCacheEntries) {

$cacheEntry.LastWriteTimes.PSObject.Properties | ForEach-Object {

if (Test-Path $_.Name) {
$file_LastWriteTime = (Get-Item $_.Name).LastWriteTimeUtc
# Truncate DateTime to seconds
Expand Down Expand Up @@ -138,7 +138,7 @@ function Invoke-DscCacheRefresh {
"Cache file not found '$cacheFilePath'" | Write-DscTrace
$refreshCache = $true
}

if ($refreshCache) {
'Constructing Get-DscResource cache' | Write-DscTrace

Expand Down Expand Up @@ -354,11 +354,11 @@ function Invoke-DscOperation {
}

# morph the INPUT object into a hashtable named "property" for the cmdlet Invoke-DscResource
$DesiredState.properties.psobject.properties | ForEach-Object -Begin { $property = @{} } -Process {
$DesiredState.properties.psobject.properties | ForEach-Object -Begin { $property = @{} } -Process {
if ($_.Value -is [System.Management.Automation.PSCustomObject]) {
$validateProperty = $cachedDscResourceInfo.Properties | Where-Object -Property Name -EQ $_.Name
$validateProperty | Write-DscTrace -Operation Debug
if ($validateProperty.PropertyType -eq '[PSCredential]') {
Write-DscTrace -Operation Debug -Message ($validateProperty | Out-String)
if ($validateProperty -and $validateProperty.PropertyType -eq '[PSCredential]') {
if (-not $_.Value.Username -or -not $_.Value.Password) {
"Credential object '$($_.Name)' requires both 'username' and 'password' properties" | Write-DscTrace -Operation Error
exit 1
Expand Down Expand Up @@ -386,7 +386,7 @@ function Invoke-DscOperation {
# the object returned by WMI is a CIM instance with a lot of additional data. only return DSC properties
$invokeResult.psobject.Properties.name | Where-Object { 'CimClass', 'CimInstanceProperties', 'CimSystemProperties' -notcontains $_ } | ForEach-Object -Begin { $ResultProperties = @{} } -Process { $ResultProperties[$_] = $invokeResult.$_ }
}

# set the properties of the OUTPUT object from the result of Get-TargetResource
$addToActualState.properties = $ResultProperties
}
Expand Down Expand Up @@ -438,7 +438,7 @@ function Invoke-DscOperation {
}
'Test' {
$Result = $dscResourceInstance.Test()
$addToActualState.properties = [psobject]@{'InDesiredState' = $Result }
$addToActualState.properties = [psobject]@{'InDesiredState' = $Result }
}
'Export' {
$t = $dscResourceInstance.GetType()
Expand Down Expand Up @@ -499,7 +499,7 @@ function Invoke-DscOperation {
# the object returned by WMI is a CIM instance with a lot of additional data. only return DSC properties
$invokeResult.psobject.Properties.name | Where-Object { 'CimClass', 'CimInstanceProperties', 'CimSystemProperties' -notcontains $_ } | ForEach-Object -Begin { $ResultProperties = @{} } -Process { $ResultProperties[$_] = $invokeResult.$_ }
}

# set the properties of the OUTPUT object from the result of Get-TargetResource
$addToActualState.properties = $ResultProperties
}
Expand Down
Loading