VerifySuppressWarnings.java revision 3155:30e288cb2d22
1226586Sdim/* 2226586Sdim * Copyright (c) 2013, 2015, Oracle and/or its affiliates. All rights reserved. 3353358Sdim * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4353358Sdim * 5353358Sdim * This code is free software; you can redistribute it and/or modify it 6226586Sdim * under the terms of the GNU General Public License version 2 only, as 7226586Sdim * published by the Free Software Foundation. 8226586Sdim * 9226586Sdim * This code is distributed in the hope that it will be useful, but WITHOUT 10226586Sdim * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 11226586Sdim * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 12226586Sdim * version 2 for more details (a copy is included in the LICENSE file that 13226586Sdim * accompanied this code). 14226586Sdim * 15226586Sdim * You should have received a copy of the GNU General Public License version 16226586Sdim * 2 along with this work; if not, write to the Free Software Foundation, 17226586Sdim * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 18226586Sdim * 19226586Sdim * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 20344779Sdim * or visit www.oracle.com if you need additional information or have any 21226586Sdim * questions. 22249423Sdim */ 23249423Sdim 24226586Sdimimport com.sun.source.tree.ClassTree; 25296417Sdimimport com.sun.source.tree.CompilationUnitTree; 26226586Sdimimport com.sun.source.tree.MethodTree; 27309124Sdimimport com.sun.source.tree.NewClassTree; 28226586Sdimimport com.sun.source.tree.Tree; 29226586Sdimimport com.sun.source.tree.VariableTree; 30226586Sdimimport com.sun.source.util.JavacTask; 31296417Sdimimport com.sun.source.util.TreeScanner; 32226586Sdimimport com.sun.source.util.Trees; 33226586Sdimimport com.sun.tools.javac.api.JavacTool; 34226586Sdimimport com.sun.tools.javac.code.Flags; 35226586Sdimimport com.sun.tools.javac.file.JavacFileManager; 36226586Sdimimport com.sun.tools.javac.tree.JCTree.JCMethodDecl; 37296417Sdimimport java.io.File; 38226586Sdimimport java.io.IOException; 39296417Sdimimport java.net.URI; 40309124Sdimimport java.net.URISyntaxException; 41226586Sdimimport java.util.ArrayList; 42226586Sdimimport java.util.Arrays; 43226586Sdimimport java.util.Iterator; 44226586Sdimimport java.util.List; 45226586Sdimimport javax.tools.Diagnostic; 46226586Sdimimport javax.tools.DiagnosticListener; 47226586Sdimimport javax.tools.FileObject; 48226586Sdimimport javax.tools.ForwardingJavaFileManager; 49249423Sdimimport javax.tools.JavaFileManager; 50226586Sdimimport javax.tools.JavaFileObject; 51226586Sdimimport javax.tools.SimpleJavaFileObject; 52226586Sdim 53249423Sdim/**Takes a source file, parses it once to get the warnings inside the file and 54226586Sdim * then for each and every declaration in the file, it tries to place 55226586Sdim * the @SuppressWarnings annotation on the declaration and verifies than no 56226586Sdim * warnings are produced inside the declaration, but all are produced outside it. 57226586Sdim * 58226586Sdim * Currently only works with <code>unchecked,deprecation,cast,divzero</code> warnings. 59296417Sdim */ 60296417Sdimpublic class VerifySuppressWarnings { 61296417Sdim 62296417Sdim private static final List<String> STANDARD_PARAMS = 63296417Sdim Arrays.asList("-Xlint:unchecked,deprecation,cast,divzero"); 64226586Sdim 65249423Sdim public static void main(String... args) throws IOException, URISyntaxException { 66226586Sdim if (args.length != 1) throw new IllegalStateException("Must provide class name!"); 67226586Sdim String testContent = null; 68226586Sdim List<File> sourcePath = new ArrayList<>(); 69226586Sdim for (String sourcePaths : System.getProperty("test.src.path").split(":")) { 70226586Sdim sourcePath.add(new File(sourcePaths)); 71226586Sdim } 72226586Sdim JavacFileManager fm = JavacTool.create().getStandardFileManager(null, null, null); 73226586Sdim for (File sp : sourcePath) { 74296417Sdim File inp = new File(sp, args[0]); 75276479Sdim 76296417Sdim if (inp.canRead()) { 77226586Sdim testContent = fm.getJavaFileObject(inp.toPath()).getCharContent(true).toString(); 78226586Sdim } 79296417Sdim } 80226586Sdim if (testContent == null) throw new IllegalStateException(); 81296417Sdim final List<Diagnostic<?>> diagnostics = new ArrayList<>(); 82226586Sdim DiagnosticListener<JavaFileObject> collectDiagnostics = new DiagnosticListener<JavaFileObject>() { 83226586Sdim @Override public void report(Diagnostic<? extends JavaFileObject> diagnostic) { 84276479Sdim diagnostics.add(diagnostic); 85226586Sdim } 86226586Sdim }; 87226586Sdim JavaFileObject testFile = new TestFO(new URI("mem://" + args[0]), testContent); 88226586Sdim JavacTask task = JavacTool.create().getTask(null, 89226586Sdim new TestFM(fm), 90226586Sdim collectDiagnostics, 91296417Sdim STANDARD_PARAMS, 92226586Sdim null, 93296417Sdim Arrays.asList(testFile)); 94296417Sdim final Trees trees = Trees.instance(task); 95296417Sdim final CompilationUnitTree cut = task.parse().iterator().next(); 96296417Sdim task.analyze(); 97296417Sdim 98296417Sdim final List<int[]> declarationSpans = new ArrayList<>(); 99296417Sdim 100296417Sdim new TreeScanner<Void, Void>() { 101226586Sdim @Override public Void visitClass(ClassTree node, Void p) { 102296417Sdim handleDeclaration(node); 103226586Sdim return super.visitClass(node, p); 104226586Sdim } 105226586Sdim @Override public Void visitMethod(MethodTree node, Void p) { 106226586Sdim handleDeclaration(node); 107226586Sdim return super.visitMethod(node, p); 108226586Sdim } 109226586Sdim @Override public Void visitVariable(VariableTree node, Void p) { 110226586Sdim handleDeclaration(node); 111276479Sdim return super.visitVariable(node, p); 112226586Sdim } 113226586Sdim 114226586Sdim @Override 115226586Sdim public Void visitNewClass(NewClassTree node, Void p) { 116226586Sdim if (node.getClassBody() != null) { 117226586Sdim scan(node.getClassBody().getMembers(), null); 118226586Sdim } 119226586Sdim return null; 120296417Sdim } 121226586Sdim 122226586Sdim private void handleDeclaration(Tree node) { 123226586Sdim int endPos = (int) trees.getSourcePositions().getEndPosition(cut, node); 124226586Sdim 125226586Sdim if (endPos == (-1)) { 126226586Sdim if (node.getKind() == Tree.Kind.METHOD && (((JCMethodDecl) node).getModifiers().flags & Flags.GENERATEDCONSTR) != 0) { 127226586Sdim return ; 128249423Sdim } 129226586Sdim throw new IllegalStateException(); 130226586Sdim } 131226586Sdim 132226586Sdim declarationSpans.add(new int[] {(int) trees.getSourcePositions().getStartPosition(cut, node), endPos}); 133226586Sdim } 134226586Sdim }.scan(cut, null); 135226586Sdim 136226586Sdim for (final int[] declarationSpan : declarationSpans) { 137344779Sdim final String suppressWarnings = 138226586Sdim "@SuppressWarnings({\"deprecation\", \"unchecked\", \"serial\", \"divzero\"})"; 139344779Sdim final String updatedContent = testContent.substring(0, declarationSpan[0]) + suppressWarnings + testContent.substring(declarationSpan[0]); 140226586Sdim final List<Diagnostic<?>> foundErrors = new ArrayList<>(diagnostics); 141226586Sdim DiagnosticListener<JavaFileObject> verifyDiagnostics = new DiagnosticListener<JavaFileObject>() { 142226586Sdim @Override public void report(Diagnostic<? extends JavaFileObject> diagnostic) { 143309124Sdim long adjustedPos = diagnostic.getPosition(); 144309124Sdim 145309124Sdim if (adjustedPos >= declarationSpan[0]) adjustedPos -= suppressWarnings.length(); 146309124Sdim 147226586Sdim if (declarationSpan[0] <= adjustedPos && adjustedPos <= declarationSpan[1]) { 148296417Sdim throw new IllegalStateException("unsuppressed: " + diagnostic.getMessage(null)); 149309124Sdim } 150309124Sdim 151309124Sdim boolean found = false; 152309124Sdim 153309124Sdim for (Iterator<Diagnostic<?>> it = foundErrors.iterator(); it.hasNext();) { 154309124Sdim Diagnostic<?> d = it.next(); 155309124Sdim if (d.getPosition() == adjustedPos && d.getCode().equals(diagnostic.getCode())) { 156309124Sdim it.remove(); 157309124Sdim found = true; 158296417Sdim break; 159296417Sdim } 160296417Sdim } 161309124Sdim 162296417Sdim if (!found) { 163296417Sdim throw new IllegalStateException("diagnostic not originally reported: " + diagnostic.getMessage(null)); 164296417Sdim } 165288943Sdim } 166296417Sdim }; 167296417Sdim 168296417Sdim JavaFileObject updatedFile = new TestFO(new URI("mem://" + args[0]), updatedContent); 169296417Sdim JavacTask testTask = JavacTool.create().getTask(null, 170296417Sdim new TestFM(fm), 171296417Sdim verifyDiagnostics, 172296417Sdim STANDARD_PARAMS, 173296417Sdim null, 174296417Sdim Arrays.asList(updatedFile)); 175296417Sdim 176296417Sdim testTask.analyze(); 177296417Sdim 178296417Sdim for (Diagnostic<?> d : foundErrors) { 179296417Sdim if (d.getPosition() < declarationSpan[0] || declarationSpan[1] < d.getPosition()) { 180296417Sdim throw new IllegalStateException("missing: " + d.getMessage(null)); 181296417Sdim } 182296417Sdim } 183296417Sdim } 184296417Sdim } 185296417Sdim 186296417Sdim private static final class TestFO extends SimpleJavaFileObject { 187296417Sdim private final String content; 188296417Sdim public TestFO(URI uri, String content) { 189296417Sdim super(uri, Kind.SOURCE); 190296417Sdim this.content = content; 191296417Sdim } 192296417Sdim 193344779Sdim @Override public CharSequence getCharContent(boolean ignoreEncodingErrors) throws IOException { 194344779Sdim return content; 195344779Sdim } 196296417Sdim 197344779Sdim @Override public boolean isNameCompatible(String simpleName, Kind kind) { 198296417Sdim return true; 199296417Sdim } 200296417Sdim } 201226586Sdim 202226586Sdim private static final class TestFM extends ForwardingJavaFileManager<JavaFileManager> { 203296417Sdim 204296417Sdim public TestFM(JavaFileManager fileManager) { 205296417Sdim super(fileManager); 206296417Sdim } 207296417Sdim 208296417Sdim @Override 209296417Sdim public boolean isSameFile(FileObject a, FileObject b) { 210296417Sdim return a.equals(b); 211296417Sdim } 212296417Sdim 213296417Sdim } 214296417Sdim} 215309124Sdim