Merge pull request #541 from SteveL-MSFT/trace-envvar

Add `pass-through` trace format to `dsc` so that child-processes get traced appropriately by top process
PowerShell · Sep 13, 2024 · 2e742c9 · 2e742c9
2 parents f047b42 + f573900
commit 2e742c9
Show file tree

Hide file tree

Showing 15 changed files with 148 additions and 37 deletions.
diff --git a/dsc/Cargo.lock b/dsc/Cargo.lock
diff --git a/dsc/assertion.dsc.resource.json b/dsc/assertion.dsc.resource.json
@@ -7,6 +7,8 @@
   "get": {
     "executable": "dsc",
     "args": [
+      "--trace-format",
+      "pass-through",
       "config",
       "--as-group",
       "test",
@@ -17,6 +19,8 @@
   "set": {
     "executable": "dsc",
     "args": [
+      "--trace-format",
+      "pass-through",
       "config",
       "--as-group",
       "test"
@@ -28,6 +32,8 @@
   "test": {
     "executable": "dsc",
     "args": [
+      "--trace-format",
+      "pass-through",
       "config",
       "--as-group",
       "test",
@@ -45,19 +51,11 @@
     "5": "Resource instance failed schema validation",
     "6": "Command cancelled"
   },
-  "schema": {
-    "command": {
-      "executable": "dsc",
-      "args": [
-        "schema",
-        "--type",
-        "configuration"
-      ]
-    }
-  },
   "validate": {
     "executable": "dsc",
     "args": [
+      "--trace-format",
+      "pass-through",
       "config",
       "validate"
     ],

diff --git a/dsc/group.dsc.resource.json b/dsc/group.dsc.resource.json
@@ -7,6 +7,8 @@
   "get": {
     "executable": "dsc",
     "args": [
+      "--trace-format",
+      "pass-through",
       "config",
       "--as-group",
       "get"
@@ -16,6 +18,8 @@
   "set": {
     "executable": "dsc",
     "args": [
+      "--trace-format",
+      "pass-through",
       "config",
       "--as-group",
       "set"
@@ -27,6 +31,8 @@
   "test": {
     "executable": "dsc",
     "args": [
+      "--trace-format",
+      "pass-through",
       "config",
       "--as-group",
       "test"
@@ -46,6 +52,8 @@
   "validate": {
     "executable": "dsc",
     "args": [
+      "--trace-format",
+      "pass-through",
       "config",
       "validate"
     ],

diff --git a/dsc/include.dsc.resource.json b/dsc/include.dsc.resource.json
@@ -7,6 +7,8 @@
   "get": {
     "executable": "dsc",
     "args": [
+      "--trace-format",
+      "pass-through",
       "config",
       "--as-include",
       "--as-group",
@@ -17,6 +19,8 @@
   "set": {
     "executable": "dsc",
     "args": [
+      "--trace-format",
+      "pass-through",
       "config",
       "--as-include",
       "--as-group",
@@ -29,6 +33,8 @@
   "test": {
     "executable": "dsc",
     "args": [
+      "--trace-format",
+      "pass-through",
       "config",
       "--as-include",
       "--as-group",
@@ -48,6 +54,8 @@
   "validate": {
     "executable": "dsc",
     "args": [
+      "--trace-format",
+      "pass-through",
       "config",
       "--as-include",
       "validate"

diff --git a/dsc/parallel.dsc.resource.json b/dsc/parallel.dsc.resource.json
@@ -7,6 +7,8 @@
   "get": {
     "executable": "dsc",
     "args": [
+      "--trace-format",
+      "pass-through",
       "config",
       "--parallel",
       "--as-group",
@@ -17,6 +19,8 @@
   "set": {
     "executable": "dsc",
     "args": [
+      "--trace-format",
+      "pass-through",
       "config",
       "--parallel",
       "--as-group",
@@ -29,6 +33,8 @@
   "test": {
     "executable": "dsc",
     "args": [
+      "--trace-format",
+      "pass-through",
       "config",
       "--parallel",
       "--as-group",
@@ -49,6 +55,8 @@
   "validate": {
     "executable": "dsc",
     "args": [
+      "--trace-format",
+      "pass-through",
       "config",
       "validate"
     ],

diff --git a/dsc/src/args.rs b/dsc/src/args.rs
@@ -3,6 +3,7 @@
 
 use clap::{Parser, Subcommand, ValueEnum};
 use clap_complete::Shell;
+use dsc_lib::dscresources::command_resource::TraceLevel;
 
 #[derive(Debug, Clone, PartialEq, Eq, ValueEnum)]
 pub enum OutputFormat {
@@ -16,15 +17,8 @@ pub enum TraceFormat {
     Default,
     Plaintext,
     Json,
-}
-
-#[derive(Debug, Clone, PartialEq, Eq, ValueEnum)]
-pub enum TraceLevel {
-    Error,
-    Warn,
-    Info,
-    Debug,
-    Trace
+    #[clap(hide = true)]
+    PassThrough,
 }
 
 #[derive(Debug, Parser)]

diff --git a/dsc/src/tablewriter.rs b/dsc/src/tablewriter.rs
@@ -1,4 +1,4 @@
-use crossterm::terminal::{size};
+use crossterm::terminal::size;
 
 pub struct Table {
     header: Vec<String>,
@@ -8,13 +8,13 @@ pub struct Table {
 
 impl Table {
     /// Create a new table.
-    /// 
+    ///
     /// # Arguments
-    /// 
+    ///
     /// * `header` - The header row
-    /// 
+    ///
     /// # Returns
-    /// 
+    ///
     /// * `Table` - The new table
     #[must_use]
     pub fn new(header: &[&str]) -> Table {
@@ -31,9 +31,9 @@ impl Table {
     }
 
     /// Add a row to the table.
-    /// 
+    ///
     /// # Arguments
-    /// 
+    ///
     /// * `row` - The row to add
     pub fn add_row(&mut self, row: Vec<String>) {
         for (i, column) in row.iter().enumerate() {

diff --git a/dsc/src/util.rs b/dsc/src/util.rs
@@ -1,8 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-use crate::args::{DscType, OutputFormat, TraceFormat, TraceLevel};
-
+use crate::args::{DscType, OutputFormat, TraceFormat};
 use atty::Stream;
 use crate::resolve::Include;
 use dsc_lib::{
@@ -16,6 +15,7 @@ use dsc_lib::{
     },
     dscerror::DscError,
     dscresources::{
+        command_resource::TraceLevel,
         dscresource::DscResource, invoke_result::{
             GetResult,
             SetResult,
@@ -323,15 +323,15 @@ pub fn enable_tracing(trace_level: &Option<TraceLevel>, trace_format: &TraceForm
                 .with_line_number(with_source)
                 .boxed()
         },
-        TraceFormat::Json => {
+        TraceFormat::Json | TraceFormat::PassThrough => {
             layer
                 .with_ansi(false)
                 .with_level(true)
                 .with_target(with_source)
                 .with_line_number(with_source)
                 .json()
                 .boxed()
-        }
+        },
     };
 
     let subscriber = tracing_subscriber::Registry::default().with(fmt).with(filter).with(indicatif_layer);

diff --git a/dsc/tests/dsc_tracing.tests.ps1 b/dsc/tests/dsc_tracing.tests.ps1
@@ -85,4 +85,16 @@ Describe 'tracing tests' {
         $out = (dsc -l $level config get -d $configYaml 2> $null) | ConvertFrom-Json
         $out.results[0].result.actualState.level | Should -BeExactly $level
     }
+
+    It 'Pass-through tracing should only emit JSON for child processes' {
+        $logPath = "$TestDrive/dsc_trace.log"
+        $out = dsc -l info -f pass-through  config get -p ../examples/groups.dsc.yaml 2> $logPath
+        foreach ($line in (Get-Content $logPath)) {
+            $line | Should -Not -BeNullOrEmpty
+            $json = $line | ConvertFrom-Json
+            $json.timestamp | Should -Not -BeNullOrEmpty
+            $json.level | Should -BeIn 'ERROR', 'WARN', 'INFO', 'DEBUG', 'TRACE'
+        }
+        $out | Should -BeNullOrEmpty
+    }
 }
diff --git a/dsc_lib/Cargo.lock b/dsc_lib/Cargo.lock
diff --git a/dsc_lib/Cargo.toml b/dsc_lib/Cargo.toml
@@ -6,6 +6,7 @@ edition = "2021"
 [dependencies]
 base64 = "0.22.1"
 chrono = "0.4.26"
+clap = { version = "4.4", features = ["derive"] }
 derive_builder ="0.20.0"
 indicatif = "0.17.0"
 jsonschema = "0.18.0"