Merge branch 'main' into fix-pending-reboot

Gijsreyn · web-flow · commit c346935c6706 · 2025-06-05T04:06:37.000+02:00
diff --git a/build.ps1 b/build.ps1
@@ -158,6 +158,10 @@ if ($null -ne $packageType) {
             Remove-Item temp:/rustup-init.exe -ErrorAction Ignore
         }
     }
+    else  {
+        Write-Verbose -Verbose "Rust found, updating..."
+        & $rustup update
+    }
 
     $BuildToolsPath = "${env:ProgramFiles(x86)}\Microsoft Visual Studio\2022\BuildTools\VC\Tools\MSVC"
 
diff --git a/dsc/locales/en-us.toml b/dsc/locales/en-us.toml
@@ -73,6 +73,7 @@ implementedAs = "implemented as"
 invalidOperationOnAdapter = "Can not perform this operation on the adapter itself"
 setInputEmpty = "Desired input is empty"
 testInputEmpty = "Expected input is required"
+jsonError = "JSON: %{err}"
 
 [subcommand]
 actualStateNotObject = "actual_state is not an object"
@@ -108,6 +109,7 @@ tableHeader_capabilities = "Capabilities"
 tableHeader_adapter = "RequireAdapter"
 tableHeader_description = "Description"
 invalidManifest = "Error in manifest for"
+jsonArrayNotSupported = "JSON array output format is only supported for `--all'"
 
 [util]
 failedToConvertJsonToString = "Failed to convert JSON to string"
diff --git a/dsc/src/args.rs b/dsc/src/args.rs
@@ -15,6 +15,14 @@ pub enum OutputFormat {
     Yaml,
 }
 
+#[derive(Debug, Clone, PartialEq, Eq, ValueEnum)]
+pub enum GetOutputFormat {
+    Json,
+    JsonArray,
+    PrettyJson,
+    Yaml,
+}
+
 #[derive(Debug, Clone, PartialEq, Eq, ValueEnum)]
 pub enum ListOutputFormat {
     Json,
@@ -195,7 +203,7 @@ pub enum ResourceSubCommand {
         #[clap(short = 'f', long, help = t!("args.file").to_string(), conflicts_with = "input")]
         file: Option<String>,
         #[clap(short = 'o', long, help = t!("args.outputFormat").to_string())]
-        output_format: Option<OutputFormat>,
+        output_format: Option<GetOutputFormat>,
     },
     #[clap(name = "set", about = "Invoke the set operation to a resource", arg_required_else_help = true)]
     Set {
diff --git a/dsc/src/resource_command.rs b/dsc/src/resource_command.rs
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-use crate::args::OutputFormat;
+use crate::args::{GetOutputFormat, OutputFormat};
 use crate::util::{EXIT_DSC_ERROR, EXIT_INVALID_ARGS, EXIT_JSON_ERROR, EXIT_DSC_RESOURCE_NOT_FOUND, write_object};
 use dsc_lib::configure::config_doc::{Configuration, ExecutionKind};
 use dsc_lib::configure::add_resource_export_results_to_configuration;
@@ -47,7 +47,7 @@ pub fn get(dsc: &DscManager, resource_type: &str, input: &str, format: Option<&O
     }
 }
 
-pub fn get_all(dsc: &DscManager, resource_type: &str, format: Option<&OutputFormat>) {
+pub fn get_all(dsc: &DscManager, resource_type: &str, format: Option<&GetOutputFormat>) {
     let input = String::new();
     let Some(resource) = get_resource(dsc, resource_type) else {
         error!("{}", DscError::ResourceNotFound(resource_type.to_string()).to_string());
@@ -68,6 +68,18 @@ pub fn get_all(dsc: &DscManager, resource_type: &str, format: Option<&OutputForm
         }
     };
 
+    if format == Some(&GetOutputFormat::JsonArray) {
+        let json = match serde_json::to_string(&export_result.actual_state) {
+            Ok(json) => json,
+            Err(err) => {
+                error!("{}", t!("resource_command.jsonError", err = err));
+                exit(EXIT_JSON_ERROR);
+            }
+        };
+        write_object(&json, Some(&OutputFormat::Json), false);
+        return;
+    }
+
     let mut include_separator = false;
     for instance in export_result.actual_state
     {
@@ -78,10 +90,15 @@ pub fn get_all(dsc: &DscManager, resource_type: &str, format: Option<&OutputForm
         let json = match serde_json::to_string(&get_result) {
             Ok(json) => json,
             Err(err) => {
-                error!("JSON Error: {err}");
+                error!("{}", t!("resource_command.jsonError", err = err));
                 exit(EXIT_JSON_ERROR);
             }
         };
+        let format = match format {
+            Some(&GetOutputFormat::PrettyJson) => Some(&OutputFormat::PrettyJson),
+            Some(&GetOutputFormat::Yaml) => Some(&OutputFormat::Yaml),
+            _ => Some(&OutputFormat::Json),
+        };
         write_object(&json, format, include_separator);
         include_separator = true;
     }
diff --git a/dsc/src/subcommand.rs b/dsc/src/subcommand.rs
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-use crate::args::{ConfigSubCommand, DscType, ExtensionSubCommand, ListOutputFormat, OutputFormat, ResourceSubCommand};
+use crate::args::{ConfigSubCommand, DscType, ExtensionSubCommand, GetOutputFormat, ListOutputFormat, OutputFormat, ResourceSubCommand};
 use crate::resolve::{get_contents, Include};
 use crate::resource_command::{get_resource, self};
 use crate::tablewriter::Table;
@@ -590,7 +590,17 @@ pub fn resource(subcommand: &ResourceSubCommand, progress_format: ProgressFormat
             if *all { resource_command::get_all(&dsc, resource, output_format.as_ref()); }
             else {
                 let parsed_input = get_input(input.as_ref(), path.as_ref());
-                resource_command::get(&dsc, resource, &parsed_input, output_format.as_ref());
+                let format = match output_format {
+                    Some(GetOutputFormat::Json) => Some(OutputFormat::Json),
+                    Some(GetOutputFormat::JsonArray) => {
+                        error!("{}", t!("subcommand.jsonArrayNotSupported"));
+                        exit(EXIT_INVALID_ARGS);
+                    },
+                    Some(GetOutputFormat::PrettyJson) => Some(OutputFormat::PrettyJson),
+                    Some(GetOutputFormat::Yaml) => Some(OutputFormat::Yaml),
+                    None => None,
+                };
+                resource_command::get(&dsc, resource, &parsed_input, format.as_ref());
             }
         },
         ResourceSubCommand::Set { resource, input, file: path, output_format } => {
diff --git a/dsc/tests/dsc_discovery.tests.ps1 b/dsc/tests/dsc_discovery.tests.ps1
@@ -220,4 +220,35 @@ Describe 'tests for resource discovery' {
             $env:DSC_RESOURCE_PATH = $oldPath
         }
     }
+
+    It 'DSC_RESOURCE_PATH should be used for executable lookup' {
+        $dscTest = Get-Command dscecho -ErrorAction Stop
+        $target = if ($IsWindows) {
+            'echoIt.exe'
+        } else {
+            'echoIt'
+        }
+        Copy-Item -Path "$($dscTest.Source)" -Destination "$testdrive\$target"
+        $manifest = Get-Content -Raw -Path "$(Split-Path -Path $dscTest.Source -Parent)\echo.dsc.resource.json" | ConvertFrom-Json
+        $manifest.type = 'Test/MyEcho'
+        $manifest.get.executable = $target
+        $manifest.set = $null
+        $manifest.test = $null
+        $manifest.schema.command.executable = $target
+        Set-Content -Path "$testdrive/test.dsc.resource.json" -Value ($manifest | ConvertTo-Json -Depth 10)
+
+        $oldPath = $env:DSC_RESOURCE_PATH
+        try {
+            $env:DSC_RESOURCE_PATH = $testdrive
+            $out = dsc resource get -r 'Test/MyEcho' -i '{"output":"Custom"}' 2> "$testdrive/error.txt" | ConvertFrom-Json
+            $LASTEXITCODE | Should -Be 0
+            $out.actualState.output | Should -BeExactly 'Custom'
+            dsc resource get -r 'Microsoft.DSC.Debug/Echo' -i '{"output":"Custom"}' 2> "$testdrive/error.txt" | ConvertFrom-Json
+            $LASTEXITCODE | Should -Be 7
+            Get-Content -Raw -Path "$testdrive/error.txt" | Should -Match "ERROR.*?Resource not found"
+        }
+        finally {
+            $env:DSC_RESOURCE_PATH = $oldPath
+        }
+    }
 }
diff --git a/dsc/tests/dsc_extension_discover.tests.ps1 b/dsc/tests/dsc_extension_discover.tests.ps1
@@ -4,9 +4,8 @@
 Describe 'Discover extension tests' {
     BeforeAll {
         $oldPath = $env:PATH
-        $separator = [System.IO.Path]::PathSeparator
         $toolPath = Resolve-Path -Path "$PSScriptRoot/../../extensions/test/discover"
-        $env:PATH = "$toolPath$separator$oldPath"
+        $env:PATH = "$toolPath" + [System.IO.Path]::PathSeparator + $oldPath
     }
 
     AfterAll {
@@ -75,10 +74,10 @@ Describe 'Discover extension tests' {
         Set-Content -Path "$TestDrive/test.dsc.extension.json" -Value $extension_json
         Copy-Item -Path "$toolPath/discover.ps1" -Destination $TestDrive | Out-Null
         Copy-Item -Path "$toolPath/resources" -Destination $TestDrive -Recurse | Out-Null
-        $env:DSC_RESOURCE_PATH = $TestDrive
+        $env:DSC_RESOURCE_PATH = "$TestDrive" + [System.IO.Path]::PathSeparator + (Split-Path (Get-Command pwsh).Source -Parent)
         try {
             $out = dsc extension list | ConvertFrom-Json
-            $out.Count | Should -Be 1
+            $out.Count | Should -Be 1 -Because ($out | Out-String)
             $out.type | Should -Be 'Test/DiscoverRelative'
             $out = dsc resource list 2> $TestDrive/error.log
             write-verbose -verbose (Get-Content -Path "$TestDrive/error.log" -Raw)
diff --git a/dsc/tests/dsc_resource_get.tests.ps1 b/dsc/tests/dsc_resource_get.tests.ps1
@@ -48,4 +48,10 @@ Describe 'resource get tests' {
         $testError[0] | SHould -match 'error:'
         $LASTEXITCODE | Should -Be 2
     }
+
+    It '--output-format json-array returns single object' {
+        $out = dsc resource get -r Microsoft/Process --all --output-format json-array
+        $LASTEXITCODE | Should -Be 0
+        ($out | Measure-Object).Count | Should -Be 1
+    }
 }
diff --git a/dsc/tests/dsc_resource_input.tests.ps1 b/dsc/tests/dsc_resource_input.tests.ps1
@@ -85,7 +85,7 @@ Describe 'tests for resource input' {
     }
 '@
         $oldPath = $env:DSC_RESOURCE_PATH
-        $env:DSC_RESOURCE_PATH = $TestDrive
+        $env:DSC_RESOURCE_PATH = $TestDrive + [System.IO.Path]::PathSeparator + $env:PATH
         Set-Content $TestDrive/EnvVarInput.dsc.resource.json -Value $manifest
     }
 
diff --git a/dsc/tests/dsc_set.tests.ps1 b/dsc/tests/dsc_set.tests.ps1
@@ -147,7 +147,7 @@ changedProperties:
 
         $oldPath = $env:DSC_RESOURCE_PATH
         try {
-            $env:DSC_RESOURCE_PATH = $TestDrive
+            $env:DSC_RESOURCE_PATH = $TestDrive + [System.IO.Path]::PathSeparator + $env:PATH
             $out = '{ "test": true }' | dsc resource set -r Test/SetNoTest -f - --output-format $format | Out-String
             $LASTEXITCODE | Should -Be 0
             $out.Trim() | Should -BeExactly $expected
@@ -160,7 +160,7 @@ changedProperties:
     It 'set can be used on a resource that does not implement test' {
         $oldPath = $env:DSC_RESOURCE_PATH
         try {
-            $env:DSC_RESOURCE_PATH = $TestDrive
+            $env:DSC_RESOURCE_PATH = $TestDrive + [System.IO.Path]::PathSeparator + $env:PATH
             $out = '{ "test": true }' | dsc resource set -r Test/SetNoTest -f - | ConvertFrom-Json
             $LASTEXITCODE | Should -Be 0
             $out.BeforeState.test | Should -Be $true
diff --git a/dsc_lib/locales/en-us.toml b/dsc_lib/locales/en-us.toml
@@ -72,6 +72,7 @@ couldNotReadSetting = "Could not read 'resourcePath' setting"
 appendingEnvPath = "Appending PATH to resourcePath"
 originalPath = "Original PATH: %{path}"
 failedGetEnvPath = "Failed to get PATH environment variable"
+failedJoinEnvPath = "Failed to join PATH environment variable"
 exeHomeAlreadyInPath = "Exe home is already in path: %{path}"
 addExeHomeToPath = "Adding exe home to path: %{path}"
 usingResourcePath = "Using Resource Path: %{path}"
diff --git a/dsc_lib/src/discovery/command_discovery.rs b/dsc_lib/src/discovery/command_discovery.rs
@@ -149,8 +149,16 @@ impl CommandDiscovery {
         let mut uniques: HashSet<PathBuf> = HashSet::new();
         paths.retain(|e|uniques.insert((*e).clone()));
 
-        // if exe home is not already in PATH env var then add it to env var and list of searched paths
-        if !using_custom_path {
+        if using_custom_path {
+            // when using custom path, intent is to isolate the search of manifests and executables to the custom path
+            // so we replace the PATH with the custom path
+            if let Ok(new_path) = env::join_paths(paths.clone()) {
+                env::set_var("PATH", new_path);
+            } else {
+                return Err(DscError::Operation(t!("discovery.commandDiscovery.failedJoinEnvPath").to_string()));
+            }
+        } else {
+            // if exe home is not already in PATH env var then add it to env var and list of searched paths
             if let Some(exe_home) = get_exe_path()?.parent() {
                 let exe_home_pb = exe_home.to_path_buf();
                 if paths.contains(&exe_home_pb) {
diff --git a/powershell-adapter/Tests/win_powershellgroup.tests.ps1 b/powershell-adapter/Tests/win_powershellgroup.tests.ps1
@@ -292,6 +292,12 @@ resources:
             Tags       = @(
                 'PSDscResource_PSClassResource'
             )
+            DscCapabilities = @(
+            'get'
+            'test'
+            'set'
+            'export'
+            )
         }
     }
 }
@@ -303,11 +309,24 @@ resources:
 
 
       $module = @'
+enum Ensure {
+    Present
+    Absent
+}
+
 [DSCResource()]
 class PSClassResource {
     [DscProperty(Key)]
     [string] $Name
 
+    [string] $NonDscProperty
+
+    hidden
+    [string] $HiddenNonDscProperty
+
+    [DscProperty()]
+    [Ensure] $Ensure = [Ensure]::Present
+
     PSClassResource() {
     }
 
@@ -333,6 +352,7 @@ class PSClassResource {
         1..$resultCount | %{
             $obj = New-Object PSClassResource
             $obj.Name = "Object$_"
+            $obj.Ensure = [Ensure]::Present
             $resultList.Add($obj)
         }
 
@@ -358,6 +378,8 @@ class PSClassResource {
     $out = dsc resource get -r PSClassResource/PSClassResource --input (@{Name = 'TestName' } | ConvertTo-Json) | ConvertFrom-Json
     $LASTEXITCODE | Should -Be 0
     $out.actualState.Name | Should -Be 'TestName'
+    $propCount = $out.actualState | Get-Member -MemberType NoteProperty 
+    $propCount.Count | Should -Be 1 # Only the DscProperty should be returned
   }
 
   It 'Set works with class-based PS DSC resources' -Skip:(!$IsWindows) {
@@ -373,5 +395,7 @@ class PSClassResource {
     $LASTEXITCODE | Should -Be 0
     $out | Should -Not -BeNullOrEmpty
     $out.resources.count | Should -Be 5
+    $out.resources[0].properties.Ensure | Should -Be 'Present' # Check for enum property
   }
-}
+}
+
diff --git a/powershell-adapter/psDscAdapter/win_psDscAdapter.psm1 b/powershell-adapter/psDscAdapter/win_psDscAdapter.psm1
@@ -402,6 +402,10 @@ function Invoke-DscOperation {
                     $resource = GetTypeInstanceFromModule -modulename $cachedDscResourceInfo.ModuleName -classname $cachedDscResourceInfo.Name
                     $dscResourceInstance = $resource::New()
 
+                    $ValidProperties = $cachedDscResourceInfo.Properties.Name
+
+                    $ValidProperties | ConvertTo-Json | Write-DscTrace -Operation Trace
+
                     if ($DesiredState.properties) {
                         # set each property of $dscResourceInstance to the value of the property in the $desiredState INPUT object
                         $DesiredState.properties.psobject.properties | ForEach-Object -Process {
@@ -427,7 +431,16 @@ function Invoke-DscOperation {
 
                     switch ($Operation) {
                         'Get' {
-                            $Result = $dscResourceInstance.Get()
+                            $Result = @{}
+                            $raw_obj = $dscResourceInstance.Get()
+                            $ValidProperties | ForEach-Object { 
+                                if ($raw_obj.$_ -is [System.Enum]) {
+                                    $Result[$_] = $raw_obj.$_.ToString()
+                                }
+                                else {
+                                    $Result[$_] = $raw_obj.$_
+                                }
+                            }
                             $addToActualState.properties = $Result
                         }
                         'Set' {
diff --git a/runcommandonset/tests/runcommandonset.get.tests.ps1 b/runcommandonset/tests/runcommandonset.get.tests.ps1
@@ -2,15 +2,6 @@
 # Licensed under the MIT License.
 
 Describe 'tests for runcommandonset get' {
-    BeforeAll {
-        $oldPath = $env:DSC_RESOURCE_PATH
-        $env:DSC_RESOURCE_PATH = Join-Path $PSScriptRoot ".."
-    }
-
-    AfterAll {
-        $env:DSC_RESOURCE_PATH = $oldPath
-    }
-
     It 'Input passed for executable, arguments, and exit code' {
         $json = @"
         {
@@ -21,6 +12,7 @@ Describe 'tests for runcommandonset get' {
 "@
 
         $result = $json | dsc resource get -r Microsoft.DSC.Transitional/RunCommandOnSet -f - | ConvertFrom-Json
+        $LASTEXITCODE | Should -Be 0
         $result.actualState.arguments | Should -BeExactly @('bar', 'baz')
         $result.actualState.executable | Should -BeExactly 'foo'
         $result.actualState.exitCode | Should -BeExactly 5
diff --git a/runcommandonset/tests/runcommandonset.set.tests.ps1 b/runcommandonset/tests/runcommandonset.set.tests.ps1
@@ -2,21 +2,12 @@
 # Licensed under the MIT License.
 
 Describe 'tests for runcommandonset set' {
-    BeforeAll {
-        $oldPath = $env:DSC_RESOURCE_PATH
-        $env:DSC_RESOURCE_PATH = Join-Path $PSScriptRoot ".."
-    }
-
     AfterEach {
         if (Test-Path $TestDrive/output.txt) {
             Remove-Item -Path $TestDrive/output.txt
         }
     }
 
-    AfterAll {
-        $env:DSC_RESOURCE_PATH = $oldPath
-    }
-
     It 'Input for executable and arguments can be sent to the resource' {
         $input_json = @"
         {

Original file line number	Diff line number	Diff line change
`@@ -158,6 +158,10 @@ if ($null -ne $packageType) {`
`158`	`158`	`Remove-Item temp:/rustup-init.exe -ErrorAction Ignore`
`159`	`159`	`}`
`160`	`160`	`}`
	`161`	`+ else {`
	`162`	`+ Write-Verbose -Verbose "Rust found, updating..."`
	`163`	`+ & $rustup update`
	`164`	`+ }`
`161`	`165`
`162`	`166`	`$BuildToolsPath = "${env:ProgramFiles(x86)}\Microsoft Visual Studio\2022\BuildTools\VC\Tools\MSVC"`
`163`	`167`
Original file line number	Diff line number	Diff line change
`@@ -48,4 +48,10 @@ Describe 'resource get tests' {`
`48`	`48`	`$testError[0] \| SHould -match 'error:'`
`49`	`49`	`$LASTEXITCODE \| Should -Be 2`
`50`	`50`	`}`
	`51`	`+`
	`52`	`+ It '--output-format json-array returns single object' {`
	`53`	`+ $out = dsc resource get -r Microsoft/Process --all --output-format json-array`
	`54`	`+ $LASTEXITCODE \| Should -Be 0`
	`55`	`+ ($out \| Measure-Object).Count \| Should -Be 1`
	`56`	`+ }`
`51`	`57`	`}`
Original file line number	Diff line number	Diff line change
`@@ -85,7 +85,7 @@ Describe 'tests for resource input' {`
`85`	`85`	`}`
`86`	`86`	`'@`
`87`	`87`	`$oldPath = $env:DSC_RESOURCE_PATH`
`88`		`- $env:DSC_RESOURCE_PATH = $TestDrive`
	`88`	`+ $env:DSC_RESOURCE_PATH = $TestDrive + [System.IO.Path]::PathSeparator + $env:PATH`
`89`	`89`	`Set-Content $TestDrive/EnvVarInput.dsc.resource.json -Value $manifest`
`90`	`90`	`}`
`91`	`91`