/
Test.java
1065 lines (955 loc) · 31.5 KB
/
Test.java
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
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright 2010 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.testing;
import com.google.common.collect.Lists;
import groovy.lang.Closure;
import org.gradle.StartParameter;
import org.gradle.api.Action;
import org.gradle.api.Incubating;
import org.gradle.api.JavaVersion;
import org.gradle.api.NonNullApi;
import org.gradle.api.file.FileCollection;
import org.gradle.api.file.FileTree;
import org.gradle.api.file.FileTreeElement;
import org.gradle.api.internal.DocumentationRegistry;
import org.gradle.api.internal.classpath.ModuleRegistry;
import org.gradle.api.internal.file.FileResolver;
import org.gradle.api.internal.initialization.loadercache.ClassLoaderCache;
import org.gradle.api.internal.tasks.testing.JvmTestExecutionSpec;
import org.gradle.api.internal.tasks.testing.TestExecuter;
import org.gradle.api.internal.tasks.testing.TestFramework;
import org.gradle.api.internal.tasks.testing.detection.DefaultTestExecuter;
import org.gradle.api.internal.tasks.testing.filter.DefaultTestFilter;
import org.gradle.api.internal.tasks.testing.junit.JUnitTestFramework;
import org.gradle.api.internal.tasks.testing.junit.result.TestClassResult;
import org.gradle.api.internal.tasks.testing.junit.result.TestResultSerializer;
import org.gradle.api.internal.tasks.testing.junitplatform.JUnitPlatformTestFramework;
import org.gradle.api.internal.tasks.testing.testng.TestNGTestFramework;
import org.gradle.api.specs.Spec;
import org.gradle.api.tasks.CacheableTask;
import org.gradle.api.tasks.Classpath;
import org.gradle.api.tasks.Input;
import org.gradle.api.tasks.InputFiles;
import org.gradle.api.tasks.Internal;
import org.gradle.api.tasks.Nested;
import org.gradle.api.tasks.PathSensitive;
import org.gradle.api.tasks.PathSensitivity;
import org.gradle.api.tasks.SkipWhenEmpty;
import org.gradle.api.tasks.TaskAction;
import org.gradle.api.tasks.options.Option;
import org.gradle.api.tasks.testing.junit.JUnitOptions;
import org.gradle.api.tasks.testing.junitplatform.JUnitPlatformOptions;
import org.gradle.api.tasks.testing.testng.TestNGOptions;
import org.gradle.api.tasks.util.PatternFilterable;
import org.gradle.internal.Actions;
import org.gradle.internal.Cast;
import org.gradle.internal.actor.ActorFactory;
import org.gradle.internal.jvm.UnsupportedJavaRuntimeException;
import org.gradle.internal.jvm.inspection.JvmVersionDetector;
import org.gradle.internal.operations.BuildOperationExecutor;
import org.gradle.internal.time.Clock;
import org.gradle.internal.work.WorkerLeaseRegistry;
import org.gradle.process.CommandLineArgumentProvider;
import org.gradle.process.JavaForkOptions;
import org.gradle.process.ProcessForkOptions;
import org.gradle.process.internal.JavaForkOptionsFactory;
import org.gradle.process.internal.worker.WorkerProcessFactory;
import org.gradle.util.ConfigureUtil;
import javax.annotation.Nullable;
import javax.inject.Inject;
import java.io.File;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import static org.gradle.util.ConfigureUtil.configureUsing;
/**
* Executes JUnit (3.8.x, 4.x or 5.x) or TestNG tests. Test are always run in (one or more) separate JVMs.
*
* <p>
* The sample below shows various configuration options.
*
* <pre class='autoTested'>
* apply plugin: 'java' // adds 'test' task
*
* test {
* // enable TestNG support (default is JUnit)
* useTestNG()
* // enable JUnit Platform (a.k.a. JUnit 5) support
* useJUnitPlatform()
*
* // set a system property for the test JVM(s)
* systemProperty 'some.prop', 'value'
*
* // explicitly include or exclude tests
* include 'org/foo/**'
* exclude 'org/boo/**'
*
* // show standard out and standard error of the test JVM(s) on the console
* testLogging.showStandardStreams = true
*
* // set heap size for the test JVM(s)
* minHeapSize = "128m"
* maxHeapSize = "512m"
*
* // set JVM arguments for the test JVM(s)
* jvmArgs '-XX:MaxPermSize=256m'
*
* // listen to events in the test execution lifecycle
* beforeTest { descriptor ->
* logger.lifecycle("Running test: " + descriptor)
* }
*
* // Fail the 'test' task on the first test failure
* failFast = true
*
* // listen to standard out and standard error of the test JVM(s)
* onOutput { descriptor, event ->
* logger.lifecycle("Test: " + descriptor + " produced standard out/err: " + event.message )
* }
* }
* </pre>
* <p>
* The test process can be started in debug mode (see {@link #getDebug()}) in an ad-hoc manner by supplying the `--debug-jvm` switch when invoking the build.
* <pre>
* gradle someTestTask --debug-jvm
* </pre>
*/
@NonNullApi
@CacheableTask
public class Test extends AbstractTestTask implements JavaForkOptions, PatternFilterable {
private final JavaForkOptions forkOptions;
private FileCollection testClassesDirs;
private PatternFilterable patternSet;
private FileCollection classpath;
private TestFramework testFramework;
private boolean scanForTestClasses = true;
private long forkEvery;
private int maxParallelForks = 1;
private TestExecuter<JvmTestExecutionSpec> testExecuter;
public Test() {
patternSet = getFileResolver().getPatternSetFactory().create();
forkOptions = getForkOptionsFactory().newJavaForkOptions();
forkOptions.setEnableAssertions(true);
}
@Inject
protected ActorFactory getActorFactory() {
throw new UnsupportedOperationException();
}
@Inject
protected ClassLoaderCache getClassLoaderCache() {
throw new UnsupportedOperationException();
}
@Inject
protected WorkerProcessFactory getProcessBuilderFactory() {
throw new UnsupportedOperationException();
}
@Inject
protected FileResolver getFileResolver() {
throw new UnsupportedOperationException();
}
@Inject
protected JavaForkOptionsFactory getForkOptionsFactory() {
throw new UnsupportedOperationException();
}
@Inject
protected ModuleRegistry getModuleRegistry() {
throw new UnsupportedOperationException();
}
/**
* {@inheritDoc}
*/
@Override
@Internal
public File getWorkingDir() {
return forkOptions.getWorkingDir();
}
/**
* {@inheritDoc}
*/
@Override
public void setWorkingDir(File dir) {
forkOptions.setWorkingDir(dir);
}
/**
* {@inheritDoc}
*/
@Override
public void setWorkingDir(Object dir) {
forkOptions.setWorkingDir(dir);
}
/**
* {@inheritDoc}
*/
@Override
public Test workingDir(Object dir) {
forkOptions.workingDir(dir);
return this;
}
/**
* Returns the version of Java used to run the tests based on the executable specified by {@link #getExecutable()}.
*
* @since 3.3
*/
@Input
public JavaVersion getJavaVersion() {
return getServices().get(JvmVersionDetector.class).getJavaVersion(getExecutable());
}
/**
* {@inheritDoc}
*/
@Override
@Internal
public String getExecutable() {
return forkOptions.getExecutable();
}
/**
* {@inheritDoc}
*/
@Override
public Test executable(Object executable) {
forkOptions.executable(executable);
return this;
}
/**
* {@inheritDoc}
*/
@Override
public void setExecutable(String executable) {
forkOptions.setExecutable(executable);
}
/**
* {@inheritDoc}
*/
@Override
public void setExecutable(Object executable) {
forkOptions.setExecutable(executable);
}
/**
* {@inheritDoc}
*/
@Override
public Map<String, Object> getSystemProperties() {
return forkOptions.getSystemProperties();
}
/**
* {@inheritDoc}
*/
@Override
public void setSystemProperties(Map<String, ?> properties) {
forkOptions.setSystemProperties(properties);
}
/**
* {@inheritDoc}
*/
@Override
public Test systemProperties(Map<String, ?> properties) {
forkOptions.systemProperties(properties);
return this;
}
/**
* {@inheritDoc}
*/
@Override
public Test systemProperty(String name, Object value) {
forkOptions.systemProperty(name, value);
return this;
}
/**
* {@inheritDoc}
*/
@Override
public FileCollection getBootstrapClasspath() {
return forkOptions.getBootstrapClasspath();
}
/**
* {@inheritDoc}
*/
@Override
public void setBootstrapClasspath(FileCollection classpath) {
forkOptions.setBootstrapClasspath(classpath);
}
/**
* {@inheritDoc}
*/
@Override
public Test bootstrapClasspath(Object... classpath) {
forkOptions.bootstrapClasspath(classpath);
return this;
}
/**
* {@inheritDoc}
*/
@Override
public String getMinHeapSize() {
return forkOptions.getMinHeapSize();
}
/**
* {@inheritDoc}
*/
@Override
public String getDefaultCharacterEncoding() {
return forkOptions.getDefaultCharacterEncoding();
}
/**
* {@inheritDoc}
*/
@Override
public void setDefaultCharacterEncoding(String defaultCharacterEncoding) {
forkOptions.setDefaultCharacterEncoding(defaultCharacterEncoding);
}
/**
* {@inheritDoc}
*/
@Override
public void setMinHeapSize(String heapSize) {
forkOptions.setMinHeapSize(heapSize);
}
/**
* {@inheritDoc}
*/
@Override
public String getMaxHeapSize() {
return forkOptions.getMaxHeapSize();
}
/**
* {@inheritDoc}
*/
@Override
public void setMaxHeapSize(String heapSize) {
forkOptions.setMaxHeapSize(heapSize);
}
/**
* {@inheritDoc}
*/
@Override
public List<String> getJvmArgs() {
return forkOptions.getJvmArgs();
}
/**
* {@inheritDoc}
*/
@Override
public List<CommandLineArgumentProvider> getJvmArgumentProviders() {
return forkOptions.getJvmArgumentProviders();
}
/**
* {@inheritDoc}
*/
@Override
public void setJvmArgs(List<String> arguments) {
forkOptions.setJvmArgs(arguments);
}
/**
* {@inheritDoc}
*/
@Override
public void setJvmArgs(Iterable<?> arguments) {
forkOptions.setJvmArgs(arguments);
}
/**
* {@inheritDoc}
*/
@Override
public Test jvmArgs(Iterable<?> arguments) {
forkOptions.jvmArgs(arguments);
return this;
}
/**
* {@inheritDoc}
*/
@Override
public Test jvmArgs(Object... arguments) {
forkOptions.jvmArgs(arguments);
return this;
}
/**
* {@inheritDoc}
*/
@Override
public boolean getEnableAssertions() {
return forkOptions.getEnableAssertions();
}
/**
* {@inheritDoc}
*/
@Override
public void setEnableAssertions(boolean enabled) {
forkOptions.setEnableAssertions(enabled);
}
/**
* {@inheritDoc}
*/
@Override
public boolean getDebug() {
return forkOptions.getDebug();
}
/**
* {@inheritDoc}
*/
@Override
@Option(option = "debug-jvm", description = "Enable debugging for the test process. The process is started suspended and listening on port 5005.")
public void setDebug(boolean enabled) {
forkOptions.setDebug(enabled);
}
/**
* Enables fail fast behavior causing the task to fail on the first failed test.
*/
@Option(option = "fail-fast", description = "Stops test execution after the first failed test.")
@Override
public void setFailFast(boolean failFast) {
super.setFailFast(failFast);
}
/**
* Indicates if this task will fail on the first failed test
*
* @return whether this task will fail on the first failed test
*/
@Override
public boolean getFailFast() {
return super.getFailFast();
}
/**
* {@inheritDoc}
*/
@Override
public List<String> getAllJvmArgs() {
return forkOptions.getAllJvmArgs();
}
/**
* {@inheritDoc}
*/
@Override
public void setAllJvmArgs(List<String> arguments) {
forkOptions.setAllJvmArgs(arguments);
}
/**
* {@inheritDoc}
*/
@Override
public void setAllJvmArgs(Iterable<?> arguments) {
forkOptions.setAllJvmArgs(arguments);
}
/**
* {@inheritDoc}
*/
@Override
@Internal
public Map<String, Object> getEnvironment() {
return forkOptions.getEnvironment();
}
/**
* {@inheritDoc}
*/
@Override
public Test environment(Map<String, ?> environmentVariables) {
forkOptions.environment(environmentVariables);
return this;
}
/**
* {@inheritDoc}
*/
@Override
public Test environment(String name, Object value) {
forkOptions.environment(name, value);
return this;
}
/**
* {@inheritDoc}
*/
@Override
public void setEnvironment(Map<String, ?> environmentVariables) {
forkOptions.setEnvironment(environmentVariables);
}
/**
* {@inheritDoc}
*/
@Override
public Test copyTo(ProcessForkOptions target) {
forkOptions.copyTo(target);
return this;
}
/**
* {@inheritDoc}
*/
@Override
public Test copyTo(JavaForkOptions target) {
forkOptions.copyTo(target);
return this;
}
/**
* {@inheritDoc}
* @since 4.4
*/
@Override
protected JvmTestExecutionSpec createTestExecutionSpec() {
JavaForkOptions javaForkOptions = getForkOptionsFactory().newJavaForkOptions();
copyTo(javaForkOptions);
return new JvmTestExecutionSpec(getTestFramework(), getClasspath(), getCandidateClassFiles(), isScanForTestClasses(), getTestClassesDirs(), getPath(), getIdentityPath(), getForkEvery(), javaForkOptions, getMaxParallelForks(), getPreviousFailedTestClasses());
}
private Set<String> getPreviousFailedTestClasses() {
TestResultSerializer serializer = new TestResultSerializer(getBinResultsDir());
if (serializer.isHasResults()) {
final Set<String> previousFailedTestClasses = new HashSet<String>();
serializer.read(new Action<TestClassResult>() {
@Override
public void execute(TestClassResult testClassResult) {
if (testClassResult.getFailuresCount() > 0) {
previousFailedTestClasses.add(testClassResult.getClassName());
}
}
});
return previousFailedTestClasses;
} else {
return Collections.emptySet();
}
}
@Override
@TaskAction
public void executeTests() {
JavaVersion javaVersion = getJavaVersion();
if (!javaVersion.isJava6Compatible()) {
throw new UnsupportedJavaRuntimeException("Support for test execution using Java 5 or earlier was removed in Gradle 3.0.");
}
if (getDebug()) {
getLogger().info("Running tests for remote debugging.");
}
try {
super.executeTests();
} finally {
testFramework = null;
}
}
@Override
protected TestExecuter<JvmTestExecutionSpec> createTestExecuter() {
if (testExecuter == null) {
return new DefaultTestExecuter(getProcessBuilderFactory(), getActorFactory(), getModuleRegistry(),
getServices().get(WorkerLeaseRegistry.class),
getServices().get(BuildOperationExecutor.class),
getServices().get(StartParameter.class).getMaxWorkerCount(),
getServices().get(Clock.class),
getServices().get(DocumentationRegistry.class),
(DefaultTestFilter) getFilter());
} else {
return testExecuter;
}
}
@Override
protected List<String> getNoMatchingTestErrorReasons() {
List<String> reasons = Lists.newArrayList();
if (!getIncludes().isEmpty()) {
reasons.add(getIncludes() + "(include rules)");
}
if (!getExcludes().isEmpty()) {
reasons.add(getExcludes() + "(exclude rules)");
}
reasons.addAll(super.getNoMatchingTestErrorReasons());
return reasons;
}
/**
* Adds include patterns for the files in the test classes directory (e.g. '**/*Test.class')).
*
* @see #setIncludes(Iterable)
*/
@Override
public Test include(String... includes) {
patternSet.include(includes);
return this;
}
/**
* Adds include patterns for the files in the test classes directory (e.g. '**/*Test.class')).
*
* @see #setIncludes(Iterable)
*/
@Override
public Test include(Iterable<String> includes) {
patternSet.include(includes);
return this;
}
/**
* {@inheritDoc}
*/
@Override
public Test include(Spec<FileTreeElement> includeSpec) {
patternSet.include(includeSpec);
return this;
}
/**
* {@inheritDoc}
*/
@Override
public Test include(Closure includeSpec) {
patternSet.include(includeSpec);
return this;
}
/**
* Adds exclude patterns for the files in the test classes directory (e.g. '**/*Test.class')).
*
* @see #setExcludes(Iterable)
*/
@Override
public Test exclude(String... excludes) {
patternSet.exclude(excludes);
return this;
}
/**
* Adds exclude patterns for the files in the test classes directory (e.g. '**/*Test.class')).
*
* @see #setExcludes(Iterable)
*/
@Override
public Test exclude(Iterable<String> excludes) {
patternSet.exclude(excludes);
return this;
}
/**
* {@inheritDoc}
*/
@Override
public Test exclude(Spec<FileTreeElement> excludeSpec) {
patternSet.exclude(excludeSpec);
return this;
}
/**
* {@inheritDoc}
*/
@Override
public Test exclude(Closure excludeSpec) {
patternSet.exclude(excludeSpec);
return this;
}
/**
* {@inheritDoc}
*/
@Override
public Test setTestNameIncludePatterns(List<String> testNamePattern) {
super.setTestNameIncludePatterns(testNamePattern);
return this;
}
/**
* Returns the directories for the compiled test sources.
*
* @return All test class directories to be used.
* @since 4.0
*/
@Internal
public FileCollection getTestClassesDirs() {
return testClassesDirs;
}
/**
* Sets the directories to scan for compiled test sources.
*
* Typically, this would be configured to use the output of a source set:
* <pre class='autoTested'>
* apply plugin: 'java'
*
* sourceSets {
* integrationTest {
* compileClasspath += main.output
* runtimeClasspath += main.output
* }
* }
*
* task integrationTest(type: Test) {
* // Runs tests from src/integrationTest
* testClassesDirs = sourceSets.integrationTest.output.classesDirs
* classpath = sourceSets.integrationTest.runtimeClasspath
* }
* </pre>
*
* @param testClassesDirs All test class directories to be used.
* @since 4.0
*/
public void setTestClassesDirs(FileCollection testClassesDirs) {
this.testClassesDirs = testClassesDirs;
}
/**
* Returns the include patterns for test execution.
*
* @see #include(String...)
*/
@Override
@Internal
public Set<String> getIncludes() {
return patternSet.getIncludes();
}
/**
* Sets the include patterns for test execution.
*
* @param includes The patterns list
* @see #include(String...)
*/
@Override
public Test setIncludes(Iterable<String> includes) {
patternSet.setIncludes(includes);
return this;
}
/**
* Returns the exclude patterns for test execution.
*
* @see #exclude(String...)
*/
@Override
@Internal
public Set<String> getExcludes() {
return patternSet.getExcludes();
}
/**
* Sets the exclude patterns for test execution.
*
* @param excludes The patterns list
* @see #exclude(String...)
*/
@Override
public Test setExcludes(Iterable<String> excludes) {
patternSet.setExcludes(excludes);
return this;
}
@Internal
public TestFramework getTestFramework() {
return testFramework(null);
}
public TestFramework testFramework(@Nullable Closure testFrameworkConfigure) {
if (testFramework == null) {
useJUnit(testFrameworkConfigure);
}
return testFramework;
}
/**
* Returns test framework specific options. Make sure to call {@link #useJUnit()}, {@link #useJUnitPlatform()} or {@link #useTestNG()} before using this method.
*
* @return The test framework options.
*/
@Nested
public TestFrameworkOptions getOptions() {
return getTestFramework().getOptions();
}
/**
* Configures test framework specific options. Make sure to call {@link #useJUnit()}, {@link #useJUnitPlatform()} or {@link #useTestNG()} before using this method.
*
* @return The test framework options.
*/
public TestFrameworkOptions options(Closure testFrameworkConfigure) {
return ConfigureUtil.configure(testFrameworkConfigure, getOptions());
}
/**
* Configures test framework specific options. Make sure to call {@link #useJUnit()}, {@link #useJUnitPlatform()} or {@link #useTestNG()} before using this method.
*
* @return The test framework options.
* @since 3.5
*/
public TestFrameworkOptions options(Action<? super TestFrameworkOptions> testFrameworkConfigure) {
TestFrameworkOptions options = getOptions();
testFrameworkConfigure.execute(options);
return options;
}
TestFramework useTestFramework(TestFramework testFramework) {
return useTestFramework(testFramework, null);
}
private <T extends TestFrameworkOptions> TestFramework useTestFramework(TestFramework testFramework, @Nullable Action<? super T> testFrameworkConfigure) {
if (testFramework == null) {
throw new IllegalArgumentException("testFramework is null!");
}
this.testFramework = testFramework;
if (testFrameworkConfigure != null) {
testFrameworkConfigure.execute(Cast.<T>uncheckedCast(this.testFramework.getOptions()));
}
return this.testFramework;
}
/**
* Specifies that JUnit should be used to execute the tests. <p> To configure JUnit specific options, see {@link #useJUnit(groovy.lang.Closure)}.
*/
public void useJUnit() {
useJUnit(Actions.<JUnitOptions>doNothing());
}
/**
* Specifies that JUnit should be used to execute the tests, configuring JUnit specific options. <p> The supplied closure configures an instance of {@link
* org.gradle.api.tasks.testing.junit.JUnitOptions}, which can be used to configure how JUnit runs.
*
* @param testFrameworkConfigure A closure used to configure the JUnit options.
*/
public void useJUnit(@Nullable Closure testFrameworkConfigure) {
useJUnit(ConfigureUtil.<JUnitOptions>configureUsing(testFrameworkConfigure));
}
/**
* Specifies that JUnit should be used to execute the tests, configuring JUnit specific options. <p> The supplied action configures an instance of {@link
* org.gradle.api.tasks.testing.junit.JUnitOptions}, which can be used to configure how JUnit runs.
*
* @param testFrameworkConfigure An action used to configure the JUnit options.
* @since 3.5
*/
public void useJUnit(Action<? super JUnitOptions> testFrameworkConfigure) {
useTestFramework(new JUnitTestFramework(this, (DefaultTestFilter) getFilter()), testFrameworkConfigure);
}
/**
* Specifies that JUnit Platform (a.k.a. JUnit 5) should be used to execute the tests. <p> To configure JUnit platform specific options, see {@link #useJUnitPlatform(Action)}.
*
* @since 4.6
*/
@Incubating
public void useJUnitPlatform() {
useJUnitPlatform(Actions.<JUnitPlatformOptions>doNothing());
}
/**
* Specifies that JUnit Platform (a.k.a. JUnit 5) should be used to execute the tests, configuring JUnit platform specific options. <p> The supplied action configures an instance of {@link
* org.gradle.api.tasks.testing.junitplatform.JUnitPlatformOptions}, which can be used to configure how JUnit platform runs.
*
* @param testFrameworkConfigure An action used to configure the JUnit platform options.
* @since 4.6
*/
@Incubating
public void useJUnitPlatform(Action<? super JUnitPlatformOptions> testFrameworkConfigure) {
useTestFramework(new JUnitPlatformTestFramework((DefaultTestFilter) getFilter()), testFrameworkConfigure);
}
/**
* Specifies that TestNG should be used to execute the tests. <p> To configure TestNG specific options, see {@link #useTestNG(Closure)}.
*/
public void useTestNG() {
useTestNG(Actions.<TestFrameworkOptions>doNothing());
}
/**
* Specifies that TestNG should be used to execute the tests, configuring TestNG specific options. <p> The supplied closure configures an instance of {@link
* org.gradle.api.tasks.testing.testng.TestNGOptions}, which can be used to configure how TestNG runs.
*
* @param testFrameworkConfigure A closure used to configure the TestNG options.
*/
public void useTestNG(Closure testFrameworkConfigure) {
useTestNG(configureUsing(testFrameworkConfigure));
}
/**
* Specifies that TestNG should be used to execute the tests, configuring TestNG specific options. <p> The supplied action configures an instance of {@link
* org.gradle.api.tasks.testing.testng.TestNGOptions}, which can be used to configure how TestNG runs.
*
* @param testFrameworkConfigure An action used to configure the TestNG options.
* @since 3.5
*/
public void useTestNG(Action<? super TestNGOptions> testFrameworkConfigure) {
useTestFramework(new TestNGTestFramework(this, (DefaultTestFilter) getFilter(), getInstantiator(), getClassLoaderCache()), testFrameworkConfigure);
}
/**
* Returns the classpath to use to execute the tests.
*/
@Classpath
public FileCollection getClasspath() {
return classpath;
}
public void setClasspath(FileCollection classpath) {
this.classpath = classpath;
}
/**
* Specifies whether test classes should be detected. When {@code true} the classes which match the include and exclude patterns are scanned for test classes, and any found are executed. When
* {@code false} the classes which match the include and exclude patterns are executed.
*/
@Input
public boolean isScanForTestClasses() {
return scanForTestClasses;
}
public void setScanForTestClasses(boolean scanForTestClasses) {
this.scanForTestClasses = scanForTestClasses;
}
/**
* Returns the maximum number of test classes to execute in a forked test process. The forked test process will be restarted when this limit is reached.
*
* <p>
* By default, Gradle automatically uses a separate JVM when executing tests.
* <ul>
* <li>A value of <code>0</code> (no limit) means to reuse the test process for all test classes. This is the default.</li>
* <li>A value of <code>1</code> means that a new test process is started for <b>every</b> test class. <b>This is very expensive.</b></li>
* <li>A value of <code>N</code> means that a new test process is started after <code>N</code> test classes.</li>
* </ul>
* This property can have a large impact on performance due to the cost of stopping and starting each test process. It is unusual for this property to be changed from the default.
*
* @return The maximum number of test classes to execute in a test process. Returns 0 when there is no maximum.
*/
@Internal
public long getForkEvery() {
return forkEvery;
}
/**
* Sets the maximum number of test classes to execute in a forked test process.
* <p>
* By default, Gradle automatically uses a separate JVM when executing tests, so changing this property is usually not necessary.
* </p>
*
* @param forkEvery The maximum number of test classes. Use null or 0 to specify no maximum.
*/
public void setForkEvery(@Nullable Long forkEvery) {
if (forkEvery != null && forkEvery < 0) {
throw new IllegalArgumentException("Cannot set forkEvery to a value less than 0.");
}
this.forkEvery = forkEvery == null ? 0 : forkEvery;
}