1 /*
2 * Copyright (c) 2007, 2015, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 */
23 /*
24 * @test
25 * @bug 4052473 4052679 4055602 4066550 4067619 4068012 4068073 4070174 4070452
26 * 4070178 4070450 4070695 4070725 4070795 4071003 4071183 4071782 4072013
27 * 4072388 4072773 4075404 4084356 4087238 4092361 4094033 4094371 4098518
28 * 4099810 4103218 4103220 4103861 4112136 4113638 4113654 4117054 4122468
29 * 4122840 4139860 4156708 4175306 4215747 4209960 4290801 4900884 4942982
30 * 4518811 4945388 4936845 4794068 4461740 4965260 4984277 4826794 5032580
31 * 5102005 5074431 6182685 6208712 6277020 6245766 6351682 6386647 6379382
32 * 6414459 6455680 6498742 6558863 6488119 6547501 6497154 6558856 6481177
33 * 6379214 6485516 6486607 4225362 4494727 6533691 6531591 6531593 6570259
34 * 6509039 6609737 6610748 6645271 6507067 6873931 6450945 6645268 6646611
35 * 6645405 6650730 6910489 6573250 6870908 6585666 6716626 6914413 6916787
36 * 6919624 6998391 7019267 7020960 7025837 7020583 7036905 7066203 7101495
37 * 7003124 7085757 7028073 7171028 7189611 8000983 7195759 8004489 8006509
38 * 7114053 7074882 7040556 8008577 8013836 8021121 6192407 6931564 8027695
39 * 8017142 8037343 8055222 8042126 8074791 8075173
40 * @summary Verify locale data
41 * @run main LocaleDataTest
42 * @run main LocaleDataTest -cldr
43 *
44 */
45
46 /*
47 *
48 * (C) Copyright Taligent, Inc. 1996, 1997 - All Rights Reserved
49 * (C) Copyright IBM Corp. 1996 - 1998 - All Rights Reserved
50 *
51 * Portions copyright (c) 2007 Sun Microsystems, Inc.
52 * All Rights Reserved.
53 *
54 * The original version of this source code and documentation
55 * is copyrighted and owned by Taligent, Inc., a wholly-owned
56 * subsidiary of IBM. These materials are provided under terms
57 * of a License Agreement between Taligent and Sun. This technology
58 * is protected by multiple US and International patents.
59 *
60 * This notice and attribution to Taligent may not be removed.
61 * Taligent is a registered trademark of Taligent, Inc.
62 *
63 * Permission to use, copy, modify, and distribute this software
64 * and its documentation for NON-COMMERCIAL purposes and without
65 * fee is hereby granted provided that this copyright notice
66 * appears in all copies. Please refer to the file "copyright.html"
67 * for further important copyright and licensing information.
68 *
69 * SUN MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF
70 * THE SOFTWARE, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
71 * TO THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
72 * PARTICULAR PURPOSE, OR NON-INFRINGEMENT. SUN SHALL NOT BE LIABLE FOR
73 * ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
74 * DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES.
75 *
76 */
77
78 /* This test is a generalized test for verifying changes to the locale data.
79 * It is driven by an external file that specifies the particular pieces of locale
80 * data to check. That file is in .properties file format: a series of key/value
81 * pairs delimited by newline characters, with the keys separated from the values
82 * by = signs. The keys are similar in syntax to a Unix pathname, with keys at
83 * successive levels of containment in the resource-data hierarchy separated by
84 * slashes. The file is in ISO 8859-1 encoding, with control characters and
85 * non-ASCII characters denoted with backslash-u escape sequences. The program also allows
86 * blank lines and comment lines to be interspersed with the data. Comment lines
87 * begin with '#'.
88 *
89 * A data file for this test would look something like this:<pre>
90 * FormatData//MonthNames/0=January
91 * FormatData//MonthNames/1=February
92 * LocaleNames//US=United States
93 * LocaleNames//FR=France
94 * FormatData/fr_FR/MonthNames/0=janvier
95 * FormatData/fr_FR/MonthNames/1=f\u00e9vrier
96 * LocaleNames/fr_FR/US=\u00c9tats-Unis
97 * LocaleNames/fr_FR/FR=France</pre>
98 *
99 * You can use language tag with '-' in locale field like this:<pre>
100 * LocaleNames/sr-Latn/SR=Surinam
101 * FormatData/sr-Latn-BA/DayNames/2=utorak</pre>
102 *
103 * The command-line syntax of this test is
104 * <tt>java LocaleDataTest [-w] [{ -s | <filename> }] [-cldr]</tt>
105 *
106 * This program always sends its results to standard output. If -w is not specified,
107 * this program prints out only the differences between the data file and the actual
108 * resource data. If -w is specified, the program prints out every entry, comment,
109 * and blank line from the data file. Where there is a difference between the data
110 * file and the resource data, the data is the data from the resources. This feature
111 * can be used to quickly generate a new data file.
112 *
113 * The user can specify an optional filename or -s. If the user specifies a filename,
114 * the program uses that file as the data file. If the user specifies -s, the program
115 * reads its input from standard input rather than from a file. If the user specifies
116 * neither, the program reads its input from a file called LocaleData in the same
117 * directory the program itself resides in.
118 *
119 * The -nothrow option prevents the program from throwing an exception when it
120 * gets an error. -w implies -nothrow.
121 *
122 * -cldr option specifies to test CLDR locale data. The default data file name for this
123 * option is "CLDRLocaleData".
124 *
125 * Other command-line options can be specified, but are ignored.
126 *
127 * It's important to note what this test will NOT test. Certain changes to the locale
128 * data are meant to have certain effects on the internationalization frameworks. For
129 * instance, we could ensure round-trip formatting/parsing integrity for the full
130 * date/time format of SimpleDateFormat by making sure that the full date and time
131 * patterns include sufficient data. The test of this is not whether changes were
132 * made to the locale data; it's whether using this data gives round-trip integrity.
133 * Likewise, changing the currency patterns to use \u00a4 instead of local currency
134 * symbols isn't something that can be tested by this test; instead, you want to
135 * actually format currency values and make sure the proper currency symbol was used.
136 *
137 * This test by itself doesn't do an exhaustive comparison of locale data. It is
138 * possible to do this manually, however: Use the GenerateKeyList tool to produce
139 * a complete list of keys for the two versions of the locales you want to compare,
140 * and then diff them. This will flag additions and deletions. Generate a data file
141 * for the base version of the data using the -w option and the output from
142 * GenerateKeyList, and then use the resultant file as the data file when you run
143 * this test against the new version of the data.
144 */
145
146 import java.io.*;
147 import java.text.*;
148 import java.util.Locale;
149 import java.util.ResourceBundle;
150 import java.util.ResourceBundle.Control;
151 import java.util.MissingResourceException;
152
153 public class LocaleDataTest
154 {
155 static final String TEXT_RESOURCES_PACKAGE ="sun.text.resources";
156 static final String UTIL_RESOURCES_PACKAGE ="sun.util.resources";
157 static final String DEFAULT_DATAFILE ="LocaleData";
158 static String cldrSuffix = "";
159
160 public static void main(String[] args) throws Exception {
161
162 // set up our flags and our input and output streams based on the
163 // command-line arguments (exceptions generated here will propagate out
164 // to the environment)
165 BufferedReader in = null;
166 PrintWriter out = null;
167 boolean writeNewFile = false;
168 boolean doThrow = true;
169
170 for (int i = 0; i < args.length; i++) {
171 if (args[i].equals("-w")) {
172 writeNewFile = true;
173 doThrow = false;
174 }
175
176 else if (args[i].equals("-nothrow"))
177 doThrow = false;
178
179 else if (args[i].equals("-cldr")) {
180 cldrSuffix = ".cldr";
181 }
182
183 else if (args[i].equals("-s") && in == null)
184 in = new BufferedReader(new EscapeReader(new InputStreamReader(System.in,
185 "ISO8859_1")));
186 else if (!args[i].startsWith("-") && in == null)
187 in = new BufferedReader(new EscapeReader(new InputStreamReader(new
188 FileInputStream(args[i]), "ISO8859_1")));
189 }
190 if (in == null) {
191 File localeData = new File(System.getProperty("test.src", "."), DEFAULT_DATAFILE + cldrSuffix);
192 in = new BufferedReader(new EscapeReader(new InputStreamReader(new
193 FileInputStream(localeData), "ISO8859_1")));
194 }
195 out = new PrintWriter(new EscapeWriter(new OutputStreamWriter(System.out,
196 "ISO8859_1")), true);
197
198 // perform the actual test
199 int errorCount = doTest(in, out, writeNewFile);
200
201 // write out the error count, and throw an exception out into the environment
202 // if there were any errors
203 if (errorCount != 0) {
204 if (!writeNewFile)
205 out.println("Test failed. " + errorCount + " errors.");
206 if (doThrow)
207 throw new Exception("Test failed. " + errorCount + " errors.");
208 }
209 else if (!writeNewFile)
210 out.println("Test passed.");
211
212 in.close();
213 out.close();
214 }
215
216 static int doTest(BufferedReader in, PrintWriter out, boolean writeNewFile)
217 throws Exception {
218 int errorCount = 0;
219
220 String key = null;
221 String expectedValue = null;
222 String line = in.readLine();
223 while (line != null) {
224 if (line.startsWith("#") || line.length() == 0) {
225 if (writeNewFile)
226 out.println(line);
227 }
228
229 else {
230 int index = line.indexOf("=");
231 if (index == -1) {
232 key = line;
233 expectedValue = "";
234 }
235 else {
236 key = line.substring(0, index);
237 if (index + 1 == line.length())
238 expectedValue = "";
239 else
240 expectedValue = line.substring(index + 1);
241 }
242 if (!processLine(key, expectedValue, out, writeNewFile))
243 ++errorCount;
244 }
245 line = in.readLine();
246 }
247 return errorCount;
248 }
249
250 static boolean processLine(String key, String expectedValue, PrintWriter out,
251 boolean writeNewFile) throws Exception {
252 String rbName, localeName, resTag, qualifier;
253 String language = "", country = "", variant = "";
254 int index, oldIndex;
255
256 index = key.indexOf("/");
257 if (index == -1 || index + 1 == key.length())
258 throw new Exception("Malformed input file: no slashes in \"" + key + "\"");
259 rbName = key.substring(0, index);
260
261 oldIndex = index + 1;
262 index = key.indexOf("/", oldIndex);
263 if (index == -1 || index + 1 == key.length())
264 throw new Exception("Malformed input file: \"" + key + "\" is missing locale name");
265 localeName = key.substring(oldIndex, index);
266 boolean use_tag = localeName.indexOf("-") != -1;
267
268 if (use_tag == false && localeName.length() > 0) {
269 language = localeName.substring(0, 2);
270 if (localeName.length() > 3) {
271 country = localeName.substring(3, 5);
272 if (localeName.length() > 5)
273 variant = localeName.substring(6);
274 }
275 }
276
277 oldIndex = index + 1;
278 index = key.indexOf("/", oldIndex);
279 if (index == -1)
280 index = key.length();
281 resTag = key.substring(oldIndex, index);
282
283 // TimeZone name may have "/" in it, for example "Asia/Taipei", so use "Asia\/Taipei in LocaleData.
284 if(resTag.endsWith("\\")) {
285 resTag = resTag.substring(0, resTag.length() - 1);
286 oldIndex = index;
287 index = key.indexOf("/", oldIndex + 1);
288 if (index == -1) index = key.length();
289 resTag += key.substring(oldIndex, index);
290 }
291
292 if (index < key.length() - 1)
293 qualifier = key.substring(index + 1);
294 else
295 qualifier = "";
296
297 String retrievedValue = null;
298 Object resource = null;
299 try {
300 String fullName = null;
301 if (rbName.equals("CalendarData")
302 || rbName.equals("CurrencyNames")
303 || rbName.equals("LocaleNames")
304 || rbName.equals("TimeZoneNames")) {
305 fullName = UTIL_RESOURCES_PACKAGE + cldrSuffix + "." + rbName;
306 } else {
307 fullName = TEXT_RESOURCES_PACKAGE + cldrSuffix + "." + rbName;
308 }
309 Locale locale;
310 if (use_tag) {
311 locale = Locale.forLanguageTag(localeName);
312 } else {
313 locale = new Locale(language, country, variant);
314 }
315 ResourceBundle bundle = ResourceBundle.getBundle(fullName,
316 locale,
317 JRELocaleResourceBundleControl.INSTANCE);
318 resource = bundle.getObject(resTag);
319 }
320 catch (MissingResourceException e) {
321 }
322
323 if (resource != null) {
324 if (resource instanceof String) {
325 retrievedValue = (String)resource;
326 }
327 else if (resource instanceof String[]) {
328 int element = Integer.valueOf(qualifier).intValue();
329 String[] stringList = (String[])resource;
330 if (element >= 0 && element < stringList.length)
331 retrievedValue = stringList[element];
332 }
333 else if (resource instanceof String[][]) {
334 String[][] stringArray = (String[][])resource;
335 int slash = qualifier.indexOf("/");
336 if (slash == -1) {
337 for (int i = 0; i < stringArray.length; i++) {
338 if (stringArray[i][0].equals(qualifier))
339 retrievedValue = stringArray[i][1];
340 }
341 }
342 else {
343 int row = Integer.valueOf(qualifier.substring(0, slash)).intValue();
344 int column = Integer.valueOf(qualifier.substring(slash + 1)).intValue();
345 if (row >= 0 && row < stringArray.length && column >= 0 && column <
346 stringArray[row].length)
347 retrievedValue = stringArray[row][column];
348 }
349 }
350 }
351
352 if (retrievedValue == null || !retrievedValue.equals(expectedValue)) {
353 if (retrievedValue == null)
354 retrievedValue = "<MISSING!>";
355
356 if (writeNewFile)
357 out.println(key + "=" + retrievedValue);
358 else {
359 out.println("Mismatch in " + key + ":");
360 out.println(" file = \"" + expectedValue + "\"");
361 out.println(" jvm = \"" + retrievedValue + "\"");
362 }
363 return false;
364 }
365 else {
366 if (writeNewFile)
367 out.println(key + "=" + expectedValue);
368 }
369 return true;
370 }
371
372 private static class JRELocaleResourceBundleControl extends ResourceBundle.Control {
373 static final JRELocaleResourceBundleControl INSTANCE = new JRELocaleResourceBundleControl();
374
375 private JRELocaleResourceBundleControl() {
376 }
377
378 @Override
379 public Locale getFallbackLocale(String baseName, Locale locale) {
380 if (baseName == null || locale == null) {
381 throw new NullPointerException();
382 }
383 return null;
384 }
385
386 /**
387 * Changes baseName to its per-language/country package name and
388 * calls the super class implementation. For example,
389 * if the baseName is "sun.text.resources.FormatData" and locale is ja_JP,
390 * the baseName is changed to "sun.text.resources.ja.JP.FormatData". If
391 * baseName contains "cldr", such as "sun.text.resources.cldr.FormatData",
392 * the name is changed to "sun.text.resources.cldr.ja.JP.FormatData".
393 */
394 @Override
395 public String toBundleName(String baseName, Locale locale) {
396 String newBaseName = baseName;
397 String lang = locale.getLanguage();
398 String ctry = locale.getCountry();
399 if (lang.length() > 0) {
400 if (baseName.startsWith(UTIL_RESOURCES_PACKAGE + cldrSuffix)
401 || baseName.startsWith(TEXT_RESOURCES_PACKAGE + cldrSuffix)) {
402 // Assume the lengths are the same.
403 if (UTIL_RESOURCES_PACKAGE.length()
404 != TEXT_RESOURCES_PACKAGE.length()) {
405 throw new InternalError("The resources package names have different lengths.");
406 }
407 int index = (TEXT_RESOURCES_PACKAGE + cldrSuffix).length();
408 ctry = (ctry.length() == 2) ? ("." + ctry) : "";
409 newBaseName = baseName.substring(0, index + 1) + lang + ctry
410 + baseName.substring(index);
411 }
412 }
413 return super.toBundleName(newBaseName, locale);
414 }
415 }
416 }
417
418 class EscapeReader extends FilterReader {
419 public EscapeReader(Reader in) {
420 super(in);
421 }
422
423 public int read() throws IOException {
424 if (buffer != null) {
425 String b = buffer.toString();
426 int result = b.charAt(0);
427 if (b.length() > 1)
428 buffer = new StringBuffer(b.substring(1));
429 else
430 buffer = null;
431 return result;
432 }
433 else {
434 int result = super.read();
435 if (result != '\\')
436 return result;
437 else {
438 buffer = new StringBuffer();
439 result = super.read();
440 buffer.append((char)result);
441 if (result == 'u') {
442 for (int i = 0; i < 4; i++) {
443 result = super.read();
444 if (result == -1)
445 break;
446 buffer.append((char)result);
447 }
448 String number = buffer.toString().substring(1);
449 result = Integer.parseInt(number, 16);
450 buffer = null;
451 return result;
452 }
453 return '\\';
454 }
455 }
456 }
457
458 public int read(char[] cbuf, int start, int len) throws IOException {
459 int p = start;
460 int end = start + len;
461 int c = 0;
462 while (c != -1 && p < end) {
463 c = read();
464 if (c != -1)
465 cbuf[p++] = (char)c;
466 }
467 if (c == -1 && p == start)
468 return -1;
469 else
470 return p - start;
471 }
472
473 private StringBuffer buffer = null;
474 }
475
476 class EscapeWriter extends FilterWriter {
477 public EscapeWriter(Writer out) {
478 super(out);
479 }
480
481 public void write(int c) throws IOException {
482 if ((c >= ' ' && c <= '\u007e') || c == '\r' || c == '\n')
483 super.write(c);
484 else {
485 super.write('\\');
486 super.write('u');
487 String number = Integer.toHexString(c);
488 if (number.length() < 4)
489 number = zeros.substring(0, 4 - number.length()) + number;
490 super.write(number.charAt(0));
491 super.write(number.charAt(1));
492 super.write(number.charAt(2));
493 super.write(number.charAt(3));
494 }
495 }
496
497 public void write(char[] cbuf, int off, int len) throws IOException {
498 int end = off + len;
499 while (off < end)
500 write(cbuf[off++]);
501 }
502
503 public void write(String str, int off, int len) throws IOException {
504 int end = off + len;
505 while (off < end)
506 write(str.charAt(off++));
507 }
508
509 private static String zeros = "0000";
510 }