-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Add PR category detection for UI tests #33176
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.
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
jfversluis
wants to merge
19
commits into
main
Choose a base branch
from
feature/detect-uitest-categories
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+317
−36
Open
Changes from all commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
a7e4e33
Add PR category detection for UI tests
jfversluis fdbc7cb
Fix default matrix handling in UI test template
jfversluis 068e0e8
Fix: use runtime coalesce expression for category matrix
jfversluis d252f7c
Fix PowerShell variable interpolation syntax
jfversluis 3a1df7b
Fix regex character class syntax in PowerShell
jfversluis 0104024
Add dummy Button test to validate category detection
jfversluis 3903280
Add category filtering logic to all test stages
jfversluis 6179f0e
Fix variable scoping: move stage dependency reference to job level
jfversluis a3843b5
Fix: Overwrite CATEGORYGROUP variable instead of creating new one
jfversluis 9c51137
Fix: Use EFFECTIVE_FILTER variable - CATEGORYGROUP is readonly
jfversluis f6e8f5f
Simplify: Move category filter logic into ui-tests-steps.yml
jfversluis f2ffe5f
Fix: Exit early when no matching categories instead of running tests
jfversluis e6e4542
Skip setup steps when UI test category doesn't match
jfversluis f060cc5
Add SKIP_PROVISIONING check to provision.yml
jfversluis 07df240
Add category detection to CV2/CARV2 stages
jfversluis 7e2ca94
Fix: Detect unexpanded $(CATEGORYGROUP) variable
jfversluis 599710f
Test: Add dummy Label test for category detection validation
jfversluis d5d2dde
Fix: Add explicit Category attribute to dummy Label test
jfversluis f9ec697
Remove dummy Button and Label tests
jfversluis File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 |
|---|---|---|
|
|
@@ -15,23 +15,82 @@ parameters: | |
| checkoutDirectory: $(System.DefaultWorkingDirectory) | ||
|
|
||
| steps: | ||
| # EARLY CHECK: Determine if this category group should run tests | ||
| # This runs FIRST to avoid wasting time on provisioning if no tests will run | ||
| - pwsh: | | ||
| $testFilterParam = $env:CATEGORY_GROUP | ||
| $testFilterFallback = $env:TEST_FILTER_PARAM | ||
| $detectedCategories = $env:DETECTED_CATEGORIES | ||
| $isPR = $env:BUILD_REASON -eq "PullRequest" | ||
|
|
||
| Write-Host "=== Early Category Check ===" | ||
| Write-Host "Build Reason: $env:BUILD_REASON" | ||
| Write-Host "Category Group (from matrix): '$testFilterParam'" | ||
| Write-Host "Test Filter (from parameter): '$testFilterFallback'" | ||
| Write-Host "Detected Categories: '$detectedCategories'" | ||
|
|
||
| # Use testFilter parameter as fallback when CATEGORYGROUP is not set or not expanded | ||
| # When CATEGORYGROUP variable doesn't exist, it shows as literal '$(CATEGORYGROUP)' | ||
| $categoryGroupNotSet = [string]::IsNullOrWhiteSpace($testFilterParam) -or $testFilterParam -eq '$(CATEGORYGROUP)' | ||
| if ($categoryGroupNotSet -and -not [string]::IsNullOrWhiteSpace($testFilterFallback)) { | ||
| $testFilterParam = $testFilterFallback | ||
| Write-Host "Using testFilter parameter as category: '$testFilterParam'" | ||
| } | ||
|
|
||
| $shouldRun = $true | ||
|
|
||
| # For PRs with detected categories, check if this category group has any matches | ||
| if ($isPR -and -not [string]::IsNullOrWhiteSpace($detectedCategories) -and -not [string]::IsNullOrWhiteSpace($testFilterParam)) { | ||
| $categoryList = $testFilterParam -split "," | ||
| $detectedList = $detectedCategories -split "," | ||
| $hasMatch = $false | ||
|
|
||
| foreach ($cat in $categoryList) { | ||
| $cat = $cat.Trim() | ||
| foreach ($det in $detectedList) { | ||
| $det = $det.Trim() | ||
| if ($cat -eq $det) { | ||
| $hasMatch = $true | ||
| Write-Host "Match found: '$cat'" | ||
| break | ||
| } | ||
| } | ||
| if ($hasMatch) { break } | ||
| } | ||
|
|
||
| if (-not $hasMatch) { | ||
| $shouldRun = $false | ||
| Write-Host "##[warning]No matching categories - SKIPPING all steps for this job" | ||
| Write-Host "Category group '$testFilterParam' does not contain any detected categories: $detectedCategories" | ||
| } | ||
| } | ||
|
|
||
| Write-Host "Should run tests: $shouldRun" | ||
| Write-Host "##vso[task.setvariable variable=SHOULD_RUN_TESTS]$shouldRun" | ||
|
Comment on lines
+20
to
+69
|
||
| displayName: 'Check if category should run' | ||
| env: | ||
| CATEGORY_GROUP: $(CATEGORYGROUP) | ||
| TEST_FILTER_PARAM: ${{ parameters.testFilter }} | ||
| DETECTED_CATEGORIES: $(DETECTED_CATEGORIES) | ||
| BUILD_REASON: $(Build.Reason) | ||
|
|
||
| - task: DownloadPipelineArtifact@2 | ||
| condition: and(ne('${{ parameters.platform }}' , 'windows'), eq('${{ parameters.runtimeVariant }}' , 'Mono')) | ||
| condition: and(succeeded(), eq(variables['SHOULD_RUN_TESTS'], 'True'), ne('${{ parameters.platform }}' , 'windows'), eq('${{ parameters.runtimeVariant }}' , 'Mono')) | ||
| inputs: | ||
| artifact: ui-tests-samples | ||
|
|
||
| - task: DownloadPipelineArtifact@2 | ||
| condition: and(ne('${{ parameters.platform }}' , 'windows'), eq('${{ parameters.runtimeVariant }}' , 'NativeAOT')) | ||
| condition: and(succeeded(), eq(variables['SHOULD_RUN_TESTS'], 'True'), ne('${{ parameters.platform }}' , 'windows'), eq('${{ parameters.runtimeVariant }}' , 'NativeAOT')) | ||
| inputs: | ||
| artifact: ui-tests-samples-nativeaot | ||
|
|
||
| - task: DownloadPipelineArtifact@2 | ||
| condition: and(ne('${{ parameters.platform }}' , 'windows'), eq('${{ parameters.runtimeVariant }}' , 'CoreCLR')) | ||
| condition: and(succeeded(), eq(variables['SHOULD_RUN_TESTS'], 'True'), ne('${{ parameters.platform }}' , 'windows'), eq('${{ parameters.runtimeVariant }}' , 'CoreCLR')) | ||
| inputs: | ||
| artifact: ui-tests-samples-coreclr | ||
|
|
||
| - task: DownloadPipelineArtifact@2 | ||
| condition: eq('${{ parameters.platform }}' , 'windows') | ||
| condition: and(succeeded(), eq(variables['SHOULD_RUN_TESTS'], 'True'), eq('${{ parameters.platform }}' , 'windows')) | ||
| inputs: | ||
| artifact: ui-tests-samples-windows | ||
|
|
||
|
|
@@ -40,6 +99,7 @@ steps: | |
| chmod +x $(System.DefaultWorkingDirectory)/eng/scripts/clean-bot.sh | ||
| $(System.DefaultWorkingDirectory)/eng/scripts/clean-bot.sh | ||
| displayName: 'Clean bot' | ||
| condition: and(succeeded(), eq(variables['SHOULD_RUN_TESTS'], 'True')) | ||
| continueOnError: true | ||
| timeoutInMinutes: 60 | ||
|
|
||
|
|
@@ -50,13 +110,14 @@ steps: | |
| sudo udevadm control --reload-rules | ||
| sudo udevadm trigger --name-match=kvm | ||
| displayName: Enable KVM | ||
| condition: and(succeeded(), eq(variables['Agent.OS'], 'Linux')) | ||
| condition: and(succeeded(), eq(variables['SHOULD_RUN_TESTS'], 'True'), eq(variables['Agent.OS'], 'Linux')) | ||
|
|
||
| - ${{ if eq(parameters.platform, 'catalyst')}}: | ||
| - bash: | | ||
| chmod +x $(System.DefaultWorkingDirectory)/eng/scripts/disable-notification-center.sh | ||
| $(System.DefaultWorkingDirectory)/eng/scripts/disable-notification-center.sh | ||
| displayName: 'Disable Notification Center' | ||
| condition: and(succeeded(), eq(variables['SHOULD_RUN_TESTS'], 'True')) | ||
| continueOnError: true | ||
| timeoutInMinutes: 60 | ||
|
|
||
|
|
@@ -80,7 +141,7 @@ steps: | |
| openSslArgs: '' # Do not use legacy openssl for Catalyst builds | ||
|
|
||
| - task: PowerShell@2 | ||
| condition: and(ne('${{ parameters.platform }}', 'windows'), ne('${{ parameters.platform }}', 'android')) | ||
| condition: and(succeeded(), eq(variables['SHOULD_RUN_TESTS'], 'True'), ne('${{ parameters.platform }}', 'windows'), ne('${{ parameters.platform }}', 'android')) | ||
| inputs: | ||
| targetType: 'inline' | ||
| script: | | ||
|
|
@@ -92,22 +153,25 @@ steps: | |
|
|
||
| - pwsh: ./build.ps1 --target=dotnet --configuration="${{ parameters.configuration }}" --verbosity=diagnostic | ||
| displayName: 'Install .NET' | ||
| condition: and(succeeded(), eq(variables['SHOULD_RUN_TESTS'], 'True')) | ||
| retryCountOnTaskFailure: 2 | ||
| env: | ||
| DOTNET_TOKEN: $(dotnetbuilds-internal-container-read-token) | ||
| PRIVATE_BUILD: $(PrivateBuild) | ||
|
|
||
| - pwsh: echo "##vso[task.prependpath]$(DotNet.Dir)" | ||
| displayName: 'Add .NET to PATH' | ||
| condition: and(succeeded(), eq(variables['SHOULD_RUN_TESTS'], 'True')) | ||
|
|
||
| # AzDO hosted agents default to 1024x768; set something bigger for Windows UI tests | ||
| - pwsh: | | ||
| $scriptPath = Join-Path "$(System.DefaultWorkingDirectory)" "eng" "scripts" "Set-ScreenResolution.ps1" | ||
| & $scriptPath -Width 1920 -Height 1080 | ||
| condition: eq('${{ parameters.platform }}' , 'windows') | ||
| condition: and(succeeded(), eq(variables['SHOULD_RUN_TESTS'], 'True'), eq('${{ parameters.platform }}' , 'windows')) | ||
| displayName: "Set screen resolution" | ||
|
|
||
| - task: UseNode@1 | ||
| condition: and(succeeded(), eq(variables['SHOULD_RUN_TESTS'], 'True')) | ||
| inputs: | ||
| version: "20.3.1" | ||
| displayName: "Install node" | ||
|
|
@@ -116,6 +180,7 @@ steps: | |
| $skipAppiumDoctor = if ($IsMacOS -or $IsLinux) { "true" } else { "false" } | ||
| dotnet build ./src/Provisioning/Provisioning.csproj -t:ProvisionAppium -p:SkipAppiumDoctor="$skipAppiumDoctor" -bl:"$(LogDirectory)/provision-appium.binlog" | ||
| displayName: "Install Appium" | ||
| condition: and(succeeded(), eq(variables['SHOULD_RUN_TESTS'], 'True')) | ||
| continueOnError: false | ||
| retryCountOnTaskFailure: 2 | ||
| timeoutInMinutes: 10 | ||
|
|
@@ -131,12 +196,50 @@ steps: | |
|
|
||
| $testFilter = "" | ||
| $testConfigrationArgs = "${{ parameters.testConfigurationArgs }}" | ||
|
|
||
| "${{ parameters.testFilter }}".Split(",") | ForEach { | ||
| $testFilter += "TestCategory=" + $_ + "|" | ||
|
|
||
| # Get test filter from environment variable (passed from matrix via env block) | ||
| $testFilterParam = $env:CATEGORY_GROUP | ||
| $detectedCategories = $env:DETECTED_CATEGORIES | ||
| $isPR = $env:BUILD_REASON -eq "PullRequest" | ||
|
|
||
| Write-Host "Category Group from matrix: '$testFilterParam'" | ||
| Write-Host "Detected Categories: '$detectedCategories'" | ||
|
|
||
| # Fallback to parameter for non-matrix builds | ||
| if (-not $testFilterParam) { | ||
| $testFilterParam = "${{ parameters.testFilter }}" | ||
| Write-Host "Using testFilter parameter: '$testFilterParam'" | ||
| } | ||
|
|
||
| # For PRs with detected categories, use only matching categories | ||
| if ($isPR -and -not [string]::IsNullOrWhiteSpace($detectedCategories) -and -not [string]::IsNullOrWhiteSpace($testFilterParam)) { | ||
| $categoryList = $testFilterParam -split "," | ||
| $detectedList = $detectedCategories -split "," | ||
| $matchingCategories = @() | ||
|
|
||
| foreach ($cat in $categoryList) { | ||
| $cat = $cat.Trim() | ||
| foreach ($det in $detectedList) { | ||
| $det = $det.Trim() | ||
| if ($cat -eq $det) { | ||
| $matchingCategories += $cat | ||
| break | ||
| } | ||
| } | ||
|
Comment on lines
+220
to
+228
|
||
| } | ||
|
|
||
| $testFilterParam = $matchingCategories -join "," | ||
| Write-Host "Running matching categories: $testFilterParam" | ||
| } | ||
|
|
||
| Write-Host "Final test filter: '$testFilterParam'" | ||
|
|
||
| if ($testFilterParam) { | ||
| $testFilterParam.Split(",") | ForEach { | ||
| $testFilter += "TestCategory=" + $_ + "|" | ||
| } | ||
| $testFilter = $testFilter.TrimEnd("|") | ||
| } | ||
|
|
||
| $testFilter = $testFilter.TrimEnd("|") | ||
|
|
||
|
Comment on lines
196
to
243
|
||
| # Cake does not allow empty parameters, so check if our filter is empty before adding it | ||
| if ($testConfigrationArgs) { | ||
|
|
@@ -155,10 +258,14 @@ steps: | |
|
|
||
| Invoke-Expression $command | ||
| displayName: $(Agent.JobName) | ||
| condition: and(succeeded(), eq(variables['SHOULD_RUN_TESTS'], 'True')) | ||
| ${{ if ne(parameters.platform, 'android')}}: | ||
| retryCountOnTaskFailure: 1 | ||
| env: | ||
| APPIUM_HOME: $(APPIUM_HOME) | ||
| CATEGORY_GROUP: $(CATEGORYGROUP) | ||
| DETECTED_CATEGORIES: $(DETECTED_CATEGORIES) | ||
| BUILD_REASON: $(Build.Reason) | ||
|
|
||
| - bash: | | ||
| cat ${BASH_SOURCE[0]} | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
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.
The category comparison at lines 52 and 224 uses case-sensitive string equality (
$cat -eq $det). However, the HashSet used for collecting categories in the PowerShell detection script uses case-insensitive comparison (line 57:[System.StringComparer]::OrdinalIgnoreCase). This inconsistency could cause matching failures if category names differ in case between the detection script output and the matrix CATEGORYGROUP values. Use case-insensitive comparison here as well with-ieqor.ToLower()for consistency.