Merge pull request #748 from Gijsreyn/fix-module-add-run-ps

Fix resourceCache to return proper modules when PS modules are installed during run

Author: SteveL-MSFT

powershell-adapter/Tests/win_powershellgroup.tests.ps1

@@ -30,7 +30,7 @@ Describe 'WindowsPowerShell adapter resource tests - requires elevated permissio
         $r = dsc resource list --adapter Microsoft.Windows/WindowsPowerShell
         $LASTEXITCODE | Should -Be 0
         $resources = $r | ConvertFrom-Json
-        ($resources | ? {$_.Type -eq 'PSDesiredStateConfiguration/File'}).Count | Should -Be 1
+        ($resources | Where-Object {$_.Type -eq 'PSDesiredStateConfiguration/File'}).Count | Should -Be 1
     }
 
     It 'Get works on Binary "File" resource' -Skip:(!$IsWindows){
@@ -72,7 +72,6 @@ Describe 'WindowsPowerShell adapter resource tests - requires elevated permissio
     }
 
     It 'Verify that there are no cache rebuilds for several sequential executions' -Skip:(!$IsWindows) {
-
         # remove cache file
         $cacheFilePath = Join-Path $env:LocalAppData "dsc\WindowsPSAdapterCache.json"
         Remove-Item -Force -Path $cacheFilePath -ErrorAction Ignore
@@ -82,12 +81,100 @@ Describe 'WindowsPowerShell adapter resource tests - requires elevated permissio
         "$TestDrive/tracing.txt" | Should -FileContentMatchExactly 'Constructing Get-DscResource cache'
 
         # next executions following shortly after should Not rebuild the cache
-        1..3 | %{
+        1..3 | ForEach-Object {
             dsc -l trace resource list -a Microsoft.Windows/WindowsPowerShell 2> $TestDrive/tracing.txt
             "$TestDrive/tracing.txt" | Should -Not -FileContentMatchExactly 'Constructing Get-DscResource cache'
         }
     }
 
+    It 'Verify if assertion is used that no module is cleared in the cache' -Skip:(!$IsWindows) {
+        # create a test file in the test drive
+        $testFile = "$testdrive\test.txt"
+        New-Item -Path $testFile -ItemType File -Force | Out-Null
+
+        # remove cache file
+        $cacheFilePath = Join-Path $env:LocalAppData "dsc\WindowsPSAdapterCache.json"
+        Remove-Item -Force -Path $cacheFilePath -ErrorAction Ignore
+
+        # build the cache
+        dsc resource list --adapter Microsoft.Windows/WindowsPowerShell | Out-Null
+
+        # Create a test module in the test drive
+        $testModuleDir = "$testdrive\TestModule\1.0.0"
+        New-Item -Path $testModuleDir -ItemType Directory -Force | Out-Null
+
+        $manifestContent = @"
+        @{
+            RootModule = 'TestModule.psm1'
+            ModuleVersion = '1.0.0'
+            GUID = $([guid]::NewGuid().Guid)
+            Author = 'Microsoft Corporation'
+            CompanyName = 'Microsoft Corporation'
+            Copyright = '(c) Microsoft Corporation. All rights reserved.'
+            Description = 'Test module for DSC tests'
+            PowerShellVersion = '5.1'
+            DscResourcesToExport = @()
+            FunctionsToExport = @()
+            CmdletsToExport = @()
+            VariablesToExport = @()
+            AliasesToExport = @()
+        }
+"@
+        Set-Content -Path "$testModuleDir\TestModule.psd1" -Value $manifestContent
+
+        $scriptContent = @"
+Write-Host 'The DSC world!'
+"@
+        Set-Content -Path "$testModuleDir\TestModule.psm1" -Value $scriptContent
+
+        # Add the test module directory to PSModulePath
+        $env:PSModulePath += [System.IO.Path]::PathSeparator + $testdrive
+
+        $yaml = @"
+`$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
+resources:
+  - name: File
+    type: Microsoft.Windows/WindowsPowerShell
+    properties:
+      resources:
+        - name: File
+          type: PSDesiredStateConfiguration/File
+          properties:
+            DestinationPath: $testfile
+  - name: File present
+    type: Microsoft.DSC/Assertion
+    properties:
+      `$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
+      resources:
+        - name: Use powershell adapter
+          type: Microsoft.Windows/WindowsPowerShell
+          properties:
+            resources:
+              - name: File present
+                type: PSDesiredStateConfiguration/File
+                properties:
+                  DestinationPath: $testFile
+    dependsOn:
+      - "[resourceId('Microsoft.Windows/WindowsPowerShell', 'File')]"
+  - name: TestPSRepository
+    type: PSTestModule/TestPSRepository
+    properties: 
+      Name: NuGet
+    dependsOn:
+      - "[resourceId('Microsoft.Windows/WindowsPowerShell', 'File')]"
+      - "[resourceId('Microsoft.DSC/Assertion', 'File present')]"
+"@
+        # output to file for Windows PowerShell 5.1
+        $filePath = "$testdrive\test.assertion.dsc.resource.yaml"
+        $yaml | Set-Content -Path $filePath -Force
+        dsc config test -f $filePath 2> "$TestDrive/error.txt"
+        $LASTEXITCODE | Should -Be 2
+
+        $cache = Get-Content -Path $cacheFilePath -Raw | ConvertFrom-Json
+        $cache.ResourceCache.Type | Should -Contain 'PSTestModule/TestPSRepository'
+        $cache.ResourceCache.Type | Should -Contain 'PSDesiredStateConfiguration/File'
+    }
+
     It '_inDesiredState is returned correction: <Context>' -Skip:(!$IsWindows) -TestCases @(
         @{ Context = 'Both running'; FirstState = 'Running'; SecondState = 'Running' }
         @{ Context = 'Both stopped'; FirstState = 'Stopped'; SecondState = 'Stopped' }

powershell-adapter/psDscAdapter/win_psDscAdapter.psm1

@@ -127,7 +127,6 @@ function Invoke-DscCacheRefresh {
                     $diff = $hs_cache
 
                     "PSModulePath diff '$diff'" | Write-DscTrace
-
                     if ($diff.Count -gt 0) {
                         $refreshCache = $true
                     }
@@ -154,10 +153,17 @@ function Invoke-DscCacheRefresh {
             }
             $DscResources = [System.Collections.Generic.List[Object]]::new()
             $Modules = [System.Collections.Generic.List[Object]]::new()
+            $filteredResources = @()
             foreach ($m in $module) {
                 $DscResources += Get-DscResource -Module $m
                 $Modules += Get-Module -Name $m -ListAvailable
+
+                # Grab all DSC resources to filter out of the cache
+                $filteredResources += $dscResources | Where-Object -Property ModuleName -NE $null | ForEach-Object { [System.String]::Concat($_.ModuleName, '/', $_.Name) }
             }
+
+            # Exclude the one module that was passed in as a parameter
+            $existingDscResourceCacheEntries = $cache.ResourceCache | Where-Object -Property Type -NotIn $filteredResources
         }
         elseif ('PSDesiredStateConfiguration' -eq $module -and $PSVersionTable.PSVersion.Major -le 5 ) {
             # the resources in Windows should only load in Windows PowerShell
@@ -248,6 +254,13 @@ function Invoke-DscCacheRefresh {
         $cache.PSModulePaths = $m.FullName
         $cache.CacheSchemaVersion = $script:CurrentCacheSchemaVersion
 
+        if ($existingDscResourceCacheEntries) {
+            $cache.ResourceCache += $existingDscResourceCacheEntries
+
+            # Make sure all resource cache entries are returned
+            $dscResourceCacheEntries = $cache.ResourceCache
+        }
+
         # save cache for future use
         # TODO: replace this with a high-performance serializer
         "Saving Get-DscResource cache to '$cacheFilePath'" | Write-DscTrace