Skip to content

Fix PowerShell profile casing #303

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix PowerShell profile casing #303

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8279e24
Fix profile folder casing
JustinGrote Mar 27, 2023
9df63c9
Add migration logic to script
JustinGrote Apr 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 65 additions & 14 deletions linux/powershell/PSCloudShellStartup.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Startupscript for PowerShell Cloud Shell

#region Script Variables
$script:Startuptime = [System.DateTime]::Now
$script:Startuptime = [System.DateTime]::Now
$script:AzureADModuleName = 'AzureAD.Standard.Preview'

# Set SkipAzInstallationChecks to avoid az check for AzInstallationChecks.json
Expand All @@ -14,8 +14,8 @@ Microsoft.PowerShell.Core\Import-Module -Name PSCloudShellUtility
$script:PSCloudShellUtilityModuleInfo = Microsoft.PowerShell.Core\Get-Module PSCloudShellUtility

$script:CloudEnvironmentMap = @{
PROD = 'AzureCloud';
Fairfax = 'AzureUSGovernment';
PROD = 'AzureCloud';
Fairfax = 'AzureUSGovernment';
Mooncake = 'AzureChinaCloud';
BlackForest = 'AzureGermanCloud';
dogfood = 'dogfood'
Expand All @@ -29,12 +29,15 @@ Microsoft.PowerShell.Core\Import-Module Az.Tools.Predictor -Force
Microsoft.PowerShell.Core\Import-Module Az.Accounts
Az.Accounts\Enable-AzureRmAlias

# On Linux, we are not loading the profile from the clouddrive since we are already mounted on the Linux OS image: \clouddrive\.cloudconsole\acc_<user>.img
# On Linux, we are not loading the profile from the clouddrive since we are already mounted on the Linux OS image: \clouddrive\.cloudconsole\acc_<user>.img
# For Pwsh profile, see https://docs.microsoft.com/en-us/powershell/scripting/whats-new/what-s-new-in-powershell-core-60?view=powershell-6#filesystem

$script:UserDefaultPath = $HOME
$script:CurrentHostProfilePath = (Microsoft.PowerShell.Management\Join-Path -Path $script:UserDefaultPath -ChildPath '.config/PowerShell/Microsoft.PowerShell_profile.ps1')
$script:AllHostsProfilePath = (Microsoft.PowerShell.Management\Join-Path -Path $script:UserDefaultPath -ChildPath '.config/PowerShell/profile.ps1')
$script:CurrentHostProfilePath = (Microsoft.PowerShell.Management\Join-Path -Path $script:UserDefaultPath -ChildPath '.config/powershell/Microsoft.PowerShell_profile.ps1')
$script:AllHostsProfilePath = (Microsoft.PowerShell.Management\Join-Path -Path $script:UserDefaultPath -ChildPath '.config/powershell/profile.ps1')

Complete-UpperCaseProfileFolderMigration


# To ensure that the installed script is immediately usable, we need to add the scope path to the PATH enviroment variable.
$scriptPath = Microsoft.PowerShell.Management\Join-Path $env:HOME '.local/share/powershell/Scripts'
Expand All @@ -48,6 +51,54 @@ if(($existingPath -split ':') -notcontains $scriptPath)

#region Utility Functions

# Migrate profile from incorrect uppercase profile location to standard location. Added to help migration from a breaking change of fixing incorrectly cased powershell profile paths
function Complete-UpperCaseProfileFolderMigration {
[CmdletBinding(SupportsShouldProcess,ConfirmImpact='High')]
param()

$errorActionPreference = 'stop'

$legacyUpperCaseProfilePath = (Microsoft.PowerShell.Management\Join-Path -Path $script:UserDefaultPath -ChildPath '.config/PowerShell')
$standardProfilePath = Split-Path $script:CurrentHostProfilePath

if (-not (Test-Path $legacyUpperCaseProfilePath)) {
#Nothing to do
return
}

$legacyUpperCaseProfilePathItem = Get-Item $legacyUpperCaseProfilePath
if ($legacyUpperCaseProfilePathItem -isnot [IO.DirectoryInfo]) {
#This would be a very rare occurance
Write-Warning "A non-directory item was detected at $legacyUpperCaseProfilePathItem. You should remove this or otherwise transition it to $standardProfilePath"
return
}
if ($legacyUpperCaseProfilePathItem.LinkType -eq 'SymbolicLink') {
if ((Resolve-Path $legacyUpperCaseProfilePathItem.Target -ne $standardProfilePath)) {
Write-Warning "A symbolic link was detected for the legacy profile folder $legacyUpperCaseProfilePathItem, but it points to $($legacyUpperCaseProfilePathItem.Target). You should remove this or otherwise transition it to $standardProfilePath"
return
} else {
#A migration has already completed
return
}
}

if (Test-Path $standardProfilePath) {
Write-Warning "$legacyUpperCaseProfilePathItem requires migration but a standard profile folder was already detected at $standardProfilePath. If you have completed migration manually, please remove $legacyUpperCaseProfilePathItem and any references to it."
return
}

#Prerequisites for migration have been met at this point.
Write-Warning "We have detected a legacy profile folder at $legacyUpperCaseProfilePathItem. We are moving this to the standard profile folder $standardProfilePath for you and will link the old location to maintain compatibility."

if ($PSCmdlet.ShouldProcess("Migrate profile folder from $legacyUpperCaseProfilePathItem to $standardProfilePath")) {
Move-Item -Path $legacyUpperCaseProfilePathItem -Destination $standardProfilePath
}
if ($PSCmdlet.ShouldProcess("Create symbolic link from $legacyUpperCaseProfilePathItem to $standardProfilePath to maintain compatibility")) {
New-Item -ItemType SymbolicLink -Path $legacyUpperCaseProfilePath -Value $standardProfilePath
}
}


# Helper to do telemetry logging.
function Invoke-CloudShellTelemetry
{
Expand Down Expand Up @@ -104,14 +155,14 @@ function Get-SubscriptionIdFromStorageProfile
function Connect-AzService
{
param (

[string]$currentSubscriptionId
)

# Enable Az Data collection
# Else User is prompted when Connect-AzAccount is invoked
Set-PSCloudShellTelemetry

$startTime = [System.DateTime]::Now

try
Expand Down Expand Up @@ -171,7 +222,7 @@ function Connect-AzureAD
$startTime = [System.DateTime]::Now

try
{
{
$envName = $env:ACC_CLOUD
if ($CloudEnvironmentMap.ContainsKey($env:ACC_CLOUD))
{
Expand All @@ -183,7 +234,7 @@ function Connect-AzureAD

# This call sets the local process context with the token, account and tenant information
& $script:AzureADModuleName\Connect-AzureAD @azureADParameters -ErrorAction SilentlyContinue -ErrorVariable azureADError | Microsoft.PowerShell.Core\Out-Null

# Log any errors from AzureAD authentication
if ($azureADError)
{
Expand Down Expand Up @@ -325,7 +376,7 @@ if($script:SkipMSIAuth -eq $true)
{
Microsoft.PowerShell.Utility\Write-Debug -Message "Skip authenticating with MSI, instead test scripts will take care of Auth."
}
else
else
{
Microsoft.PowerShell.Utility\Write-Debug -Message "Authenticating with MSI ..."

Expand Down Expand Up @@ -356,9 +407,9 @@ else

# Import AzureAD module so cmdlets are visible, they are not currently being auto-discovered
$azureADLoadStartTime = [System.DateTime]::Now
try
try
{
Microsoft.PowerShell.Core\Import-Module -Name $script:AzureADModuleName
Microsoft.PowerShell.Core\Import-Module -Name $script:AzureADModuleName
}
finally
{
Expand Down