Fri, 24 Apr 2020 03:58:51 +0100
Merge
aoqi@0 | 1 | /* |
aoqi@0 | 2 | * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. |
aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
aoqi@0 | 4 | * |
aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
aoqi@0 | 7 | * published by the Free Software Foundation. |
aoqi@0 | 8 | * |
aoqi@0 | 9 | * This code is distributed in the hope that it will be useful, but WITHOUT |
aoqi@0 | 10 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
aoqi@0 | 11 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
aoqi@0 | 12 | * version 2 for more details (a copy is included in the LICENSE file that |
aoqi@0 | 13 | * accompanied this code). |
aoqi@0 | 14 | * |
aoqi@0 | 15 | * You should have received a copy of the GNU General Public License version |
aoqi@0 | 16 | * 2 along with this work; if not, write to the Free Software Foundation, |
aoqi@0 | 17 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
aoqi@0 | 18 | * |
aoqi@0 | 19 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
aoqi@0 | 20 | * or visit www.oracle.com if you need additional information or have any |
aoqi@0 | 21 | * questions. |
aoqi@0 | 22 | */ |
aoqi@0 | 23 | |
aoqi@0 | 24 | /* |
aoqi@0 | 25 | * @test |
aoqi@0 | 26 | * @bug 8026180 |
aoqi@0 | 27 | * @summary Ensuring javax.lang.model.**, javax.tools.**, javax.annotation.processing.** |
aoqi@0 | 28 | * and com.sun.source.** don't export inappropriate types. |
aoqi@0 | 29 | * @library /tools/javac/lib |
aoqi@0 | 30 | * @build JavacTestingAbstractProcessor NoPrivateTypesExported |
aoqi@0 | 31 | * @compile -processor NoPrivateTypesExported NoPrivateTypesExported.java |
aoqi@0 | 32 | */ |
aoqi@0 | 33 | import java.lang.annotation.Documented; |
aoqi@0 | 34 | import java.util.Arrays; |
aoqi@0 | 35 | import java.util.HashSet; |
aoqi@0 | 36 | import java.util.List; |
aoqi@0 | 37 | import java.util.Set; |
aoqi@0 | 38 | import javax.annotation.processing.RoundEnvironment; |
aoqi@0 | 39 | import javax.lang.model.element.AnnotationMirror; |
aoqi@0 | 40 | import javax.lang.model.element.AnnotationValue; |
aoqi@0 | 41 | import javax.lang.model.element.Element; |
aoqi@0 | 42 | import javax.lang.model.element.ElementKind; |
aoqi@0 | 43 | import javax.lang.model.element.ExecutableElement; |
aoqi@0 | 44 | import javax.lang.model.element.PackageElement; |
aoqi@0 | 45 | import javax.lang.model.element.TypeElement; |
aoqi@0 | 46 | import javax.lang.model.element.TypeParameterElement; |
aoqi@0 | 47 | import javax.lang.model.element.VariableElement; |
aoqi@0 | 48 | import javax.lang.model.type.ArrayType; |
aoqi@0 | 49 | import javax.lang.model.type.DeclaredType; |
aoqi@0 | 50 | import javax.lang.model.type.IntersectionType; |
aoqi@0 | 51 | import javax.lang.model.type.TypeMirror; |
aoqi@0 | 52 | import javax.lang.model.type.TypeVariable; |
aoqi@0 | 53 | import javax.lang.model.type.WildcardType; |
aoqi@0 | 54 | import javax.lang.model.util.ElementScanner8; |
aoqi@0 | 55 | import javax.lang.model.util.SimpleAnnotationValueVisitor8; |
aoqi@0 | 56 | import javax.tools.Diagnostic.Kind; |
aoqi@0 | 57 | |
aoqi@0 | 58 | public class NoPrivateTypesExported extends JavacTestingAbstractProcessor { |
aoqi@0 | 59 | |
aoqi@0 | 60 | private static final String[] javaxLangModelPackages = new String[] { |
aoqi@0 | 61 | "javax.lang.model", |
aoqi@0 | 62 | "javax.lang.model.element", |
aoqi@0 | 63 | "javax.lang.model.type", |
aoqi@0 | 64 | "javax.lang.model.util", |
aoqi@0 | 65 | }; |
aoqi@0 | 66 | |
aoqi@0 | 67 | private static final Set<String> javaxLangModelAcceptable; |
aoqi@0 | 68 | |
aoqi@0 | 69 | private static final String[] javaxToolsProcessingPackages = new String[] { |
aoqi@0 | 70 | "javax.annotation.processing", |
aoqi@0 | 71 | "javax.tools", |
aoqi@0 | 72 | }; |
aoqi@0 | 73 | |
aoqi@0 | 74 | private static final Set<String> javaxToolsProcessingAcceptable; |
aoqi@0 | 75 | |
aoqi@0 | 76 | private static final String[] comSunSourcePackages = new String[] { |
aoqi@0 | 77 | "com.sun.source.doctree", |
aoqi@0 | 78 | "com.sun.source.tree", |
aoqi@0 | 79 | "com.sun.source.util" |
aoqi@0 | 80 | }; |
aoqi@0 | 81 | |
aoqi@0 | 82 | private static final Set<String> comSunSourceAcceptable; |
aoqi@0 | 83 | |
aoqi@0 | 84 | static { |
aoqi@0 | 85 | javaxLangModelAcceptable = new HashSet<>(Arrays.asList( |
aoqi@0 | 86 | "java.io.", |
aoqi@0 | 87 | "java.lang.", |
aoqi@0 | 88 | "java.net.", |
aoqi@0 | 89 | "java.nio.", |
aoqi@0 | 90 | "java.util.", |
aoqi@0 | 91 | "javax.lang.model.", |
aoqi@0 | 92 | "javax.annotation.processing.SupportedSourceVersion", |
aoqi@0 | 93 | "jdk.Exported" |
aoqi@0 | 94 | )); |
aoqi@0 | 95 | Set<String> javaxToolsProcessingAcceptableTemp = new HashSet<>(); |
aoqi@0 | 96 | javaxToolsProcessingAcceptableTemp.addAll(javaxLangModelAcceptable); |
aoqi@0 | 97 | javaxToolsProcessingAcceptableTemp.addAll(Arrays.asList( |
aoqi@0 | 98 | "javax.annotation.processing.", |
aoqi@0 | 99 | "javax.tools." |
aoqi@0 | 100 | )); |
aoqi@0 | 101 | javaxToolsProcessingAcceptable = javaxToolsProcessingAcceptableTemp; |
aoqi@0 | 102 | Set<String> comSunSourceAcceptableTemp = new HashSet<>(); |
aoqi@0 | 103 | comSunSourceAcceptableTemp.addAll(javaxToolsProcessingAcceptable); |
aoqi@0 | 104 | comSunSourceAcceptableTemp.addAll(Arrays.asList( |
aoqi@0 | 105 | "com.sun.source.doctree.", |
aoqi@0 | 106 | "com.sun.source.tree.", |
aoqi@0 | 107 | "com.sun.source.util." |
aoqi@0 | 108 | )); |
aoqi@0 | 109 | comSunSourceAcceptable = comSunSourceAcceptableTemp; |
aoqi@0 | 110 | } |
aoqi@0 | 111 | |
aoqi@0 | 112 | @Override |
aoqi@0 | 113 | public boolean process(Set<? extends TypeElement> annotations, |
aoqi@0 | 114 | RoundEnvironment roundEnv) { |
aoqi@0 | 115 | if (roundEnv.processingOver()) { |
aoqi@0 | 116 | verifyPackage(javaxLangModelPackages, javaxLangModelAcceptable); |
aoqi@0 | 117 | verifyPackage(javaxToolsProcessingPackages, javaxToolsProcessingAcceptable); |
aoqi@0 | 118 | verifyPackage(comSunSourcePackages, comSunSourceAcceptable); |
aoqi@0 | 119 | } |
aoqi@0 | 120 | return true; |
aoqi@0 | 121 | } |
aoqi@0 | 122 | |
aoqi@0 | 123 | private void verifyPackage(String[] packagesToTest, Set<String> acceptable) { |
aoqi@0 | 124 | for (String packageToTest : packagesToTest) { |
aoqi@0 | 125 | PackageElement packageElement = processingEnv.getElementUtils() |
aoqi@0 | 126 | .getPackageElement(packageToTest); |
aoqi@0 | 127 | |
aoqi@0 | 128 | verifyReferredTypesAcceptable(packageElement, acceptable); |
aoqi@0 | 129 | } |
aoqi@0 | 130 | } |
aoqi@0 | 131 | |
aoqi@0 | 132 | private void verifyReferredTypesAcceptable(Element rootElement, |
aoqi@0 | 133 | final Set<String> acceptable) { |
aoqi@0 | 134 | new ElementScanner8<Void, Void>() { |
aoqi@0 | 135 | @Override public Void visitType(TypeElement e, Void p) { |
aoqi@0 | 136 | verifyTypeAcceptable(e.getSuperclass(), acceptable); |
aoqi@0 | 137 | verifyTypesAcceptable(e.getInterfaces(), acceptable); |
aoqi@0 | 138 | scan(e.getTypeParameters(), p); |
aoqi@0 | 139 | scan(e.getEnclosedElements(), p); |
aoqi@0 | 140 | verifyAnnotations(e.getAnnotationMirrors(), acceptable); |
aoqi@0 | 141 | return null; |
aoqi@0 | 142 | } |
aoqi@0 | 143 | @Override public Void visitTypeParameter(TypeParameterElement e, Void p) { |
aoqi@0 | 144 | verifyTypesAcceptable(e.getBounds(), acceptable); |
aoqi@0 | 145 | scan(e.getEnclosedElements(), p); |
aoqi@0 | 146 | verifyAnnotations(e.getAnnotationMirrors(), acceptable); |
aoqi@0 | 147 | return null; |
aoqi@0 | 148 | } |
aoqi@0 | 149 | @Override public Void visitPackage(PackageElement e, Void p) { |
aoqi@0 | 150 | scan(e.getEnclosedElements(), p); |
aoqi@0 | 151 | verifyAnnotations(e.getAnnotationMirrors(), acceptable); |
aoqi@0 | 152 | return null; |
aoqi@0 | 153 | } |
aoqi@0 | 154 | @Override public Void visitVariable(VariableElement e, Void p) { |
aoqi@0 | 155 | verifyTypeAcceptable(e.asType(), acceptable); |
aoqi@0 | 156 | scan(e.getEnclosedElements(), p); |
aoqi@0 | 157 | verifyAnnotations(e.getAnnotationMirrors(), acceptable); |
aoqi@0 | 158 | return null; |
aoqi@0 | 159 | } |
aoqi@0 | 160 | @Override |
aoqi@0 | 161 | public Void visitExecutable(ExecutableElement e, Void p) { |
aoqi@0 | 162 | scan(e.getTypeParameters(), p); |
aoqi@0 | 163 | verifyTypeAcceptable(e.getReturnType(), acceptable); |
aoqi@0 | 164 | scan(e.getParameters(), p); |
aoqi@0 | 165 | verifyTypesAcceptable(e.getThrownTypes(), acceptable); |
aoqi@0 | 166 | scan(e.getEnclosedElements(), p); |
aoqi@0 | 167 | verifyAnnotations(e.getAnnotationMirrors(), acceptable); |
aoqi@0 | 168 | return null; |
aoqi@0 | 169 | } |
aoqi@0 | 170 | }.scan(rootElement, null); |
aoqi@0 | 171 | } |
aoqi@0 | 172 | |
aoqi@0 | 173 | private void verifyAnnotations(Iterable<? extends AnnotationMirror> annotations, |
aoqi@0 | 174 | Set<String> acceptable) { |
aoqi@0 | 175 | for (AnnotationMirror mirror : annotations) { |
aoqi@0 | 176 | Element annotationElement = mirror.getAnnotationType().asElement(); |
aoqi@0 | 177 | |
aoqi@0 | 178 | if (annotationElement.getAnnotation(Documented.class) == null) { |
aoqi@0 | 179 | note("Ignoring undocumented annotation: " + mirror.getAnnotationType()); |
aoqi@0 | 180 | } |
aoqi@0 | 181 | |
aoqi@0 | 182 | verifyTypeAcceptable(mirror.getAnnotationType(), acceptable); |
aoqi@0 | 183 | |
aoqi@0 | 184 | for (AnnotationValue value : mirror.getElementValues().values()) { |
aoqi@0 | 185 | verifyAnnotationValue(value, acceptable); |
aoqi@0 | 186 | } |
aoqi@0 | 187 | } |
aoqi@0 | 188 | } |
aoqi@0 | 189 | |
aoqi@0 | 190 | private void verifyAnnotationValue(AnnotationValue value, |
aoqi@0 | 191 | final Set<String> acceptable) { |
aoqi@0 | 192 | value.accept(new SimpleAnnotationValueVisitor8<Void, Void>() { |
aoqi@0 | 193 | @Override public Void visitType(TypeMirror t, Void p) { |
aoqi@0 | 194 | verifyTypeAcceptable(t, acceptable); |
aoqi@0 | 195 | return null; |
aoqi@0 | 196 | } |
aoqi@0 | 197 | @Override |
aoqi@0 | 198 | public Void visitEnumConstant(VariableElement c, Void p) { |
aoqi@0 | 199 | verifyReferredTypesAcceptable(c, acceptable); |
aoqi@0 | 200 | return null; |
aoqi@0 | 201 | } |
aoqi@0 | 202 | @Override public Void visitArray(List<? extends AnnotationValue> vals, |
aoqi@0 | 203 | Void p) { |
aoqi@0 | 204 | for (AnnotationValue val : vals) { |
aoqi@0 | 205 | val.accept(this, p); |
aoqi@0 | 206 | } |
aoqi@0 | 207 | return null; |
aoqi@0 | 208 | } |
aoqi@0 | 209 | @Override protected Void defaultAction(Object o, Void p) { |
aoqi@0 | 210 | error("Unexpected AnnotationValue: " + o.toString()); |
aoqi@0 | 211 | return super.defaultAction(o, p); |
aoqi@0 | 212 | } |
aoqi@0 | 213 | }, null); |
aoqi@0 | 214 | } |
aoqi@0 | 215 | |
aoqi@0 | 216 | private void verifyTypesAcceptable(Iterable<? extends TypeMirror> types, |
aoqi@0 | 217 | Set<String> acceptable) { |
aoqi@0 | 218 | if (types == null) return ; |
aoqi@0 | 219 | |
aoqi@0 | 220 | for (TypeMirror type : types) { |
aoqi@0 | 221 | verifyTypeAcceptable(type, acceptable); |
aoqi@0 | 222 | } |
aoqi@0 | 223 | } |
aoqi@0 | 224 | |
aoqi@0 | 225 | private void verifyTypeAcceptable(TypeMirror type, Set<String> acceptable) { |
aoqi@0 | 226 | if (type == null) return ; |
aoqi@0 | 227 | |
aoqi@0 | 228 | verifyAnnotations(type.getAnnotationMirrors(), acceptable); |
aoqi@0 | 229 | |
aoqi@0 | 230 | switch (type.getKind()) { |
aoqi@0 | 231 | case BOOLEAN: case BYTE: case CHAR: case DOUBLE: case FLOAT: |
aoqi@0 | 232 | case INT: case LONG: case SHORT: case VOID: case NONE: case NULL: |
aoqi@0 | 233 | return ; |
aoqi@0 | 234 | case DECLARED: |
aoqi@0 | 235 | DeclaredType dt = (DeclaredType) type; |
aoqi@0 | 236 | TypeElement outermostTypeElement = outermostTypeElement(dt.asElement()); |
aoqi@0 | 237 | String outermostType = outermostTypeElement.getQualifiedName().toString(); |
aoqi@0 | 238 | boolean isAcceptable = false; |
aoqi@0 | 239 | for (String acceptablePackage : acceptable) { |
aoqi@0 | 240 | if (outermostType.startsWith(acceptablePackage)) { |
aoqi@0 | 241 | isAcceptable = true; |
aoqi@0 | 242 | break; |
aoqi@0 | 243 | } |
aoqi@0 | 244 | } |
aoqi@0 | 245 | if (!isAcceptable) { |
aoqi@0 | 246 | error("Type not acceptable for this API: " + dt.toString()); |
aoqi@0 | 247 | } |
aoqi@0 | 248 | |
aoqi@0 | 249 | for (TypeMirror bound : dt.getTypeArguments()) { |
aoqi@0 | 250 | verifyTypeAcceptable(bound, acceptable); |
aoqi@0 | 251 | } |
aoqi@0 | 252 | break; |
aoqi@0 | 253 | case ARRAY: |
aoqi@0 | 254 | verifyTypeAcceptable(((ArrayType) type).getComponentType(), acceptable); |
aoqi@0 | 255 | break; |
aoqi@0 | 256 | case INTERSECTION: |
aoqi@0 | 257 | for (TypeMirror element : ((IntersectionType) type).getBounds()) { |
aoqi@0 | 258 | verifyTypeAcceptable(element, acceptable); |
aoqi@0 | 259 | } |
aoqi@0 | 260 | break; |
aoqi@0 | 261 | case TYPEVAR: |
aoqi@0 | 262 | verifyTypeAcceptable(((TypeVariable) type).getLowerBound(), acceptable); |
aoqi@0 | 263 | verifyTypeAcceptable(((TypeVariable) type).getUpperBound(), acceptable); |
aoqi@0 | 264 | break; |
aoqi@0 | 265 | case WILDCARD: |
aoqi@0 | 266 | verifyTypeAcceptable(((WildcardType) type).getExtendsBound(), acceptable); |
aoqi@0 | 267 | verifyTypeAcceptable(((WildcardType) type).getSuperBound(), acceptable); |
aoqi@0 | 268 | break; |
aoqi@0 | 269 | default: |
aoqi@0 | 270 | error("Type not acceptable for this API: " + type.toString()); |
aoqi@0 | 271 | break; |
aoqi@0 | 272 | |
aoqi@0 | 273 | } |
aoqi@0 | 274 | } |
aoqi@0 | 275 | |
aoqi@0 | 276 | private TypeElement outermostTypeElement(Element el) { |
aoqi@0 | 277 | while (el.getEnclosingElement().getKind() != ElementKind.PACKAGE) { |
aoqi@0 | 278 | el = el.getEnclosingElement(); |
aoqi@0 | 279 | } |
aoqi@0 | 280 | |
aoqi@0 | 281 | return (TypeElement) el; |
aoqi@0 | 282 | } |
aoqi@0 | 283 | |
aoqi@0 | 284 | private void error(String text) { |
aoqi@0 | 285 | processingEnv.getMessager().printMessage(Kind.ERROR, text); |
aoqi@0 | 286 | } |
aoqi@0 | 287 | |
aoqi@0 | 288 | private void note(String text) { |
aoqi@0 | 289 | processingEnv.getMessager().printMessage(Kind.NOTE, text); |
aoqi@0 | 290 | } |
aoqi@0 | 291 | } |