Merge pull request #644 from SteveL-MSFT/progress-json

Fix progress display when using JSON, add None option; exhance progress schema

Author: SteveL-MSFT

dsc/Cargo.lock

@@ -4,7 +4,7 @@
 use clap::{Parser, Subcommand, ValueEnum};
 use clap_complete::Shell;
 use dsc_lib::dscresources::command_resource::TraceLevel;
-use dsc_lib::util::ProgressFormat;
+use dsc_lib::progress::ProgressFormat;
 use rust_i18n::t;
 use serde::Deserialize;
 

dsc/src/args.rs

@@ -8,7 +8,7 @@ use rust_i18n::{i18n, t};
 use std::{io, process::exit};
 use sysinfo::{Process, RefreshKind, System, get_current_pid, ProcessRefreshKind};
 use tracing::{error, info, warn, debug};
-use dsc_lib::util::ProgressFormat;
+use dsc_lib::progress::ProgressFormat;
 
 #[cfg(debug_assertions)]
 use crossterm::event;

dsc/src/main.rs

@@ -25,7 +25,7 @@ use dsc_lib::{
     },
     dscresources::dscresource::{Capability, ImplementedAs, Invoke},
     dscresources::resource_manifest::{import_manifest, ResourceManifest},
-    util::ProgressFormat,
+    progress::ProgressFormat,
 };
 use rust_i18n::t;
 use std::{
@@ -288,16 +288,14 @@ pub fn config(subcommand: &ConfigSubCommand, parameters: &Option<String>, mounte
         }
     };
 
-    let mut configurator = match Configurator::new(&json_string) {
+    let mut configurator = match Configurator::new(&json_string, progress_format) {
         Ok(configurator) => configurator,
         Err(err) => {
             error!("Error: {err}");
             exit(EXIT_DSC_ERROR);
         }
     };
 
-    configurator.set_progress_format(progress_format);
-
     if let ConfigSubCommand::Set { what_if , .. } = subcommand {
         if *what_if {
             configurator.context.execution_type = ExecutionKind::WhatIf;

dsc/src/subcommand.rs

@@ -303,4 +303,10 @@ resources:
         $LASTEXITCODE | Should -Be 1
         "$TestDrive/tracing.txt" | Should -FileContentMatchExactly "Target path does not exist: '/invalid/path'"
     }
+
+    It '--progress-format can be None' {
+        dsc -p none resource list 2> $TestDrive/tracing.txt
+        $LASTEXITCODE | Should -Be 0
+        (Get-Content $TestDrive/tracing.txt -Raw) | Should -BeNullOrEmpty
+    }
 }

dsc/tests/dsc_args.tests.ps1

@@ -60,23 +60,92 @@ Describe 'dsc config get tests' {
         $config_yaml = @"
             `$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
             resources:
-            - name: Echo
+            - name: Echo 1
               type: Microsoft.DSC.Debug/Echo
               properties:
                 output: hello
+            - name: Echo 2
+              type: Microsoft.DSC.Debug/Echo
+              properties:
+                output: world
 "@
         $config_yaml | dsc --progress-format json config get -f - 2> $TestDrive/ErrorStream.txt
         $LASTEXITCODE | Should -Be 0
         $lines = Get-Content $TestDrive/ErrorStream.txt
-        $ProgressMessagesFound = $False
+        $ProgressMessagesFound = $false
+        $InstanceOneFound = $false
+        $InstanceTwoFound = $false
         foreach ($line in $lines) {
             $jp = $line | ConvertFrom-Json
             if ($jp.activity) { # if line is a progress message
-                $jp.percent_complete | Should -BeIn (0..100)
-                $ProgressMessagesFound = $True
+                $jp.id | Should -Not -BeNullOrEmpty
+                $jp.totalItems | Should -Not -BeNullOrEmpty
+                $jp.completedItems | Should -Not -BeNullOrEmpty
+                $ProgressMessagesFound = $true
+            }
+
+            if ($null -ne $jp.result -and $jp.resourceType -eq 'Microsoft.DSC.Debug/Echo') {
+                if ($jp.resourceName -eq 'Echo 1') {
+                    $InstanceOneFound = $true
+                    $jp.result.actualState.output | Should -BeExactly 'hello'
+                } elseif ($jp.resourceName -eq 'Echo 2') {
+                    $InstanceTwoFound = $true
+                    $jp.result.actualState.output | Should -BeExactly 'world'
+                }
+            }
+        }
+        $ProgressMessagesFound | Should -BeTrue
+        $InstanceOneFound | Should -BeTrue
+        $InstanceTwoFound | Should -BeTrue
+    }
+
+    It 'json progress returns correctly for failed resource' {
+        $config_yaml = @'
+            $schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
+            resources:
+            - name: Echo 1
+              type: Microsoft.DSC.Debug/Echo
+              properties:
+                output: hello
+            - name: ErrorTest
+              type: Test/ExitCode
+              properties:
+                exitCode: 8
+'@
+        dsc --progress-format json --trace-format json config get -i $config_yaml 2> $TestDrive/ErrorStream.txt
+        $LASTEXITCODE | Should -Be 2
+        $lines = Get-Content $TestDrive/ErrorStream.txt
+        $ProgressMessagesFound = $false
+        $InstanceOneFound = $false
+        $InstanceTwoFound = $false
+        foreach ($line in $lines) {
+            $jp = $line | ConvertFrom-Json
+            if ($jp.activity) { # if line is a progress message
+                $jp.id | Should -Not -BeNullOrEmpty
+                $jp.totalItems | Should -Not -BeNullOrEmpty
+                $jp.completedItems | Should -Not -BeNullOrEmpty
+                $ProgressMessagesFound = $true
+            }
+
+            if ($null -ne $jp.result -and $jp.resourceType -eq 'Microsoft.DSC.Debug/Echo') {
+                if ($jp.resourceName -eq 'Echo 1') {
+                    $InstanceOneFound = $true
+                    $jp.result.actualState.output | Should -BeExactly 'hello'
+                    $jp.failed | Should -BeNullOrEmpty
+                }
+            }
+            elseif ($null -ne $jp.failure -and $jp.resourceType -eq 'Test/ExitCode') {
+                if ($jp.resourceName -eq 'ErrorTest') {
+                    $InstanceTwoFound = $true
+                    $jp.result | Should -BeNullOrEmpty
+                    $jp.failure.exitCode | Should -Be 8
+                    $jp.failure.message | Should -Not -BeNullOrEmpty
+                }
             }
         }
         $ProgressMessagesFound | Should -BeTrue
+        $InstanceOneFound | Should -BeTrue
+        $InstanceTwoFound | Should -BeTrue
     }
 
     It 'contentVersion is ignored' {

dsc/tests/dsc_config_get.tests.ps1

@@ -66,7 +66,9 @@ Describe 'Tests for listing resources' {
         foreach ($line in $lines) {
             $jp = $line | ConvertFrom-Json
             if ($jp.activity) { # if line is a progress message
-                $jp.percent_complete | Should -BeIn (0..100)
+                $jp.id | Should -Not -BeNullOrEmpty
+                $jp.totalItems | Should -Not -BeNullOrEmpty
+                $jp.completedItems | Should -Not -BeNullOrEmpty
                 $ProgressMessagesFound = $True
             }
         }

dsc/tests/dsc_resource_list.tests.ps1

@@ -35,6 +35,7 @@ tracing-indicatif = { version = "0.3" }
 tree-sitter = "0.25"
 tree-sitter-rust = "0.23"
 tree-sitter-dscexpression = { path = "../tree-sitter-dscexpression" }
+uuid = { version = "1.13", features = ["v4"] }
 
 [dev-dependencies]
 serde_yaml = "0.9"

dsc_lib/Cargo.lock

@@ -314,6 +314,9 @@ unknown = "Unknown"
 validation = "Validation"
 setting = "Setting"
 
+[progress]
+failedToSerialize = "Failed to serialize progress JSON: %{json}"
+
 [util]
 foundSetting = "Found setting '%{name}' in %{path}"
 notFoundSetting = "Setting '%{name}' not found in %{path}"