Merge pull request #3787 from corbob/3681-refreshenv-as-system

(#3681) Check for correct computer name when refreshing environment variables

Author: vexx32

src/Chocolatey.PowerShell/Chocolatey.PowerShell.csproj

@@ -87,5 +87,8 @@
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </Content>
   </ItemGroup>
+  <ItemGroup>
+    <None Include="ReadMe.md" />
+  </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
 </Project>

src/Chocolatey.PowerShell/Helpers/EnvironmentHelper.cs

@@ -226,7 +226,7 @@ public static void UpdateSession(PSCmdlet cmdlet)
             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 != Shared.EnvironmentNames.System)
+            if (userName != $"{computerName}$" && userName != Shared.EnvironmentNames.System)
             {
                 scopeList.Add(EnvironmentVariableTarget.User);
             }

src/Chocolatey.PowerShell/ReadMe.md

@@ -0,0 +1,29 @@
+## About this project
+
+The Chocolatey.PowerShell project within the Chocolatey CLI solution is the compiled PowerShell cmdlets.
+
+## Debugging the Chocolatey.PowerShell cmdlets
+
+Because the Chocolatey.PowerShell module is a compiled module, debugging it is a little more involved than a script based module.
+If you need to debug cmdlets within a Chocolatey CLI execution, you can merely create a package that calls the Chocolatey.PowerShell function you are debugging, and it will work.
+However, if you need to test the functions outside of a Chocolatey CLI invocation, that is a little bit more involved.
+Fortunately, Marc-Andr� Moreau provides and [excellent guide](https://awakecoding.com/posts/debugging-powershell-binary-modules-in-visual-studio/) on debugging a binary PowerShell module from Visual Studio.
+The below steps are greatly simplified and targetted specifically at the Chocolatey.PowerShell project.
+
+1. Edit or create a `Chocolatey.PowerShell.csproj.user` file beside the `Chocolatey.PowerShell.csproj` file (located at `$ChocoSourceRepository/src/Chocolatey.PowerShell`).
+1. Set it's contents to the XML following this list.
+1. (Re)Launch Visual Studio to have it pick up the addition of the `Chocolatey.PowerShell.csproj.user` file.
+1. Set the `Chocolatey.PowerShell` project as the startup project.
+1. Start the debugger.
+1. In the Windows PowerShell that launched, import the module with `Import-Module ./Chocolatey.PowerShell.dll`.
+1. Now when you call any of the compiled PowerShell files, you will be able to stop at set breakpoints and debug as normal.
+
+```xml
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="Current" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'Debug|AnyCPU'">
+    <StartAction>Program</StartAction>
+    <StartProgram>c:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe</StartProgram>
+  </PropertyGroup>
+</Project>
+```

tests/helpers/common/ConvertTo-Base64String.ps1

@@ -0,0 +1,14 @@
+function ConvertTo-Base64String {
+    <#
+        .Synopsis
+            Helper function to Convert a string to a Base64 encoded string.
+    #>
+    [CmdletBinding()]
+    param(
+        # The string to be converted to base64.
+        [Parameter(ValueFromPipeline)]
+        [string]$InputObject
+    )
+    $bytes = [system.text.encoding]::Unicode.GetBytes($InputObject)
+    [Convert]::ToBase64String($bytes)
+}

tests/pester-tests/features/EnvironmentVariables.Tests.ps1

@@ -87,3 +87,32 @@ Describe "Ensuring Chocolatey Environment variables are not present (<_>)" -Tag
         $Output.Lines | Should -Not -Contain $ExpectedLine -Because $Output.String
     }
 }
+
+Describe "Ensuring variables are not incorrectly set for the SYSTEM account" -Tag EnvironmentVariables, Chocolatey, SystemAccount {
+    BeforeAll {
+        Initialize-ChocolateyTestInstall
+        New-ChocolateyInstallSnapshot
+        Invoke-Choco install psexec -s https://community.chocolatey.org/api/v2/
+
+        # We execute this as an encoded command as it doesn't seem to like the strings unless it's encoded.
+        $encodedCommand = @'
+            "Temp: $($env:TEMP)" > {1}/before.txt
+            "Tmp: $($env:TMP)" >> {1}/before.txt
+            Import-Module {0}/helpers/chocolateyProfile.psm1 -Verbose *>&1
+            refreshenv
+            "Temp: $($env:TEMP)" > {1}/after.txt
+            "Tmp: $($env:TMP)" >> {1}/after.txt
+'@ -f (Get-ChocolateyTestLocation), $PSScriptRoot | ConvertTo-Base64String
+        $Output = psexec /accepteula /s powershell.exe -NoProfile -EncodedCommand $encodedCommand 2>$null
+    }
+
+    AfterAll {
+        Remove-ChocolateyTestInstall
+    }
+
+    It 'Should not change the temp environment variables' {
+        $Before = Get-Content $PSScriptRoot/before.txt
+        $After = Get-Content $PSScriptRoot/after.txt
+        $Before | Should -Be $After -Because $Output
+    }
+}