-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
DefaultCachedClasspathTransformerTest.groovy
575 lines (463 loc) · 18.8 KB
/
DefaultCachedClasspathTransformerTest.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
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
/*
* Copyright 2016 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.internal.classpath
import org.gradle.api.Action
import org.gradle.api.internal.cache.CacheConfigurationsInternal
import org.gradle.api.internal.file.TestFiles
import org.gradle.cache.CacheBuilder
import org.gradle.cache.internal.CleanupActionDecorator
import org.gradle.cache.FileLockManager
import org.gradle.cache.GlobalCacheLocations
import org.gradle.cache.internal.UsedGradleVersions
import org.gradle.cache.scopes.GlobalScopedCache
import org.gradle.internal.Pair
import org.gradle.internal.classloader.FilteringClassLoader
import org.gradle.internal.file.FileAccessTimeJournal
import org.gradle.internal.hash.Hasher
import org.gradle.internal.io.ClassLoaderObjectInputStream
import org.gradle.test.fixtures.archive.ZipTestFixture
import org.gradle.test.fixtures.concurrent.ConcurrentSpec
import org.gradle.test.fixtures.file.TestFile
import org.gradle.test.fixtures.file.TestNameTestDirectoryProvider
import org.gradle.testfixtures.internal.TestInMemoryCacheFactory
import org.junit.Rule
import spock.lang.Subject
import java.util.zip.ZipEntry
import static org.gradle.internal.classpath.CachedClasspathTransformer.StandardTransform.BuildLogic
import static org.gradle.internal.classpath.CachedClasspathTransformer.StandardTransform.None
class DefaultCachedClasspathTransformerTest extends ConcurrentSpec {
@Rule
TestNameTestDirectoryProvider testDirectoryProvider = new TestNameTestDirectoryProvider(getClass())
def testDir = testDirectoryProvider.testDirectory
def cachedDir = testDir.file("cached")
def cache = new TestInMemoryCacheFactory().open(cachedDir, "jars")
def cacheBuilder = Stub(CacheBuilder) {
open() >> cache
withDisplayName(_) >> { cacheBuilder }
withCrossVersionCache(_) >> { cacheBuilder }
withLockOptions(_) >> { cacheBuilder }
withCleanupStrategy(_) >> { cacheBuilder }
}
def cacheRepository = Stub(GlobalScopedCache) {
crossVersionCache(_) >> cacheBuilder
}
def fileAccessTimeJournal = Mock(FileAccessTimeJournal)
def usedGradleVersions = Stub(UsedGradleVersions)
def cleanupActionDecorator = Stub(CleanupActionDecorator)
def cacheConfigurations = Stub(CacheConfigurationsInternal)
def cacheFactory = new DefaultClasspathTransformerCacheFactory(usedGradleVersions, cleanupActionDecorator, cacheConfigurations)
def classpathWalker = new ClasspathWalker(TestFiles.fileSystem())
def classpathBuilder = new ClasspathBuilder(TestFiles.tmpDirTemporaryFileProvider(testDirectoryProvider.root))
def fileSystemAccess = TestFiles.fileSystemAccess()
def globalCacheLocations = Stub(GlobalCacheLocations)
def fileLockManager = Stub(FileLockManager)
URLClassLoader testClassLoader = null
@Subject
DefaultCachedClasspathTransformer transformer = new DefaultCachedClasspathTransformer(
cacheRepository,
cacheFactory,
fileAccessTimeJournal,
classpathWalker,
classpathBuilder,
fileSystemAccess,
executorFactory,
globalCacheLocations,
fileLockManager
)
def cleanup() {
testClassLoader?.close()
}
def "does nothing to empty classpath when transform is none"() {
given:
def classpath = DefaultClassPath.of()
when:
def cachedClasspath = transformer.transform(classpath, None)
then:
cachedClasspath.empty
and:
0 * fileAccessTimeJournal._
}
def "does nothing to empty classpath when transform is build logic"() {
given:
def classpath = DefaultClassPath.of()
when:
def cachedClasspath = transformer.transform(classpath, None)
then:
cachedClasspath.empty
and:
0 * fileAccessTimeJournal._
}
def "discards missing file when transform is none"() {
given:
def classpath = DefaultClassPath.of(testDir.file("missing"))
when:
def cachedClasspath = transformer.transform(classpath, None)
then:
cachedClasspath.empty
and:
0 * fileAccessTimeJournal._
}
def "discards missing file when transform is build logic"() {
given:
def classpath = DefaultClassPath.of(testDir.file("missing"))
when:
def cachedClasspath = transformer.transform(classpath, BuildLogic)
then:
cachedClasspath.empty
and:
0 * fileAccessTimeJournal._
}
def "copies file into cache when transform is none"() {
given:
def file = testDir.file("thing.jar")
jar(file)
def classpath = DefaultClassPath.of(file)
def cachedFile = testDir.file("cached/o_e161f24809571a55f09d3f820c8e5942/thing.jar")
when:
def cachedClasspath = transformer.transform(classpath, None)
then:
cachedClasspath.asFiles == [cachedFile]
and:
1 * fileAccessTimeJournal.setLastAccessTime(cachedFile.parentFile, _)
0 * fileAccessTimeJournal._
}
def "reuses file from cache when transform is none"() {
given:
def file = testDir.file("thing.jar")
jar(file)
def classpath = DefaultClassPath.of(file)
def cachedFile = testDir.file("cached/o_e161f24809571a55f09d3f820c8e5942/thing.jar")
transformer.transform(classpath, None)
when:
def cachedClasspath = transformer.transform(classpath, None)
then:
cachedClasspath.asFiles == [cachedFile]
and:
1 * fileAccessTimeJournal.setLastAccessTime(cachedFile.parentFile, _)
0 * fileAccessTimeJournal._
}
def "reuses file from its origin cache when transform is none"() {
given:
def file = testDir.file("other/thing.jar")
_ * globalCacheLocations.isInsideGlobalCache(file.absolutePath) >> true
jar(file)
def classpath = DefaultClassPath.of(file)
transformer.transform(classpath, None)
when:
def cachedClasspath = transformer.transform(classpath, None)
then:
cachedClasspath.asFiles == [file]
and:
0 * fileAccessTimeJournal._
}
def "copies file into cache when content has changed and transform is none"() {
given:
def file = testDir.file("thing.jar")
jar(file)
def classpath = DefaultClassPath.of(file)
def cachedFile = testDir.file("cached/o_e161f24809571a55f09d3f820c8e5942/thing.jar")
transformer.transform(classpath, None)
modifiedJar(file)
when:
def cachedClasspath = transformer.transform(classpath, None)
then:
cachedClasspath.asFiles == [cachedFile]
and:
1 * fileAccessTimeJournal.setLastAccessTime(cachedFile.parentFile, _)
0 * fileAccessTimeJournal._
}
def "reuses directory from its original location when transform is none"() {
given:
def dir = testDir.file("thing.dir")
classesDir(dir)
def classpath = DefaultClassPath.of(dir)
when:
def cachedClasspath = transformer.transform(classpath, None)
then:
cachedClasspath.asFiles == [dir]
and:
0 * fileAccessTimeJournal._
}
def "transforms file into cache when transform is build logic"() {
given:
def file = testDir.file("thing.jar")
jar(file)
def classpath = DefaultClassPath.of(file)
def cachedFile = testDir.file("cached/7d8f1bdd1ac5894c19082a4927eeff0b/thing.jar")
when:
def cachedClasspath = transformer.transform(classpath, BuildLogic)
then:
cachedClasspath.asFiles == [cachedFile]
and:
1 * fileAccessTimeJournal.setLastAccessTime(cachedFile.parentFile, _)
0 * fileAccessTimeJournal._
when:
def cachedClasspath2 = transformer.transform(classpath, BuildLogic)
then:
cachedClasspath2.asFiles == [cachedFile]
and:
1 * fileAccessTimeJournal.setLastAccessTime(cachedFile.parentFile, _)
0 * fileAccessTimeJournal._
}
def "transforms directory into cache when usage is build logic"() {
given:
def dir = testDir.file("thing.dir")
classesDir(dir)
def classpath = DefaultClassPath.of(dir)
def cachedFile = testDir.file("cached/deed05338c460a99c155e591a360d09a/thing.dir.jar")
when:
def cachedClasspath = transformer.transform(classpath, BuildLogic)
then:
cachedClasspath.asFiles == [cachedFile]
and:
1 * fileAccessTimeJournal.setLastAccessTime(cachedFile.parentFile, _)
0 * fileAccessTimeJournal._
when:
def cachedClasspath2 = transformer.transform(classpath, BuildLogic)
then:
cachedClasspath2.asFiles == [cachedFile]
and:
1 * fileAccessTimeJournal.setLastAccessTime(cachedFile.parentFile, _)
0 * fileAccessTimeJournal._
}
def "transforms multiple entries into cache when usage is build logic"() {
given:
def dir = testDir.file("thing.dir")
classesDir(dir)
def file = testDir.file("thing.jar")
jar(file)
def classpath = DefaultClassPath.of(dir, file)
def cachedDir = testDir.file("cached/deed05338c460a99c155e591a360d09a/thing.dir.jar")
def cachedFile = testDir.file("cached/7d8f1bdd1ac5894c19082a4927eeff0b/thing.jar")
when:
def cachedClasspath = transformer.transform(classpath, BuildLogic)
then:
cachedClasspath.asFiles == [cachedDir, cachedFile]
and:
1 * fileAccessTimeJournal.setLastAccessTime(cachedDir.parentFile, _)
1 * fileAccessTimeJournal.setLastAccessTime(cachedFile.parentFile, _)
0 * fileAccessTimeJournal._
}
def "removes entries with duplicate content when usage is none"() {
given:
def dir = testDir.file("thing.dir")
classesDir(dir)
def file = testDir.file("thing.jar")
jar(file)
def dir2 = testDir.file("thing2.dir")
classesDir(dir2)
def file2 = testDir.file("thing2.jar")
jar(file2)
def dir3 = testDir.file("thing3.dir")
classesDir(dir3)
def file3 = testDir.file("thing3.jar")
jar(file3)
def classpath = DefaultClassPath.of(dir, file, dir2, file2, dir3, file3)
def cachedFile = testDir.file("cached/o_e161f24809571a55f09d3f820c8e5942/thing.jar")
when:
def cachedClasspath = transformer.transform(classpath, None)
then:
cachedClasspath.asFiles == [dir, cachedFile]
and:
1 * fileAccessTimeJournal.setLastAccessTime(cachedFile.parentFile, _)
0 * fileAccessTimeJournal._
}
def "removes entries with duplicate content when usage is build logic"() {
given:
def dir = testDir.file("thing.dir")
classesDir(dir)
def file = testDir.file("thing.jar")
jar(file)
def dir2 = testDir.file("thing2.dir")
classesDir(dir2)
def file2 = testDir.file("thing2.jar")
jar(file2)
def dir3 = testDir.file("thing3.dir")
classesDir(dir3)
def file3 = testDir.file("thing3.jar")
jar(file3)
def classpath = DefaultClassPath.of(dir, file, dir2, file2, dir3, file3)
def cachedDir = testDir.file("cached/deed05338c460a99c155e591a360d09a/thing.dir.jar")
def cachedFile = testDir.file("cached/7d8f1bdd1ac5894c19082a4927eeff0b/thing.jar")
when:
def cachedClasspath = transformer.transform(classpath, BuildLogic)
then:
cachedClasspath.asFiles == [cachedDir, cachedFile]
and:
1 * fileAccessTimeJournal.setLastAccessTime(cachedDir.parentFile, _)
1 * fileAccessTimeJournal.setLastAccessTime(cachedFile.parentFile, _)
0 * fileAccessTimeJournal._
}
def "applies client provided transform to file"() {
given:
def transform = Mock(CachedClasspathTransformer.Transform)
def file = testDir.file("thing.jar")
jar(file)
def classpath = DefaultClassPath.of(file)
def cachedFile = testDir.file("cached/c850e684600f7febc81bb5a9e6129d55/thing.jar")
when:
def cachedClasspath = transformer.transform(classpath, BuildLogic, transform)
then:
cachedClasspath.asFiles == [cachedFile]
and:
1 * transform.applyConfigurationTo(_) >> { Hasher hasher -> hasher.putInt(123) }
1 * transform.apply(_, _) >> { entry, visitor ->
assert entry.name == "a.class"
Pair.of(entry.path, visitor)
}
1 * fileAccessTimeJournal.setLastAccessTime(cachedFile.parentFile, _)
0 * _
when:
def cachedClasspath2 = transformer.transform(classpath, BuildLogic, transform)
then:
cachedClasspath2.asFiles == [cachedFile]
and:
1 * transform.applyConfigurationTo(_) >> { Hasher hasher -> hasher.putInt(123) }
1 * fileAccessTimeJournal.setLastAccessTime(cachedFile.parentFile, _)
0 * _
}
def "transformation keeps the compression level of archive entries"() {
given:
def file = testDir.file("thing.jar")
jarWithStoredResource(file)
def classpath = DefaultClassPath.of(file)
def cachedFile = testDir.file("cached/d6260d908e7840629ecf6df971fd26d8/thing.jar")
when:
def cachedClasspath = transformer.transform(classpath, BuildLogic)
then:
cachedClasspath.asFiles == [cachedFile]
def zip = new ZipTestFixture(cachedFile)
zip.hasCompression("a.class", ZipEntry.DEFLATED)
zip.hasCompression("res.txt", ZipEntry.STORED)
}
def "uses non-file URL from origin"() {
given:
def file = testDir.file("thing.jar")
jar(file)
def remote = new URL("https://somewhere")
def cachedFile = testDir.file("cached/o_e161f24809571a55f09d3f820c8e5942/thing.jar")
when:
def cachedClasspath = transformer.transform([file.toURI().toURL(), remote], None)
then:
cachedClasspath == [cachedFile.toURI().toURL(), remote]
and:
1 * fileAccessTimeJournal.setLastAccessTime(cachedFile.parentFile, _)
0 * fileAccessTimeJournal._
}
def "transforms class to intercept calls to System.getProperty()"() {
given:
def listener = Mock(Instrumented.Listener)
Instrumented.setListener(listener)
def cl = transformAndLoad(SystemPropertyAccessingThing)
when:
cl.readProperty()
then:
1 * listener.systemPropertyQueried("prop", null, SystemPropertyAccessingThing.name)
0 * listener._
cleanup:
Instrumented.discardListener()
}
def "transforms Java lambda Action implementations so they can be serialized"() {
given:
def cl = transformAndLoad(ClassWithActionLambda)
expect:
def original = cl.action(123)
original instanceof Serializable
def action = recreate(original)
def result = new StringBuilder()
action.execute(result)
result.toString() == "123"
}
def "class can include both serializable lambda and Action implementations"() {
given:
def cl = transformAndLoad(ClassWithActionAndSerializableLambda, ClassWithActionAndSerializableLambda.SerializableThing)
expect:
def original1 = cl.action(123)
original1 instanceof Serializable
def recreated1 = recreate(original1)
def result1 = new StringBuilder()
recreated1.execute(result1)
result1.toString() == "123"
def original2 = cl.thing(123)
def result2 = recreate(original2).call()
result2 == "123"
}
def "class can include only serializable lambda"() {
given:
def cl = transformAndLoad(ClassWithSerializableLambda, ClassWithSerializableLambda.SerializableThing)
expect:
def original = cl.thing(123)
def result = recreate(original).call()
result == "123"
}
def "interface can include only serializable lambda"() {
given:
def cl = transformAndLoad(SerializableLambda)
expect:
def original = cl.thing(123)
def result = recreate(original).call()
result == "123"
}
Object recreate(Object value) {
def outputStream = new ByteArrayOutputStream()
new ObjectOutputStream(outputStream).with {
writeObject(value)
flush()
}
return new ClassLoaderObjectInputStream(new ByteArrayInputStream(outputStream.toByteArray()), value.class.classLoader).readObject()
}
Class transformAndLoad(Class cl, Class... additional) {
def jar = testDir.file("${cl.name}.jar")
classpathBuilder.jar(jar) { builder ->
([cl] + additional.toList()).forEach { required ->
def fileName = required.name.replace('.', '/') + ".class"
def content = required.classLoader.getResource(fileName).bytes
builder.put(fileName, content)
}
}
def transformed = transformer.transform(DefaultClassPath.of(jar), BuildLogic)
def filtering = new FilteringClassLoader(getClass().classLoader, new FilteringClassLoader.Spec([Action.name, Instrumented.name], [], [], [], [], [], []))
testClassLoader = new URLClassLoader(transformed.asURLArray, filtering)
return testClassLoader.loadClass(cl.name)
}
void classesDir(TestFile dir) {
dir.deleteDir()
dir.createDir()
dir.file("a.class").bytes = classOne()
}
void jar(TestFile file) {
classpathBuilder.jar(file) {
it.put("a.class", classOne())
}
}
void modifiedJar(TestFile file) {
classpathBuilder.jar(file) {
it.put("b.class", classTwo())
}
}
void jarWithStoredResource(TestFile file) {
classpathBuilder.jar(file) {
it.put("a.class", classOne(), ClasspathEntryVisitor.Entry.CompressionMethod.DEFLATED)
it.put("res.txt", "resource".bytes, ClasspathEntryVisitor.Entry.CompressionMethod.STORED)
}
}
byte[] classOne() {
return getClass().classLoader.getResource(SystemPropertyAccessingThing.name.replace('.', '/') + ".class").bytes
}
byte[] classTwo() {
return getClass().classLoader.getResource(AnotherSystemPropertyAccessingThing.name.replace('.', '/') + ".class").bytes
}
}