Merge branch 'main' into gh-57/main/add-shallowmerge-function

Author: Gijsreyn

Cargo.lock

@@ -6,6 +6,7 @@ members = [
     "dsc",
     "lib/dsc-lib",
     "lib/dsc-lib-jsonschema",
+    "lib/dsc-lib-jsonschema-macros",
     "resources/dscecho",
     "lib/dsc-lib-osinfo",
     "resources/osinfo",
@@ -29,6 +30,7 @@ default-members = [
     "dsc",
     "lib/dsc-lib",
     "lib/dsc-lib-jsonschema",
+    "lib/dsc-lib-jsonschema-macros",
     "resources/dscecho",
     "lib/dsc-lib-osinfo",
     "resources/osinfo",
@@ -54,6 +56,7 @@ Windows = [
     "dsc",
     "lib/dsc-lib",
     "lib/dsc-lib-jsonschema",
+    "lib/dsc-lib-jsonschema-macros",
     "resources/dscecho",
     "lib/dsc-lib-osinfo",
     "resources/osinfo",
@@ -74,6 +77,7 @@ macOS = [
     "dsc",
     "lib/dsc-lib",
     "lib/dsc-lib-jsonschema",
+    "lib/dsc-lib-jsonschema-macros",
     "resources/dscecho",
     "lib/dsc-lib-osinfo",
     "resources/osinfo",
@@ -91,6 +95,7 @@ Linux = [
     "dsc",
     "lib/dsc-lib",
     "lib/dsc-lib-jsonschema",
+    "lib/dsc-lib-jsonschema-macros",
     "resources/dscecho",
     "lib/dsc-lib-osinfo",
     "resources/osinfo",
@@ -130,6 +135,8 @@ clap_complete = { version = "4.5" }
 crossterm = { version = "0.29" }
 # dsc
 ctrlc = { version = "3.5" }
+# dsc-lib-jsonschema-macros
+darling = { version = "0.23" }
 # dsc-lib
 derive_builder = { version = "0.20" }
 # dsc, dsc-lib
@@ -150,6 +157,10 @@ num-traits = { version = "0.2" }
 os_info = { version = "3.13" }
 # dsc, dsc-lib
 path-absolutize = { version = "3.1" }
+# dsc-lib-jsonschema-macros
+proc-macro2 = { version = "1.0" }
+# dsc-lib-jsonschema-macros
+quote = { version = "1.0" }
 # dsc, dsc-lib
 regex = { version = "1.12" }
 # registry, dsc-lib-registry
@@ -170,6 +181,8 @@ serde = { version = "1.0", features = ["derive"] }
 serde_json = { version = "1.0", features = ["preserve_order"] }
 # dsc, dsc-lib, y2j
 serde_yaml = { version = "0.9" }
+# dsc-lib-jsonschema-macros
+syn = { version = "2.0" }
 # dsc, y2j
 syntect = { version = "5.3", features = ["default-fancy"], default-features = false }
 # dsc, process
@@ -200,7 +213,7 @@ utfx = { version = "0.1" }
 uuid = { version = "1.18", features = ["v4"] }
 # dsc-lib, dsc-lib-jsonschema
 url = { version = "2.5" }
-# dsc-lib
+# dsc-lib, dsc-lib-jsonschema
 urlencoding = { version = "2.1" }
 # dsc-lib
 which = { version = "8.0" }
@@ -218,6 +231,7 @@ pretty_assertions = { version = "1.4.1" }
 # Workspace crates as dependencies
 dsc-lib = { path = "lib/dsc-lib" }
 dsc-lib-jsonschema = { path = "lib/dsc-lib-jsonschema" }
+dsc-lib-jsonschema-macros = { path = "lib/dsc-lib-jsonschema-macros" }
 dsc-lib-osinfo = { path = "lib/dsc-lib-osinfo" }
 dsc-lib-security_context = { path = "lib/dsc-lib-security_context" }
 tree-sitter-dscexpression = { path = "grammars/tree-sitter-dscexpression" }

Cargo.toml

@@ -34,7 +34,7 @@ VariablesToExport = @()
 AliasesToExport = @()
 
 # DSC resources to export from this module
-DscResourcesToExport = @('TestClassResource', 'NoExport')
+DscResourcesToExport = @('TestClassResource', 'NoExport', 'FilteredExport')
 
 # Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
 PrivateData = @{

adapters/powershell/Tests/TestClassResource/0.0.1/TestClassResource.psd1

@@ -155,6 +155,52 @@ class NoExport: BaseTestClass
     }
 }
 
+[DscResource()]
+class FilteredExport : BaseTestClass
+{
+    [DscProperty(Key)]
+    [string] $Name
+
+    [DscProperty()]
+    [string] $Prop1
+
+    [void] Set()
+    {
+    }
+
+    [bool] Test()
+    {
+        return $true
+    }
+
+    [FilteredExport] Get()
+    {
+        return $this
+    }
+
+    static [FilteredExport[]] Export()
+    {
+        $resultList = [List[FilteredExport]]::new()
+        $obj = New-Object FilteredExport
+        $obj.Name = "DefaultObject"
+        $obj.Prop1 = "Default Property"
+        $resultList.Add($obj)
+
+        return $resultList.ToArray()
+    }
+
+    static [FilteredExport[]] Export([FilteredExport]$Name)
+    {
+        $resultList = [List[FilteredExport]]::new()
+        $obj = New-Object FilteredExport
+        $obj.Name = $Name
+        $obj.Prop1 = "Filtered Property for $Name"
+        $resultList.Add($obj)
+
+        return $resultList.ToArray()
+    }
+}
+
 function Test-World()
 {
     "Hello world from PSTestModule!"

adapters/powershell/Tests/TestClassResource/0.0.1/TestClassResource.psm1

@@ -105,6 +105,49 @@ Describe 'PowerShell adapter resource tests' {
     $out | Should -BeLike "*ERROR*Export method not implemented by resource 'TestClassResource/NoExport'*"
   }
 
+  It 'Export works with filtered export property' {
+    $yaml = @'
+            $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
+            resources:
+            - name: Working with class-based resources
+              type: Microsoft.DSC/PowerShell
+              properties:
+                resources:
+                - name: Class-resource Info
+                  type: TestClassResource/FilteredExport
+                  properties:
+                    Name: 'FilteredExport'
+'@
+    $out = $yaml | dsc -l trace config export -f - 2> "$TestDrive/export_trace.txt"
+    $LASTEXITCODE | Should -Be 0
+    $res = $out | ConvertFrom-Json
+    $res.'$schema' | Should -BeExactly 'https://aka.ms/dsc/schemas/v3/bundled/config/document.json'
+    $res.'resources' | Should -Not -BeNullOrEmpty
+    $res.resources[0].properties.result.count | Should -Be 1
+    $res.resources[0].properties.result[0].Name | Should -Be "FilteredExport"
+    $res.resources[0].properties.result[0].Prop1 | Should -Be "Filtered Property for FilteredExport"
+    "$TestDrive/export_trace.txt" | Should -FileContentMatch "Properties provided for filtered export"
+  }
+
+  It 'Export fails when filtered export is requested but not implemented' {
+    $yaml = @'
+            $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
+            resources:
+            - name: Working with class-based resources
+              type: Microsoft.DSC/PowerShell
+              properties:
+                resources:
+                - name: Class-resource Info
+                  type: TestClassResource/NoExport
+                  properties:
+                    Name: 'SomeFilter'
+'@
+    $out = $yaml | dsc config export -f - 2>&1 | Out-String
+    $LASTEXITCODE | Should -Be 2
+    $out | Should -Not -BeNullOrEmpty
+    $out | Should -BeLike "*ERROR*Export method with parameters not implemented by resource 'TestClassResource/NoExport'*"
+  }
+
   It 'Custom psmodulepath in config works' {
 
     $OldPSModulePath = $env:PSModulePath

adapters/powershell/Tests/powershellgroup.config.tests.ps1

@@ -181,7 +181,7 @@ switch ($Operation) {
             # process the INPUT (desiredState) for each resource as dscresourceInfo and return the OUTPUT as actualState
             $actualState = $psDscAdapter.invoke( { param($op, $ds, $dscResourceCache) Invoke-DscOperation -Operation $op -DesiredState $ds -dscResourceCache $dscResourceCache }, $Operation, $ds, $dscResourceCache)
             if ($null -eq $actualState) {
-                Write-DscTrace -Operation Error -Message 'Incomplete GET for resource ' + $ds.Name
+                "Failed to invoke operation '{0}' for resource name '{1}'." -f $Operation, $ds.Name | Write-DscTrace -Operation Error
                 exit 1
             }
             if ($null -ne $actualState.Properties -and $actualState.Properties.InDesiredState -eq $false) {