-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
TestSuitesIntegrationTest.groovy
778 lines (663 loc) · 26.4 KB
/
TestSuitesIntegrationTest.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
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
/*
* Copyright 2021 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.testing.testsuites
import org.gradle.api.internal.tasks.testing.junit.JUnitTestFramework
import org.gradle.api.internal.tasks.testing.junitplatform.JUnitPlatformTestFramework
import org.gradle.api.internal.tasks.testing.testng.TestNGTestFramework
import org.gradle.api.plugins.jvm.internal.DefaultJvmTestSuite
import org.gradle.api.tasks.testing.junit.JUnitOptions
import org.gradle.api.tasks.testing.junitplatform.JUnitPlatformOptions
import org.gradle.integtests.fixtures.AbstractIntegrationSpec
import org.gradle.integtests.fixtures.JUnitXmlTestExecutionResult
import spock.lang.Issue
class TestSuitesIntegrationTest extends AbstractIntegrationSpec {
def "new test suites adds appropriate test tasks"() {
buildFile << """
plugins {
id 'java'
}
${mavenCentralRepository()}
testing {
suites {
eagerTest(JvmTestSuite)
register("registerTest", JvmTestSuite)
}
}
"""
expect:
succeeds("eagerTest")
succeeds("registerTest")
}
def "built-in test suite does not have any testing framework set at the test suite level"() {
buildFile << """
plugins {
id 'java'
}
${mavenCentralRepository()}
task checkConfiguration {
dependsOn test
doLast {
assert test.testFramework instanceof ${JUnitTestFramework.canonicalName}
assert configurations.testRuntimeClasspath.files.empty
}
}
"""
expect:
succeeds("checkConfiguration")
}
def "configuring test framework on built-in test suite is honored in task and dependencies with JUnit"() {
buildFile << """
plugins {
id 'java'
}
${mavenCentralRepository()}
testing {
suites {
test {
useJUnit()
}
}
}
task checkConfiguration {
dependsOn test
doLast {
assert test.testFramework instanceof ${JUnitTestFramework.canonicalName}
assert configurations.testRuntimeClasspath.files.size() == 2
assert configurations.testRuntimeClasspath.files.any { it.name == "junit-${DefaultJvmTestSuite.Frameworks.JUNIT4.getDefaultVersion()}.jar" }
}
}
"""
expect:
succeeds("checkConfiguration")
}
def "configuring test framework on built-in test suite is honored in task and dependencies with JUnit and explicit version"() {
buildFile << """
plugins {
id 'java'
}
${mavenCentralRepository()}
testing {
suites {
test {
useJUnit("4.12")
}
}
}
task checkConfiguration {
dependsOn test
doLast {
assert test.testFramework instanceof ${JUnitTestFramework.canonicalName}
assert configurations.testRuntimeClasspath.files.size() == 2
assert configurations.testRuntimeClasspath.files.any { it.name == "junit-4.12.jar" }
}
}
"""
expect:
succeeds("checkConfiguration")
}
def "configuring test framework on built-in test suite using a Provider is honored in task and dependencies with JUnit and explicit version"() {
buildFile << """
plugins {
id 'java'
}
${mavenCentralRepository()}
Provider<String> junitVersion = project.provider(() -> '4.12')
testing {
suites {
test {
useJUnit(junitVersion)
}
}
}
task checkConfiguration {
dependsOn test
doLast {
assert test.testFramework instanceof ${JUnitTestFramework.canonicalName}
assert configurations.testRuntimeClasspath.files.size() == 2
assert configurations.testRuntimeClasspath.files.any { it.name == "junit-4.12.jar" }
}
}
"""
expect:
succeeds("checkConfiguration")
}
def "configuring test framework on built-in test suite is honored in task and dependencies with JUnit Jupiter"() {
buildFile << """
plugins {
id 'java'
}
${mavenCentralRepository()}
testing {
suites {
test {
useJUnitJupiter()
}
}
}
task checkConfiguration {
dependsOn test
doLast {
assert test.testFramework instanceof ${JUnitPlatformTestFramework.canonicalName}
assert configurations.testRuntimeClasspath.files.size() == 7
assert configurations.testRuntimeClasspath.files.any { it.name == "junit-jupiter-${DefaultJvmTestSuite.Frameworks.JUNIT_JUPITER.getDefaultVersion()}.jar" }
}
}
"""
expect:
succeeds("checkConfiguration")
}
def "configuring test framework on built-in test suite is honored in task and dependencies with JUnit Jupiter with explicit version"() {
buildFile << """
plugins {
id 'java'
}
${mavenCentralRepository()}
testing {
suites {
test {
useJUnitJupiter("5.7.2")
}
}
}
task checkConfiguration {
dependsOn test
doLast {
assert test.testFramework instanceof ${JUnitPlatformTestFramework.canonicalName}
assert configurations.testRuntimeClasspath.files.size() == 8
assert configurations.testRuntimeClasspath.files.any { it.name == "junit-jupiter-5.7.2.jar" }
}
}
"""
expect:
succeeds("checkConfiguration")
}
def "configuring test framework on built-in test suite using a Provider is honored in task and dependencies with JUnit Jupiter with explicit version"() {
buildFile << """
plugins {
id 'java'
}
${mavenCentralRepository()}
Provider<String> junitVersion = project.provider(() -> '5.7.2')
testing {
suites {
test {
useJUnitJupiter(junitVersion)
}
}
}
task checkConfiguration {
dependsOn test
doLast {
assert test.testFramework instanceof ${JUnitPlatformTestFramework.canonicalName}
assert configurations.testRuntimeClasspath.files.size() == 8
assert configurations.testRuntimeClasspath.files.any { it.name == "junit-jupiter-5.7.2.jar" }
}
}
"""
expect:
succeeds("checkConfiguration")
}
def "conventional test framework on custom test suite is JUnit Jupiter"() {
buildFile << """
plugins {
id 'java'
}
${mavenCentralRepository()}
testing {
suites {
integTest(JvmTestSuite)
}
}
task checkConfiguration {
dependsOn integTest
doLast {
assert integTest.testFramework instanceof ${JUnitPlatformTestFramework.canonicalName}
assert configurations.integTestRuntimeClasspath.files.size() == 7
assert configurations.integTestRuntimeClasspath.files.any { it.name == "junit-jupiter-${DefaultJvmTestSuite.Frameworks.JUNIT_JUPITER.getDefaultVersion()}.jar" }
}
}
"""
expect:
succeeds("checkConfiguration")
}
def "configuring test framework on custom test suite is honored in task and dependencies with #testingFrameworkDeclaration"() {
buildFile << """
plugins {
id 'java'
}
${mavenCentralRepository()}
testing {
suites {
integTest(JvmTestSuite) {
${testingFrameworkDeclaration}
}
}
}
task checkConfiguration {
dependsOn integTest
doLast {
assert integTest.testFramework instanceof ${testingFrameworkType.canonicalName}
assert configurations.integTestRuntimeClasspath.files.any { it.name == "${testingFrameworkDep}" }
}
}
"""
expect:
succeeds("checkConfiguration")
where: // When testing a custom version, this should be a different version that the default
testingFrameworkDeclaration | testingFrameworkType | testingFrameworkDep
'useJUnit()' | JUnitTestFramework | "junit-${DefaultJvmTestSuite.Frameworks.JUNIT4.getDefaultVersion()}.jar"
'useJUnit("4.12")' | JUnitTestFramework | "junit-4.12.jar"
'useJUnitJupiter()' | JUnitPlatformTestFramework | "junit-jupiter-${DefaultJvmTestSuite.Frameworks.JUNIT_JUPITER.getDefaultVersion()}.jar"
'useJUnitJupiter("5.7.1")' | JUnitPlatformTestFramework | "junit-jupiter-5.7.1.jar"
'useSpock()' | JUnitPlatformTestFramework | "spock-core-${DefaultJvmTestSuite.Frameworks.SPOCK.getDefaultVersion()}.jar"
'useSpock("2.1-groovy-3.0")' | JUnitPlatformTestFramework | "spock-core-2.1-groovy-3.0.jar" // Not possible to test a different version from the default yet, since this is the first groovy 3.0 targeted release
'useKotlinTest()' | JUnitPlatformTestFramework | "kotlin-test-junit5-${DefaultJvmTestSuite.Frameworks.KOTLIN_TEST.getDefaultVersion()}.jar"
'useKotlinTest("1.5.30")' | JUnitPlatformTestFramework | "kotlin-test-junit5-1.5.30.jar"
'useTestNG()' | TestNGTestFramework | "testng-${DefaultJvmTestSuite.Frameworks.TESTNG.getDefaultVersion()}.jar"
'useTestNG("7.3.0")' | TestNGTestFramework | "testng-7.3.0.jar"
}
def "configuring test framework on custom test suite using a Provider is honored in task and dependencies with #testingFrameworkMethod version #testingFrameworkVersion"() {
buildFile << """
plugins {
id 'java'
}
${mavenCentralRepository()}
Provider<String> frameworkVersion = project.provider(() -> '$testingFrameworkVersion')
testing {
suites {
integTest(JvmTestSuite) {
$testingFrameworkMethod(frameworkVersion)
}
}
}
task checkConfiguration {
dependsOn integTest
doLast {
assert integTest.testFramework instanceof ${testingFrameworkType.canonicalName}
assert configurations.integTestRuntimeClasspath.files.any { it.name == "$testingFrameworkDep" }
}
}
"""
expect:
succeeds("checkConfiguration")
where: // When testing a custom version, this should be a different version that the default
testingFrameworkMethod | testingFrameworkVersion | testingFrameworkType | testingFrameworkDep
'useJUnit' | '4.12' | JUnitTestFramework | "junit-4.12.jar"
'useJUnitJupiter' | '5.7.1' | JUnitPlatformTestFramework | "junit-jupiter-5.7.1.jar"
'useSpock' | '2.1-groovy-3.0' | JUnitPlatformTestFramework | "spock-core-2.1-groovy-3.0.jar" // Not possible to test a different version from the default yet, since this is the first groovy 3.0 targeted release
'useKotlinTest' | '1.5.30' | JUnitPlatformTestFramework | "kotlin-test-junit5-1.5.30.jar"
'useTestNG' | '7.3.0' | TestNGTestFramework | "testng-7.3.0.jar"
}
def "can override previously configured test framework on a test suite"() {
buildFile << """
plugins {
id 'java'
}
${mavenCentralRepository()}
testing {
suites {
integTest(JvmTestSuite) {
useJUnit()
useJUnitJupiter()
}
}
}
task checkConfigurationIsJupiter {
dependsOn integTest
doLast {
assert integTest.testFramework instanceof ${JUnitPlatformTestFramework.canonicalName}
assert configurations.integTestRuntimeClasspath.files.size() == 7
assert configurations.integTestRuntimeClasspath.files.any { it.name == "junit-jupiter-${DefaultJvmTestSuite.Frameworks.JUNIT_JUPITER.getDefaultVersion()}.jar" }
}
}
task checkConfigurationIsJUnit {
dependsOn integTest
doLast {
assert test.testFramework instanceof ${JUnitTestFramework.canonicalName}
assert configurations.integTestRuntimeClasspath.files.size() == 2
assert configurations.integTestRuntimeClasspath.files.any { it.name == "junit-4.13.2.jar" }
}
}
"""
expect:
succeeds("checkConfigurationIsJupiter")
buildFile << """
testing {
suites {
integTest {
useJUnit()
}
}
}
"""
// Now we're using JUnit again
succeeds("checkConfigurationIsJUnit")
}
def "task configuration overrules test suite configuration"() {
buildFile << """
plugins {
id 'java'
}
${mavenCentralRepository()}
testing {
suites {
integTest(JvmTestSuite) {
// uses junit jupiter by default
targets {
all {
testTask.configure {
useJUnit()
}
}
}
}
}
}
task checkConfiguration {
dependsOn integTest
doLast {
// task is configured to use JUnit4
assert integTest.testFramework instanceof ${JUnitTestFramework.canonicalName}
// but test suite still adds JUnit Jupiter
assert configurations.integTestRuntimeClasspath.files.size() == 7
assert configurations.integTestRuntimeClasspath.files.any { it.name == "junit-jupiter-${DefaultJvmTestSuite.Frameworks.JUNIT_JUPITER.getDefaultVersion()}.jar" }
}
}
"""
expect:
succeeds("checkConfiguration")
}
def "task configuration overrules test suite configuration with test suite set test framework"() {
buildFile << """
plugins {
id 'java'
}
${mavenCentralRepository()}
testing {
suites {
integTest(JvmTestSuite) {
useJUnit()
targets {
all {
testTask.configure {
useJUnitPlatform()
}
}
}
}
}
}
task checkConfiguration {
dependsOn integTest
doLast {
// task is configured to use JUnit Jupiter
assert integTest.testFramework instanceof ${JUnitPlatformTestFramework.canonicalName}
// but test suite still adds JUnit4
assert configurations.integTestRuntimeClasspath.files.size() == 2
assert configurations.integTestRuntimeClasspath.files.any { it.name == "junit-4.13.2.jar" }
}
}
"""
expect:
succeeds("checkConfiguration")
}
def "test framework can not be changed once options have been used with test suites"() {
buildFile << """
plugins {
id 'java'
}
${mavenCentralRepository()}
testing {
suites {
integrationTest(JvmTestSuite) {
useJUnit()
targets.all {
testTask.configure {
options {
excludeCategories "com.example.Exclude"
}
}
}
}
}
}
integrationTest {
useTestNG()
}
check.dependsOn testing.suites
"""
when:
fails("check")
then:
failure.assertHasErrorOutput("You cannot change the test framework to: Test NG after accessing test options. The current framework is: JUnit 4.")
}
def "can change not the test framework multiple times before execution when not using test suites"() {
given:
buildFile << """
plugins {
id 'java'
}
${mavenCentralRepository()}
dependencies { testImplementation "junit:junit:4.13" }
test {
useJUnit()
options {
assert it instanceof ${JUnitOptions.canonicalName}
}
useJUnitPlatform()
options {
assert it instanceof ${JUnitPlatformOptions.canonicalName}
}
useJUnit()
}
"""
and:
file("src/test/java/SomeTest.java") << """
import org.junit.*;
public class SomeTest {
@Test public void foo() {
}
}
"""
when:
fails("test")
then:
failure.assertHasErrorOutput("You cannot change the test framework to: JUnit Platform after accessing test options. The current framework is: JUnit 4.")
}
// This is not the behavior we want in the long term because this makes build configuration sensitive to the order
// that tasks are realized.
// useTestNG() is ignored here because we finalize the test framework on the task as soon as we configure options
// The test framework options should be pushed up into the test suite target/test suite and passed down into the
// Test task
def "build succeeds when test framework is changed to another kind when realizing task and configuring options"() {
buildFile << """
plugins {
id 'java'
}
${mavenCentralRepository()}
testing {
suites {
integrationTest(JvmTestSuite) {
useJUnit()
targets.all {
// explicitly realize the task now to cause this configuration to run now
testTask.get().configure {
options {
excludeCategories "com.example.Exclude"
}
}
}
}
}
}
testing {
suites {
integrationTest {
// This is ignored
useTestNG()
}
}
}
check.dependsOn testing.suites
"""
expect:
succeeds("check")
}
@Issue("https://github.com/gradle/gradle/issues/18622")
def "custom Test tasks eagerly realized prior to Java and Test Suite plugin application do not fail to be configured when combined with test suites"() {
buildFile << """
tasks.withType(Test) {
// realize all test tasks
}
tasks.register("mytest", Test)
apply plugin: 'java'
${mavenCentralRepository()}
testing {
suites {
test {
useJUnit()
}
}
}
"""
file('src/test/java/example/UnitTest.java') << '''
package example;
import org.junit.Assert;
import org.junit.Test;
public class UnitTest {
@Test
public void unitTest() {
Assert.assertTrue(true);
}
}
'''
expect:
succeeds("mytest")
def unitTestResults = new JUnitXmlTestExecutionResult(testDirectory, 'build/test-results/mytest')
unitTestResults.assertTestClassesExecuted('example.UnitTest')
}
@Issue("https://github.com/gradle/gradle/issues/18622")
def "custom Test tasks still function if java plugin is never applied to create sourcesets"() {
buildFile << """
tasks.withType(Test) {
// realize all test tasks
}
def customClassesDir = file('src/custom/java')
tasks.register("mytest", Test) {
// Must ensure a base dir is set here
testClassesDirs = files(customClassesDir)
}
task assertNoTestClasses {
inputs.files mytest.testClassesDirs
doLast {
assert inputs.files.contains(customClassesDir)
}
}
"""
expect:
succeeds("mytest", "assertNoTestClasses")
}
def "multiple getTestingFramework() calls on a test suite return same instance"() {
given:
buildFile << """
plugins {
id 'java'
}
def first = testing.suites.test.getVersionedTestingFramework()
def second = testing.suites.test.getVersionedTestingFramework()
tasks.register('assertSameFrameworkInstance') {
doLast {
assert first === second
}
}""".stripIndent()
expect:
succeeds("assertSameFrameworkInstance")
}
def "multiple getTestingFramework() calls on a test suite return same instance even when calling useJUnit"() {
given:
buildFile << """
plugins {
id 'java'
}
def first = testing.suites.test.getVersionedTestingFramework()
testing {
suites {
test {
useJUnit()
}
}
}
def second = testing.suites.test.getVersionedTestingFramework()
tasks.register('assertSameFrameworkInstance') {
doLast {
assert first === second
}
}""".stripIndent()
expect:
succeeds("assertSameFrameworkInstance")
}
def "multiple getTestingFramework() calls on a test suite return same instance even after toggling testing framework"() {
given:
buildFile << """
plugins {
id 'java'
}
def first = testing.suites.test.getVersionedTestingFramework()
testing.suites.test.useJUnit()
testing.suites.test.useTestNG()
testing.suites.test.useJUnit()
def second = testing.suites.test.getVersionedTestingFramework()
tasks.register('assertSameFrameworkInstance') {
doLast {
assert first === second
}
}""".stripIndent()
expect:
succeeds("assertSameFrameworkInstance")
}
def "the default test suite does NOT use JUnit 4 by default"() {
given: "a build which uses the default test suite and doesn't specify a testing framework"
file("build.gradle") << """
plugins {
id 'java-library'
}
${mavenCentralRepository()}
testing {
suites {
test {
// Empty
}
}
}
"""
and: "containing a test which uses Junit 4"
file("src/test/java/org/test/MyTest.java") << """
package org.test;
import org.junit.Test;
import org.junit.Assert;
public class MyTest {
@Test
public void testSomething() {
Assert.assertEquals(1, MyFixture.calculateSomething());
}
}
"""
expect: "does NOT compile due to a missing dependency"
fails("test")
failure.assertHasErrorOutput("Compilation failed; see the compiler error output for details.")
failure.assertHasErrorOutput("error: package org.junit does not exist")
}
}