Skip to content
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

Refactor WinDbg install #1058

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Refactor WinDbg install #1058

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
35 changes: 25 additions & 10 deletions packages/windbg.vm/tools/chocolateyinstall.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,32 @@ try {
$toolName = 'WinDbg'
$category = 'Debuggers'

# It seems WinDbg is now distributed as an .appinstaller and we need to install it using Add-AppxPackage
Add-AppxPackage -AppInstallerFile 'https://windbg.download.prss.microsoft.com/dbazure/prod/1-0-0/windbg.appinstaller'
$bundleUrl = "https://windbg.download.prss.microsoft.com/dbazure/prod/1-2402-24001-0/windbg.msixbundle"
$bundleSha256 = "e941076cb4d7912d32a22ea87ad2693c01fa465227b4d1ead588283518de428f"

$shortcutDir = Join-Path ${Env:TOOL_LIST_DIR} $category
$shortcut = Join-Path $shortcutDir "$toolName.lnk"
$executableCmd = Join-Path ${Env:WinDir} "system32\cmd.exe"
# Use `start` to close the open console
$executableArgs = "/C start WinDbgX.exe"
$executableDir = Join-Path ${Env:UserProfile} "Desktop"
Install-ChocolateyShortcut -shortcutFilePath $shortcut -targetPath $executableCmd -Arguments $executableArgs -WorkingDirectory $executableDir -RunAsAdmin
$packageArgs = @{
packageName = ${Env:ChocolateyPackageName}
url = $bundleUrl
checksum = $bundleSha256
checksumType = "sha256"
fileFullPath = Join-Path ${Env:TEMP} "$toolName.msixbundle"
}
Get-ChocolateyWebFile @packageArgs
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should add a VM-Assert-Path $packageArgs.fileFullPath to ensure the file has been downloaded before installing it.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not necessary, as Get-ChocolateyWebFile will throw an error with "incorrect hash" if the file has not been downloaded.

Add-AppxPackage -Path $packageArgs.fileFullPath

$installDir = (Get-AppxPackage -Name "Microsoft.$toolName").InstallLocation
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This normally resolves to %programfiles%\WindowsApps\xxx and %programfiles%\WindowsApps is a protected folder causing it to fail to execute DbgX.Shell.exe directly from it.

Capture

Modifying the owner and the access permissions fixes the problem, I'm not sure if it breaks any thing else though.

Copy link
Member

@Ana06 Ana06 Oct 7, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the error I got as well. @d35ha do you get the error for the icon or only when used as executable path?

$iconLocation = Join-Path $installDir "DbgX.Shell.exe" -Resolve
$executablePath = "$(where.exe WinDbgXA.exe)"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually where.exe doesn't throw exceptions, it returns 1 in case of failure and since $ErrorActionPreference is set to Stop; the non-zero return code is treated as an exception with the stderr as exception message.

It's a way better to use the powershell function Get-Command with the ErrorAction set to Continue and to check the returned path if empty or not instead of relying on exceptions.

It would be like this:

$executablePath = (Get-Command WinDbgXA.exe -ea 0).Path
if (!$executablePath)
{
    $executablePath = Join-Path $installDir DbgX.Shell.exe
}

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@d35ha your proposal could cause that $executablePath is set to Join-Path $installDir DbgX.Shell.exe which doesn't fail the package, but we know fails to open in Windows 10 because of being in a protected directory. This results in a broken shortcut without noticing during the installation, or am I missing something?

VM-Install-Shortcut -toolName $toolName -category $category -executablePath $executablePath -iconLocation $iconLocation -RunAsAdmin
} catch {
VM-Write-Log-Exception $_
if ($_.Exception.Message -match "INFO: Could not find files for the given pattern\(s\).")
{
$executablePath = Join-Path $installDir "DbgX.Shell.exe"
VM-Install-Shortcut -toolName $toolName -category $category -executablePath $executablePath -iconLocation $iconLocation -RunAsAdmin
}
else
{
VM-Write-Log-Exception $_
}
Comment on lines +26 to +34
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if this is the route we want to take, as noted in my comments on the PR.

I think our current route of just making a shortcut may be the better alternative for the moment, unless we want to take the time to properly test and confirm one of the possible working solutions I noted in my comments.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At least we need to continue on this error, or windows-2019 will fail on where.exe WinDbgX.exe.

}

2 changes: 1 addition & 1 deletion packages/windbg.vm/windbg.vm.nuspec
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<package xmlns="http://schemas.microsoft.com/packaging/2015/06/nuspec.xsd">
<metadata>
<id>windbg.vm</id>
<version>0.0.0</version>
<version>1.2402.24001.20240527</version>
<authors>Microsoft</authors>
<description>WinDbg is a debugger that can be used to analyze crash dumps, debug live user-mode and kernel-mode code, and examine CPU registers and memory.</description>
<dependencies>
Expand Down
Loading