File: DuplicateAnnotationsTest.java

package info (click to toggle)
openjdk-25 25~32ea-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 825,280 kB
  • sloc: java: 5,584,902; cpp: 1,333,941; xml: 1,321,242; ansic: 487,993; asm: 404,003; objc: 21,088; sh: 15,102; javascript: 13,265; python: 8,319; makefile: 2,515; perl: 357; awk: 351; pascal: 103; exp: 83; sed: 72; jsp: 24
file content (141 lines) | stat: -rw-r--r-- 6,271 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
/*
 * Copyright (c) 2024, 2025, 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 8345614 8350704
 * @summary Ensure behavior with duplicated annotations - class, method, or
 *          field fails fast on duplicate annotations, but parameter allows them
 * @library /test/lib
 * @run junit DuplicateAnnotationsTest
 */

import java.io.IOException;
import java.lang.annotation.AnnotationFormatError;
import java.lang.classfile.*;
import java.lang.classfile.attribute.RuntimeVisibleAnnotationsAttribute;
import java.lang.classfile.attribute.RuntimeVisibleParameterAnnotationsAttribute;
import java.lang.constant.ClassDesc;
import java.lang.reflect.AnnotatedElement;
import java.nio.file.Path;
import java.util.Arrays;
import java.util.List;

import jdk.test.lib.ByteCodeLoader;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.function.Executable;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;

import static org.junit.jupiter.api.Assertions.*;

class DuplicateAnnotationsTest {
    static ClassModel cm;

    @BeforeAll
    static void setup() throws IOException {
        Path annoDuplicatedClass = Path.of(System.getProperty("test.classes")).resolve("AnnotationDuplicated.class");
        cm = ClassFile.of().parse(annoDuplicatedClass);
    }

    interface Extractor {
        AnnotatedElement find(Class<?> cl) throws ReflectiveOperationException;
    }

    // Compiler hint
    static Extractor extract(Extractor e) {
        return e;
    }

    static Arguments[] arguments() {
        Annotation annotationOne = Annotation.of(ClassDesc.of("java.lang.Deprecated"), AnnotationElement.ofBoolean("forRemoval", true));
        Annotation annotationTwo = Annotation.of(ClassDesc.of("java.lang.Deprecated"), AnnotationElement.ofString("since", "24"));
        RuntimeVisibleAnnotationsAttribute rvaa = RuntimeVisibleAnnotationsAttribute.of(
                List.of(annotationOne, annotationTwo)
        );

        return new Arguments[]{
                Arguments.of(
                        "class", true,
                        ClassTransform.endHandler(cob -> cob.with(rvaa)),
                        extract(c -> c)
                ),
                Arguments.of(
                        "field", true,
                        ClassTransform.transformingFields(FieldTransform.endHandler(fb -> fb.with(rvaa))),
                        extract(c -> c.getDeclaredField("field"))
                ),
                Arguments.of(
                        "method", true,
                        ClassTransform.transformingMethods(MethodTransform.endHandler(mb -> mb.with(rvaa))),
                        extract(c -> c.getDeclaredConstructor(int.class))
                ),
                Arguments.of(
                        "parameter", false, // Surprisingly, parameters always allowed duplicate annotations
                        ClassTransform.transformingMethods(MethodTransform.endHandler(mb -> mb.with(
                                RuntimeVisibleParameterAnnotationsAttribute.of(
                                        List.of(List.of(annotationOne, annotationTwo))
                                )
                        ))),
                        extract(c -> c.getDeclaredConstructor(int.class).getParameters()[0])
                ),
        };
    }

    /**
     * A test case represents a declaration that can be annotated.
     * Different declarations have different behaviors when multiple annotations
     * of the same interface are present (without a container annotation).
     *
     * @param caseName the type of declaration, for pretty printing in JUnit
     * @param fails whether this case should fail upon encountering duplicate annotations
     * @param ct transform to install duplicate annotations on the specific declaration
     * @param extractor function to access the AnnotatedElement representing that declaration
     */
    @MethodSource("arguments")
    @ParameterizedTest
    void test(String caseName, boolean fails, ClassTransform ct, Extractor extractor) throws IOException, ReflectiveOperationException {
        var clazz = ByteCodeLoader.load("AnnotationDuplicated", ClassFile.of().transformClass(cm, ct));
        var element = assertDoesNotThrow(() -> extractor.find(clazz));
        Executable exec = () -> element.getAnnotation(Deprecated.class);
        if (fails) {
            var ex = assertThrows(AnnotationFormatError.class, exec, "no duplicate annotation access");
            assertTrue(ex.getMessage().contains("Deprecated"), () -> "missing problematic annotation: " + ex.getMessage());
            assertTrue(ex.getMessage().contains("AnnotationDuplicated"), () -> "missing container class: " + ex.getMessage());
        } else {
            assertDoesNotThrow(exec, "obtaining duplicate annotations should be fine");
            assertEquals(2, Arrays.stream(element.getAnnotations())
                    .filter(anno -> anno instanceof Deprecated)
                    .count());
        }
    }
}

// Duplicate annotations on class, field, method (constructor), method parameter
class AnnotationDuplicated {
    int field;

    AnnotationDuplicated(int arg) {
    }
}