CheckResourceKeys.java revision 3711:3fc90eaaf922
1/* 2 * Copyright (c) 2010, 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/* 25 * @test 26 * @bug 6964768 6964461 6964469 6964487 6964460 6964481 6980021 27 * @summary need test program to validate javac resource bundles 28 * @modules jdk.jdeps/com.sun.tools.classfile 29 * jdk.compiler/com.sun.tools.javac.code 30 */ 31 32import java.io.*; 33import java.lang.reflect.Layer; 34import java.lang.reflect.Module; 35import java.util.*; 36import javax.tools.*; 37import com.sun.tools.classfile.*; 38import com.sun.tools.javac.code.Lint.LintCategory; 39 40/** 41 * Compare string constants in javac classes against keys in javac resource bundles. 42 */ 43public class CheckResourceKeys { 44 /** 45 * Main program. 46 * Options: 47 * -finddeadkeys 48 * look for keys in resource bundles that are no longer required 49 * -findmissingkeys 50 * look for keys in resource bundles that are missing 51 * 52 * @throws Exception if invoked by jtreg and errors occur 53 */ 54 public static void main(String... args) throws Exception { 55 CheckResourceKeys c = new CheckResourceKeys(); 56 if (c.run(args)) 57 return; 58 59 if (is_jtreg()) 60 throw new Exception(c.errors + " errors occurred"); 61 else 62 System.exit(1); 63 } 64 65 static boolean is_jtreg() { 66 return (System.getProperty("test.src") != null); 67 } 68 69 /** 70 * Main entry point. 71 */ 72 boolean run(String... args) throws Exception { 73 boolean findDeadKeys = false; 74 boolean findMissingKeys = false; 75 76 if (args.length == 0) { 77 if (is_jtreg()) { 78 findDeadKeys = true; 79 findMissingKeys = true; 80 } else { 81 System.err.println("Usage: java CheckResourceKeys <options>"); 82 System.err.println("where options include"); 83 System.err.println(" -finddeadkeys find keys in resource bundles which are no longer required"); 84 System.err.println(" -findmissingkeys find keys in resource bundles that are required but missing"); 85 return true; 86 } 87 } else { 88 for (String arg: args) { 89 if (arg.equalsIgnoreCase("-finddeadkeys")) 90 findDeadKeys = true; 91 else if (arg.equalsIgnoreCase("-findmissingkeys")) 92 findMissingKeys = true; 93 else 94 error("bad option: " + arg); 95 } 96 } 97 98 if (errors > 0) 99 return false; 100 101 Set<String> codeStrings = getCodeStrings(); 102 Set<String> resourceKeys = getResourceKeys(); 103 104 if (findDeadKeys) 105 findDeadKeys(codeStrings, resourceKeys); 106 107 if (findMissingKeys) 108 findMissingKeys(codeStrings, resourceKeys); 109 110 return (errors == 0); 111 } 112 113 /** 114 * Find keys in resource bundles which are probably no longer required. 115 * A key is probably required if there is a string fragment in the code 116 * that is part of the resource key, or if the key is well-known 117 * according to various pragmatic rules. 118 */ 119 void findDeadKeys(Set<String> codeStrings, Set<String> resourceKeys) { 120 String[] prefixes = { 121 "compiler.err.", "compiler.warn.", "compiler.note.", "compiler.misc.", 122 "javac." 123 }; 124 for (String rk: resourceKeys) { 125 // some keys are used directly, without a prefix. 126 if (codeStrings.contains(rk)) 127 continue; 128 129 // remove standard prefix 130 String s = null; 131 for (int i = 0; i < prefixes.length && s == null; i++) { 132 if (rk.startsWith(prefixes[i])) { 133 s = rk.substring(prefixes[i].length()); 134 } 135 } 136 if (s == null) { 137 error("Resource key does not start with a standard prefix: " + rk); 138 continue; 139 } 140 141 if (codeStrings.contains(s)) 142 continue; 143 144 // keys ending in .1 are often synthesized 145 if (s.endsWith(".1") && codeStrings.contains(s.substring(0, s.length() - 2))) 146 continue; 147 148 // verbose keys are generated by ClassReader.printVerbose 149 if (s.startsWith("verbose.") && codeStrings.contains(s.substring(8))) 150 continue; 151 152 // mandatory warning messages are synthesized with no characteristic substring 153 if (isMandatoryWarningString(s)) 154 continue; 155 156 // check known (valid) exceptions 157 if (knownRequired.contains(rk)) 158 continue; 159 160 // check known suspects 161 if (needToInvestigate.contains(rk)) 162 continue; 163 164 //check lint description keys: 165 if (s.startsWith("opt.Xlint.desc.")) { 166 String option = s.substring(15); 167 boolean found = false; 168 169 for (LintCategory lc : LintCategory.values()) { 170 if (option.equals(lc.option)) 171 found = true; 172 } 173 174 if (found) 175 continue; 176 } 177 178 error("Resource key not found in code: " + rk); 179 } 180 } 181 182 /** 183 * The keys for mandatory warning messages are all synthesized and do not 184 * have a significant recognizable substring to look for. 185 */ 186 private boolean isMandatoryWarningString(String s) { 187 String[] bases = { "deprecated", "unchecked", "varargs" }; 188 String[] tails = { ".filename", ".filename.additional", ".plural", ".plural.additional", ".recompile" }; 189 for (String b: bases) { 190 if (s.startsWith(b)) { 191 String tail = s.substring(b.length()); 192 for (String t: tails) { 193 if (tail.equals(t)) 194 return true; 195 } 196 } 197 } 198 return false; 199 } 200 201 Set<String> knownRequired = new TreeSet<String>(Arrays.asList( 202 // See Resolve.getErrorKey 203 "compiler.err.cant.resolve.args", 204 "compiler.err.cant.resolve.args.params", 205 "compiler.err.cant.resolve.location.args", 206 "compiler.err.cant.resolve.location.args.params", 207 "compiler.misc.cant.resolve.location.args", 208 "compiler.misc.cant.resolve.location.args.params", 209 // JavaCompiler, reports #errors and #warnings 210 "compiler.misc.count.error", 211 "compiler.misc.count.error.plural", 212 "compiler.misc.count.warn", 213 "compiler.misc.count.warn.plural", 214 // Used for LintCategory 215 "compiler.warn.lintOption", 216 // Other 217 "compiler.misc.base.membership" // (sic) 218 )); 219 220 221 Set<String> needToInvestigate = new TreeSet<String>(Arrays.asList( 222 "compiler.misc.fatal.err.cant.close.loader", // Supressed by JSR308 223 "compiler.err.cant.read.file", // UNUSED 224 "compiler.err.illegal.self.ref", // UNUSED 225 "compiler.err.io.exception", // UNUSED 226 "compiler.err.limit.pool.in.class", // UNUSED 227 "compiler.err.name.reserved.for.internal.use", // UNUSED 228 "compiler.err.no.match.entry", // UNUSED 229 "compiler.err.not.within.bounds.explain", // UNUSED 230 "compiler.err.signature.doesnt.match.intf", // UNUSED 231 "compiler.err.signature.doesnt.match.supertype", // UNUSED 232 "compiler.err.type.var.more.than.once", // UNUSED 233 "compiler.err.type.var.more.than.once.in.result", // UNUSED 234 "compiler.misc.non.denotable.type", // UNUSED 235 "compiler.misc.unnamed.package", // should be required, CR 6964147 236 "compiler.warn.proc.type.already.exists", // TODO in JavacFiler 237 "javac.err.invalid.arg", // UNUSED ?? 238 "javac.opt.arg.class", // UNUSED ?? 239 "javac.opt.arg.pathname", // UNUSED ?? 240 "javac.opt.moreinfo", // option commented out 241 "javac.opt.nogj", // UNUSED 242 "javac.opt.printsearch", // option commented out 243 "javac.opt.prompt", // option commented out 244 "javac.opt.s" // option commented out 245 )); 246 247 /** 248 * For all strings in the code that look like they might be fragments of 249 * a resource key, verify that a key exists. 250 */ 251 void findMissingKeys(Set<String> codeStrings, Set<String> resourceKeys) { 252 for (String cs: codeStrings) { 253 if (cs.matches("[A-Za-z][^.]*\\..*")) { 254 // ignore filenames (i.e. in SourceFile attribute 255 if (cs.matches(".*\\.java")) 256 continue; 257 // ignore package and class names 258 if (cs.matches("(com|java|javax|jdk|sun)\\.[A-Za-z.]+")) 259 continue; 260 if (cs.matches("(java|javax|sun)\\.")) 261 continue; 262 // ignore debug flag names 263 if (cs.startsWith("debug.")) 264 continue; 265 // ignore should-stop flag names 266 if (cs.startsWith("should-stop.")) 267 continue; 268 // ignore diagsformat flag names 269 if (cs.startsWith("diags.")) 270 continue; 271 // explicit known exceptions 272 if (noResourceRequired.contains(cs)) 273 continue; 274 // look for matching resource 275 if (hasMatch(resourceKeys, cs)) 276 continue; 277 error("no match for \"" + cs + "\""); 278 } 279 } 280 } 281 // where 282 private Set<String> noResourceRequired = new HashSet<String>(Arrays.asList( 283 // module names 284 "jdk.compiler", 285 "jdk.javadoc", 286 // system properties 287 "application.home", // in Paths.java 288 "env.class.path", 289 "line.separator", 290 "os.name", 291 "user.dir", 292 // file names 293 "ct.sym", 294 "rt.jar", 295 "jfxrt.jar", 296 "module-info.class", 297 "jrt-fs.jar", 298 // -XD option names 299 "process.packages", 300 "ignore.symbol.file", 301 "fileManager.deferClose", 302 // prefix/embedded strings 303 "compiler.", 304 "compiler.misc.", 305 "opt.Xlint.desc.", 306 "count.", 307 "illegal.", 308 "java.", 309 "javac.", 310 "verbose.", 311 "locn." 312 )); 313 314 /** 315 * Look for a resource that ends in this string fragment. 316 */ 317 boolean hasMatch(Set<String> resourceKeys, String s) { 318 for (String rk: resourceKeys) { 319 if (rk.endsWith(s)) 320 return true; 321 } 322 return false; 323 } 324 325 /** 326 * Get the set of strings from (most of) the javac classfiles. 327 */ 328 Set<String> getCodeStrings() throws IOException { 329 Set<String> results = new TreeSet<String>(); 330 JavaCompiler c = ToolProvider.getSystemJavaCompiler(); 331 try (JavaFileManager fm = c.getStandardFileManager(null, null, null)) { 332 JavaFileManager.Location javacLoc = findJavacLocation(fm); 333 String[] pkgs = { 334 "javax.annotation.processing", 335 "javax.lang.model", 336 "javax.tools", 337 "com.sun.source", 338 "com.sun.tools.javac" 339 }; 340 for (String pkg: pkgs) { 341 for (JavaFileObject fo: fm.list(javacLoc, 342 pkg, EnumSet.of(JavaFileObject.Kind.CLASS), true)) { 343 String name = fo.getName(); 344 // ignore resource files, and files which are not really part of javac 345 if (name.matches(".*resources.[A-Za-z_0-9]+\\.class.*") 346 || name.matches(".*CreateSymbols\\.class.*")) 347 continue; 348 scan(fo, results); 349 } 350 } 351 return results; 352 } 353 } 354 355 // depending on how the test is run, javac may be on bootclasspath or classpath 356 JavaFileManager.Location findJavacLocation(JavaFileManager fm) { 357 JavaFileManager.Location[] locns = 358 { StandardLocation.PLATFORM_CLASS_PATH, StandardLocation.CLASS_PATH }; 359 try { 360 for (JavaFileManager.Location l: locns) { 361 JavaFileObject fo = fm.getJavaFileForInput(l, 362 "com.sun.tools.javac.Main", JavaFileObject.Kind.CLASS); 363 if (fo != null) 364 return l; 365 } 366 } catch (IOException e) { 367 throw new Error(e); 368 } 369 throw new IllegalStateException("Cannot find javac"); 370 } 371 372 /** 373 * Get the set of strings from a class file. 374 * Only strings that look like they might be a resource key are returned. 375 */ 376 void scan(JavaFileObject fo, Set<String> results) throws IOException { 377 InputStream in = fo.openInputStream(); 378 try { 379 ClassFile cf = ClassFile.read(in); 380 for (ConstantPool.CPInfo cpinfo: cf.constant_pool.entries()) { 381 if (cpinfo.getTag() == ConstantPool.CONSTANT_Utf8) { 382 String v = ((ConstantPool.CONSTANT_Utf8_info) cpinfo).value; 383 if (v.matches("[A-Za-z0-9-_.]+")) 384 results.add(v); 385 } 386 } 387 } catch (ConstantPoolException ignore) { 388 } finally { 389 in.close(); 390 } 391 } 392 393 /** 394 * Get the set of keys from the javac resource bundles. 395 */ 396 Set<String> getResourceKeys() { 397 Module jdk_compiler = Layer.boot().findModule("jdk.compiler").get(); 398 Set<String> results = new TreeSet<String>(); 399 for (String name : new String[]{"javac", "compiler"}) { 400 ResourceBundle b = 401 ResourceBundle.getBundle("com.sun.tools.javac.resources." + name, jdk_compiler); 402 results.addAll(b.keySet()); 403 } 404 return results; 405 } 406 407 /** 408 * Report an error. 409 */ 410 void error(String msg) { 411 System.err.println("Error: " + msg); 412 errors++; 413 } 414 415 int errors; 416} 417