fix tests, add runcommandonset to vscode project

SteveL-MSFT · SteveL-MSFT · commit 5726e9502458 · 2024-05-03T17:30:48.000-07:00
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -4,6 +4,7 @@
         "./dsc_lib/Cargo.toml",
         "./osinfo/Cargo.toml",
         "./registry/Cargo.toml",
+        "./runcommandonset/Cargo.toml",
         "./tools/test_group_resource/Cargo.toml",
         "./tools/dsctest/Cargo.toml",
         "./tree-sitter-dscexpression/Cargo.toml",
diff --git a/dsc/tests/dsc_include.tests.ps1 b/dsc/tests/dsc_include.tests.ps1
@@ -94,11 +94,19 @@ Describe 'Include tests' {
         $log | Should -BeLike "*ERROR*"
     }
 
-    It 'Valid file path: <test>' -TestCases @(
-        @{ test = 'absolute configuration'; config = (Join-Path $TestDrive 'include/osinfo_parameters.dsc.yaml'); parameters = $null }
-        @{ test = 'absolute parameters'; config = 'include/osinfo_parameters.dsc.yaml'; parameters = (Join-Path $TestDrive 'include/osinfo.parameters.yaml') }
+    It 'Valid absolute file path: <test>' -TestCases @(
+        @{ test = 'configuration'; config = 'include/osinfo_parameters.dsc.yaml'; parameters = $null }
+        @{ test = 'parameters'; config = 'include/osinfo_parameters.dsc.yaml'; parameters = 'include/osinfo.parameters.yaml' }
     ) {
-        param($config, $parameters)
+        param($test, $config, $parameters)
+
+        if ($test -eq 'configuration') {
+            $config = Join-Path $TestDrive $config
+        } elseif ($test -eq 'parameters') {
+            $parameters = Join-Path $TestDrive $parameters
+        } else {
+            throw "Invalid test case: $test"
+        }
 
         $configYaml = @"
             `$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
diff --git a/dsc/tests/dsc_tracing.tests.ps1 b/dsc/tests/dsc_tracing.tests.ps1
@@ -65,13 +65,13 @@ Describe 'tracing tests' {
     }
 
     It 'trace level <level> is passed to resource' -TestCases @(
-        @{ level = 'error'; expectedLevel = 'ERROR' }
-        @{ level = 'warn'; expectedLevel = 'WARN' }
-        @{ level = 'info'; expectedLevel = 'INFO' }
-        @{ level = 'debug'; expectedLevel = 'DEBUG'}
-        @{ level = 'trace'; expectedLevel = 'TRACE'}
+        @{ level = 'error' }
+        @{ level = 'warn' }
+        @{ level = 'info' }
+        @{ level = 'debug' }
+        @{ level = 'trace' }
     ) {
-        param($level, $expectedLevel)
+        param($level)
 
         $configYaml = @"
             `$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
@@ -83,6 +83,6 @@ Describe 'tracing tests' {
 "@
 
         $out = (dsc -l $level config get -d $configYaml 2> $null) | ConvertFrom-Json
-        $out.results[0].result.actualState.level | Should -BeExactly $expectedLevel
+        $out.results[0].result.actualState.level | Should -BeExactly $level
     }
 }
diff --git a/dsc_lib/src/dscresources/command_resource.rs b/dsc_lib/src/dscresources/command_resource.rs
@@ -771,9 +771,11 @@ pub fn log_resource_traces(process_name: &str, process_id: &u32, stderr: &str)
                     debug!("Process '{process_name}' id {process_id} : {}", msg.as_str().unwrap_or_default());
                 } else if let Some(msg) = json_obj.get("Trace") {
                     trace!("Process '{process_name}' id {process_id} : {}", msg.as_str().unwrap_or_default());
+                } else {
+                    // TODO: deserialize tracing JSON to have better presentation
+                    trace!("Process '{process_name}' id {process_id} : {trace_line}");
                 };
             } else {
-                // TODO: deserialize tracing JSON to have better presentation
                 trace!("Process '{process_name}' id {process_id} : {trace_line}");
             }
         }
diff --git a/osinfo/tests/osinfo.tests.ps1 b/osinfo/tests/osinfo.tests.ps1
@@ -3,7 +3,7 @@
 
 Describe 'osinfo resource tests' {
     It 'should get osinfo' {
-        $out = dsc resource get -r Microsoft/osinfo | ConvertFrom-Json
+        $out = dsc resource get -r Microsoft/OSInfo | ConvertFrom-Json
         $LASTEXITCODE | Should -Be 0
         if ($IsWindows) {
             $out.actualState.family | Should -BeExactly 'Windows'
@@ -31,7 +31,7 @@ Describe 'osinfo resource tests' {
         else {
             $invalid = 'Windows'
         }
-        $out = "{`"family`": `"$invalid`"}" | dsc resource test -r 'Microsoft/osinfo' | ConvertFrom-Json
+        $out = "{`"family`": `"$invalid`"}" | dsc resource test -r 'Microsoft/OSInfo' | ConvertFrom-Json
         $actual = dsc resource get -r Microsoft/OSInfo | ConvertFrom-Json
         $out.actualState.family | Should -BeExactly $actual.actualState.family
         $out.actualState.version | Should -BeExactly $actual.actualState.version
@@ -41,7 +41,7 @@ Describe 'osinfo resource tests' {
     }
 
     It 'should support export' {
-        $out = dsc resource export -r Microsoft/osinfo | ConvertFrom-Json
+        $out = dsc resource export -r Microsoft/OSInfo | ConvertFrom-Json
         $out.'$schema' | Should -BeExactly 'https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json'
         if ($IsWindows) {
             $out.resources[0].properties.family | Should -BeExactly 'Windows'
diff --git a/runcommandonset/src/args.rs b/runcommandonset/src/args.rs
@@ -13,7 +13,7 @@ pub enum TraceFormat {
 #[derive(Debug, Clone, PartialEq, Eq, ValueEnum)]
 pub enum TraceLevel {
     Error,
-    Warning,
+    Warn,
     Info,
     Debug,
     Trace
@@ -26,7 +26,7 @@ pub struct Arguments {
     #[clap(subcommand)]
     pub subcommand: SubCommand,
     #[clap(short = 'l', long, help = "Trace level to use", value_enum, default_value = "info")]
-    pub trace_level: TraceLevel,
+    pub trace_level: Option<TraceLevel>,
     #[clap(short = 'f', long, help = "Trace format to use", value_enum, default_value = "json")]
     pub trace_format: TraceFormat,
 }
diff --git a/runcommandonset/src/main.rs b/runcommandonset/src/main.rs
@@ -2,12 +2,12 @@
 // Licensed under the MIT License.
 
 use atty::Stream;
-use clap::{Parser};
+use clap::Parser;
 use std::{io::{self, Read}, process::exit};
 use tracing::{error, warn, debug};
 
-use args::{Arguments, SubCommand};
-use runcommand::{RunCommand};
+use args::{Arguments, SubCommand, TraceLevel};
+use runcommand::RunCommand;
 use utils::{enable_tracing, invoke_command, parse_input, EXIT_INVALID_ARGS};
 
 pub mod args;
@@ -16,7 +16,29 @@ pub mod utils;
 
 fn main() {
     let args = Arguments::parse();
-    enable_tracing(&args.trace_level, &args.trace_format);
+    let trace_level = match args.trace_level {
+        Some(trace_level) => trace_level,
+        None => {
+            // get from DSC_TRACE_LEVEL env var
+            if let Ok(trace_level) = std::env::var("DSC_TRACE_LEVEL") {
+                match trace_level.to_lowercase().as_str() {
+                    "error" => TraceLevel::Error,
+                    "warn" => TraceLevel::Warn,
+                    "info" => TraceLevel::Info,
+                    "debug" => TraceLevel::Debug,
+                    "trace" => TraceLevel::Trace,
+                    _ => {
+                        warn!("Invalid trace level: {trace_level}");
+                        TraceLevel::Info
+                    }
+                }
+            } else {
+                // default to info
+                TraceLevel::Info
+            }
+        }
+    };
+    enable_tracing(&trace_level, &args.trace_format);
     warn!("This resource is not idempotent");
 
     let stdin = if atty::is(Stream::Stdin) {
diff --git a/runcommandonset/src/utils.rs b/runcommandonset/src/utils.rs
@@ -65,7 +65,7 @@ pub fn enable_tracing(trace_level: &TraceLevel, trace_format: &TraceFormat) {
     // originally implemented in dsc/src/util.rs
     let tracing_level = match trace_level {
         TraceLevel::Error => Level::ERROR,
-        TraceLevel::Warning => Level::WARN,
+        TraceLevel::Warn => Level::WARN,
         TraceLevel::Info => Level::INFO,
         TraceLevel::Debug => Level::DEBUG,
         TraceLevel::Trace => Level::TRACE,
diff --git a/runcommandonset/tests/runcommandonset.set.tests.ps1 b/runcommandonset/tests/runcommandonset.set.tests.ps1
@@ -76,25 +76,13 @@ Describe 'tests for runcommandonset set' {
     }
 
     It 'Executable does not exist' {
-        '{ "executable": "foo" }' | dsc resource set -r Microsoft.DSC.Transitional/RunCommandOnSet 2> $TestDrive/output.txt
-        $actual = Get-Content -Path $TestDrive/output.txt
+        '{ "executable": "foo" }' | dsc -l trace resource set -r Microsoft.DSC.Transitional/RunCommandOnSet 2> $TestDrive/output.txt
+        $actual = Get-Content -Path $TestDrive/output.txt -Raw
         $expected_logging = 'Failed to execute foo: No such file or directory (os error 2)'
         if ($IsWindows) {
             $expected_logging = 'Failed to execute foo: program not found'
         }
-        $found_logging = $false
-        ForEach ($line in $actual) {
-            try {
-                $log = $line | ConvertFrom-Json
-                if ($log.fields.message -eq $expected_logging) {
-                    $found_logging = $true
-                    break
-                }
-            } catch {
-                # skip lines that aren't JSON
-            }
-        }
-        $found_logging | Should -Be $true
+        $actual | Should -BeLike "*$expected_logging*"
         $LASTEXITCODE | Should -Be 2
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -771,9 +771,11 @@ pub fn log_resource_traces(process_name: &str, process_id: &u32, stderr: &str)`
`771`	`771`	`debug!("Process '{process_name}' id {process_id} : {}", msg.as_str().unwrap_or_default());`
`772`	`772`	`} else if let Some(msg) = json_obj.get("Trace") {`
`773`	`773`	`trace!("Process '{process_name}' id {process_id} : {}", msg.as_str().unwrap_or_default());`
	`774`	`+ } else {`
	`775`	`+ // TODO: deserialize tracing JSON to have better presentation`
	`776`	`+ trace!("Process '{process_name}' id {process_id} : {trace_line}");`
`774`	`777`	`};`
`775`	`778`	`} else {`
`776`		`- // TODO: deserialize tracing JSON to have better presentation`
`777`	`779`	`trace!("Process '{process_name}' id {process_id} : {trace_line}");`
`778`	`780`	`}`
`779`	`781`	`}`