scripts/debug_agent.ps1

Param(
    # Filename to debug.
    [Parameter(Position = 0)][string]$FileName = 'AducIotAgent',
    # Additional appArgs to pass to command line.
    [string[]] $ArgumentList,
    # Build type, e.g. Debug, Release.
    [string]$Type = 'Debug',
    # Set to true if debugging a Catch2 Unit Test.
    [switch]$DebugCatchUT = $false,
    # Set to true if process launch without debugging is desired.
    [switch]$NoDebugger = $false,
    # Run the process elevated?
    [switch]$Elevated = $false
)

# Example ArgumentList for AducIotAgent:
# '--register-extension', '/var/lib/adu/extensions/sources/microsoft_steps_1.dll', '--extension-type', 'updateContentHandler', '--extension-id', 'microsoft/steps:1'
# "--health-check"

# Example ArgumentList for adu-shell:
# '--update-type', 'common', '--update-action', 'reboot'

function Show-Error {
    Param([Parameter(mandatory = $true, position = 0)][string]$Message)
    Write-Host -ForegroundColor Red -NoNewline 'Error:'
    Write-Host " $Message"
}

function Show-Bullet {
    Param([Parameter(mandatory = $true, position = 0)][string]$Message)
    Write-Host -ForegroundColor Blue -NoNewline '*'
    Write-Host " $Message"
}

$root_dir = git.exe rev-parse --show-toplevel
$bin_dir = "$root_dir\out\$Type\bin\$Type"
$app = Join-Path $bin_dir "$FileName.exe"

if (-not (Test-Path $app -PathType Leaf)) {
    Show-Error "Cannot find $app"

    if (-not (Test-Path $bin_dir -PathType Container)) {
        Show-Error "Folder $bin_dir doesn't exist. Either rebuild or specify -Type"
    }
    else {
        ''
        'The following apps were found:'
        (Get-ChildItem -LiteralPath $bin_dir -Filter '*.exe').BaseName | Sort-Object | ForEach-Object { Show-Bullet $_ }
    }
    exit 1
}

if ($NoDebugger) {
    "Launching $app . . ."
    if (-not $Elevated) {
        & $app
    }
    else {
        Start-Process -FilePath $app -Verb RunAs
    }
}
else {
    if (-not (Get-Command -Name 'WinDbgX.exe' -CommandType Application)) {
        'WinDbgX not found'
        'To install WinDbg use: winget install --accept-package-agreements ''WinDbg Preview'''
        exit 1
    }

    $module = $FileName -replace '-', '_'

    if ($DebugCatchUT) {
        # Debugging a Catch2 Unit Test

        $debuggerArgs = `
            # e.g. https_proxy_utils_unit_tests!`anonymous namespace'::C_A_T_C_H_T_E_S_T_0::test
            '-c', "`"bm $module!*::C_A_T_C_H_T_E_S_T_*::test`"", `
            # e.g. permission_utils_unit_test!C_A_T_C_H_T_E_S_T_0
            '-c', "`"bm $module!C_A_T_C_H_T_E_S_T_*`"", `
            # e.g. https_proxy_utils_unit_tests!TestCaseFixture::TestCaseFixture
            '-c', "`"bm $module!TestCaseFixture::TestCaseFixture`"", `
            '-c', "`"bm $module!TestCaseFixture::~TestCaseFixture`"", `
            # Start test
            '-c', 'g'

        $appArgs = "--success", "--break"
    }
    else {
        # Debugging an .EXE
        # -o : Debugs all processes launched by the target application (child processes).

        $debuggerArgs = '-c', "`"bp $module!main`"", '-c', 'g'

        # Log level is DEBUG (very verbose) -- useful for debugging.
        $appArgs = '--log-level', '0'
    }

    $argList = $debuggerArgs
    $argList += $app
    $argList += $appArgs
    if ($ArgumentList) {
        $argList += $ArgumentList
    }

    "`nWinDbgX.exe $argList`n"

    if (-not $Elevated) {
        WinDbgX.exe $argList
    }
    else {
        Start-Process  -FilePath 'WinDbgX.exe' -ArgumentList $argList -Verb RunAs
    }
}

exit 0