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