langtools/test/tools/javap/output/RepeatingTypeAnnotations.java
author jjg
Fri, 12 Aug 2016 17:45:31 -0700
changeset 40316 20b50a99fe8d
parent 26532 aa84b6606229
permissions -rw-r--r--
8052398: Uniqify test framework class names Reviewed-by: darcy

/*
 * Copyright (c) 2013, 2016, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

/*
 * @test
 * @bug 8005220
 * @summary javap must display repeating annotations
 * @ignore 8057687 emit correct byte code an attributes for type annotations
 */
import java.io.*;
import java.util.*;

/**
 * This class extends the abstract {@link Tester} test-driver, and
 * encapusulates a number of test-case classes (i.e. classes extending
 * this class and annotated with {@code TestCase}).
 * <p>
 * By default (no argument), this test runs all test-cases, except
 * if annotated with {@code ignore}.
 * <p>
 * Individual test cases can be executed using a run action.
 * <p>
 * Example: @run main RepeatingTypeAnnotations RepeatingTypeAnnotations$TC4
 * <p>
 * Note: when specific test-cases are run, additional debug output is
 * produced to help debugging. Test annotated with {@code ignore}
 * can be executed explicitly.
 */
public class RepeatingTypeAnnotations extends JavapTester {

    /**
     * Main method instantiates test and run test-cases.
     */
    public static void main(String... args) throws Exception {
        JavapTester tester = new RepeatingTypeAnnotations();
        tester.run(args);
    }

    /**
     * Testcases are classes extending {@code RepeatingTypeAnnotations},
     * and calling {@link setSrc}, followed by one or more invocations
     * of {@link verify} in the body of the constructor.
     */
    public RepeatingTypeAnnotations() {
        setSrc(new TestSource(template));
    }

    /**
     * Common template for test cases. The line TESTCASE is
     * replaced with the specific lines of individual tests.
     */
    private static final String[] template = {
        "import java.lang.annotation.*;",
        "class Test {",
        "    @Repeatable(As.class)",
        "    @Target({ElementType.TYPE_USE, ElementType.TYPE_PARAMETER})",
        "    @Retention(RetentionPolicy.CLASS)",
        "    @interface A {",
        "        Class f() default int.class;",
        "    }",

        "    @Target({ElementType.TYPE_USE, ElementType.TYPE_PARAMETER})",
        "    @Retention(RetentionPolicy.CLASS)",
        "    @interface As { A[] value(); }",

        "    @Repeatable(Bs.class)",
        "    @Target({ElementType.TYPE_USE, ElementType.TYPE_PARAMETER})",
        "    @Retention(RetentionPolicy.CLASS)",
        "    @interface B {",
        "        Class f() default int.class;",
        "    }",

        "    @Target({ElementType.TYPE_USE, ElementType.TYPE_PARAMETER})",
        "    @Retention(RetentionPolicy.CLASS)",
        "    @interface Bs { B[] value(); }",

        "    @Repeatable(Cs.class)",
        "    @Target({ElementType.TYPE_USE, ElementType.TYPE_PARAMETER})",
        "    @Retention(RetentionPolicy.RUNTIME)",
        "    @interface C {",
        "        Class f() default int.class;",
        "    }",

        "    @Target({ElementType.TYPE_USE, ElementType.TYPE_PARAMETER})",
        "    @Retention(RetentionPolicy.RUNTIME)",
        "    @interface Cs { C[] value(); }",
        "TESTCASE",
        "}"
    };

    /*
     * The test cases covers annotation in the following locations:
     * - static and non-static fields
     * - local variables
     * - constructor and method return type and parameter types
     * - casts in class and method contexts.
     * For the above locations the test-cases covers:
     * - single annotation type
     * - two annotation types with same retention
     * - two annotation types with different retention
     * - three annotation types, two of same retention, one different.
     */

    @TestCase
    public static class TC1 extends RepeatingTypeAnnotations {
        public TC1() {
            setSrc(" /* TC1 */ ",
                   "    static String so = \"hello world\";",
                   "    public @A @A @A Object o = (@A @A @A String) Test.so;");
            verify("RuntimeInvisibleTypeAnnotations",
                   "0: #25(#26=[@#27(),@#27(),@#27()]): FIELD",
                   "0: #25(#26=[@#27(),@#27(),@#27()]): CAST, offset=5, type_index=0");
        }
    }

    @TestCase
    public static class TC2 extends RepeatingTypeAnnotations {
        public TC2() {
            setSrc(" /* TC2 */ ",
                   "    static String so = \"hello world\";",
                   "    public @A @B @A Object o = (@B @A @B String) Test.so;");
            verify("RuntimeInvisibleTypeAnnotations",
                   "0: #25(#26=[@#27(),@#27()]): FIELD",
                   "1: #28(): FIELD",
                   "0: #36(#26=[@#28(),@#28()]): CAST, offset=5, type_index=0",
                   "1: #27(): CAST, offset=5, type_index=0");
        }
    }

    @TestCase
    public static class TC3 extends RepeatingTypeAnnotations {
        public TC3() {
            setSrc(" /* TC3 */ ",
                   "    static String so = \"hello world\";",
                   "    public @A @A @C Object o = (@B @C @B String) Test.so;");
            verify("RuntimeVisibleTypeAnnotations",
                   "RuntimeInvisibleTypeAnnotations",
                   "0: #25(): FIELD",
                   "0: #27(#28=[@#29(),@#29()]): FIELD",
                   "0: #25(): CAST, offset=5, type_index=0",
                   "0: #37(#28=[@#38(),@#38()]): CAST, offset=5, type_index=0");
        }
    }

    @TestCase
    public static class TC4 extends RepeatingTypeAnnotations {
        public TC4() {
            setSrc(" /* TC4 */ ",
                   "    static String so = \"hello world\";",
                   "    public @A @B @C Object o = (@C @B @A String) Test.so;");
            verify("RuntimeInvisibleTypeAnnotations",
                   "RuntimeVisibleTypeAnnotations",
                   "0: #25(): FIELD",
                   "0: #27(): FIELD",
                   "1: #28(): FIELD",
                   "0: #25(): CAST, offset=5, type_index=0",
                   "0: #28(): CAST, offset=5, type_index=0",
                   "1: #27(): CAST, offset=5, type_index=0");
        }
    }

    @TestCase
    public static class TC5 extends RepeatingTypeAnnotations {
        public TC5() {
            setSrc(" /* TC5 */ ",
                   "    static String so = \"hello world\";",
                   "    public static @A @A @A Object o = (@B @B @B String) Test.so;");
            verify("RuntimeInvisibleTypeAnnotations",
                   "0: #25(#26=[@#27(),@#27(),@#27()]): FIELD",
                   "0: #36(#26=[@#37(),@#37(),@#37()]): CAST, offset=5, type_index=0");
        }
    }

    @TestCase
    public static class TC6 extends RepeatingTypeAnnotations {
        public TC6() {
            setSrc(" /* TC6 */ ",
                   "    static String so = \"hello world\";",
                   "    public static @A @B @A Object o = (@B @A @B String) Test.so;");
            verify("RuntimeInvisibleTypeAnnotations",
                   "0: #25(#26=[@#27(),@#27()]): FIELD",
                   "1: #28(): FIELD",
                   "0: #37(#26=[@#28(),@#28()]): CAST, offset=5, type_index=0",
                   "1: #27(): CAST, offset=5, type_index=0");
        }
    }

    @TestCase
    public static class TC7 extends RepeatingTypeAnnotations {
        public TC7() {
            setSrc(" /* TC7 */ ",
                   "    static String so = \"hello world\";",
                   "    public static @A @A @C Object o = (@B @C @B String) Test.so;");
            verify("RuntimeVisibleTypeAnnotations",
                   "RuntimeInvisibleTypeAnnotations",
                   "0: #25(): FIELD",
                   "0: #27(#28=[@#29(),@#29()]): FIELD",
                   "0: #25(): CAST, offset=5, type_index=0",
                   "0: #38(#28=[@#39(),@#39()]): CAST, offset=5, type_index=0");
        }
    }

    @TestCase
    public static class TC8 extends RepeatingTypeAnnotations {
        public TC8() {
            setSrc(" /* TC8 */ ",
                   "    static String so = \"hello world\";",
                   "    public static @A @B @C Object o = (@C @B @A String) Test.so;");

            verify("RuntimeVisibleTypeAnnotations",
                   "RuntimeInvisibleTypeAnnotations",
                   "0: #25(): FIELD",
                   "0: #27(): FIELD",
                   "1: #28(): FIELD",
                   "0: #25(): CAST, offset=5, type_index=0",
                   "0: #28(): CAST, offset=5, type_index=0",
                   "1: #27(): CAST, offset=5, type_index=0");
        }
    }

    @TestCase
    public static class TC9 extends RepeatingTypeAnnotations {
        public TC9() {
            setSrc(" /* TC9 */ ",
                   "    public Test(@A @A @A Object o, @A int i, long l) {",
                   "        @A @A @A String ls = (@B @B @B String) o;",
                   "    }");
            verify("RuntimeInvisibleTypeAnnotations",
                   "0: #34(#35=[@#36(),@#36(),@#36()]): LOCAL_VARIABLE, {start_pc=10, length=1, index=5}",
                   "1: #37(#35=[@#38(),@#38(),@#38()]): CAST, offset=4, type_index=0",
                   "RuntimeInvisibleTypeAnnotations",
                   "0: #36(): METHOD_FORMAL_PARAMETER, param_index=1",
                   "1: #34(#35=[@#36(),@#36(),@#36()]): METHOD_FORMAL_PARAMETER, param_index=0");
        }
    }

    @TestCase
    public static class TC10 extends RepeatingTypeAnnotations {
        public TC10() {
            setSrc(" /* TC10 */ ",
                   "    public Test(@A @A @B Object o, @A @B int i, long l) {",
                   "        @A @A @B String ls = (@B @A @B String) o;",
                   "    }");
            verify("RuntimeInvisibleTypeAnnotations",
                   "0: #34(#35=[@#36(),@#36()]): LOCAL_VARIABLE, {start_pc=10, length=1, index=5}",
                   "1: #37(): LOCAL_VARIABLE, {start_pc=10, length=1, index=5}",
                   "2: #38(#35=[@#37(),@#37()]): CAST, offset=4, type_index=0",
                   "3: #36(): CAST, offset=4, type_index=0",
                   "RuntimeInvisibleTypeAnnotations",
                   "0: #36(): METHOD_FORMAL_PARAMETER, param_index=1",
                   "1: #37(): METHOD_FORMAL_PARAMETER, param_index=1",
                   "2: #34(#35=[@#36(),@#36()]): METHOD_FORMAL_PARAMETER, param_index=0",
                   "3: #37(): METHOD_FORMAL_PARAMETER, param_index=0");
        }
    }

    @TestCase
    public static class TC11 extends RepeatingTypeAnnotations {
        public TC11() {
            setSrc(" /* TC11 */ ",
                   "    public Test(@C @C @A Object o, @A @B int i, long l) {",
                   "        @C @C @A String ls = (@A @A @C String) o;",
                   "    }");
            verify("RuntimeVisibleTypeAnnotations",
                   "RuntimeInvisibleTypeAnnotations",
                   "0: #34(#35=[@#36(),@#36()]): LOCAL_VARIABLE, {start_pc=10, length=1, index=5}",
                   "1: #36(): CAST, offset=4, type_index=0",
                   "0: #38(): LOCAL_VARIABLE, {start_pc=10, length=1, index=5}",
                   "1: #39(#35=[@#38(),@#38()]): CAST, offset=4, type_index=0",
                   "0: #34(#35=[@#36(),@#36()]): METHOD_FORMAL_PARAMETER, param_index=0",
                   "0: #38(): METHOD_FORMAL_PARAMETER, param_index=1",
                   "1: #40(): METHOD_FORMAL_PARAMETER, param_index=1",
                   "2: #38(): METHOD_FORMAL_PARAMETER, param_index=0");
        }
    }

    @TestCase
    public static class TC12 extends RepeatingTypeAnnotations {
        public TC12() {
            setSrc(" /* TC12 */ ",
                   "    public Test(@A @B @C Object o, @A @C int i, long l) {",
                   "        @A @B @C String ls = (@C @A @B String) o;",
                   "    }");
            verify("RuntimeVisibleTypeAnnotations",
                   "0: #34(): LOCAL_VARIABLE, {start_pc=10, length=1, index=5}",
                   "1: #34(): CAST, offset=4, type_index=0",
                   "RuntimeInvisibleTypeAnnotations",
                   "0: #36(): LOCAL_VARIABLE, {start_pc=10, length=1, index=5}",
                   "1: #37(): LOCAL_VARIABLE, {start_pc=10, length=1, index=5}",
                   "2: #36(): CAST, offset=4, type_index=0",
                   "3: #37(): CAST, offset=4, type_index=0",
                   "0: #34(): METHOD_FORMAL_PARAMETER, param_index=0",
                   "1: #34(): METHOD_FORMAL_PARAMETER, param_index=1",
                   "0: #36(): METHOD_FORMAL_PARAMETER, param_index=0",
                   "1: #37(): METHOD_FORMAL_PARAMETER, param_index=0",
                   "2: #36(): METHOD_FORMAL_PARAMETER, param_index=1");
        }
    }

    @TestCase
    public static class TC13 extends RepeatingTypeAnnotations {
        public TC13() {
            setSrc(" /* TC13 */ ",
                   "    public @A @A @A String foo(@A @A @A Object o, @A int i, long l) {",
                   "        @A @A @A String ls = (@B @B @B String) o;",
                   "        return (@A @A @A String) o;",
                   "    }");
            verify("RuntimeInvisibleTypeAnnotations",
                   "0: #36(#37=[@#38(),@#38(),@#38()]): LOCAL_VARIABLE, {start_pc=6, length=5, index=5}",
                   "1: #39(#37=[@#40(),@#40(),@#40()]): CAST, offset=0, type_index=0",
                   "2: #36(#37=[@#38(),@#38(),@#38()]): CAST, offset=6, type_index=0",
                    "RuntimeInvisibleTypeAnnotations",
                   "0: #38(): METHOD_FORMAL_PARAMETER, param_index=1",
                   "1: #36(#37=[@#38(),@#38(),@#38()]): METHOD_FORMAL_PARAMETER, param_index=0",
                   "2: #36(#37=[@#38(),@#38(),@#38()]): METHOD_RETURN"
                   );
        }
    }

    @TestCase
    public static class TC14 extends RepeatingTypeAnnotations {
        public TC14() {
            setSrc(" /* TC14 */ ",
                   "    public @A @B @B String foo(@A @A @B Object o, @A @B int i, long l) {",
                   "        @A @A @B String ls = (@B @A @B String) o;",
                   "        return (@A @B @B String) o;",
                   "    }");
           verify(
                    "RuntimeInvisibleTypeAnnotations:",
                  "0: #36(#37=[@#38(),@#38()]): LOCAL_VARIABLE, {start_pc=6, length=5, index=5}",
                  "1: #39(): LOCAL_VARIABLE, {start_pc=6, length=5, index=5}",
                  "2: #40(#37=[@#39(),@#39()]): CAST, offset=0, type_index=0",
                  "3: #38(): CAST, offset=0, type_index=0",
                  "4: #38(): CAST, offset=6, type_index=0",
                  "5: #40(#37=[@#39(),@#39()]): CAST, offset=6, type_index=0",
                    "RuntimeInvisibleTypeAnnotations:",
                  "0: #38(): METHOD_FORMAL_PARAMETER, param_index=1",
                  "1: #39(): METHOD_FORMAL_PARAMETER, param_index=1",
                  "2: #36(#37=[@#38(),@#38()]): METHOD_FORMAL_PARAMETER, param_index=0",
                  "3: #39(): METHOD_FORMAL_PARAMETER, param_index=0",
                  "4: #38(): METHOD_RETURN",
                  "5: #40(#37=[@#39(),@#39()]): METHOD_RETURN"
                 );
        }
    }

    @TestCase
    public static class TC15 extends RepeatingTypeAnnotations {
        public TC15() {
            setSrc(" /* TC15 */ ",
                   "    public @A @A @C String foo(@C @C @A Object o, @A @B int i, long l) {",
                   "        @C @C @A String ls = (@A @A @C String) o;",
                   "        return (@C @B @B String) o;",
                   "    }");
            verify(
                    "RuntimeVisibleTypeAnnotations:",
                   "0: #36(#37=[@#38(),@#38()]): LOCAL_VARIABLE, {start_pc=6, length=5, index=5}",
                   "1: #38(): CAST, offset=0, type_index=0",
                   "2: #38(): CAST, offset=6, type_index=0",
                    "RuntimeInvisibleTypeAnnotations:",
                   "0: #40(): LOCAL_VARIABLE, {start_pc=6, length=5, index=5}",
                   "1: #41(#37=[@#40(),@#40()]): CAST, offset=0, type_index=0",
                   "2: #42(#37=[@#43(),@#43()]): CAST, offset=6, type_index=0",
                    "RuntimeVisibleTypeAnnotations:",
                   "0: #36(#37=[@#38(),@#38()]): METHOD_FORMAL_PARAMETER, param_index=0",
                   "1: #38(): METHOD_RETURN",
                    "RuntimeInvisibleTypeAnnotations:",
                   "0: #40(): METHOD_FORMAL_PARAMETER, param_index=1",
                   "1: #43(): METHOD_FORMAL_PARAMETER, param_index=1",
                   "2: #40(): METHOD_FORMAL_PARAMETER, param_index=0",
                   "3: #41(#37=[@#40(),@#40()]): METHOD_RETURN"
                    );
        }
    }

    @TestCase
    public static class TC16 extends RepeatingTypeAnnotations {
        public TC16() {
            setSrc(" /* TC16 */ ",
                   "    public @A @B @C String foo(@A @B @C Object o, @A @C int i, long l) {",
                   "        @A @B @C String ls = (@C @A @B String) o;",
                   "        return (@B @A @C String) o;",
                   "    }");
            verify(
                    "RuntimeVisibleTypeAnnotations:",
                   "0: #36(): LOCAL_VARIABLE, {start_pc=6, length=5, index=5}",
                   "1: #36(): CAST, offset=0, type_index=0",
                   "2: #36(): CAST, offset=6, type_index=0",
                    "RuntimeInvisibleTypeAnnotations:",
                   "0: #38(): LOCAL_VARIABLE, {start_pc=6, length=5, index=5}",
                   "1: #39(): LOCAL_VARIABLE, {start_pc=6, length=5, index=5}",
                   "2: #38(): CAST, offset=0, type_index=0",
                   "3: #39(): CAST, offset=0, type_index=0",
                   "4: #39(): CAST, offset=6, type_index=0",
                   "5: #38(): CAST, offset=6, type_index=0",
                    "RuntimeVisibleTypeAnnotations:",
                   "0: #36(): METHOD_FORMAL_PARAMETER, param_index=0",
                   "1: #36(): METHOD_FORMAL_PARAMETER, param_index=1",
                   "2: #36(): METHOD_RETURN",
                    "RuntimeInvisibleTypeAnnotations:",
                   "0: #38(): METHOD_FORMAL_PARAMETER, param_index=0",
                   "1: #39(): METHOD_FORMAL_PARAMETER, param_index=0",
                   "2: #38(): METHOD_FORMAL_PARAMETER, param_index=1",
                   "3: #38(): METHOD_RETURN",
                   "4: #39(): METHOD_RETURN"
                  );
        }
    }
}