Merge pull request #876 from Gijsreyn/fix-capabilities-discover-psadapter

Fix discovery of capabilities PSAdapter

Author: SteveL-MSFT

powershell-adapter/Tests/powershellgroup.resource.tests.ps1

@@ -27,7 +27,9 @@ Describe 'PowerShell adapter resource tests' {
         $r = dsc resource list '*' -a Microsoft.DSC/PowerShell
         $LASTEXITCODE | Should -Be 0
         $resources = $r | ConvertFrom-Json
-        ($resources | ? { $_.Type -eq 'TestClassResource/TestClassResource' }).Count | Should -Be 1
+        ($resources | Where-Object { $_.Type -eq 'TestClassResource/TestClassResource' }).Count | Should -Be 1
+        ($resources | Where-Object -Property type -EQ 'TestClassResource/TestClassResource').capabilities | Should -BeIn @('get', 'set', 'test', 'export')
+        ($resources | Where-Object -Property type -EQ 'TestClassResource/NoExport').capabilities | Should -BeIn @('get', 'set', 'test')
     }
 
     It 'Get works on class-based resource' {

powershell-adapter/psDscAdapter/powershell.resource.ps1

@@ -91,10 +91,13 @@ switch ($Operation) {
             # TODO: for perf, it is better to take capabilities from psd1 in Invoke-DscCacheRefresh, not by extra call to Get-Module
             if ($DscResourceInfo.ModuleName) {
                 $module = Get-Module -Name $DscResourceInfo.ModuleName -ListAvailable | Sort-Object -Property Version -Descending | Select-Object -First 1
-                if ($module.PrivateData.PSData.DscCapabilities) {
+                # If the DscResourceInfo does have capabilities, use them or else use the module's capabilities
+                if ($DscResourceInfo.Capabilities) {
+                    $capabilities = $DscResourceInfo.Capabilities
+                } elseif ($module.PrivateData.PSData.DscCapabilities) {
+                    
                     $capabilities = $module.PrivateData.PSData.DscCapabilities
-                }
-                else {
+                } else {
                     $capabilities = @('get', 'set', 'test')
                 }
             }

powershell-adapter/psDscAdapter/psDscAdapter.psm1

@@ -1,7 +1,7 @@
 # Copyright (c) Microsoft Corporation.
 # Licensed under the MIT License.
 
-$script:CurrentCacheSchemaVersion = 2
+$script:CurrentCacheSchemaVersion = 3
 
 function Write-DscTrace {
     param(
@@ -60,7 +60,7 @@ function Add-AstMembers {
 
     foreach ($member in $TypeAst.Members) {
         $property = $member -as [System.Management.Automation.Language.PropertyMemberAst]
-        if (($property -eq $null) -or ($property.IsStatic)) {
+        if (($null -eq $property) -or ($property.IsStatic)) {
             continue;
         }
         $skipProperty = $true
@@ -117,7 +117,7 @@ function FindAndParseResourceDefinitions {
     $typeDefinitions = $ast.FindAll(
         {
             $typeAst = $args[0] -as [System.Management.Automation.Language.TypeDefinitionAst]
-            return $typeAst -ne $null;
+            return $null -ne $typeAst;
         },
         $false);
 
@@ -139,6 +139,7 @@ function FindAndParseResourceDefinitions {
                 $DscResourceInfo.Version = $moduleVersion
 
                 $DscResourceInfo.Properties = [System.Collections.Generic.List[DscResourcePropertyInfo]]::new()
+                $DscResourceInfo.Capabilities = GetClassBasedCapabilities $typeDefinitionAst.Members
                 Add-AstMembers $typeDefinitions $typeDefinitionAst $DscResourceInfo.Properties
 
                 $resourceList.Add($DscResourceInfo)
@@ -325,7 +326,7 @@ function Invoke-DscCacheRefresh {
 
             # fill in resource files (and their last-write-times) that will be used for up-do-date checks
             $lastWriteTimes = @{}
-            Get-ChildItem -Recurse -File -Path $dscResource.ParentPath -Include "*.ps1", "*.psd1", "*.psm1", "*.mof" -ea Ignore | % {
+            Get-ChildItem -Recurse -File -Path $dscResource.ParentPath -Include "*.ps1", "*.psd1", "*.psm1", "*.mof" -ea Ignore | ForEach-Object {
                 $lastWriteTimes.Add($_.FullName, $_.LastWriteTime)
             }
 
@@ -338,7 +339,7 @@ function Invoke-DscCacheRefresh {
 
         [dscResourceCache]$cache = [dscResourceCache]::new()
         $cache.ResourceCache = $dscResourceCacheEntries
-        $m = $env:PSModulePath -split [IO.Path]::PathSeparator | % { Get-ChildItem -Directory -Path $_ -Depth 1 -ea SilentlyContinue }
+        $m = $env:PSModulePath -split [IO.Path]::PathSeparator | ForEach-Object { Get-ChildItem -Directory -Path $_ -Depth 1 -ea SilentlyContinue }
         $cache.PSModulePaths = $m.FullName
         $cache.CacheSchemaVersion = $script:CurrentCacheSchemaVersion
 
@@ -529,6 +530,28 @@ function GetTypeInstanceFromModule {
     return $instance
 }
 
+function GetClassBasedCapabilities ($functionMemberAst) {
+    $capabilities = [System.Collections.Generic.List[string[]]]::new()
+    # These are the methods that we can potentially expect in a class-based DSC resource.
+    $availableMethods = @('get', 'set', 'setHandlesExist', 'whatIf', 'test', 'delete', 'export')
+    $methods = $functionMemberAst | Where-Object { $_ -is [System.Management.Automation.Language.FunctionMemberAst] -and $_.Name -in $availableMethods }
+
+    foreach ($method in $methods.Name) {
+        # We go through each method to properly case handle the method names.
+        switch ($method) {
+            'Get' { $capabilities.Add('get') }
+            'Set' { $capabilities.Add('set') }
+            'Test' { $capabilities.Add('test') }
+            'WhatIf' { $capabilities.Add('whatIf') }
+            'SetHandlesExist' { $capabilities.Add('setHandlesExist') }
+            'Delete' { $capabilities.Add('delete') }
+            'Export' { $capabilities.Add('export') }
+        }
+    }
+
+    return ($capabilities | Select-Object -Unique)
+}
+
 # cached resource
 class dscResourceCacheEntry {
     [string] $Type
@@ -578,4 +601,5 @@ class DscResourceInfo {
     [string] $ImplementedAs
     [string] $CompanyName
     [System.Collections.Generic.List[DscResourcePropertyInfo]] $Properties
+    [string[]] $Capabilities
 }