Fri, 10 Jan 2014 19:02:54 +0100
8030049: RoundEnvironment.getElementsAnnotatedWith receives wrong elements
Summary: Match the required and actual annotations using Element equivalence rather than TypeMirror equivalence, to avoid trouble with erroneous types.
Reviewed-by: darcy
duke@1 | 1 | /* |
jlahoda@2254 | 2 | * Copyright (c) 2006, 2014, Oracle and/or its affiliates. All rights reserved. |
duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
duke@1 | 4 | * |
duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
duke@1 | 7 | * published by the Free Software Foundation. |
duke@1 | 8 | * |
duke@1 | 9 | * This code is distributed in the hope that it will be useful, but WITHOUT |
duke@1 | 10 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
duke@1 | 11 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
duke@1 | 12 | * version 2 for more details (a copy is included in the LICENSE file that |
duke@1 | 13 | * accompanied this code). |
duke@1 | 14 | * |
duke@1 | 15 | * You should have received a copy of the GNU General Public License version |
duke@1 | 16 | * 2 along with this work; if not, write to the Free Software Foundation, |
duke@1 | 17 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
duke@1 | 18 | * |
ohair@554 | 19 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
ohair@554 | 20 | * or visit www.oracle.com if you need additional information or have any |
ohair@554 | 21 | * questions. |
duke@1 | 22 | */ |
duke@1 | 23 | |
duke@1 | 24 | /* |
duke@1 | 25 | * @test |
jlahoda@2254 | 26 | * @bug 6397298 6400986 6425592 6449798 6453386 6508401 6498938 6911854 8030049 |
duke@1 | 27 | * @summary Tests that getElementsAnnotatedWith works properly. |
duke@1 | 28 | * @author Joseph D. Darcy |
darcy@1466 | 29 | * @library /tools/javac/lib |
darcy@699 | 30 | * @build JavacTestingAbstractProcessor |
duke@1 | 31 | * @compile TestElementsAnnotatedWith.java |
duke@1 | 32 | * @compile InheritedAnnotation.java |
darcy@1876 | 33 | * @compile TpAnno.java |
duke@1 | 34 | * @compile -processor TestElementsAnnotatedWith -proc:only SurfaceAnnotations.java |
duke@1 | 35 | * @compile -processor TestElementsAnnotatedWith -proc:only BuriedAnnotations.java |
duke@1 | 36 | * @compile -processor TestElementsAnnotatedWith -proc:only Part1.java Part2.java |
darcy@232 | 37 | * @compile -processor TestElementsAnnotatedWith -proc:only C2.java |
darcy@232 | 38 | * @compile -processor TestElementsAnnotatedWith -proc:only Foo.java |
darcy@1876 | 39 | * @compile -processor TestElementsAnnotatedWith -proc:only TypeParameterAnnotations.java |
jlahoda@2254 | 40 | * @compile/fail/ref=ErroneousAnnotations.out -processor TestElementsAnnotatedWith -proc:only -XDrawDiagnostics ErroneousAnnotations.java |
darcy@453 | 41 | * @compile Foo.java |
darcy@453 | 42 | * @compile/process -processor TestElementsAnnotatedWith -proc:only Foo |
duke@1 | 43 | */ |
duke@1 | 44 | |
duke@1 | 45 | import java.lang.annotation.Annotation; |
duke@1 | 46 | import java.util.Collections; |
duke@1 | 47 | import java.util.Set; |
duke@1 | 48 | import java.util.HashSet; |
duke@1 | 49 | import java.util.Arrays; |
duke@1 | 50 | import javax.annotation.processing.*; |
duke@1 | 51 | import javax.lang.model.element.*; |
duke@1 | 52 | import static javax.lang.model.util.ElementFilter.*; |
duke@1 | 53 | |
duke@1 | 54 | /** |
duke@1 | 55 | * This processor verifies that the information returned by |
duke@1 | 56 | * getElementsAnnotatedWith is consistent with the expected results |
duke@1 | 57 | * stored in an AnnotatedElementInfo annotation. |
duke@1 | 58 | */ |
duke@1 | 59 | @AnnotatedElementInfo(annotationName="java.lang.SuppressWarnings", expectedSize=0, names={}) |
darcy@699 | 60 | public class TestElementsAnnotatedWith extends JavacTestingAbstractProcessor { |
duke@1 | 61 | |
duke@1 | 62 | public boolean process(Set<? extends TypeElement> annotations, |
duke@1 | 63 | RoundEnvironment roundEnvironment) { |
duke@1 | 64 | TypeElement annotatedElementInfoElement = |
darcy@699 | 65 | elements.getTypeElement("AnnotatedElementInfo"); |
duke@1 | 66 | Set<? extends Element> resultsMeta = Collections.emptySet(); |
duke@1 | 67 | Set<? extends Element> resultsBase = Collections.emptySet(); |
duke@1 | 68 | |
duke@1 | 69 | if (!roundEnvironment.processingOver()) { |
duke@1 | 70 | testNonAnnotations(roundEnvironment); |
duke@1 | 71 | |
duke@1 | 72 | // Verify AnnotatedElementInfo is present on the first |
duke@1 | 73 | // specified type. |
duke@1 | 74 | |
duke@1 | 75 | TypeElement firstType = typesIn(roundEnvironment.getRootElements()).iterator().next(); |
duke@1 | 76 | |
duke@1 | 77 | AnnotatedElementInfo annotatedElementInfo = firstType.getAnnotation(AnnotatedElementInfo.class); |
duke@1 | 78 | |
duke@1 | 79 | boolean failed = false; |
duke@1 | 80 | |
duke@1 | 81 | if (annotatedElementInfo == null) |
duke@1 | 82 | throw new IllegalArgumentException("Missing AnnotatedElementInfo annotation on " + |
duke@1 | 83 | firstType); |
duke@1 | 84 | else { |
duke@1 | 85 | // Verify that the annotation information is as |
duke@1 | 86 | // expected. |
duke@1 | 87 | |
mcimadamore@536 | 88 | Set<String> expectedNames = new HashSet<String>(Arrays.asList(annotatedElementInfo.names())); |
duke@1 | 89 | |
duke@1 | 90 | resultsMeta = |
duke@1 | 91 | roundEnvironment. |
darcy@699 | 92 | getElementsAnnotatedWith(elements.getTypeElement(annotatedElementInfo.annotationName())); |
duke@1 | 93 | |
duke@1 | 94 | System.err.println("Results: " + resultsMeta); |
duke@1 | 95 | |
duke@1 | 96 | if (resultsMeta.size() != annotatedElementInfo.expectedSize()) { |
duke@1 | 97 | failed = true; |
duke@1 | 98 | System.err.printf("Bad number of elements; expected %d, got %d%n", |
duke@1 | 99 | annotatedElementInfo.expectedSize(), resultsMeta.size()); |
duke@1 | 100 | } else { |
duke@1 | 101 | for(Element element : resultsMeta) { |
duke@1 | 102 | String simpleName = element.getSimpleName().toString(); |
duke@1 | 103 | if (!expectedNames.contains(simpleName) ) { |
duke@1 | 104 | failed = true; |
duke@1 | 105 | System.err.println("Name ``" + simpleName + "'' not expected."); |
duke@1 | 106 | } |
duke@1 | 107 | } |
duke@1 | 108 | } |
duke@1 | 109 | } |
duke@1 | 110 | |
duke@1 | 111 | resultsBase = computeResultsBase(roundEnvironment, annotatedElementInfo.annotationName()); |
duke@1 | 112 | |
duke@1 | 113 | if (!resultsMeta.equals(resultsBase)) { |
duke@1 | 114 | failed = true; |
duke@1 | 115 | System.err.println("Base and Meta sets unequal;\n meta: " + resultsMeta + |
duke@1 | 116 | "\nbase: " + resultsBase); |
duke@1 | 117 | } |
duke@1 | 118 | |
duke@1 | 119 | if (failed) { |
duke@1 | 120 | System.err.println("AnnotatedElementInfo: " + annotatedElementInfo); |
duke@1 | 121 | throw new RuntimeException(); |
duke@1 | 122 | } |
duke@1 | 123 | } else { |
duke@1 | 124 | // If processing is over without an error, the specified |
duke@1 | 125 | // elements should be empty so an empty set should be returned. |
duke@1 | 126 | resultsMeta = roundEnvironment.getElementsAnnotatedWith(annotatedElementInfoElement); |
duke@1 | 127 | resultsBase = roundEnvironment.getElementsAnnotatedWith(AnnotatedElementInfo.class); |
duke@1 | 128 | if (!resultsMeta.isEmpty()) |
duke@1 | 129 | throw new RuntimeException("Nonempty resultsMeta: " + resultsMeta); |
duke@1 | 130 | if (!resultsBase.isEmpty()) |
duke@1 | 131 | throw new RuntimeException("Nonempty resultsBase: " + resultsBase); |
duke@1 | 132 | |
duke@1 | 133 | } |
duke@1 | 134 | return true; |
duke@1 | 135 | } |
duke@1 | 136 | |
duke@1 | 137 | private Set<? extends Element> computeResultsBase(RoundEnvironment roundEnvironment, String name) { |
duke@1 | 138 | try { |
duke@1 | 139 | return roundEnvironment. |
duke@1 | 140 | getElementsAnnotatedWith(Class.forName(name).asSubclass(Annotation.class)); |
duke@1 | 141 | } catch(ClassNotFoundException cnfe) { |
duke@1 | 142 | throw new RuntimeException(cnfe); |
duke@1 | 143 | } |
duke@1 | 144 | } |
duke@1 | 145 | |
duke@1 | 146 | /** |
duke@1 | 147 | * Verify non-annotation types result in |
duke@1 | 148 | * IllegalArgumentExceptions. |
duke@1 | 149 | */ |
duke@1 | 150 | private void testNonAnnotations(RoundEnvironment roundEnvironment) { |
duke@1 | 151 | try { |
duke@1 | 152 | Set<? extends Element> elements = roundEnvironment.getElementsAnnotatedWith((Class)Object.class ); |
duke@1 | 153 | throw new RuntimeException("Illegal argument exception not thrown"); |
duke@1 | 154 | } catch(IllegalArgumentException iae) {} |
duke@1 | 155 | |
duke@1 | 156 | try { |
darcy@453 | 157 | Set<? extends Element> elements = |
darcy@453 | 158 | roundEnvironment.getElementsAnnotatedWith(processingEnv. |
darcy@453 | 159 | getElementUtils(). |
darcy@453 | 160 | getTypeElement("java.lang.Object") ); |
duke@1 | 161 | throw new RuntimeException("Illegal argument exception not thrown"); |
duke@1 | 162 | } catch(IllegalArgumentException iae) {} |
duke@1 | 163 | } |
duke@1 | 164 | } |