changeset 596:d2b7ecf33b35

6964768: need test program to validate javac resource bundles Reviewed-by: darcy
author jjg
date Wed, 30 Jun 2010 18:06:29 -0700
parents 6386f0fd6205
children 064468702a8d
files src/share/classes/com/sun/tools/javac/code/Kinds.java src/share/classes/com/sun/tools/javac/main/JavaCompiler.java src/share/classes/com/sun/tools/javac/parser/Scanner.java src/share/classes/com/sun/tools/javac/resources/compiler.properties test/tools/javac/diags/CheckResourceKeys.java test/tools/javac/literals/BadUnderscoreLiterals.6.out
diffstat 6 files changed, 377 insertions(+), 6 deletions(-) [+]
line wrap: on
line diff
--- a/src/share/classes/com/sun/tools/javac/code/Kinds.java	Tue Jun 29 12:06:46 2010 -0700
+++ b/src/share/classes/com/sun/tools/javac/code/Kinds.java	Wed Jun 30 18:06:29 2010 -0700
@@ -92,7 +92,7 @@
     public static final int ABSENT_TYP   = ERRONEOUS+8; // missing type
 
     public enum KindName implements Formattable {
-        ANNOTATION("kindname.interface"),
+        ANNOTATION("kindname.annotation"),
         CONSTRUCTOR("kindname.constructor"),
         INTERFACE("kindname.interface"),
         ENUM("kindname.enum"),
--- a/src/share/classes/com/sun/tools/javac/main/JavaCompiler.java	Tue Jun 29 12:06:46 2010 -0700
+++ b/src/share/classes/com/sun/tools/javac/main/JavaCompiler.java	Wed Jun 30 18:06:29 2010 -0700
@@ -111,14 +111,14 @@
             try {
                 versionRB = ResourceBundle.getBundle(versionRBName);
             } catch (MissingResourceException e) {
-                return Log.getLocalizedString("version.resource.missing", System.getProperty("java.version"));
+                return Log.getLocalizedString("version.not.available");
             }
         }
         try {
             return versionRB.getString(key);
         }
         catch (MissingResourceException e) {
-            return Log.getLocalizedString("version.unknown", System.getProperty("java.version"));
+            return Log.getLocalizedString("version.not.available");
         }
     }
 
--- a/src/share/classes/com/sun/tools/javac/parser/Scanner.java	Tue Jun 29 12:06:46 2010 -0700
+++ b/src/share/classes/com/sun/tools/javac/parser/Scanner.java	Wed Jun 30 18:06:29 2010 -0700
@@ -419,7 +419,7 @@
                 putChar(ch);
             } else {
                 if (!allowUnderscoresInLiterals) {
-                    lexError("unsupported.underscore", source.name);
+                    lexError("unsupported.underscore.lit", source.name);
                     allowUnderscoresInLiterals = true;
                 }
             }
--- a/src/share/classes/com/sun/tools/javac/resources/compiler.properties	Tue Jun 29 12:06:46 2010 -0700
+++ b/src/share/classes/com/sun/tools/javac/resources/compiler.properties	Wed Jun 30 18:06:29 2010 -0700
@@ -637,6 +637,9 @@
 compiler.misc.count.warn.plural=\
     {0} warnings
 
+compiler.misc.version.not.available=\
+    (version info not available)
+
 ## extra output when using -verbose (JavaCompiler)
 
 compiler.misc.verbose.checking.attribution=\
@@ -1036,7 +1039,7 @@
 ## diagnostics whose key ends in ".1"
 compiler.misc.undetermined.type=\
     undetermined type
-ncompiler.misc.type.variable.has.undetermined.type=\
+compiler.misc.type.variable.has.undetermined.type=\
     type variable {0} has undetermined type
 compiler.misc.no.unique.maximal.instance.exists=\
     no unique maximal instance exists for type variable {0} with upper bounds {1}
@@ -1122,6 +1125,8 @@
     @interface
 compiler.misc.kindname.constructor=\
     constructor
+compiler.misc.kindname.enum=\
+    enum
 compiler.misc.kindname.interface=\
     interface
 compiler.misc.kindname.static=\
@@ -1256,6 +1261,10 @@
     enums are not supported in -source {0}\n\
 (use -source 5 or higher to enable enums)
 
+compiler.err.diamond.not.supported.in.source=\
+    diamond operator is not supported in -source {0}\n\
+(use -source 7 or higher to enable multi-catch statement)
+
 compiler.err.multicatch.not.supported.in.source=\
     multi-catch statement is not supported in -source {0}\n\
 (use -source 7 or higher to enable multi-catch statement)
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/test/tools/javac/diags/CheckResourceKeys.java	Wed Jun 30 18:06:29 2010 -0700
@@ -0,0 +1,362 @@
+/*
+ * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+/*
+ * @test
+ * @bug 6964768 6964461 6964469 6964487 6964460 6964481
+ * @summary need test program to validate javac resource bundles
+ */
+
+import java.io.*;
+import java.util.*;
+import javax.tools.*;
+import com.sun.tools.classfile.*;
+
+/**
+ * Compare string constants in javac classes against keys in javac resource bundles.
+ */
+public class CheckResourceKeys {
+    /**
+     * Main program.
+     * Options:
+     * -finddeadkeys
+     *      look for keys in resource bundles that are no longer required
+     * -findmissingkeys
+     *      look for keys in resource bundles that are missing
+     *
+     * @throws Exception if invoked by jtreg and errors occur
+     */
+    public static void main(String... args) throws Exception {
+        CheckResourceKeys c = new CheckResourceKeys();
+        if (c.run(args))
+            return;
+
+        if (is_jtreg())
+            throw new Exception(c.errors + " errors occurred");
+        else
+            System.exit(1);
+    }
+
+    static boolean is_jtreg() {
+        return (System.getProperty("test.src") != null);
+    }
+
+    /**
+     * Main entry point.
+     */
+    boolean run(String... args) throws Exception {
+        boolean findDeadKeys = false;
+        boolean findMissingKeys = false;
+
+        if (args.length == 0) {
+            if (is_jtreg()) {
+                findDeadKeys = true;
+                findMissingKeys = true;
+            } else {
+                System.err.println("Usage: java CheckResourceKeys <options>");
+                System.err.println("where options include");
+                System.err.println("  -finddeadkeys      find keys in resource bundles which are no longer required");
+                System.err.println("  -findmissingkeys   find keys in resource bundles that are required but missing");
+                return true;
+            }
+        } else {
+            for (String arg: args) {
+                if (arg.equalsIgnoreCase("-finddeadkeys"))
+                    findDeadKeys = true;
+                else if (arg.equalsIgnoreCase("-findmissingkeys"))
+                    findMissingKeys = true;
+                else
+                    error("bad option: " + arg);
+            }
+        }
+
+        if (errors > 0)
+            return false;
+
+        Set<String> codeStrings = getCodeStrings();
+        Set<String> resourceKeys = getResourceKeys();
+
+        if (findDeadKeys)
+            findDeadKeys(codeStrings, resourceKeys);
+
+        if (findMissingKeys)
+            findMissingKeys(codeStrings, resourceKeys);
+
+        return (errors == 0);
+    }
+
+    /**
+     * Find keys in resource bundles which are probably no longer required.
+     * A key is probably required if there is a string fragment in the code
+     * that is part of the resource key, or if the key is well-known
+     * according to various pragmatic rules.
+     */
+    void findDeadKeys(Set<String> codeStrings, Set<String> resourceKeys) {
+        String[] prefixes = {
+            "compiler.err.", "compiler.warn.", "compiler.note.", "compiler.misc.",
+            "javac."
+        };
+        for (String rk: resourceKeys) {
+            // some keys are used directly, without a prefix.
+            if (codeStrings.contains(rk))
+                continue;
+
+            // remove standard prefix
+            String s = null;
+            for (int i = 0; i < prefixes.length && s == null; i++) {
+                if (rk.startsWith(prefixes[i])) {
+                    s = rk.substring(prefixes[i].length());
+                }
+            }
+            if (s == null) {
+                error("Resource key does not start with a standard prefix: " + rk);
+                continue;
+            }
+
+            if (codeStrings.contains(s))
+                continue;
+
+            // keys ending in .1 are often synthesized
+            if (s.endsWith(".1") && codeStrings.contains(s.substring(0, s.length() - 2)))
+                continue;
+
+            // verbose keys are generated by ClassReader.printVerbose
+            if (s.startsWith("verbose.") && codeStrings.contains(s.substring(8)))
+                continue;
+
+            // mandatory warning messages are synthesized with no characteristic substring
+            if (isMandatoryWarningString(s))
+                continue;
+
+            // check known (valid) exceptions
+            if (knownRequired.contains(rk))
+                continue;
+
+            // check known suspects
+            if (needToInvestigate.contains(rk))
+                continue;
+
+            error("Resource key not found in code: " + rk);
+        }
+    }
+
+    /**
+     * The keys for mandatory warning messages are all synthesized and do not
+     * have a significant recognizable substring to look for.
+     */
+    private boolean isMandatoryWarningString(String s) {
+        String[] bases = { "deprecated", "unchecked", "varargs", "sunapi" };
+        String[] tails = { ".filename", ".filename.additional", ".plural", ".plural.additional", ".recompile" };
+        for (String b: bases) {
+            if (s.startsWith(b)) {
+                String tail = s.substring(b.length());
+                for (String t: tails) {
+                    if (tail.equals(t))
+                        return true;
+                }
+            }
+        }
+        return false;
+    }
+
+    Set<String> knownRequired = new TreeSet<String>(Arrays.asList(
+        // See Resolve.getErrorKey
+        "compiler.err.cant.resolve.args",
+        "compiler.err.cant.resolve.args.params",
+        "compiler.err.cant.resolve.location.args",
+        "compiler.err.cant.resolve.location.args.params",
+        // JavaCompiler, reports #errors and #warnings
+        "compiler.misc.count.error",
+        "compiler.misc.count.error.plural",
+        "compiler.misc.count.warn",
+        "compiler.misc.count.warn.plural",
+        // Used for LintCategory
+        "compiler.warn.lintOption",
+        // Other
+        "compiler.misc.base.membership"                                 // (sic)
+        ));
+
+
+    Set<String> needToInvestigate = new TreeSet<String>(Arrays.asList(
+        "compiler.err.cant.read.file",                      // UNUSED
+        "compiler.err.illegal.self.ref",                    // UNUSED
+        "compiler.err.io.exception",                        // UNUSED
+        "compiler.err.limit.pool.in.class",                 // UNUSED
+        "compiler.err.name.reserved.for.internal.use",      // UNUSED
+        "compiler.err.no.match.entry",                      // UNUSED
+        "compiler.err.not.within.bounds.explain",           // UNUSED
+        "compiler.err.signature.doesnt.match.intf",         // UNUSED
+        "compiler.err.signature.doesnt.match.supertype",    // UNUSED
+        "compiler.err.type.var.more.than.once",             // UNUSED
+        "compiler.err.type.var.more.than.once.in.result",   // UNUSED
+        "compiler.misc.ccf.found.later.version",            // UNUSED
+        "compiler.misc.non.denotable.type",                 // UNUSED
+        "compiler.misc.unnamed.package",                    // should be required, CR 6964147
+        "compiler.misc.verbose.retro",                      // UNUSED
+        "compiler.misc.verbose.retro.with",                 // UNUSED
+        "compiler.misc.verbose.retro.with.list",            // UNUSED
+        "compiler.warn.proc.type.already.exists",           // TODO in JavacFiler
+        "javac.err.invalid.arg",                            // UNUSED ??
+        "javac.opt.arg.class",                              // UNUSED ??
+        "javac.opt.arg.pathname",                           // UNUSED ??
+        "javac.opt.moreinfo",                               // option commented out
+        "javac.opt.nogj",                                   // UNUSED
+        "javac.opt.printflat",                              // option commented out
+        "javac.opt.printsearch",                            // option commented out
+        "javac.opt.prompt",                                 // option commented out
+        "javac.opt.retrofit",                               // UNUSED
+        "javac.opt.s",                                      // option commented out
+        "javac.opt.scramble",                               // option commented out
+        "javac.opt.scrambleall"                             // option commented out
+        ));
+
+    /**
+     * For all strings in the code that look like they might be fragments of
+     * a resource key, verify that a key exists.
+     */
+    void findMissingKeys(Set<String> codeStrings, Set<String> resourceKeys) {
+        for (String cs: codeStrings) {
+            if (cs.matches("[A-Za-z][^.]*\\..*")) {
+                // ignore filenames (i.e. in SourceFile attribute
+                if (cs.matches(".*\\.java"))
+                    continue;
+                // ignore package and class names
+                if (cs.matches("(com|java|javax|sun)\\.[A-Za-z.]+"))
+                    continue;
+                // explicit known exceptions
+                if (noResourceRequired.contains(cs))
+                    continue;
+                // look for matching resource
+                if (hasMatch(resourceKeys, cs))
+                    continue;
+                error("no match for \"" + cs + "\"");
+            }
+        }
+    }
+    // where
+    private Set<String> noResourceRequired = new HashSet<String>(Arrays.asList(
+            // system properties
+            "application.home", // in Paths.java
+            "env.class.path",
+            "line.separator",
+            "user.dir",
+            // file names
+            "ct.sym",
+            "rt.jar",
+            "tools.jar",
+            // -XD option names
+            "process.packages",
+            "ignore.symbol.file",
+            // prefix/embedded strings
+            "compiler.",
+            "compiler.misc.",
+            "count.",
+            "illegal.",
+            "javac.",
+            "verbose."
+    ));
+
+    /**
+     * Look for a resource that ends in this string fragment.
+     */
+    boolean hasMatch(Set<String> resourceKeys, String s) {
+        for (String rk: resourceKeys) {
+            if (rk.endsWith(s))
+                return true;
+        }
+        return false;
+    }
+
+    /**
+     * Get the set of strings from (most of) the javac classfiles.
+     */
+    Set<String> getCodeStrings() throws IOException {
+        Set<String> results = new TreeSet<String>();
+        JavaCompiler c = ToolProvider.getSystemJavaCompiler();
+        JavaFileManager fm = c.getStandardFileManager(null, null, null);
+        String[] pkgs = {
+            "javax.annotation.processing",
+            "javax.lang.model",
+            "javax.tools",
+            "com.sun.source",
+            "com.sun.tools.javac"
+        };
+        for (String pkg: pkgs) {
+            for (JavaFileObject fo: fm.list(StandardLocation.PLATFORM_CLASS_PATH,
+                    pkg, EnumSet.of(JavaFileObject.Kind.CLASS), true)) {
+                String name = fo.getName();
+                // ignore resource files, and files which are not really part of javac
+                if (name.contains("resources")
+                        || name.contains("Launcher.class")
+                        || name.contains("CreateSymbols.class"))
+                    continue;
+                scan(fo, results);
+            }
+        }
+        return results;
+    }
+
+    /**
+     * Get the set of strings from a class file.
+     * Only strings that look like they might be a resource key are returned.
+     */
+    void scan(JavaFileObject fo, Set<String> results) throws IOException {
+        InputStream in = fo.openInputStream();
+        try {
+            ClassFile cf = ClassFile.read(in);
+            for (ConstantPool.CPInfo cpinfo: cf.constant_pool.entries()) {
+                if (cpinfo.getTag() == ConstantPool.CONSTANT_Utf8) {
+                    String v = ((ConstantPool.CONSTANT_Utf8_info) cpinfo).value;
+                    if (v.matches("[A-Za-z0-9-_.]+"))
+                        results.add(v);
+                }
+            }
+        } catch (ConstantPoolException ignore) {
+        } finally {
+            in.close();
+        }
+    }
+
+    /**
+     * Get the set of keys from the javac resource bundles.
+     */
+    Set<String> getResourceKeys() {
+        Set<String> results = new TreeSet<String>();
+        for (String name : new String[]{"javac", "compiler"}) {
+            ResourceBundle b =
+                    ResourceBundle.getBundle("com.sun.tools.javac.resources." + name);
+            results.addAll(b.keySet());
+        }
+        return results;
+    }
+
+    /**
+     * Report an error.
+     */
+    void error(String msg) {
+        System.err.println("Error: " + msg);
+        errors++;
+    }
+
+    int errors;
+}
--- a/test/tools/javac/literals/BadUnderscoreLiterals.6.out	Tue Jun 29 12:06:46 2010 -0700
+++ b/test/tools/javac/literals/BadUnderscoreLiterals.6.out	Wed Jun 30 18:06:29 2010 -0700
@@ -1,4 +1,4 @@
-BadUnderscoreLiterals.java:14:17: compiler.err.unsupported.underscore: 1.6
+BadUnderscoreLiterals.java:14:17: compiler.err.unsupported.underscore.lit: 1.6
 BadUnderscoreLiterals.java:18:15: compiler.err.illegal.underscore
 BadUnderscoreLiterals.java:22:19: compiler.err.illegal.underscore
 BadUnderscoreLiterals.java:25:14: compiler.err.unsupported.binary.lit: 1.6