feedback 1

Author: Andrew

dsc/default_settings.v1.dsc.json

@@ -1,12 +1,12 @@
 {
-  "resource_path": {
-    "allow_env_override": true,
-    "append_env_path": true,
+  "resourcePath": {
+    "allowEnvOverride": true,
+    "appendEnvPath": true,
     "directories": []
   },
   "tracing": {
     "level": "WARN",
     "format": "Default",
-    "allow_override": true
+    "allowOverride": true
   }
 }

dsc/settings.dsc.json

@@ -1,12 +1,12 @@
 {
-  "resource_path": {
-    "allow_env_override": true,
-    "append_env_path": true,
+  "resourcePath": {
+    "allowEnvOverride": true,
+    "appendEnvPath": true,
     "directories": []
   },
   "tracing": {
     "level": "WARN",
     "format": "Default",
-    "allow_override": true
+    "allowOverride": true
   }
 }

dsc/src/util.rs

@@ -41,7 +41,7 @@ use syntect::{
     parsing::SyntaxSet,
     util::{as_24_bit_terminal_escaped, LinesWithEndings}
 };
-use tracing::{Level, info, debug, error, warn, trace};
+use tracing::{Level, debug, error, info, warn, trace};
 use tracing_subscriber::{filter::EnvFilter, layer::SubscriberExt, Layer};
 use tracing_indicatif::IndicatifLayer;
 
@@ -59,8 +59,12 @@ pub const DSC_TRACE_LEVEL: &str = "DSC_TRACE_LEVEL";
 
 #[derive(Deserialize)]
 pub struct TracingSetting {
+    /// Trace level to use - see pub enum TraceLevel in dsc_lib\src\dscresources\command_resource.rs
     level:  TraceLevel,
+    /// Trace format to use - see pub enum TraceFormat in dsc\src\args.rs
     format: TraceFormat,
+    /// Whether the 'level' can be overrridden by DSC_TRACE_LEVEL environment variable
+    #[serde(rename = "allowOverride")]
     allow_override: bool
 }
 

dsc/tests/dsc_settings.tests.ps1

@@ -7,7 +7,7 @@ Describe 'tests for dsc settings' {
         $script:policyFilePath = if ($IsWindows) {
             Join-Path $env:ProgramData "dsc" "settings.dsc.json"
         } else {
-            "/etc/.dsc/settings.dsc.json"
+            "/etc/dsc/settings.dsc.json"
         }
 
         $script:dscHome = (Get-Command dsc).Path | Split-Path
@@ -53,9 +53,12 @@ Describe 'tests for dsc settings' {
 
     It 'ensure a new resource_path value in settings has effect' {
 
-        $script:dscDefaultv1SettingsJson.Replace('"directories": []', '"directories": ["TestDir"]') | Set-Content -Force -Path $script:dscSettingsFilePath
+        $script:dscDefaultv1SettingsJson.Replace('"directories": []', '"directories": ["TestDir1","TestDir2"]') | Set-Content -Force -Path $script:dscSettingsFilePath
+        copy-Item -Recurse -Force -Path $script:dscSettingsFilePath -Destination "C:\Temp\"
         dsc -l debug resource list 2> $TestDrive/tracing.txt
-        "$TestDrive/tracing.txt" | Should -FileContentMatchExactly 'Using Resource Path: "TestDir'
+        copy-Item -Recurse -Force -Path $TestDrive/tracing.txt -Destination "C:\Temp\"
+        $expectedString = 'Using Resource Path: "TestDir1'+[System.IO.Path]::PathSeparator+'TestDir2'
+        "$TestDrive/tracing.txt" | Should -FileContentMatchExactly $expectedString
     }
 
     It 'Confirm settings override priorities' {

dsc_lib/src/discovery/command_discovery.rs

@@ -34,8 +34,13 @@ pub struct CommandDiscovery {
 
 #[derive(Deserialize)]
 pub struct ResourcePathSetting {
+    /// whether to allow overriding with the DSC_RESOURCE_PATH environment variable
+    #[serde(rename = "allowEnvOverride")]
     allow_env_override: bool,
+    /// whether to append the PATH environment variable to the list of resource directories
+    #[serde(rename = "appendEnvPath")]
     append_env_path: bool,
+    /// array of directories that DSC should search for non-built-in resources
     directories: Vec<String>
 }
 
@@ -60,26 +65,26 @@ impl CommandDiscovery {
 
     fn get_resource_path_setting() -> Result<ResourcePathSetting, DscError>
     {
-        if let Ok(v) = get_setting("resource_path") {
+        if let Ok(v) = get_setting("resourcePath") {
             // if there is a policy value defined - use it; otherwise use setting value
             if v.policy != serde_json::Value::Null {
                 match serde_json::from_value::<ResourcePathSetting>(v.policy) {
                     Ok(v) => {
                         return Ok(v);
                     },
-                    Err(e) => { return Err(DscError::Operation(format!("{e}"))); }
+                    Err(e) => { return Err(DscError::Setting(format!("{e}"))); }
                 }
             } else if v.setting != serde_json::Value::Null {
                 match serde_json::from_value::<ResourcePathSetting>(v.setting) {
                     Ok(v) => {
                         return Ok(v);
                     },
-                    Err(e) => { return Err(DscError::Operation(format!("{e}"))); }
+                    Err(e) => { return Err(DscError::Setting(format!("{e}"))); }
                 }
             }
         }
 
-        Err(DscError::Operation("Could not read 'resource_path' setting".to_string()))
+        Err(DscError::Setting("Could not read 'resourcePath' setting".to_string()))
     }
 
     fn get_resource_paths() -> Result<Vec<PathBuf>, DscError>
@@ -112,7 +117,7 @@ impl CommandDiscovery {
             }
 
             if resource_path_setting.append_env_path {
-                trace!("Appending PATH to resource_path");
+                debug!("Appending PATH to resourcePath");
                 match env::var_os("PATH") {
                     Some(value) => {
                         trace!("Original PATH: {:?}", value.to_string_lossy());

dsc_lib/src/dscerror.rs

@@ -117,4 +117,7 @@ pub enum DscError {
 
     #[error("YAML: {0}")]
     Yaml(#[from] serde_yaml::Error),
+
+    #[error("Setting: {0}")]
+    Setting(String),
 }

dsc_lib/src/util.rs

@@ -11,15 +11,15 @@ use std::env;
 use tracing::debug;
 
 pub struct DscSettingValue {
-    pub setting:  serde_json::Value,
-    pub policy: serde_json::Value,
+    pub setting:  Value,
+    pub policy: Value,
 }
 
 impl Default for DscSettingValue {
     fn default() -> DscSettingValue {
         DscSettingValue {
-            setting: serde_json::Value::Null,
-            policy: serde_json::Value::Null,
+            setting: Value::Null,
+            policy: Value::Null,
         }
     }
 }
@@ -148,7 +148,7 @@ fn get_settings_policy_file_path() -> String
 #[cfg(not(target_os = "windows"))]
 fn get_settings_policy_file_path() -> String
 {
-    // "/etc/.dsc/settings.dsc.json"
+    // "/etc/dsc/settings.dsc.json"
     // This location is writable only by admins, but readable by all users
-    Path::new("/etc").join(".dsc").join("settings.dsc.json").display().to_string()
+    Path::new("/etc").join("dsc").join("settings.dsc.json").display().to_string()
 }