Windows 10 SDK install tests #153
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,17 +1,64 @@ | ||
| # Install the Windows 10 SDK and Visual Studio Build Tools using the value in .windows-10-sdk-version. | ||
| # | ||
| # The expected .windows-10-sdk-version format is a integer representing a valid SDK component id. | ||
| # The list of valid component ids can be found at | ||
| # https://learn.microsoft.com/en-us/visualstudio/install/workload-component-id-vs-build-tools?view=vs-2022 | ||
| # | ||
| # Example: | ||
| # | ||
| # 20348 | ||
|
|
||
|
Comment on lines
+3
to
+10
Contributor
Author
There was a problem hiding this comment. See #144 (comment) by @iangmaia I added the documentation here rather than in the prepare script as per @iangmaia 's comment because it seemed like a better place where to explain the expectation. Also, I am aware we have two PRs that add docs here, but it felt best to add a manual version in this context to get it over the line while waiting for the LLM-generated doc approach to be discussed, see #159 #160 |
||
| param ( | ||
| [switch]$DryRun = $false | ||
| ) | ||
|
|
||
| # Stop script execution when a non-terminating error occurs | ||
| $ErrorActionPreference = "Stop" | ||
|
|
||
| Write-Output "--- :windows: Installing Windows 10 SDK and Visual Studio Build Tools" | ||
|
|
||
| # See list at https://learn.microsoft.com/en-us/visualstudio/install/workload-component-id-vs-build-tools?view=vs-2022 | ||
| $allowedVersions = @( | ||
| "20348", | ||
| "19041", | ||
| "18362", | ||
| "17763", | ||
| "17134", | ||
| "16299", | ||
| "15063", | ||
| "14393" | ||
| ) | ||
|
|
||
| $windowsSDKVersionFile = ".windows-10-sdk-version" | ||
| if (-not (Test-Path $windowsSDKVersionFile)) { | ||
| Write-Output "[!] No Windows 10 SDK version file found at $windowsSDKVersionFile." | ||
| exit 1 | ||
| } | ||
|
|
||
| $windows10SDKVersion = (Get-Content -TotalCount 1 $windowsSDKVersionFile).Trim() | ||
|
|
||
| if ($windows10SDKVersion -notmatch '^\d+$') { | ||
| Write-Output "[!] Invalid version file format." | ||
| Write-Output "Expected an integer, got: '$windows10SDKVersion'" | ||
| exit 1 | ||
| } | ||
|
|
||
| if ($allowedVersions -notcontains $windows10SDKVersion) { | ||
| Write-Output "[!] Invalid Windows 10 SDK version: $windows10SDKVersion" | ||
| Write-Output "Allowed versions are:" | ||
| foreach ($version in $allowedVersions) { | ||
| Write-Output "- $version" | ||
| } | ||
| Write-Output "More info at https://learn.microsoft.com/en-us/visualstudio/install/workload-component-id-vs-build-tools?view=vs-2022" | ||
| exit 1 | ||
| } | ||
|
|
||
| Write-Output "Will attempt to set up Windows 10 ($windows10SDKVersion) SDK and Visual Studio Build Tools..." | ||
|
|
||
| if ($DryRun) { | ||
| Write-Output "Running in dry run mode, finishing here." | ||
| exit 0 | ||
| } | ||
|
|
||
| # Download the Visual Studio Build Tools Bootstrapper | ||
| Write-Output "~~~ Downloading Visual Studio Build Tools..." | ||
|
|
@@ -26,7 +73,7 @@ If (-not (Test-Path $buildToolsPath)) { | |
| Write-Output "[!] Failed to download Visual Studio Build Tools" | ||
| Exit 1 | ||
| } else { | ||
| Write-Output "Successfully downloaded Visual Studio Build Tools at $buildToolsPath." | ||
| } | ||
|
|
||
| # Install the Windows SDK and other required components | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| param ( | ||
| [int]$ExpectedExitCode = 0, | ||
| [string]$ExpectedErrorKeyphrase = "" | ||
| ) | ||
|
|
||
| # Ensure the output is UTF-8 encoded so we can use emojis... | ||
| [System.Console]::OutputEncoding = [System.Text.Encoding]::UTF8 | ||
| $emojiGreenCheck = "$([char]0x2705)" | ||
| $emojiRedCross = "$([char]0x274C)" | ||
|
|
||
| Write-Output "Running test-install-windows-10-sdk.ps1 with ExpectedExitCode=$ExpectedExitCode and ExpectedErrorKeyphrase=$ExpectedErrorKeyphrase" | ||
|
|
||
| if (($ExpectedExitCode -eq 0) -and ($ExpectedErrorKeyphrase -ne "")) { | ||
| Write-Output "$emojiRedCross Expected call to succeed (expected error code = 0), but given an error keyphrase to check." | ||
| exit 1 | ||
| } | ||
|
|
||
| $output = & "$PSScriptRoot\..\bin\install_windows_10_sdk.ps1" -DryRun | ||
| $exitCode = $LASTEXITCODE | ||
|
|
||
| if ($exitCode -ne $ExpectedExitCode) { | ||
| Write-Output "$emojiRedCross Expected exit code $ExpectedExitCode, got $exitCode" | ||
| Write-Output "Output was:" | ||
| Write-Output "$output" | ||
| exit 1 | ||
| } else { | ||
| Write-Output "$emojiGreenCheck Exit code matches expected value ($ExpectedExitCode)" | ||
| } | ||
|
|
||
| # Only check error keyphrase if exit code is not 0 | ||
| if ($exitCode -eq 0) { | ||
| exit 0 | ||
| } | ||
|
|
||
| # If keyphrase is empty, assume the caller is satisfied with only testing the exit code | ||
| if ($ExpectedErrorKeyphrase -eq "") { | ||
| Write-Output "Exit code match expectation and no error keyphrase was provided. Test completed." | ||
| exit 0 | ||
| } | ||
|
|
||
| if ($output -match [regex]::Escape($ExpectedErrorKeyphrase)) { | ||
| Write-Output "$emojiGreenCheck Error keyphrase matches expected value ($ExpectedErrorKeyphrase)" | ||
| Write-Output "Test completed." | ||
| } else { | ||
| Write-Output "$emojiRedCross Expected error to contain '$ExpectedErrorKeyphrase', but got:" | ||
| Write-Output "$output" | ||
| exit 1 | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| # Tests the prepare_windows_host_for_app_distribution.ps1 script with the -SkipWindows10SDKInstallation parameter. | ||
| # | ||
| # We only test the skip behavior because the installation takes a "long" time to run. | ||
|
|
||
| param ( | ||
| [int]$ExpectedExitCode = 0 | ||
| ) | ||
|
|
||
| # Ensure the output is UTF-8 encoded so we can use emojis... | ||
| [System.Console]::OutputEncoding = [System.Text.Encoding]::UTF8 | ||
| $emojiGreenCheck = "$([char]0x2705)" | ||
| $emojiRedCross = "$([char]0x274C)" | ||
|
|
||
| Write-Output "Testing prepare_windows_host_for_app_distribution.ps1 with -SkipWindows10SDKInstallation" | ||
|
|
||
| # Create a valid SDK version file to ensure it's not being used | ||
| $sdkVersion = "20348" | ||
| "$sdkVersion" | Out-File .windows-10-sdk-version | ||
|
|
||
| # Run the script with skip parameter | ||
| $output = & "$PSScriptRoot\..\bin\prepare_windows_host_for_app_distribution.ps1" -SkipWindows10SDKInstallation | ||
| $exitCode = $LASTEXITCODE | ||
|
|
||
| # Check exit code | ||
| if ($exitCode -ne $ExpectedExitCode) { | ||
| Write-Output "$emojiRedCross Expected exit code $ExpectedExitCode, got $exitCode" | ||
| Write-Output "Output was:" | ||
| Write-Output "$output" | ||
| exit 1 | ||
| } else { | ||
| Write-Output "$emojiGreenCheck Exit code matches expected value ($ExpectedExitCode)" | ||
| } | ||
|
|
||
| $expectedSkipMessage = "Run with SkipWindows10SDKInstallation = true. Skipping Windows 10 SDK installation check." | ||
| if ($output -match [regex]::Escape($expectedSkipMessage)) { | ||
| Write-Output "$emojiGreenCheck Found expected skip message in output" | ||
| } else { | ||
| Write-Output "$emojiRedCross Expected to find message about skipping due to parameter, but got:" | ||
| Write-Output "$output" | ||
| exit 1 | ||
| } | ||
|
|
||
| # Verify SDK was not installed by checking the file system | ||
| $windowsSDKsRoot = "C:\Program Files (x86)\Windows Kits\10\bin" | ||
| $sdkPath = "$windowsSDKsRoot\10.0.$sdkVersion\x64" | ||
| If (Test-Path $sdkPath) { | ||
| Write-Output "$emojiRedCross Found SDK installation at $sdkPath when it should have been skipped" | ||
| exit 1 | ||
| } else { | ||
| Write-Output "$emojiGreenCheck Confirmed SDK was not installed at $sdkPath" | ||
| } | ||
|
|
||
| Write-Output "Test completed successfully." |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What about making use of our new
pr_changed_filesto run this group conditionally?The nice thing is that this
a8c-ci-toolkitrepo is the only one for now where it'd actually be easy to use that helper inshared-pipeline-varsto set up an env var you could then use as anif: build.env('HAS_INSTALL_WINDOWS_10_SDK_CHANGES') == 1.This is because unlike all other repos for which the
a8c-ci-toolkitis not loaded on theuploaderagent when the main step that doespipeline uploadis run on it, our default steps don't include it as a plugin… in this specific repo we don't even need to load it as a plugin because it's already a binary in the working copy of the repo it's trying to run CI on 😛Which means you should be able to use
bin/pr_change_filesin this repo directly (instead of having the plugin loaded and having itsbin/folder added to the$PATH) toexport HAS_INSTALL_WINDOWS_10_SDK_CHANGES=$(bin/pr_changed_files --stdout --any-match './bin/install_windows_10_sdk.ps1' './tests/test-install-windows-sdk.ps1')😉Same for the other one btw.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That would be neat and great dogfooding.