-
Notifications
You must be signed in to change notification settings - Fork 335
Validate localized SqlClient resources in OneBranch builds #4635
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
cheenamalhotra
wants to merge
8
commits into
main
Choose a base branch
from
dev/cheena/sturdy-waddle
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.
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
c03f910
Add localization validation to OneBranch pipelines
cheenamalhotra 6e805aa
Run localization validation in SqlClient build
cheenamalhotra 6537128
Allow approved localization value matches
cheenamalhotra 1def6ab
Harden localization validation
cheenamalhotra cea45f6
Handle localization handback delay
cheenamalhotra b3a3711
Honor warning-only allowlist validation
cheenamalhotra a233b28
Always enforce localization validation
cheenamalhotra 11d85ba
Clarify localization validation docs
cheenamalhotra 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| { | ||
| "_comment": [ | ||
| "These culture/key pairs intentionally match the English source text.", | ||
| "Each pair was verified in the internal LCL source as localized (Stat=Loc, Orig=New). Remove an entry when its localized value changes." | ||
| ], | ||
| "AllowedEnglishValueMatches": { | ||
| "Strings.cs.resx": [ | ||
| "ADP_InvalidMultipartName", | ||
|
cheenamalhotra marked this conversation as resolved.
|
||
| "DataCategory_Data", | ||
| "DataCategory_InfoMessage", | ||
| "DataCategory_StatementCompleted", | ||
| "DataCategory_Xml", | ||
| "SQL_ExClientConnectionId", | ||
| "SqlMisc_NullString" | ||
| ], | ||
| "Strings.de.resx": [ | ||
| "ADP_InvalidMultipartName", | ||
| "DataCategory_Pooling", | ||
| "DataCategory_StatementCompleted", | ||
| "DataCategory_Xml", | ||
| "SQL_ExClientConnectionId" | ||
| ], | ||
| "Strings.es.resx": [ | ||
| "ADP_InvalidMultipartName", | ||
| "DataCategory_StatementCompleted", | ||
| "DataCategory_Xml", | ||
| "SQL_ExClientConnectionId", | ||
| "SQL_ExErrorNumberStateClass" | ||
| ], | ||
| "Strings.fr.resx": [ | ||
| "DataCategory_InfoMessage", | ||
| "DataCategory_Notification", | ||
| "DataCategory_Source", | ||
| "DataCategory_StatementCompleted", | ||
| "DataCategory_Xml", | ||
| "SqlMisc_NullString" | ||
| ], | ||
| "Strings.it.resx": [ | ||
| "ADP_InvalidMultipartName", | ||
| "DataCategory_InfoMessage", | ||
| "DataCategory_Pooling", | ||
| "DataCategory_StatementCompleted", | ||
| "DataCategory_Xml", | ||
| "SQL_ExClientConnectionId", | ||
| "SQL_ExErrorNumberStateClass", | ||
| "SqlMisc_NullString" | ||
| ], | ||
| "Strings.ja.resx": [ | ||
| "DataCategory_StatementCompleted", | ||
| "DataCategory_Xml", | ||
| "SQL_ExClientConnectionId" | ||
| ], | ||
| "Strings.ko.resx": [ | ||
| "ADP_InvalidMultipartName", | ||
| "DataCategory_InfoMessage", | ||
| "DataCategory_StatementCompleted", | ||
| "DataCategory_Xml", | ||
| "SQL_ExClientConnectionId", | ||
| "SQL_ExErrorNumberStateClass", | ||
| "SqlMisc_NullString" | ||
| ], | ||
| "Strings.pl.resx": [ | ||
| "DataCategory_InfoMessage", | ||
| "DataCategory_StatementCompleted", | ||
| "DataCategory_Xml", | ||
| "SQL_ExClientConnectionId", | ||
| "SqlMisc_NullString" | ||
| ], | ||
| "Strings.pt-BR.resx": [ | ||
| "ADP_InvalidMultipartName", | ||
| "DataCategory_InfoMessage", | ||
| "DataCategory_Pooling", | ||
| "DataCategory_StatementCompleted", | ||
| "DataCategory_Xml", | ||
| "SQL_ExClientConnectionId", | ||
| "SQL_ExErrorNumberStateClass" | ||
| ], | ||
| "Strings.ru.resx": [ | ||
| "ADP_InvalidMultipartName", | ||
| "DataCategory_InfoMessage", | ||
| "DataCategory_StatementCompleted", | ||
| "DataCategory_Xml", | ||
| "SQL_ExClientConnectionId", | ||
| "SQL_ExOriginalClientConnectionId" | ||
| ], | ||
| "Strings.tr.resx": [ | ||
| "ADP_InvalidMultipartName", | ||
| "DataCategory_StatementCompleted", | ||
| "DataCategory_Xml", | ||
| "SQL_ExClientConnectionId", | ||
| "SqlMisc_NullString" | ||
| ], | ||
| "Strings.zh-Hans.resx": [ | ||
| "DataCategory_InfoMessage", | ||
| "DataCategory_StatementCompleted", | ||
| "DataCategory_Xml", | ||
| "SQL_ExClientConnectionId", | ||
| "SQL_ExErrorNumberStateClass", | ||
| "SqlMisc_NullString" | ||
| ], | ||
| "Strings.zh-Hant.resx": [ | ||
| "DataCategory_InfoMessage", | ||
| "DataCategory_StatementCompleted", | ||
| "DataCategory_Xml", | ||
| "SQL_ExClientConnectionId", | ||
| "SQL_ExErrorNumberStateClass", | ||
| "SqlMisc_NullString" | ||
| ] | ||
| } | ||
| } | ||
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
190 changes: 190 additions & 0 deletions
190
eng/pipelines/onebranch/scripts/tests/validate-localization.Tests.ps1
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,190 @@ | ||
| <# | ||
| .SYNOPSIS | ||
| Pester tests for validate-localization.ps1. | ||
| #> | ||
|
|
||
| BeforeAll { | ||
| $scriptPath = Join-Path $PSScriptRoot '..' 'validate-localization.ps1' | ||
|
|
||
| function Set-ResourceFile { | ||
| param( | ||
| [Parameter(Mandatory)][string]$Path, | ||
| [Parameter(Mandatory)][hashtable]$Strings | ||
| ) | ||
|
|
||
| $document = [System.Xml.XmlDocument]::new() | ||
| $root = $document.CreateElement('root') | ||
| $null = $document.AppendChild($root) | ||
| foreach ($entry in $Strings.GetEnumerator()) { | ||
| $data = $document.CreateElement('data') | ||
| $data.SetAttribute('name', $entry.Key) | ||
|
|
||
| $value = $document.CreateElement('value') | ||
| $value.InnerText = $entry.Value | ||
| $null = $data.AppendChild($value) | ||
| $null = $root.AppendChild($data) | ||
| } | ||
|
|
||
| $document.Save($Path) | ||
| } | ||
|
|
||
| function New-ResourcesDirectory { | ||
| $path = Join-Path $TestDrive ([guid]::NewGuid().ToString('n')) | ||
| New-Item -ItemType Directory -Path $path | Out-Null | ||
| return $path | ||
| } | ||
| } | ||
|
|
||
| Describe 'validate-localization.ps1' { | ||
| It 'accepts complete localized files with translated values' { | ||
| $resources = New-ResourcesDirectory | ||
| Set-ResourceFile (Join-Path $resources 'Strings.resx') @{ Greeting = 'Hello'; Farewell = 'Goodbye' } | ||
| Set-ResourceFile (Join-Path $resources 'Strings.fr.resx') @{ Greeting = 'Bonjour'; Farewell = 'Au revoir' } | ||
|
|
||
| { & $scriptPath -ResourcesDirectory $resources } | Should -Not -Throw | ||
| } | ||
|
|
||
| It 'fails when a localized file is missing an English key' { | ||
| $resources = New-ResourcesDirectory | ||
| Set-ResourceFile (Join-Path $resources 'Strings.resx') @{ Greeting = 'Hello'; Farewell = 'Goodbye' } | ||
| Set-ResourceFile (Join-Path $resources 'Strings.de.resx') @{ Greeting = 'Hallo' } | ||
|
|
||
| { & $scriptPath -ResourcesDirectory $resources } | | ||
| Should -Throw '*Localization validation failed with 1 error. Review the preceding errors.*' | ||
| } | ||
|
|
||
| It 'fails when a localized value matches a non-empty English value' { | ||
| $resources = New-ResourcesDirectory | ||
| Set-ResourceFile (Join-Path $resources 'Strings.resx') @{ Greeting = 'Hello'; Unused = '' } | ||
| Set-ResourceFile (Join-Path $resources 'Strings.ja.resx') @{ Greeting = 'Hello'; Unused = '' } | ||
|
|
||
| { & $scriptPath -ResourcesDirectory $resources } | | ||
| Should -Throw '*Localization validation failed with 1 error. Review the preceding errors.*' | ||
| } | ||
|
|
||
| It 'fails when no localized resource files exist' { | ||
| $resources = New-ResourcesDirectory | ||
| Set-ResourceFile (Join-Path $resources 'Strings.resx') @{ Greeting = 'Hello' } | ||
|
|
||
| { & $scriptPath -ResourcesDirectory $resources } | | ||
| Should -Throw '*No localized Strings.*.resx files were found*' | ||
| } | ||
|
|
||
| It 'fails when a non-empty English string has an empty localized value' { | ||
| $resources = New-ResourcesDirectory | ||
| Set-ResourceFile (Join-Path $resources 'Strings.resx') @{ Greeting = 'Hello' } | ||
| Set-ResourceFile (Join-Path $resources 'Strings.es.resx') @{ Greeting = ' ' } | ||
|
|
||
| { & $scriptPath -ResourcesDirectory $resources } | | ||
| Should -Throw '*Localization validation failed with 1 error. Review the preceding errors.*' | ||
| } | ||
|
|
||
| It 'accepts empty localized values when the English value is also empty' { | ||
| $resources = New-ResourcesDirectory | ||
| Set-ResourceFile (Join-Path $resources 'Strings.resx') @{ Unused = '' } | ||
| Set-ResourceFile (Join-Path $resources 'Strings.ko.resx') @{ Unused = '' } | ||
|
|
||
| { & $scriptPath -ResourcesDirectory $resources } | Should -Not -Throw | ||
| } | ||
|
|
||
| It 'fails when a resource data element has no value' { | ||
| $resources = New-ResourcesDirectory | ||
| Set-ResourceFile (Join-Path $resources 'Strings.resx') @{ Greeting = 'Hello' } | ||
| Set-ResourceFile (Join-Path $resources 'Strings.fr.resx') @{ Greeting = 'Bonjour' } | ||
| [xml]$localized = Get-Content -LiteralPath (Join-Path $resources 'Strings.fr.resx') | ||
| $valueNode = $localized.SelectSingleNode('/root/data/value') | ||
| $null = $valueNode.ParentNode.RemoveChild($valueNode) | ||
| $localized.Save((Join-Path $resources 'Strings.fr.resx')) | ||
|
|
||
| { & $scriptPath -ResourcesDirectory $resources } | | ||
| Should -Throw '*contains a <data> element without a name or value*' | ||
| } | ||
|
|
||
| It 'accepts an approved English-value match from the allowlist' { | ||
| $resources = New-ResourcesDirectory | ||
| $allowlist = Join-Path $resources 'allowlist.json' | ||
| Set-ResourceFile (Join-Path $resources 'Strings.resx') @{ Greeting = 'Hello' } | ||
| Set-ResourceFile (Join-Path $resources 'Strings.fr.resx') @{ Greeting = 'Hello' } | ||
| @{ AllowedEnglishValueMatches = @{ 'Strings.fr.resx' = @('Greeting') } } | | ||
| ConvertTo-Json -Depth 5 | | ||
| Set-Content -LiteralPath $allowlist | ||
|
|
||
| { & $scriptPath -ResourcesDirectory $resources -AllowlistPath $allowlist } | | ||
| Should -Not -Throw | ||
| } | ||
|
|
||
| It 'does not allowlist a missing localized key' { | ||
| $resources = New-ResourcesDirectory | ||
| $allowlist = Join-Path $resources 'allowlist.json' | ||
| Set-ResourceFile (Join-Path $resources 'Strings.resx') @{ Greeting = 'Hello'; Farewell = 'Goodbye' } | ||
| Set-ResourceFile (Join-Path $resources 'Strings.fr.resx') @{ Greeting = 'Bonjour' } | ||
| @{ AllowedEnglishValueMatches = @{ 'Strings.fr.resx' = @('Farewell') } } | | ||
| ConvertTo-Json -Depth 5 | | ||
| Set-Content -LiteralPath $allowlist | ||
|
|
||
| { & $scriptPath -ResourcesDirectory $resources -AllowlistPath $allowlist } | | ||
| Should -Throw '*Localization validation failed with 1 error. Review the preceding errors.*' | ||
| } | ||
|
|
||
| It 'rejects allowlist for unknown resource keys' { | ||
| $resources = New-ResourcesDirectory | ||
| $allowlist = Join-Path $resources 'allowlist.json' | ||
| Set-ResourceFile (Join-Path $resources 'Strings.resx') @{ Greeting = 'Hello' } | ||
| Set-ResourceFile (Join-Path $resources 'Strings.fr.resx') @{ Greeting = 'Bonjour' } | ||
| @{ AllowedEnglishValueMatches = @{ 'Strings.fr.resx' = @('Unknown') } } | | ||
| ConvertTo-Json -Depth 5 | | ||
| Set-Content -LiteralPath $allowlist | ||
|
|
||
| { & $scriptPath -ResourcesDirectory $resources -AllowlistPath $allowlist } | | ||
| Should -Throw '*Localization validation failed with 1 error. Review the preceding errors.*' | ||
| } | ||
|
|
||
| It 'scopes approved English-value matches to one localized file' { | ||
| $resources = New-ResourcesDirectory | ||
| $allowlist = Join-Path $resources 'allowlist.json' | ||
| Set-ResourceFile (Join-Path $resources 'Strings.resx') @{ Greeting = 'Hello' } | ||
| Set-ResourceFile (Join-Path $resources 'Strings.de.resx') @{ Greeting = 'Hello' } | ||
| Set-ResourceFile (Join-Path $resources 'Strings.fr.resx') @{ Greeting = 'Hello' } | ||
| @{ AllowedEnglishValueMatches = @{ 'Strings.de.resx' = @('Greeting') } } | | ||
| ConvertTo-Json -Depth 5 | | ||
| Set-Content -LiteralPath $allowlist | ||
|
|
||
| { & $scriptPath -ResourcesDirectory $resources -AllowlistPath $allowlist } | | ||
| Should -Throw '*Localization validation failed with 1 error. Review the preceding errors.*' | ||
| } | ||
|
|
||
| It 'fails when a localized file contains a key absent from Strings.resx' { | ||
| $resources = New-ResourcesDirectory | ||
| Set-ResourceFile (Join-Path $resources 'Strings.resx') @{ Greeting = 'Hello' } | ||
| Set-ResourceFile (Join-Path $resources 'Strings.fr.resx') @{ Greeting = 'Bonjour'; Obsolete = 'Ancien' } | ||
|
|
||
| { & $scriptPath -ResourcesDirectory $resources } | | ||
| Should -Throw '*Localization validation failed with 1 error. Review the preceding errors.*' | ||
| } | ||
|
|
||
| It 'rejects an allowlist entry after the localized value is translated' { | ||
| $resources = New-ResourcesDirectory | ||
| $allowlist = Join-Path $resources 'allowlist.json' | ||
| Set-ResourceFile (Join-Path $resources 'Strings.resx') @{ Greeting = 'Hello' } | ||
| Set-ResourceFile (Join-Path $resources 'Strings.fr.resx') @{ Greeting = 'Bonjour' } | ||
| @{ AllowedEnglishValueMatches = @{ 'Strings.fr.resx' = @('Greeting') } } | | ||
| ConvertTo-Json -Depth 5 | | ||
| Set-Content -LiteralPath $allowlist | ||
|
|
||
| { & $scriptPath -ResourcesDirectory $resources -AllowlistPath $allowlist } | | ||
| Should -Throw '*Localization validation failed with 1 error. Review the preceding errors.*' | ||
| } | ||
|
|
||
| It 'rejects allowlist entries for empty English values' { | ||
| $resources = New-ResourcesDirectory | ||
| $allowlist = Join-Path $resources 'allowlist.json' | ||
| Set-ResourceFile (Join-Path $resources 'Strings.resx') @{ Unused = '' } | ||
| Set-ResourceFile (Join-Path $resources 'Strings.fr.resx') @{ Unused = '' } | ||
| @{ AllowedEnglishValueMatches = @{ 'Strings.fr.resx' = @('Unused') } } | | ||
| ConvertTo-Json -Depth 5 | | ||
| Set-Content -LiteralPath $allowlist | ||
|
|
||
| { & $scriptPath -ResourcesDirectory $resources -AllowlistPath $allowlist } | | ||
| Should -Throw '*does not have a non-empty English value*' | ||
| } | ||
| } |
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.
Uh oh!
There was an error while loading. Please reload this page.