/
IsolatingIncrementalAnnotationProcessingIntegrationTest.groovy
444 lines (349 loc) · 15.3 KB
/
IsolatingIncrementalAnnotationProcessingIntegrationTest.groovy
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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
/*
* Copyright 2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gradle.api.tasks.compile
import org.gradle.api.JavaVersion
import org.gradle.api.internal.tasks.compile.CompileJavaBuildOperationType
import org.gradle.api.internal.tasks.compile.incremental.processing.IncrementalAnnotationProcessorType
import org.gradle.integtests.fixtures.AvailableJavaHomes
import org.gradle.integtests.fixtures.executer.GradleContextualExecuter
import org.gradle.language.fixtures.AnnotationProcessorFixture
import org.gradle.language.fixtures.HelperProcessorFixture
import org.gradle.language.fixtures.NonIncrementalProcessorFixture
import org.gradle.language.fixtures.ResourceGeneratingProcessorFixture
import org.gradle.language.fixtures.ServiceRegistryProcessorFixture
import org.gradle.util.TextUtil
import spock.lang.IgnoreIf
import spock.lang.Issue
import javax.tools.StandardLocation
import static org.gradle.api.internal.tasks.compile.CompileJavaBuildOperationType.Result.AnnotationProcessorDetails.Type.ISOLATING
// This is failing on release6x and we don't want to spent time on it
@IgnoreIf({ GradleContextualExecuter.isForceRealize() })
class IsolatingIncrementalAnnotationProcessingIntegrationTest extends AbstractIncrementalAnnotationProcessingIntegrationTest {
private static HelperProcessorFixture writingResourcesTo(String location) {
def helperProcessorFixture = new HelperProcessorFixture()
helperProcessorFixture.writeResources = true
helperProcessorFixture.resourceLocation = location
return helperProcessorFixture
}
private HelperProcessorFixture helperProcessor
@Override
def setup() {
helperProcessor = writingResourcesTo(StandardLocation.CLASS_OUTPUT.toString())
withProcessor(helperProcessor)
}
def "generated files are recompiled when annotated file changes"() {
given:
def a = java "@Helper class A {}"
java "class Unrelated {}"
outputs.snapshot { run "compileJava" }
when:
a.text = "@Helper class A { public void foo() {} }"
run "compileJava"
then:
outputs.recompiledFiles("A", "AHelper", "AHelperResource.txt")
}
def "incremental processing works on subsequent incremental compilations"() {
given:
def a = java "@Helper class A {}"
java "class Unrelated {}"
run "compileJava"
a.text = "@Helper class A { public void foo() {} }"
outputs.snapshot { run "compileJava" }
when:
a.text = "@Helper class A { public void bar() {} }"
run "compileJava"
then:
outputs.recompiledFiles("A", "AHelper", "AHelperResource.txt")
}
def "annotated files are not recompiled on unrelated changes"() {
given:
java "@Helper class A {}"
def unrelated = java "class Unrelated {}"
outputs.snapshot { run "compileJava" }
when:
unrelated.text = "class Unrelated { public void foo() {} }"
run "compileJava"
then:
outputs.recompiledClasses("Unrelated")
}
def "classes depending on generated file are recompiled when source file changes"() {
given:
def a = java "@Helper class A {}"
java """class Dependent {
private AHelper helper = new AHelper();
}"""
outputs.snapshot { run "compileJava" }
when:
a.text = "@Helper class A { public void foo() {} }"
run "compileJava"
then:
outputs.recompiledFiles("A", "AHelper", "AHelperResource.txt")
}
def "source file is recompiled when dependency of generated file changes"() {
given:
withProcessor(new OpaqueDependencyProcessor())
java "@Thingy class A {}"
def dependency = java "class Dependency {}"
outputs.snapshot { run "compileJava" }
when:
dependency.text = "class Dependency { public void foo() {} }"
run "compileJava"
then:
outputs.recompiledClasses("A", "AThingy", "Dependency")
}
def "classes files of generated sources are deleted when annotated file is deleted"() {
given:
def a = java "@Helper class A {}"
java "class Unrelated {}"
outputs.snapshot { run "compileJava" }
when:
a.delete()
run "compileJava"
then:
outputs.deletedFiles("A", "AHelper", "AHelperResource.txt")
}
def "generated files are deleted when annotated file is deleted"() {
given:
withProcessor(writingResourcesTo(StandardLocation.SOURCE_OUTPUT.toString()))
def a = java "@Helper class A {}"
java "class Unrelated {}"
when:
outputs.snapshot { run "compileJava" }
then:
file("build/generated/sources/annotationProcessor/java/main/AHelper.java").exists()
file("build/generated/sources/annotationProcessor/java/main/AHelperResource.txt").exists()
when:
a.delete()
run "compileJava"
then:
!file("build/generated/sources/annotationProcessor/java/main/AHelper.java").exists()
!file("build/generated/sources/annotationProcessor/java/main/AHelperResource.txt").exists()
}
def "generated files and classes are deleted when processor is removed"() {
given:
withProcessor(writingResourcesTo(StandardLocation.SOURCE_OUTPUT.toString()))
java "@Helper class A {}"
when:
outputs.snapshot { run "compileJava" }
then:
file("build/generated/sources/annotationProcessor/java/main/AHelper.java").exists()
file("build/generated/sources/annotationProcessor/java/main/AHelperResource.txt").exists()
when:
buildFile << "compileJava.options.annotationProcessorPath = files()"
run "compileJava"
then:
!file("build/generated/sources/annotationProcessor/java/main/AHelper.java").exists()
!file("build/generated/sources/annotationProcessor/java/main/AHelperResource.txt").exists()
and:
outputs.deletedFiles("AHelper")
}
def "all files are recompiled when processor changes"() {
given:
java "@Helper class A {}"
outputs.snapshot { run "compileJava" }
when:
helperProcessor.suffix = "world"
withProcessor(helperProcessor)
run "compileJava"
then:
outputs.recompiledFiles("A", "AHelper", "AHelperResource.txt")
}
def "all files are recompiled if compiler does not support incremental annotation processing"() {
given:
buildFile << """
compileJava {
options.fork = true
options.forkOptions.executable = '${TextUtil.escapeString(AvailableJavaHomes.getJdk(JavaVersion.current()).javacExecutable)}'
}
"""
def a = java "@Helper class A {}"
java "class Unrelated {}"
outputs.snapshot { run "compileJava" }
when:
a.text = "@Helper class A { public void foo() {} }"
run "compileJava", "--info"
then:
outputs.recompiledFiles("A", "AHelper", "Unrelated", "AHelperResource.txt")
and:
outputContains("the chosen compiler did not support incremental annotation processing")
}
def "all files are recompiled if a generated source file is deleted"() {
given:
java "@Helper class A {}"
java "class Unrelated {}"
outputs.snapshot { run "compileJava" }
when:
file("build/generated/sources/annotationProcessor/java/main/AHelper.java").delete()
run "compileJava"
then:
outputs.recompiledFiles('A', "AHelper", "AHelperResource.txt", "Unrelated")
}
def "all files are recompiled if a generated class is deleted"() {
given:
java "@Helper class A {}"
java "class Unrelated {}"
outputs.snapshot { run "compileJava" }
when:
file("build/classes/java/main/AHelper.class").delete()
run "compileJava"
then:
outputs.recompiledFiles('A', "AHelper", "AHelperResource.txt", "Unrelated")
}
def "all files are recompiled if a generated resource is deleted"() {
given:
java "@Helper class A {}"
java "class Unrelated {}"
outputs.snapshot { run "compileJava" }
when:
file("build/classes/java/main/AHelperResource.txt").delete()
run "compileJava"
then:
outputs.recompiledFiles('A', "AHelper", "AHelperResource.txt", "Unrelated")
}
def "processors must provide an originating element for each source element"() {
given:
withProcessor(new NonIncrementalProcessorFixture().providingNoOriginatingElements().withDeclaredType(IncrementalAnnotationProcessorType.ISOLATING))
def a = java "@Thing class A {}"
outputs.snapshot { succeeds "compileJava" }
when:
a.text = "@Thing class A { void foo() {} }"
then:
succeeds "compileJava", "--info"
and:
outputContains("Full recompilation is required because the generated type 'AThing' must have exactly one originating element, but had 0.")
}
def "processors must provide an originating element for each resource"() {
given:
withProcessor(new ResourceGeneratingProcessorFixture().providingNoOriginatingElements().withDeclaredType(IncrementalAnnotationProcessorType.ISOLATING))
def a = java "@Thing class A {}"
outputs.snapshot { succeeds "compileJava" }
when:
a.text = "@Thing class A { void foo() {} }"
then:
succeeds "compileJava", "--info"
and:
outputContains("Full recompilation is required because the generated resource 'A.txt in SOURCE_OUTPUT' must have exactly one originating element, but had 0.")
}
def "processors cannot provide multiple originating elements for types"() {
given:
withProcessor(new ServiceRegistryProcessorFixture().withDeclaredType(IncrementalAnnotationProcessorType.ISOLATING))
def a = java "@Service class A {}"
java "@Service class B {}"
outputs.snapshot { succeeds "compileJava" }
when:
a.text = "@Service class A { void foo() {} }"
then:
succeeds "compileJava", "--info"
and:
outputContains("Full recompilation is required because the generated type 'ServiceRegistry' must have exactly one originating element, but had 2.")
}
def "processors cannot provide multiple originating elements for resources"() {
given:
def proc = new ServiceRegistryProcessorFixture()
proc.writeResources = true
withProcessor(proc.withDeclaredType(IncrementalAnnotationProcessorType.ISOLATING))
def a = java "@Service class A {}"
java "@Service class B {}"
outputs.snapshot { succeeds "compileJava" }
when:
a.text = "@Service class A { void foo() {} }"
then:
succeeds "compileJava", "--info"
and:
outputContains("Full recompilation is required because the generated resource 'ServiceRegistryResource.txt in CLASS_OUTPUT' must have exactly one originating element, but had 2.")
}
def "processors can generate identical resources in different locations"() {
given:
def locations = [StandardLocation.SOURCE_OUTPUT.toString(), StandardLocation.NATIVE_HEADER_OUTPUT.toString(), StandardLocation.CLASS_OUTPUT.toString()]
withProcessor(new ResourceGeneratingProcessorFixture().withOutputLocations(locations).withDeclaredType(IncrementalAnnotationProcessorType.ISOLATING))
def a = java "@Thing class A {}"
java "class Unrelated {}"
when:
outputs.snapshot { succeeds "compileJava" }
then:
file("build/generated/sources/annotationProcessor/java/main/A.txt").exists()
file("build/generated/sources/headers/java/main/A.txt").exists()
file("build/classes/java/main/A.txt").exists()
when:
a.delete()
succeeds "compileJava"
then: "they all get cleaned"
outputs.deletedClasses("A")
!file("build/generated/sources/annotationProcessor/java/main/A.txt").exists()
!file("build/generated/sources/headers/java/main/A.txt").exists()
!file("build/classes/java/main/A.txt").exists()
}
@Issue(["https://github.com/gradle/gradle/issues/8128", "https://bugs.openjdk.java.net/browse/JDK-8162455"])
def "incremental processing doesn't trigger unmatched processor option warning"() {
buildFile << """
dependencies {
compileOnly project(":annotation")
annotationProcessor project(":processor")
}
compileJava.options.compilerArgs += [ "-Werror", "-Amessage=fromOptions" ]
"""
java "@Helper class A {}"
outputs.snapshot { succeeds "compileJava" }
when:
java "class B {}"
then:
succeeds "compileJava"
outputs.recompiledClasses("B")
}
def "reports isolating processor in build operation"() {
java "class Irrelevant {}"
when:
succeeds "compileJava"
then:
with(operations[':compileJava'].result.annotationProcessorDetails as List<CompileJavaBuildOperationType.Result.AnnotationProcessorDetails>) {
size() == 1
first().className == 'HelperProcessor'
first().type == ISOLATING.name()
}
}
/**
* An annotation processor whose generated code depends on some library class that the annotated
* file does not depend on. A real-world example would be a processor that generated database
* access classes and depends on the concrete database driver, which might change.
*/
private static class OpaqueDependencyProcessor extends AnnotationProcessorFixture {
OpaqueDependencyProcessor() {
super("Thingy")
}
@Override
protected String getGeneratorCode() {
"""
for (Element element : elements) {
TypeElement typeElement = (TypeElement) element;
String className = typeElement.getSimpleName().toString() + "Thingy";
try {
JavaFileObject sourceFile = filer.createSourceFile(className, element);
Writer writer = sourceFile.openWriter();
try {
writer.write("class " + className + " {");
writer.write(" Dependency getValue() { return new Dependency();}");
writer.write("}");
} finally {
writer.close();
}
} catch (IOException e) {
messager.printMessage(Diagnostic.Kind.ERROR, "Failed to generate source file " + className, element);
}
}
"""
}
}
}