langtools/test/tools/javac/processing/filer/TestPackageInfo.java
author darcy
Fri, 21 Dec 2012 08:45:43 -0800
changeset 14963 974d4423c999
parent 8845 42fb82dfbf52
child 30730 d3ce7619db2c
permissions -rw-r--r--
8005282: Use @library tag with non-relative path for javac tests Reviewed-by: jjg
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     1
/*
8845
42fb82dfbf52 6993311: annotations on packages are not validated
jjg
parents: 6720
diff changeset
     2
 * Copyright (c) 2006, 2011, Oracle and/or its affiliates. All rights reserved.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
06bc494ca11e Initial load
duke
parents:
diff changeset
     4
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
06bc494ca11e Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
06bc494ca11e Initial load
duke
parents:
diff changeset
     7
 * published by the Free Software Foundation.
06bc494ca11e Initial load
duke
parents:
diff changeset
     8
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
06bc494ca11e Initial load
duke
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
06bc494ca11e Initial load
duke
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
06bc494ca11e Initial load
duke
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
06bc494ca11e Initial load
duke
parents:
diff changeset
    13
 * accompanied this code).
06bc494ca11e Initial load
duke
parents:
diff changeset
    14
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
06bc494ca11e Initial load
duke
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
06bc494ca11e Initial load
duke
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
06bc494ca11e Initial load
duke
parents:
diff changeset
    18
 *
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
    21
 * questions.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    22
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    23
06bc494ca11e Initial load
duke
parents:
diff changeset
    24
/*
06bc494ca11e Initial load
duke
parents:
diff changeset
    25
 * @test
8845
42fb82dfbf52 6993311: annotations on packages are not validated
jjg
parents: 6720
diff changeset
    26
 * @bug 6380018 6392177 6993311
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
 * @summary Test the ability to create and process package-info.java files
06bc494ca11e Initial load
duke
parents:
diff changeset
    28
 * @author  Joseph D. Darcy
14963
974d4423c999 8005282: Use @library tag with non-relative path for javac tests
darcy
parents: 8845
diff changeset
    29
 * @library /tools/javac/lib
6720
f16f91662ad8 6983738: Use a JavacTestingAbstractProcessor
darcy
parents: 5520
diff changeset
    30
 * @build   JavacTestingAbstractProcessor
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    31
 * @compile TestPackageInfo.java
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
 * @compile -processor TestPackageInfo -proc:only foo/bar/package-info.java TestPackageInfo.java
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    34
06bc494ca11e Initial load
duke
parents:
diff changeset
    35
import java.util.Set;
06bc494ca11e Initial load
duke
parents:
diff changeset
    36
import java.util.HashSet;
06bc494ca11e Initial load
duke
parents:
diff changeset
    37
import java.util.Map;
06bc494ca11e Initial load
duke
parents:
diff changeset
    38
import javax.annotation.processing.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    39
import javax.lang.model.SourceVersion;
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
import static javax.lang.model.SourceVersion.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    41
import javax.lang.model.element.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    42
import javax.lang.model.util.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    43
import static javax.lang.model.util.ElementFilter.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    44
import static javax.tools.Diagnostic.Kind.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    45
import static javax.tools.StandardLocation.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    46
06bc494ca11e Initial load
duke
parents:
diff changeset
    47
import java.io.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    48
06bc494ca11e Initial load
duke
parents:
diff changeset
    49
/**
06bc494ca11e Initial load
duke
parents:
diff changeset
    50
 * Test the ability to process annotations on package-info.java files:
06bc494ca11e Initial load
duke
parents:
diff changeset
    51
 * 1) Visibility of package-info files from the command line
06bc494ca11e Initial load
duke
parents:
diff changeset
    52
 * 2) Visibility of generated package-info.java source files
06bc494ca11e Initial load
duke
parents:
diff changeset
    53
 */
6720
f16f91662ad8 6983738: Use a JavacTestingAbstractProcessor
darcy
parents: 5520
diff changeset
    54
public class TestPackageInfo extends JavacTestingAbstractProcessor {
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    55
    private int round = 0;
06bc494ca11e Initial load
duke
parents:
diff changeset
    56
06bc494ca11e Initial load
duke
parents:
diff changeset
    57
    public boolean process(Set<? extends TypeElement> annotations,
06bc494ca11e Initial load
duke
parents:
diff changeset
    58
                           RoundEnvironment roundEnv) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    59
        round++;
06bc494ca11e Initial load
duke
parents:
diff changeset
    60
06bc494ca11e Initial load
duke
parents:
diff changeset
    61
        // Verify annotations are as expected
06bc494ca11e Initial load
duke
parents:
diff changeset
    62
        Set<TypeElement> expectedAnnotations = new HashSet<TypeElement>();
8845
42fb82dfbf52 6993311: annotations on packages are not validated
jjg
parents: 6720
diff changeset
    63
        expectedAnnotations.add(eltUtils.getTypeElement("java.lang.Deprecated"));
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    64
06bc494ca11e Initial load
duke
parents:
diff changeset
    65
        if (!roundEnv.processingOver()) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    66
            System.out.println("\nRound " + round);
06bc494ca11e Initial load
duke
parents:
diff changeset
    67
            int rootElementSize = roundEnv.getRootElements().size();
06bc494ca11e Initial load
duke
parents:
diff changeset
    68
06bc494ca11e Initial load
duke
parents:
diff changeset
    69
            for(Element elt : roundEnv.getRootElements()) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    70
                System.out.printf("%nElement %s\tkind: %s%n", elt.getSimpleName(), elt.getKind());
06bc494ca11e Initial load
duke
parents:
diff changeset
    71
                eltUtils.printElements(new PrintWriter(System.out), elt);
06bc494ca11e Initial load
duke
parents:
diff changeset
    72
            }
06bc494ca11e Initial load
duke
parents:
diff changeset
    73
06bc494ca11e Initial load
duke
parents:
diff changeset
    74
            switch (round) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    75
            case 1:
06bc494ca11e Initial load
duke
parents:
diff changeset
    76
                if (rootElementSize != 2)
06bc494ca11e Initial load
duke
parents:
diff changeset
    77
                    throw new RuntimeException("Unexpected root element size " + rootElementSize);
06bc494ca11e Initial load
duke
parents:
diff changeset
    78
06bc494ca11e Initial load
duke
parents:
diff changeset
    79
                // Note that foo.bar.FuBar, an element of package
06bc494ca11e Initial load
duke
parents:
diff changeset
    80
                // foo.bar, contains @Deprecated which should *not* be
06bc494ca11e Initial load
duke
parents:
diff changeset
    81
                // included in the set of annotations to process
06bc494ca11e Initial load
duke
parents:
diff changeset
    82
                if (!expectedAnnotations.equals(annotations)) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    83
                    throw new RuntimeException("Unexpected annotations: " + annotations);
06bc494ca11e Initial load
duke
parents:
diff changeset
    84
                }
06bc494ca11e Initial load
duke
parents:
diff changeset
    85
06bc494ca11e Initial load
duke
parents:
diff changeset
    86
                try {
06bc494ca11e Initial load
duke
parents:
diff changeset
    87
                    try {
06bc494ca11e Initial load
duke
parents:
diff changeset
    88
                        filer.createClassFile("package-info");
06bc494ca11e Initial load
duke
parents:
diff changeset
    89
                        throw new RuntimeException("Created class file for \"package-info\".");
06bc494ca11e Initial load
duke
parents:
diff changeset
    90
                    } catch(FilerException fe) {}
06bc494ca11e Initial load
duke
parents:
diff changeset
    91
06bc494ca11e Initial load
duke
parents:
diff changeset
    92
                    PrintWriter pw = new PrintWriter(filer.createSourceFile("foo.package-info").openWriter());
8845
42fb82dfbf52 6993311: annotations on packages are not validated
jjg
parents: 6720
diff changeset
    93
                    pw.println("@Deprecated");
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    94
                    pw.println("package foo;");
06bc494ca11e Initial load
duke
parents:
diff changeset
    95
                    pw.close();
06bc494ca11e Initial load
duke
parents:
diff changeset
    96
06bc494ca11e Initial load
duke
parents:
diff changeset
    97
                } catch(IOException ioe) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    98
                    throw new RuntimeException(ioe);
06bc494ca11e Initial load
duke
parents:
diff changeset
    99
                }
06bc494ca11e Initial load
duke
parents:
diff changeset
   100
                break;
06bc494ca11e Initial load
duke
parents:
diff changeset
   101
06bc494ca11e Initial load
duke
parents:
diff changeset
   102
            case 2:
06bc494ca11e Initial load
duke
parents:
diff changeset
   103
                // Expect foo.package-info
06bc494ca11e Initial load
duke
parents:
diff changeset
   104
06bc494ca11e Initial load
duke
parents:
diff changeset
   105
                Set<Element> expectedElement = new HashSet<Element>();
06bc494ca11e Initial load
duke
parents:
diff changeset
   106
                expectedElement.add(eltUtils.getPackageElement("foo"));
06bc494ca11e Initial load
duke
parents:
diff changeset
   107
                if (!expectedElement.equals(roundEnv.getRootElements()))
06bc494ca11e Initial load
duke
parents:
diff changeset
   108
                    throw new RuntimeException("Unexpected root element set " + roundEnv.getRootElements());
06bc494ca11e Initial load
duke
parents:
diff changeset
   109
06bc494ca11e Initial load
duke
parents:
diff changeset
   110
                if (!expectedAnnotations.equals(annotations)) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   111
                    throw new RuntimeException("Unexpected annotations: " + annotations);
06bc494ca11e Initial load
duke
parents:
diff changeset
   112
                }
06bc494ca11e Initial load
duke
parents:
diff changeset
   113
06bc494ca11e Initial load
duke
parents:
diff changeset
   114
                break;
06bc494ca11e Initial load
duke
parents:
diff changeset
   115
06bc494ca11e Initial load
duke
parents:
diff changeset
   116
            default:
06bc494ca11e Initial load
duke
parents:
diff changeset
   117
                throw new RuntimeException("Unexpected round number " + round);
06bc494ca11e Initial load
duke
parents:
diff changeset
   118
            }
06bc494ca11e Initial load
duke
parents:
diff changeset
   119
        }
06bc494ca11e Initial load
duke
parents:
diff changeset
   120
        return false;
06bc494ca11e Initial load
duke
parents:
diff changeset
   121
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   122
}