-
Notifications
You must be signed in to change notification settings - Fork 19
/
ResolutionRulesPluginSpec.groovy
430 lines (365 loc) · 16.7 KB
/
ResolutionRulesPluginSpec.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
/*
* Copyright 2015 Netflix, Inc.
*
* 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 nebula.plugin.resolutionrules
import nebula.test.IntegrationSpec
import org.codehaus.groovy.runtime.StackTraceUtils
/**
* Functional test for {@link ResolutionRulesPlugin}.
*/
class ResolutionRulesPluginSpec extends IntegrationSpec {
File rulesJsonFile
File optionalRulesJsonFile
def setup() {
rulesJsonFile = new File(projectDir, "${moduleName}.json")
optionalRulesJsonFile = new File(projectDir, "optional-${moduleName}.json")
buildFile << """
apply plugin: 'java'
apply plugin: 'nebula.resolution-rules'
repositories {
jcenter()
}
dependencies {
resolutionRules files("$rulesJsonFile", "$optionalRulesJsonFile")
}
""".stripIndent()
rulesJsonFile << """
{
"replace" : [
{
"module" : "asm:asm",
"with" : "org.ow2.asm:asm",
"reason" : "The asm group id changed for 4.0 and later",
"author" : "Danny Thomas <dmthomas@gmail.com>",
"date" : "2015-10-07T20:21:20.368Z"
}
],
"substitute": [
{
"module" : "bouncycastle:bcprov-jdk15",
"with" : "org.bouncycastle:bcprov-jdk15:latest.release",
"reason" : "The latest version of BC is required, using the new coordinate",
"author" : "Danny Thomas <dmthomas@gmail.com>",
"date" : "2015-10-07T20:21:20.368Z"
}
],
"deny": [
{
"module": "com.google.guava:guava:19.0-rc2",
"reason" : "Guava 19.0-rc2 is not permitted",
"author" : "Danny Thomas <dmthomas@gmail.com>",
"date" : "2015-10-07T20:21:20.368Z"
},
{
"module": "com.sun.jersey:jersey-bundle",
"reason" : "jersey-bundle is a fat jar that includes non-relocated (shaded) third party classes, which can cause duplicated classes on the classpath. Please specify the jersey- libraries you need directly",
"author" : "Danny Thomas <dmthomas@gmail.com>",
"date" : "2015-10-07T20:21:20.368Z"
}
],
"reject": [
{
"module": "com.google.guava:guava:12.0",
"reason" : "Guava 12.0 significantly regressed LocalCache performance",
"author" : "Danny Thomas <dmthomas@gmail.com>",
"date" : "2015-10-07T20:21:20.368Z"
}
],
"exclude": [
{
"module": "io.netty:netty-all",
"reason": "Bundle dependencies are harmful, they do not conflict resolve",
"author" : "Danny Thomas <dmthomas@gmail.com>",
"date" : "2015-10-07T20:21:20.368Z"
}
]
}
""".stripIndent()
optionalRulesJsonFile << """
{
"substitute" : [
{
"module" : "log4j:log4j",
"with" : "org.slf4j:log4j-over-slf4j:1.7.21",
"reason" : "SLF4J bridge replacement",
"author" : "Danny Thomas <dmthomas@gmail.com>",
"date" : "2015-10-07T20:21:20.368Z"
}
],
"align": [
{
"group": "org.slf4j",
"reason": "Align SLF4J dependencies",
"author" : "Danny Thomas <dmthomas@gmail.com>",
"date" : "2015-10-07T20:21:20.368Z"
}
]
}
"""
}
def 'plugin applies'() {
when:
def result = runTasksSuccessfully('help')
then:
result.standardError.isEmpty()
}
def 'warning output when no rules source'() {
given:
buildFile.delete()
buildFile << """
apply plugin: 'java'
apply plugin: 'nebula.resolution-rules'
""".stripIndent()
when:
def result = runTasksSuccessfully('dependencies')
then:
result.standardOutput.contains("No resolution rules have been added to the 'resolutionRules' configuration")
}
def 'empty configuration'() {
expect:
runTasksSuccessfully()
}
def 'warning logged when configuration has been resolved'() {
given:
buildFile.text = """\
apply plugin: 'java'
configurations.compile.resolve()
apply plugin: 'nebula.resolution-rules'
repositories {
jcenter()
}
dependencies {
resolutionRules files("$rulesJsonFile", "$optionalRulesJsonFile")
}
""".stripIndent()
when:
def result = runTasksSuccessfully()
then:
result.standardOutput.contains("Configuration 'compile' has been resolved. Dependency resolution rules will not be applied")
}
def 'all rules sources'() {
def ant = new AntBuilder()
def rulesJarFile = new File(projectDir, 'rules.jar')
ant.jar(destfile: rulesJarFile, basedir: rulesJsonFile.parentFile)
def rulesZipFile = new File(projectDir, 'rules.zip')
ant.zip(destfile: rulesZipFile, basedir: rulesJsonFile.parentFile)
buildFile << """
dependencies {
resolutionRules files("$rulesJarFile")
resolutionRules files("$rulesZipFile")
}
""".stripIndent()
when:
def result = runTasksSuccessfully('dependencies')
then:
result.standardOutput.contains 'Using all-rules-sources (all-rules-sources.json) a dependency rules source'
result.standardOutput.contains "Using all-rules-sources ($projectDir/rules.jar) a dependency rules source"
result.standardOutput.contains "Using all-rules-sources ($projectDir/rules.zip) a dependency rules source"
}
def 'replace module'() {
given:
buildFile << """
dependencies {
compile 'asm:asm:3.3.1'
compile 'org.ow2.asm:asm:5.0.4'
}
""".stripIndent()
when:
def result = runTasksSuccessfully('dependencies', '--configuration', 'compile')
then:
result.standardOutput.contains('asm:asm:3.3.1 -> org.ow2.asm:asm:5.0.4')
}
def "module is not replaced if the replacement isn't in the configuration"() {
given:
buildFile << """
dependencies {
compile 'asm:asm:3.3.1'
}
""".stripIndent()
when:
def result = runTasksSuccessfully('dependencies', '--configuration', 'compile')
then:
result.standardOutput.contains('asm:asm:3.3.1')
!result.standardOutput.contains('asm:asm:3.3.1 -> org.ow2.asm:asm:5.0.4')
}
def 'substitute dependency'() {
given:
buildFile << """
dependencies {
compile 'bouncycastle:bcprov-jdk15:140'
}
""".stripIndent()
when:
def result = runTasksSuccessfully('dependencies', '--configuration', 'compile')
then:
result.standardOutput.contains('bouncycastle:bcprov-jdk15:140 -> org.bouncycastle:bcprov-jdk15:latest.release')
}
def 'exclude dependency'() {
given:
buildFile << """
dependencies {
compile 'io.netty:netty-all:5.0.0.Alpha2'
}
""".stripIndent()
when:
def result = runTasksSuccessfully('dependencies', '--configuration', 'compile')
then:
result.standardOutput.contains('No dependencies')
}
def 'optional rules are not applied by default'() {
given:
buildFile << """
dependencies {
compile 'log4j:log4j:1.2.17'
}
""".stripIndent()
when:
def result = runTasksSuccessfully('dependencies', '--configuration', 'compile')
then:
result.standardOutput.contains('\\--- log4j:log4j:1.2.17\n')
}
def 'optional rules are applied when specified'() {
given:
buildFile << """
nebulaResolutionRules {
optional = ["${moduleName}"]
}
dependencies {
resolutionRules files("$optionalRulesJsonFile")
compile 'log4j:log4j:1.2.17'
compile 'org.slf4j:jcl-over-slf4j:1.7.0'
}
""".stripIndent()
when:
def result = runTasksSuccessfully('dependencies', '--configuration', 'compile')
then:
result.standardOutput.contains("""\
+--- log4j:log4j:1.2.17 -> org.slf4j:log4j-over-slf4j:1.7.21
| \\--- org.slf4j:slf4j-api:1.7.21
\\--- org.slf4j:jcl-over-slf4j:1.7.0 -> 1.7.21
\\--- org.slf4j:slf4j-api:1.7.21
""")
}
def 'only included rules are applied'() {
given:
def otherRulesFile = new File(projectDir, "other-${moduleName}.json")
otherRulesFile << """
{
"substitute" : [
{
"module" : "log4j:log4j",
"with" : "org.slf4j:log4j-over-slf4j:1.7.21",
"reason" : "SLF4J bridge replacement",
"author" : "Danny Thomas <dmthomas@gmail.com>",
"date" : "2015-10-07T20:21:20.368Z"
}
]
}
"""
buildFile << """
nebulaResolutionRules {
include = ["other-${moduleName}"]
}
dependencies {
resolutionRules files("$optionalRulesJsonFile", "$otherRulesFile")
compile 'log4j:log4j:1.2.17'
compile 'asm:asm:3.3.1'
compile 'org.ow2.asm:asm:5.0.4'
}
""".stripIndent()
when:
def result = runTasksSuccessfully('dependencies', '--configuration', 'compile')
then:
result.standardOutput.contains('log4j:log4j:1.2.17 -> org.slf4j:log4j-over-slf4j:1.7.21')
!result.standardOutput.contains('asm:asm:3.3.1 -> org.ow2.asm:asm:5.0.4')
}
def 'missing version in substitution rule'() {
given:
rulesJsonFile.delete()
rulesJsonFile << """
{
"substitute": [
{
"module" : "asm:asm",
"with" : "org.ow2.asm:asm",
"reason" : "The asm group id changed for 4.0 and later",
"author" : "Danny Thomas <dmthomas@gmail.com>",
"date" : "2015-10-07T20:21:20.368Z"
}
]
}
""".stripIndent()
when:
def result = runTasks('dependencies', '--configuration', 'compile')
then:
def rootCause = StackTraceUtils.extractRootCause(result.failure)
rootCause.class.simpleName == 'SubstituteRuleMissingVersionException'
rootCause.message == "The dependency to be substituted (org.ow2.asm:asm) must have a version. Invalid rule: SubstituteRule(module=asm:asm, with=org.ow2.asm:asm, reason=The asm group id changed for 4.0 and later, author=Danny Thomas <dmthomas@gmail.com>, date=2015-10-07T20:21:20.368Z)"
}
def 'validator gives error for invalid json'() {
given:
rulesJsonFile.delete()
rulesJsonFile << """
{}
"""
when:
def result = runTasks('dependencies', '--configuration', 'compile')
then:
def rootCause = StackTraceUtils.extractRootCause(result.failure)
rootCause.class.simpleName == 'InvalidRulesJsonException'
rootCause.message.endsWith("is not a valid resolution json file")
}
def 'deny dependency'() {
given:
buildFile << """
dependencies {
compile 'com.google.guava:guava:19.0-rc2'
}
""".stripIndent()
when:
def result = runTasks('dependencies', '--configuration', 'compile')
then:
def rootCause = StackTraceUtils.extractRootCause(result.failure)
rootCause.class.simpleName == 'DependencyDeniedException'
rootCause.message == "Dependency com.google.guava:guava:19.0-rc2 denied by dependency rule: Guava 19.0-rc2 is not permitted"
}
def 'deny dependency without version'() {
given:
buildFile << """
dependencies {
compile 'com.sun.jersey:jersey-bundle:1.19'
}
""".stripIndent()
when:
def result = runTasks('dependencies', '--configuration', 'compile')
then:
def rootCause = StackTraceUtils.extractRootCause(result.failure)
rootCause.class.simpleName == 'DependencyDeniedException'
rootCause.message == "Dependency com.sun.jersey:jersey-bundle denied by dependency rule: jersey-bundle is a fat jar that includes non-relocated (shaded) third party classes, which can cause duplicated classes on the classpath. Please specify the jersey- libraries you need directly"
}
def 'reject dependency'() {
given:
buildFile << """
dependencies {
compile 'com.google.guava:guava:12.0'
}
""".stripIndent()
when:
def result = runTasksSuccessfully('dependencies', '--configuration', 'compile')
then:
result.standardOutput.contains("Selection of com.google.guava:guava:12.0 rejected by component selection rule: Rejected by resolution rule reject-dependency - Guava 12.0 significantly regressed LocalCache performance")
}
}