fix(psresourcelist): Get operation filters out resources on installed version (#1998)

Author: Gijsreyn

src/dsc/psresourceget.ps1

@@ -342,33 +342,38 @@ function GetPSResourceList {
         )
     }
 
-    $resourcesExist = @()
-
-    foreach ($resource in $allPSResources) {
-        foreach ($inputResource in $inputResources) {
-            if ($resource.Name -eq $inputResource.Name) {
-                Write-Trace -message "Found matching resource for input: $($inputResource.Name). Checking version constraints. Input version: $($inputResource.Version), Resource version: $($resource.Version)" -level debug
-                if ($inputResource.Version) {
-                    # Use the NuGet.Versioning package if available, otherwise do a simple comparison
-                    try {
-                        if (SatisfiesVersion -version $resource.Version -versionRange $inputResource.Version) {
-                            $resourcesExist += $resource
-                        }
-                    }
-                    catch {
-                        Write-Trace -message "Error checking version constraints for resource: $($inputResource.Name). Error details: $($_.Exception.Message)" -level debug
-                        # Fallback: simple string comparison (not full NuGet range support)
-                        if ($resource.Version.ToString() -eq $inputResource.Version) {
-                            $resourcesExist += $resource
-                        }
-                    }
-                }
+    $resolvedResources = @()
+
+    foreach ($inputResource in $inputResources) {
+        $matchingResources = $allPSResources | Where-Object { $_.Name -eq $inputResource.Name }
+
+        if ($matchingResources) {
+            $preferred = $null
+            if ($inputResource.Version) {
+                $preferred = $matchingResources | Where-Object {
+                    try { SatisfiesVersion -version $_.Version -versionRange $inputResource.Version } catch { $false }
+                } | Select-Object -First 1
+            } else {
+                $preferred = $matchingResources | Select-Object -First 1
+            }
+
+            if ($preferred) {
+                Write-Trace -message "Resource '$($inputResource.Name)' version '$($preferred.Version)' satisfies requested range '$($inputResource.Version)'." -level debug
+                $resolvedResources += $preferred
+            } else {
+                # Installed but doesn't satisfy the version range - report actual installed version with _exist = false
+                $fallback = $matchingResources | Select-Object -First 1
+                Write-Trace -message "Resource '$($inputResource.Name)' installed at '$($fallback.Version)' does not satisfy requested range '$($inputResource.Version)'. Reporting _exist = false." -level debug
+                $fallback._exist = $false
+                $resolvedResources += $fallback
             }
+        } else {
+            Write-Trace -message "Resource '$($inputResource.Name)' is not installed. Reporting _exist = false." -level debug
+            $resolvedResources += [PSResource]::new($inputResource.Name)
         }
     }
 
-    ## For get operation we only need the first resource that exists, which is always the latest for currentUser
-    PopulatePSResourceListObjectByRepository -resourcesExist $resourcesExist -inputResources $inputResources -repositoryName $inputPSResourceList.RepositoryName -trustedRepository $inputPSResourceList.trustedRepository
+    PopulatePSResourceListObjectByRepository -resourcesExist $resolvedResources -inputResources $inputResources -repositoryName $inputPSResourceList.RepositoryName -trustedRepository $inputPSResourceList.trustedRepository
 }
 
 function GetOperation {
@@ -771,13 +776,20 @@ function PopulatePSResourceListObjectByRepository {
     }
     else {
         $resources += $resourcesExist | ForEach-Object {
-            [PSResource]::new(
-                $_.Name,
-                $_.Version.PreRelease ? $_.Version.ToString() + "-" + $_.PreRelease : $_.Version.ToString(),
-                $_.Scope,
-                $_.RepositoryName,
-                $_.PreRelease ? $true : $false
-            )
+            $srcExist = $_._exist
+            $r = if ($_.version) {
+                [PSResource]::new(
+                    $_.Name,
+                    $_.Version.ToString(),
+                    $_.Scope,
+                    $_.RepositoryName,
+                    $_.PreRelease ? $true : $false
+                )
+            } else {
+                [PSResource]::new($_.Name)
+            }
+            $r._exist = $srcExist
+            $r
         }
     }
 

test/DscResource/PSResourceGetDSCResource.Tests.ps1

@@ -221,6 +221,16 @@ Describe "PSResourceList Resource Tests" -Tags 'CI' {
             return
         }
 
+        # Remove test modules installed through DSC so they do not leak into later runs.
+        foreach ($moduleToRemove in @($script:testModuleName, $script:testModuleName2)) {
+            $cleanupInput = @{
+                repositoryName    = $script:localRepo
+                trustedRepository = $true
+                resources         = @(@{ name = $moduleToRemove; _exist = $false })
+            } | ConvertTo-Json -Depth 5
+            $null = & $script:dscExe resource set --resource Microsoft.PowerShell.PSResourceGet/PSResourceList --input $cleanupInput -o json 2>&1
+        }
+
         # Clean up the test repository
         Get-RevertPSResourceRepositoryFile
     }
@@ -370,6 +380,70 @@ Describe "PSResourceList Resource Tests" -Tags 'CI' {
         $testResult = & $script:dscExe resource test --resource Microsoft.PowerShell.PSResourceGet/PSResourceList --input $resourceInput -o json | ConvertFrom-Json
         $testResult.inDesiredState | Should -BeFalse
     }
+
+    It 'Get returns actual installed version with _exist false when installed version does not satisfy requested version' {
+        # Install 1.0.0 but request 5.0.0 - get should report _exist = false (requested version absent)
+        $removeAllInput = @{
+            repositoryName    = $script:localRepo
+            trustedRepository = $true
+            resources         = @(@{ name = $script:testModuleName; _exist = $false })
+        } | ConvertTo-Json -Depth 5
+        $null = & $script:dscExe resource set --resource Microsoft.PowerShell.PSResourceGet/PSResourceList --input $removeAllInput -o json
+
+        $installOldInput = @{
+            repositoryName    = $script:localRepo
+            trustedRepository = $true
+            resources         = @(@{ name = $script:testModuleName; version = '1.0.0' })
+        } | ConvertTo-Json -Depth 5
+        $null = & $script:dscExe resource set --resource Microsoft.PowerShell.PSResourceGet/PSResourceList --input $installOldInput -o json
+
+        $psResourceListParams = @{
+            repositoryName = $script:localRepo
+            resources      = @(
+                @{
+                    name    = $script:testModuleName
+                    version = '5.0.0'
+                }
+            )
+        }
+
+        $resourceInput = $psResourceListParams | ConvertTo-Json -Depth 5
+        $getResult = & $script:dscExe resource get --resource Microsoft.PowerShell.PSResourceGet/PSResourceList --input $resourceInput -o json | ConvertFrom-Json
+        $getResult.actualState.resources.Count | Should -Be 1
+        $getResult.actualState.resources[0].name | Should -BeExactly $script:testModuleName
+        $getResult.actualState.resources[0].version | Should -BeExactly '1.0.0'
+        $getResult.actualState.resources[0]._exist | Should -BeFalse
+    }
+
+    It 'Get prefers installed version that satisfies requested version range when multiple versions are installed' {
+        # Install both 1.0.0 and 5.0.0 but request 5.0.0 - get should prefer the satisfying version (5.0.0).
+        # Setup goes through DSC for the same reason as the previous test.
+        foreach ($setupVersion in @('1.0.0', '5.0.0')) {
+            $installInput = @{
+                repositoryName    = $script:localRepo
+                trustedRepository = $true
+                resources         = @(@{ name = $script:testModuleName; version = $setupVersion })
+            } | ConvertTo-Json -Depth 5
+            $null = & $script:dscExe resource set --resource Microsoft.PowerShell.PSResourceGet/PSResourceList --input $installInput -o json
+        }
+
+        $psResourceListParams = @{
+            repositoryName = $script:localRepo
+            resources      = @(
+                @{
+                    name    = $script:testModuleName
+                    version = '5.0.0'
+                }
+            )
+        }
+
+        $resourceInput = $psResourceListParams | ConvertTo-Json -Depth 5
+        $getResult = & $script:dscExe resource get --resource Microsoft.PowerShell.PSResourceGet/PSResourceList --input $resourceInput -o json | ConvertFrom-Json
+        $getResult.actualState.resources.Count | Should -Be 1
+        $getResult.actualState.resources[0].name | Should -BeExactly $script:testModuleName
+        $getResult.actualState.resources[0].version | Should -BeExactly '5.0.0'
+        $getResult.actualState.resources[0]._exist | Should -BeTrue
+    }
 }
 
 Describe 'E2E tests for Repository resource' -Tags 'CI' {