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