opentelemetry-java/custom-checks/src/test/java/io/opentelemetry/gradle/customchecks/OtelDeprecatedApiUsageTest.java at 411f30130c73ba57c6ed707388ca482ce3baee3e · open-telemetry/opentelemetry-java · GitHub

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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
/*
 * Copyright The OpenTelemetry Authors
 * SPDX-License-Identifier: Apache-2.0
 */

package io.opentelemetry.gradle.customchecks;

import com.google.errorprone.CompilationTestHelper;
import org.junit.jupiter.api.Test;

class OtelDeprecatedApiUsageTest {

  @Test
  void positiveCases() {
    CompilationTestHelper.newInstance(
            OtelDeprecatedApiUsage.class, OtelDeprecatedApiUsageTest.class)
        .addSourceLines(
            "DeprecatedClass.java",
            "package test;",
            "@Deprecated",
            "public class DeprecatedClass {",
            "  @Deprecated",
            "  public static void deprecatedMethod() {}",
            "  @Deprecated",
            "  public static String DEPRECATED_FIELD = \"old\";",
            "}")
        .addSourceLines(
            "PositiveCases.java",
            "package test;",
            "public class PositiveCases {",
            "  void method() {",
            "    // BUG: Diagnostic contains: Use of deprecated API: deprecatedMethod()",
            "    DeprecatedClass.deprecatedMethod();",
            "    // BUG: Diagnostic contains: Use of deprecated API: DEPRECATED_FIELD",
            "    String s = DeprecatedClass.DEPRECATED_FIELD;",
            "  }",
            "}")
        .doTest();
  }

  @Test
  void positiveCases_classAsFieldType() {
    CompilationTestHelper.newInstance(
            OtelDeprecatedApiUsage.class, OtelDeprecatedApiUsageTest.class)
        .addSourceLines(
            "DeprecatedClass.java",
            "package test;",
            "@Deprecated",
            "public class DeprecatedClass {}")
        .addSourceLines(
            "PositiveCases.java",
            "package test;",
            "public class PositiveCases {",
            "  // BUG: Diagnostic contains: Use of deprecated API: test.DeprecatedClass",
            "  DeprecatedClass obj;",
            "}")
        .doTest();
  }

  @Test
  void negativeCases_suppressWarningsDeprecation() {
    CompilationTestHelper.newInstance(
            OtelDeprecatedApiUsage.class, OtelDeprecatedApiUsageTest.class)
        .addSourceLines(
            "DeprecatedClass.java",
            "package test;",
            "@Deprecated",
            "public class DeprecatedClass {",
            "  @Deprecated",
            "  public static void deprecatedMethod() {}",
            "}")
        .addSourceLines(
            "NegativeCases.java",
            "package test;",
            "@SuppressWarnings(\"deprecation\")",
            "public class NegativeCases {",
            "  DeprecatedClass obj;",
            "  void method() {",
            "    DeprecatedClass.deprecatedMethod();",
            "  }",
            "}")
        .doTest();
  }

  @Test
  void negativeCases_suppressWarningsCheckName() {
    CompilationTestHelper.newInstance(
            OtelDeprecatedApiUsage.class, OtelDeprecatedApiUsageTest.class)
        .addSourceLines(
            "DeprecatedClass.java",
            "package test;",
            "@Deprecated",
            "public class DeprecatedClass {}")
        .addSourceLines(
            "NegativeCases.java",
            "package test;",
            "@SuppressWarnings(\"OtelDeprecatedApiUsage\")",
            "public class NegativeCases {",
            "  DeprecatedClass obj;",
            "}")
        .doTest();
  }

  @Test
  void negativeCases_insideDeprecatedClass() {
    CompilationTestHelper.newInstance(
            OtelDeprecatedApiUsage.class, OtelDeprecatedApiUsageTest.class)
        .addSourceLines(
            "DeprecatedClass.java",
            "package test;",
            "@Deprecated",
            "public class DeprecatedClass {",
            "  @Deprecated",
            "  public static void deprecatedMethod() {}",
            "}")
        .addSourceLines(
            "NegativeCases.java",
            "package test;",
            "@Deprecated",
            "public class NegativeCases {",
            "  // Inside a deprecated class, using other deprecated APIs is fine",
            "  DeprecatedClass obj;",
            "  void method() {",
            "    DeprecatedClass.deprecatedMethod();",
            "  }",
            "}")
        .doTest();
  }

  @Test
  void negativeCases_sameClassDeprecation() {
    // Matches javac behavior: using deprecated members within the same class doesn't warn
    CompilationTestHelper.newInstance(
            OtelDeprecatedApiUsage.class, OtelDeprecatedApiUsageTest.class)
        .addSourceLines(
            "SameClass.java",
            "package test;",
            "public class SameClass {",
            "  @Deprecated",
            "  public SameClass() {}",
            "  public static SameClass create() {",
            "    // No warning: deprecated constructor is in same class",
            "    return new SameClass();",
            "  }",
            "  @Deprecated",
            "  public static void deprecatedMethod() {}",
            "  public void caller() {",
            "    // No warning: deprecated method is in same class",
            "    deprecatedMethod();",
            "  }",
            "}")
        .doTest();
  }

  @Test
  void negativeCases_importDeprecatedClass() {
    CompilationTestHelper.newInstance(
            OtelDeprecatedApiUsage.class, OtelDeprecatedApiUsageTest.class)
        .addSourceLines(
            "deprecated/DeprecatedClass.java",
            "package deprecated;",
            "@Deprecated",
            "public class DeprecatedClass {}")
        .addSourceLines(
            "NegativeCases.java",
            "package test;",
            "import deprecated.DeprecatedClass;", // Should NOT warn on import
            "@SuppressWarnings(\"deprecation\")",
            "public class NegativeCases {",
            "  void method(DeprecatedClass obj) {}",
            "}")
        .doTest();
  }

  @Test
  void positiveCases_externalDeprecatedApi() {
    // Verify the check detects deprecated APIs from external code (JDK in this case)
    CompilationTestHelper.newInstance(
            OtelDeprecatedApiUsage.class, OtelDeprecatedApiUsageTest.class)
        .addSourceLines(
            "ExternalDeprecated.java",
            "package test;",
            "public class ExternalDeprecated {",
            "  void method() {",
            "    // BUG: Diagnostic contains: Use of deprecated API",
            "    new Boolean(false);",
            "  }",
            "}")
        .doTest();
  }
}