SqlClient/eng/pipelines/onebranch/scripts/tests/validate-localization.Tests.ps1 at 11d85ba6117b5c09ec6ae95bed39f4d768f522e1 · dotnet/SqlClient · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
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*'
    }
}