Remove Write-Host from PRTest.ps1 (#240696)

Author: Trenly

Tools/PRTest.ps1

@@ -1,5 +1,4 @@
 # This script does a checkout of a Pull Request using the GitHub CLI, and then runs it using SandboxTest.ps1.
-[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingWriteHost', '', Justification = 'This script is not intended to have any outputs piped')]
 
 Param(
     [Parameter(Position = 0, HelpMessage = 'The Pull Request to checkout.', Mandatory = $true)]
@@ -16,38 +15,45 @@ Param(
     [switch] $Clean
 )
 
-$PullRequest = $PullRequest.TrimStart('#')
+# Virtual Terminal
+filter Initialize-VirtualTerminalSequence {
+    # https://learn.microsoft.com/en-us/windows/console/console-virtual-terminal-sequences
+    if ($script:vtSupported) {
+        return "$([char]0x001B)[${_}m"
+    }
+}
 
-$ErrorActionPreference = 'Stop'
+# Flags
+Write-Debug 'Checking for supported features'
+$script:vtSupported = (Get-Host).UI.SupportsVirtualTerminal
+$script:GitIsPresent = Get-Command 'git' -ErrorAction SilentlyContinue
+$script:GhIsPresent = Get-Command 'gh' -ErrorAction SilentlyContinue
+$script:SandboxIsPresent = Get-Command 'WindowsSandbox' -ErrorAction SilentlyContinue
 
-$repositoryRoot = 'https://github.com/microsoft/winget-pkgs/'
+Write-Debug 'Initializing Virtual Terminal Sequences'
+$script:vtDefault = 0 | Initialize-VirtualTerminalSequence
+$script:vtForegroundGreen = 32 | Initialize-VirtualTerminalSequence
 
+Write-Debug 'Creating internal state'
+$PullRequest = $PullRequest.TrimStart('#')
+$ErrorActionPreference = 'Stop'
+$repositoryRoot = 'https://github.com/microsoft/winget-pkgs/'
 $rootDirectory = ((Resolve-Path (git rev-parse --show-toplevel)).ToString() + '\')
 
-if (-Not (Get-Command 'gh' -ErrorAction 'SilentlyContinue')) {
-    Write-Host "The GitHub CLI is not installed. Install it via 'winget install GitHub.cli' and come back here!" -ForegroundColor Red
-    return
-}
-
-if (-Not (Get-Command 'git' -ErrorAction 'SilentlyContinue')) {
-    Write-Host "Git is not installed. Install it via 'winget install Git.Git' and come back here!" -ForegroundColor Red
-    return
-}
+Write-Verbose 'Ensuring Dependencies are Present'
+if (!$script:GhIsPresent) { Write-Error "The GitHub CLI is not installed. Install it via 'winget install GitHub.cli' and come back here!" -ErrorAction Stop }
+if (!$script:GitIsPresent) { Write-Error "Git is not installed. Install it via 'winget install Git.Git' and come back here!" -ErrorAction Stop }
+if (!$script:SandboxIsPresent) { Write-Error 'Windows Sandbox is not enabled. Enable it and come back here!' -ErrorAction Stop }
 
+Write-Verbose 'Checking out PR'
 gh pr checkout $PullRequest $(if (!$KeepBranch) { '--detach' }) -f -R $repositoryRoot | Out-Null
+if ($LASTEXITCODE -ne 0) { Write-Error "There was an error checking out the PR. Make sure you're logged into GitHub via 'gh auth login' and come back here!" -ErrorAction Stop }
 
-if ($LASTEXITCODE -ne 0) {
-    Write-Host "There was an error checking out the PR. Make sure you're logged into GitHub via 'gh auth login' and come back here!" -ForegroundColor Red
-    return
-}
-
-$manifest = (git diff --name-only HEAD~1..HEAD)
-if ($manifest.GetType().Name -eq 'Object[]') {
-    $path = (Get-Item (Resolve-Path ($rootDirectory + $manifest[0]))).Directory
-} else {
-    $path = (Get-Item (Resolve-Path ($rootDirectory + $manifest))).Directory
-}
+Write-Verbose 'Parsing changed files'
+$manifest = @(gh pr diff $PullRequest --name-only)
+$path = (Get-Item (Resolve-Path ($rootDirectory + $manifest[0]))).Directory
 
+Write-Verbose 'Passing execution to SandboxTest.ps1'
 $sandboxTestPath = (Resolve-Path ($PSScriptRoot.ToString() + '\SandboxTest.ps1')).ToString()
 $params = @{
     Manifest                   = $path
@@ -63,6 +69,7 @@ $params = @{
 & $sandboxTestPath @params
 
 if ($Review) {
-    Write-Host "Opening $PullRequest in browser..." -ForegroundColor Green
-    Start-Process ($repositoryRoot + 'pull/' + $PullRequest + '/files')
+    Write-Information "${script:vtForegroundGreen}" -InformationAction 'Continue'
+    & gh pr diff --web $PullRequest
+    Write-Information "${script:vtDefault}" -InformationAction 'Continue'
 }