Allow ${WinGetConfigRoot} variable expansion

.github/actions/spelling/expect.txt

@@ -431,6 +431,7 @@ winapifamily
 windir
 windowsdeveloper
 winerror
+wingetconfigroot
 wingetcreate
 wingetdev
 wingetutil

src/Microsoft.Management.Configuration.Processor/Exceptions/UnitSettingConfigRootException.cs

@@ -9,7 +9,7 @@ namespace Microsoft.Management.Configuration.Processor.Exceptions
     using System;
 
     /// <summary>
-    /// A setting uses the config root variable and the Origin was not set in the ConfigurationSet.
+    /// A setting uses the config root variable and the Path was not set in the ConfigurationSet.
     /// </summary>
     internal class UnitSettingConfigRootException : Exception
     {
@@ -19,7 +19,7 @@ internal class UnitSettingConfigRootException : Exception
         /// <param name="unitName">Unit name.</param>
         /// <param name="setting">Setting.</param>
         public UnitSettingConfigRootException(string unitName, string setting)
-            : base($"Unit: {unitName} Setting {setting} requires the ConfigurationSet Origin")
+            : base($"Unit: {unitName} Setting {setting} requires the ConfigurationSet Path")
         {
             this.HResult = ErrorCodes.WinGetConfigUnitSettingConfigRoot;
             this.UnitName = unitName;

src/Microsoft.Management.Configuration.Processor/Helpers/ConfigurationUnitInternal.cs

@@ -8,6 +8,7 @@ namespace Microsoft.Management.Configuration.Processor.Helpers
 {
     using System;
     using System.Collections.Generic;
+    using System.IO;
     using Microsoft.Management.Configuration.Processor.Constants;
     using Microsoft.Management.Configuration.Processor.Exceptions;
     using Microsoft.PowerShell.Commands;
@@ -19,24 +20,24 @@ namespace Microsoft.Management.Configuration.Processor.Helpers
     /// </summary>
     internal class ConfigurationUnitInternal
     {
-        private static string configRoot = "$WinGetConfigRoot";
+        private static string configRootVar = "$WinGetConfigRoot";
 
-        private readonly string origin;
+        private readonly string configurationFilePath;
         private readonly Dictionary<string, object> normalizedDirectives = new ();
 
         /// <summary>
         /// Initializes a new instance of the <see cref="ConfigurationUnitInternal"/> class.
         /// </summary>
         /// <param name="unit">Configuration unit.</param>
-        /// <param name="origin">The origin of the unit.</param>
+        /// <param name="configurationFilePath">The configuration file path.</param>
         /// <param name="directivesOverlay">Directives overlay.</param>
         public ConfigurationUnitInternal(
             ConfigurationUnit unit,
-            string origin,
+            string configurationFilePath,
             IReadOnlyDictionary<string, object>? directivesOverlay = null)
         {
             this.Unit = unit;
-            this.origin = origin;
+            this.configurationFilePath = configurationFilePath;
             this.DirectivesOverlay = directivesOverlay;
             this.InitializeDirectives();
 
@@ -172,8 +173,8 @@ public ValueSet GetExpandedSettings()
             {
                 if (value.Value is string)
                 {
-                    // For now, we just expand origin.
-                    valueSet.Add(value.Key, this.ExpandOrigin(value.Value as string, value.Key));
+                    // For now, we just expand config root.
+                    valueSet.Add(value.Key, this.ExpandConfigRoot(value.Value as string, value.Key));
                 }
                 else
                 {
@@ -184,21 +185,32 @@ public ValueSet GetExpandedSettings()
             return valueSet;
         }
 
-        private string? ExpandOrigin(string? value, string settingName)
+        private string? ExpandConfigRoot(string? value, string settingName)
         {
             if (!string.IsNullOrEmpty(value))
             {
                 // TODO: since we only support one variable, this only finds and replace
                 // $WingetConfigRoot if found in the string when the work of expanding
                 // string is done it should take into account other operators like the subexpression operator $()
-                if (value.Contains(configRoot, StringComparison.OrdinalIgnoreCase))
+                if (value.Contains(configRootVar, StringComparison.OrdinalIgnoreCase))
                 {
-                    if (string.IsNullOrEmpty(this.origin))
+                    if (string.IsNullOrEmpty(this.configurationFilePath))
                     {
                         throw new UnitSettingConfigRootException(this.Unit.UnitName, settingName);
                     }
 
-                    return value.Replace(configRoot, this.origin, StringComparison.OrdinalIgnoreCase);
+                    if (!File.Exists(this.configurationFilePath))
+                    {
+                        throw new FileNotFoundException(this.configurationFilePath);
+                    }
+
+                    var configRoot = Path.GetDirectoryName(this.configurationFilePath);
+                    if (configRoot == null)
+                    {
+                        throw new ArgumentException();
+                    }
+
+                    return value.Replace(configRootVar, configRoot, StringComparison.OrdinalIgnoreCase);
                 }
             }
 

src/Microsoft.Management.Configuration.Processor/Set/ConfigurationSetProcessor.cs

@@ -57,7 +57,7 @@ public IConfigurationUnitProcessor CreateUnitProcessor(
         {
             try
             {
-                var configurationUnitInternal = new ConfigurationUnitInternal(unit, this.configurationSet.Origin, directivesOverlay);
+                var configurationUnitInternal = new ConfigurationUnitInternal(unit, this.configurationSet.Path, directivesOverlay);
                 this.OnDiagnostics(DiagnosticLevel.Verbose, $"Creating unit processor for: {configurationUnitInternal.ToIdentifyingString()}...");
 
                 var dscResourceInfo = this.PrepareUnitForProcessing(configurationUnitInternal);
@@ -87,7 +87,7 @@ public IConfigurationUnitProcessor CreateUnitProcessor(
         {
             try
             {
-                var unitInternal = new ConfigurationUnitInternal(unit, this.configurationSet.Origin);
+                var unitInternal = new ConfigurationUnitInternal(unit, this.configurationSet.Path);
                 this.OnDiagnostics(DiagnosticLevel.Verbose, $"Getting unit details [{detailLevel}] for: {unitInternal.ToIdentifyingString()}");
                 var dscResourceInfo = this.ProcessorEnvironment.GetDscResource(unitInternal);
 

src/Microsoft.Management.Configuration.UnitTests/Tests/ConfigurationUnitInternalTests.cs

@@ -8,11 +8,13 @@ namespace Microsoft.Management.Configuration.UnitTests.Tests
 {
     using System;
     using System.Collections.Generic;
+    using System.IO;
     using System.Management.Automation;
     using Microsoft.Management.Configuration;
     using Microsoft.Management.Configuration.Processor.Exceptions;
     using Microsoft.Management.Configuration.Processor.Helpers;
     using Microsoft.Management.Configuration.UnitTests.Fixtures;
+    using Microsoft.Management.Configuration.UnitTests.Helpers;
     using Xunit;
     using Xunit.Abstractions;
 
@@ -112,11 +114,13 @@ public void GetVersion_BadVersion()
         }
 
         /// <summary>
-        /// Verifies expansion of origin.
+        /// Verifies expansion of ConfigRoot.
         /// </summary>
         [Fact]
-        public void GetExpandedSettings_Origin()
+        public void GetExpandedSettings_ConfigRoot()
         {
+            using var tmpFile = new TempFile("fakeConfigFile.yml", content: "content");
+
             var unit = new ConfigurationUnit();
             unit.Settings.Add("var1", @"WinGetConfigRoot\this\is\a\path.txt");
             unit.Settings.Add("var2", @"$WinGetConfigRoot\this\is\a\path.txt");
@@ -125,7 +129,8 @@ public void GetExpandedSettings_Origin()
             unit.Settings.Add("var5", @"this\is\a\path\wingetconfigroot");
             unit.Settings.Add("var6", @"this\is\a\path\$wingetconfigroot");
 
-            string configPath = @"one\root";
+            string configPath = tmpFile.FullFileName;
+            string? expectedPath = Path.GetDirectoryName(configPath);
             var unitInternal = new ConfigurationUnitInternal(unit, configPath);
 
             var expandedSettings = unitInternal.GetExpandedSettings();
@@ -134,26 +139,26 @@ public void GetExpandedSettings_Origin()
             Assert.Equal(@"WinGetConfigRoot\this\is\a\path.txt", var1 as string);
 
             var var2 = expandedSettings["var2"];
-            Assert.Equal(@"one\root\this\is\a\path.txt", var2 as string);
+            Assert.Equal($@"{expectedPath}\this\is\a\path.txt", var2 as string);
 
             var var3 = expandedSettings["var3"];
             Assert.Equal(@"this\is\a\WINGETCONFIGROOT\path.txt", var3 as string);
 
             var var4 = expandedSettings["var4"];
-            Assert.Equal(@"this\is\a\one\root\path.txt", var4 as string);
+            Assert.Equal($@"this\is\a\{expectedPath}\path.txt", var4 as string);
 
             var var5 = expandedSettings["var5"];
             Assert.Equal(@"this\is\a\path\wingetconfigroot", var5 as string);
 
             var var6 = expandedSettings["var6"];
-            Assert.Equal(@"this\is\a\path\one\root", var6 as string);
+            Assert.Equal($@"this\is\a\path\{expectedPath}", var6 as string);
         }
 
         /// <summary>
-        /// Verifies throws when origin is not set.
+        /// Verifies throws when config root is not set.
         /// </summary>
         [Fact]
-        public void GetExpandedSetting_Origin_Throw()
+        public void GetExpandedSetting_ConfigRoot_Throw()
         {
             var unit = new ConfigurationUnit();
             unit.Settings.Add("var2", @"$WinGetConfigRoot\this\is\a\path.txt");