(#3675) Migrate environment variable references to StringResources

AdmiringWorm · AdmiringWorm · commit 4ba0e5709c2f · 2025-06-02T15:38:24.000+02:00
Update EnvironmentVariables class to reference constants from
chocolatey.StringResources instead of hardcoded strings. Mark the
old EnvironmentVariables class as obsolete to enforce usage of the
new centralized resource definitions.

Refactor Helpers/Paths.cs and Helpers/EnvironmentHelper.cs to use
EnvironmentVariables.System.Path for PATH variable access and
modification, ensuring consistency with the updated resource usage.

These changes improve maintainability by consolidating environment
variable names in a single source and prevent duplication errors.
diff --git a/src/Chocolatey.PowerShell/Chocolatey.PowerShell.csproj b/src/Chocolatey.PowerShell/Chocolatey.PowerShell.csproj
@@ -58,6 +58,9 @@
     </Reference>
   </ItemGroup>
   <ItemGroup>
+    <Compile Include="..\chocolatey\StringResources.cs">
+      <Link>Shared\StringResources.cs</Link>
+    </Compile>
     <Compile Include="Commands\GetEnvironmentVariableCommand.cs" />
     <Compile Include="Commands\GetEnvironmentVariableNamesCommand.cs" />
     <Compile Include="Commands\InstallChocolateyPathCommand.cs" />
diff --git a/src/Chocolatey.PowerShell/Helpers/EnvironmentHelper.cs b/src/Chocolatey.PowerShell/Helpers/EnvironmentHelper.cs
@@ -18,9 +18,9 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Management.Automation;
-using Chocolatey.PowerShell.Shared;
 using Chocolatey.PowerShell.Win32;
 using Microsoft.Win32;
+using static chocolatey.StringResources;
 
 namespace Chocolatey.PowerShell.Helpers
 {
@@ -163,7 +163,7 @@ public static void SetVariable(PSCmdlet cmdlet, string name, EnvironmentVariable
                     // The value doesn't exist yet, suppress the error.
                 }
 
-                if (name.ToUpper() == EnvironmentVariables.Path)
+                if (name.ToUpper() == EnvironmentVariables.System.Path)
                 {
                     registryType = RegistryValueKind.ExpandString;
                 }
@@ -199,8 +199,8 @@ public static void SetVariable(PSCmdlet cmdlet, string name, EnvironmentVariable
                         out UIntPtr result);
 
                     // 2. Set a user environment variable making the system refresh
-                    var setxPath = string.Format(@"{0}\System32\setx.exe", GetVariable(cmdlet, EnvironmentVariables.SystemRoot, EnvironmentVariableTarget.Process));
-                    cmdlet.InvokeCommand.InvokeScript($"& \"{setxPath}\" {EnvironmentVariables.ChocolateyLastPathUpdate} \"{DateTime.Now.ToFileTime()}\"");
+                    var setxPath = string.Format(@"{0}\System32\setx.exe", GetVariable(cmdlet, EnvironmentVariables.System.SystemRoot, EnvironmentVariableTarget.Process));
+                    cmdlet.InvokeCommand.InvokeScript($"& \"{setxPath}\" {EnvironmentVariables.Package.ChocolateyLastPathUpdate} \"{DateTime.Now.ToFileTime()}\"");
                 }
             }
             catch (Exception error)
@@ -217,16 +217,16 @@ public static void SetVariable(PSCmdlet cmdlet, string name, EnvironmentVariable
         /// <param name="cmdlet">The cmdlet calling the method.</param>
         public static void UpdateSession(PSCmdlet cmdlet)
         {
-            var userName = GetVariable(cmdlet, EnvironmentVariables.Username, EnvironmentVariableTarget.Process);
-            var architecture = GetVariable(cmdlet, EnvironmentVariables.ProcessorArchitecture, EnvironmentVariableTarget.Process);
-            var psModulePath = GetVariable(cmdlet, EnvironmentVariables.PSModulePath, EnvironmentVariableTarget.Process);
+            var userName = GetVariable(cmdlet, EnvironmentVariables.System.Username, EnvironmentVariableTarget.Process);
+            var architecture = GetVariable(cmdlet, EnvironmentVariables.System.ProcessorArchitecture, EnvironmentVariableTarget.Process);
+            var psModulePath = GetVariable(cmdlet, EnvironmentVariables.System.PSModulePath, EnvironmentVariableTarget.Process);
 
             var scopeList = new List<EnvironmentVariableTarget>() { EnvironmentVariableTarget.Process, EnvironmentVariableTarget.Machine };
 
-            var computerName = GetVariable(cmdlet, EnvironmentVariables.ComputerName, EnvironmentVariableTarget.Process);
+            var computerName = GetVariable(cmdlet, EnvironmentVariables.System.ComputerName, EnvironmentVariableTarget.Process);
 
             // User scope should override (be checked after) machine scope, but only if we're not running as SYSTEM
-            if (userName != computerName && userName != EnvironmentVariables.System)
+            if (userName != computerName && userName != EnvironmentVariables.System.SystemName)
             {
                 scopeList.Add(EnvironmentVariableTarget.User);
             }
@@ -247,23 +247,23 @@ public static void UpdateSession(PSCmdlet cmdlet)
 
                 // Update PATH, combining both scopes' values.
                 var paths = new string[2];
-                paths[0] = GetVariable(cmdlet, EnvironmentVariables.Path, EnvironmentVariableTarget.Machine);
-                paths[1] = GetVariable(cmdlet, EnvironmentVariables.Path, EnvironmentVariableTarget.User);
+                paths[0] = GetVariable(cmdlet, EnvironmentVariables.System.Path, EnvironmentVariableTarget.Machine);
+                paths[1] = GetVariable(cmdlet, EnvironmentVariables.System.Path, EnvironmentVariableTarget.User);
 
-                SetVariable(cmdlet, EnvironmentVariables.Path, EnvironmentVariableTarget.Process, string.Join(";", paths));
+                SetVariable(cmdlet, EnvironmentVariables.System.Path, EnvironmentVariableTarget.Process, string.Join(";", paths));
 
                 // Preserve PSModulePath as it's almost always updated by process, preserve it
-                SetVariable(cmdlet, EnvironmentVariables.PSModulePath, EnvironmentVariableTarget.Process, psModulePath);
+                SetVariable(cmdlet, EnvironmentVariables.System.PSModulePath, EnvironmentVariableTarget.Process, psModulePath);
 
                 // Preserve user and architecture
                 if (!string.IsNullOrEmpty(userName))
                 {
-                    SetVariable(cmdlet, EnvironmentVariables.Username, EnvironmentVariableTarget.Process, userName);
+                    SetVariable(cmdlet, EnvironmentVariables.System.Username, EnvironmentVariableTarget.Process, userName);
                 }
 
                 if (!string.IsNullOrEmpty(architecture))
                 {
-                    SetVariable(cmdlet, EnvironmentVariables.ProcessorArchitecture, EnvironmentVariableTarget.Process, architecture);
+                    SetVariable(cmdlet, EnvironmentVariables.System.ProcessorArchitecture, EnvironmentVariableTarget.Process, architecture);
                 }
             }
         }
diff --git a/src/Chocolatey.PowerShell/Helpers/Paths.cs b/src/Chocolatey.PowerShell/Helpers/Paths.cs
@@ -20,7 +20,7 @@
 using System.Management.Automation;
 using System.Text;
 using System.Text.RegularExpressions;
-using Chocolatey.PowerShell.Shared;
+using static chocolatey.StringResources;
 
 namespace Chocolatey.PowerShell.Helpers
 {
@@ -106,7 +106,7 @@ internal static string GetPathString(IList<string> paths)
         /// <param name="scope">The target scope of the PATH variable to modify.</param>
         public static void InstallPathEntry(PSCmdlet cmdlet, string pathEntry, EnvironmentVariableTarget scope)
         {
-            var pathEntries = new List<string>(ParsePathString(EnvironmentHelper.GetVariable(cmdlet, EnvironmentVariables.Path, scope, preserveVariables: true)));
+            var pathEntries = new List<string>(ParsePathString(EnvironmentHelper.GetVariable(cmdlet, EnvironmentVariables.System.Path, scope, preserveVariables: true)));
             if (FindPathIndex(pathEntries, pathEntry) == -1)
             {
                 PSHelper.WriteHost(cmdlet, $"PATH environment variable does not have {pathEntry} in it. Adding...");
@@ -116,7 +116,7 @@ public static void InstallPathEntry(PSCmdlet cmdlet, string pathEntry, Environme
 
                 void updatePath()
                 {
-                    EnvironmentHelper.SetVariable(cmdlet, EnvironmentVariables.Path, scope, newPath);
+                    EnvironmentHelper.SetVariable(cmdlet, EnvironmentVariables.System.Path, scope, newPath);
                 }
 
                 if (scope == EnvironmentVariableTarget.Machine)
@@ -138,7 +138,7 @@ void updatePath()
         /// <param name="scope">The target scope of the PATH variable to modify.</param>
         public static void UninstallPathEntry(PSCmdlet cmdlet, string pathEntry, EnvironmentVariableTarget scope)
         {
-            var pathEntries = new List<string>(ParsePathString(EnvironmentHelper.GetVariable(cmdlet, EnvironmentVariables.Path, scope, preserveVariables: true)));
+            var pathEntries = new List<string>(ParsePathString(EnvironmentHelper.GetVariable(cmdlet, EnvironmentVariables.System.Path, scope, preserveVariables: true)));
             var removeIndex = FindPathIndex(pathEntries, pathEntry);
             if (removeIndex >= 0)
             {
@@ -149,7 +149,7 @@ public static void UninstallPathEntry(PSCmdlet cmdlet, string pathEntry, Environ
 
                 void updatePath()
                 {
-                    EnvironmentHelper.SetVariable(cmdlet, EnvironmentVariables.Path, scope, newPath);
+                    EnvironmentHelper.SetVariable(cmdlet, EnvironmentVariables.System.Path, scope, newPath);
                 }
 
                 if (scope == EnvironmentVariableTarget.Machine)
diff --git a/src/Chocolatey.PowerShell/Shared/EnvironmentVariables.cs b/src/Chocolatey.PowerShell/Shared/EnvironmentVariables.cs
@@ -14,17 +14,21 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+using chocolatey;
+using System;
+
 namespace Chocolatey.PowerShell.Shared
 {
+    [Obsolete("This class has been deprecated, make use of chocolatey.StringResourrces.EnvironmentVariables instead.", error: false)]
     public static class EnvironmentVariables
     {
-        public const string ChocolateyLastPathUpdate = "ChocolateyLastPathUpdate";
-        public const string ComputerName = "COMPUTERNAME";
-        public const string Path = "PATH";
-        public const string ProcessorArchitecture = "PROCESSOR_ARCHITECTURE";
-        public const string PSModulePath = "PSModulePath";
-        public const string System = "SYSTEM";
-        public const string SystemRoot = "SystemRoot";
-        public const string Username = "USERNAME";
+        public const string ChocolateyLastPathUpdate = StringResources.EnvironmentVariables.Package.ChocolateyLastPathUpdate;
+        public const string ComputerName = StringResources.EnvironmentVariables.System.ComputerName;
+        public const string Path = StringResources.EnvironmentVariables.System.Path;
+        public const string ProcessorArchitecture = StringResources.EnvironmentVariables.System.ProcessorArchitecture;
+        public const string PSModulePath = StringResources.EnvironmentVariables.System.PSModulePath;
+        public const string System = StringResources.EnvironmentVariables.System.SystemName;
+        public const string SystemRoot = StringResources.EnvironmentVariables.System.SystemRoot;
+        public const string Username = StringResources.EnvironmentVariables.System.Username;
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -18,9 +18,9 @@`
`18`	`18`	`using System.Collections.Generic;`
`19`	`19`	`using System.Linq;`
`20`	`20`	`using System.Management.Automation;`
`21`		`-using Chocolatey.PowerShell.Shared;`
`22`	`21`	`using Chocolatey.PowerShell.Win32;`
`23`	`22`	`using Microsoft.Win32;`
	`23`	`+using static chocolatey.StringResources;`
`24`	`24`
`25`	`25`	`namespace Chocolatey.PowerShell.Helpers`
`26`	`26`	`{`
`@@ -163,7 +163,7 @@ public static void SetVariable(PSCmdlet cmdlet, string name, EnvironmentVariable`
`163`	`163`	`// The value doesn't exist yet, suppress the error.`
`164`	`164`	`}`
`165`	`165`
`166`		`- if (name.ToUpper() == EnvironmentVariables.Path)`
	`166`	`+ if (name.ToUpper() == EnvironmentVariables.System.Path)`
`167`	`167`	`{`
`168`	`168`	`registryType = RegistryValueKind.ExpandString;`
`169`	`169`	`}`
`@@ -199,8 +199,8 @@ public static void SetVariable(PSCmdlet cmdlet, string name, EnvironmentVariable`
`199`	`199`	`out UIntPtr result);`
`200`	`200`
`201`	`201`	`// 2. Set a user environment variable making the system refresh`
`202`		`- var setxPath = string.Format(@"{0}\System32\setx.exe", GetVariable(cmdlet, EnvironmentVariables.SystemRoot, EnvironmentVariableTarget.Process));`
`203`		`- cmdlet.InvokeCommand.InvokeScript($"& \"{setxPath}\" {EnvironmentVariables.ChocolateyLastPathUpdate} \"{DateTime.Now.ToFileTime()}\"");`
	`202`	`+ var setxPath = string.Format(@"{0}\System32\setx.exe", GetVariable(cmdlet, EnvironmentVariables.System.SystemRoot, EnvironmentVariableTarget.Process));`
	`203`	`+ cmdlet.InvokeCommand.InvokeScript($"& \"{setxPath}\" {EnvironmentVariables.Package.ChocolateyLastPathUpdate} \"{DateTime.Now.ToFileTime()}\"");`
`204`	`204`	`}`
`205`	`205`	`}`
`206`	`206`	`catch (Exception error)`
`@@ -217,16 +217,16 @@ public static void SetVariable(PSCmdlet cmdlet, string name, EnvironmentVariable`
`217`	`217`	`/// <param name="cmdlet">The cmdlet calling the method.</param>`
`218`	`218`	`public static void UpdateSession(PSCmdlet cmdlet)`
`219`	`219`	`{`
`220`		`- var userName = GetVariable(cmdlet, EnvironmentVariables.Username, EnvironmentVariableTarget.Process);`
`221`		`- var architecture = GetVariable(cmdlet, EnvironmentVariables.ProcessorArchitecture, EnvironmentVariableTarget.Process);`
`222`		`- var psModulePath = GetVariable(cmdlet, EnvironmentVariables.PSModulePath, EnvironmentVariableTarget.Process);`
	`220`	`+ var userName = GetVariable(cmdlet, EnvironmentVariables.System.Username, EnvironmentVariableTarget.Process);`
	`221`	`+ var architecture = GetVariable(cmdlet, EnvironmentVariables.System.ProcessorArchitecture, EnvironmentVariableTarget.Process);`
	`222`	`+ var psModulePath = GetVariable(cmdlet, EnvironmentVariables.System.PSModulePath, EnvironmentVariableTarget.Process);`
`223`	`223`
`224`	`224`	`var scopeList = new List<EnvironmentVariableTarget>() { EnvironmentVariableTarget.Process, EnvironmentVariableTarget.Machine };`
`225`	`225`
`226`		`- var computerName = GetVariable(cmdlet, EnvironmentVariables.ComputerName, EnvironmentVariableTarget.Process);`
	`226`	`+ var computerName = GetVariable(cmdlet, EnvironmentVariables.System.ComputerName, EnvironmentVariableTarget.Process);`
`227`	`227`
`228`	`228`	`// User scope should override (be checked after) machine scope, but only if we're not running as SYSTEM`
`229`		`- if (userName != computerName && userName != EnvironmentVariables.System)`
	`229`	`+ if (userName != computerName && userName != EnvironmentVariables.System.SystemName)`
`230`	`230`	`{`
`231`	`231`	`scopeList.Add(EnvironmentVariableTarget.User);`
`232`	`232`	`}`
`@@ -247,23 +247,23 @@ public static void UpdateSession(PSCmdlet cmdlet)`
`247`	`247`
`248`	`248`	`// Update PATH, combining both scopes' values.`
`249`	`249`	`var paths = new string[2];`
`250`		`- paths[0] = GetVariable(cmdlet, EnvironmentVariables.Path, EnvironmentVariableTarget.Machine);`
`251`		`- paths[1] = GetVariable(cmdlet, EnvironmentVariables.Path, EnvironmentVariableTarget.User);`
	`250`	`+ paths[0] = GetVariable(cmdlet, EnvironmentVariables.System.Path, EnvironmentVariableTarget.Machine);`
	`251`	`+ paths[1] = GetVariable(cmdlet, EnvironmentVariables.System.Path, EnvironmentVariableTarget.User);`
`252`	`252`
`253`		`- SetVariable(cmdlet, EnvironmentVariables.Path, EnvironmentVariableTarget.Process, string.Join(";", paths));`
	`253`	`+ SetVariable(cmdlet, EnvironmentVariables.System.Path, EnvironmentVariableTarget.Process, string.Join(";", paths));`
`254`	`254`
`255`	`255`	`// Preserve PSModulePath as it's almost always updated by process, preserve it`
`256`		`- SetVariable(cmdlet, EnvironmentVariables.PSModulePath, EnvironmentVariableTarget.Process, psModulePath);`
	`256`	`+ SetVariable(cmdlet, EnvironmentVariables.System.PSModulePath, EnvironmentVariableTarget.Process, psModulePath);`
`257`	`257`
`258`	`258`	`// Preserve user and architecture`
`259`	`259`	`if (!string.IsNullOrEmpty(userName))`
`260`	`260`	`{`
`261`		`- SetVariable(cmdlet, EnvironmentVariables.Username, EnvironmentVariableTarget.Process, userName);`
	`261`	`+ SetVariable(cmdlet, EnvironmentVariables.System.Username, EnvironmentVariableTarget.Process, userName);`
`262`	`262`	`}`
`263`	`263`
`264`	`264`	`if (!string.IsNullOrEmpty(architecture))`
`265`	`265`	`{`
`266`		`- SetVariable(cmdlet, EnvironmentVariables.ProcessorArchitecture, EnvironmentVariableTarget.Process, architecture);`
	`266`	`+ SetVariable(cmdlet, EnvironmentVariables.System.ProcessorArchitecture, EnvironmentVariableTarget.Process, architecture);`
`267`	`267`	`}`
`268`	`268`	`}`
`269`	`269`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@`
`20`	`20`	`using System.Management.Automation;`
`21`	`21`	`using System.Text;`
`22`	`22`	`using System.Text.RegularExpressions;`
`23`		`-using Chocolatey.PowerShell.Shared;`
	`23`	`+using static chocolatey.StringResources;`
`24`	`24`
`25`	`25`	`namespace Chocolatey.PowerShell.Helpers`
`26`	`26`	`{`
`@@ -106,7 +106,7 @@ internal static string GetPathString(IList<string> paths)`
`106`	`106`	`/// <param name="scope">The target scope of the PATH variable to modify.</param>`
`107`	`107`	`public static void InstallPathEntry(PSCmdlet cmdlet, string pathEntry, EnvironmentVariableTarget scope)`
`108`	`108`	`{`
`109`		`- var pathEntries = new List<string>(ParsePathString(EnvironmentHelper.GetVariable(cmdlet, EnvironmentVariables.Path, scope, preserveVariables: true)));`
	`109`	`+ var pathEntries = new List<string>(ParsePathString(EnvironmentHelper.GetVariable(cmdlet, EnvironmentVariables.System.Path, scope, preserveVariables: true)));`
`110`	`110`	`if (FindPathIndex(pathEntries, pathEntry) == -1)`
`111`	`111`	`{`
`112`	`112`	`PSHelper.WriteHost(cmdlet, $"PATH environment variable does not have {pathEntry} in it. Adding...");`
`@@ -116,7 +116,7 @@ public static void InstallPathEntry(PSCmdlet cmdlet, string pathEntry, Environme`
`116`	`116`
`117`	`117`	`void updatePath()`
`118`	`118`	`{`
`119`		`- EnvironmentHelper.SetVariable(cmdlet, EnvironmentVariables.Path, scope, newPath);`
	`119`	`+ EnvironmentHelper.SetVariable(cmdlet, EnvironmentVariables.System.Path, scope, newPath);`
`120`	`120`	`}`
`121`	`121`
`122`	`122`	`if (scope == EnvironmentVariableTarget.Machine)`
`@@ -138,7 +138,7 @@ void updatePath()`
`138`	`138`	`/// <param name="scope">The target scope of the PATH variable to modify.</param>`
`139`	`139`	`public static void UninstallPathEntry(PSCmdlet cmdlet, string pathEntry, EnvironmentVariableTarget scope)`
`140`	`140`	`{`
`141`		`- var pathEntries = new List<string>(ParsePathString(EnvironmentHelper.GetVariable(cmdlet, EnvironmentVariables.Path, scope, preserveVariables: true)));`
	`141`	`+ var pathEntries = new List<string>(ParsePathString(EnvironmentHelper.GetVariable(cmdlet, EnvironmentVariables.System.Path, scope, preserveVariables: true)));`
`142`	`142`	`var removeIndex = FindPathIndex(pathEntries, pathEntry);`
`143`	`143`	`if (removeIndex >= 0)`
`144`	`144`	`{`
`@@ -149,7 +149,7 @@ public static void UninstallPathEntry(PSCmdlet cmdlet, string pathEntry, Environ`
`149`	`149`
`150`	`150`	`void updatePath()`
`151`	`151`	`{`
`152`		`- EnvironmentHelper.SetVariable(cmdlet, EnvironmentVariables.Path, scope, newPath);`
	`152`	`+ EnvironmentHelper.SetVariable(cmdlet, EnvironmentVariables.System.Path, scope, newPath);`
`153`	`153`	`}`
`154`	`154`
`155`	`155`	`if (scope == EnvironmentVariableTarget.Machine)`