@@ -10,39 +10,58 @@ import org.gradle.api.file.FileCollection
10
10
import org.gradle.api.tasks.testing.TestFilter
11
11
12
12
/* *
13
- * @suppress TODO: KT-58858 add documentation
13
+ * A [KotlinExecution] that runs configured tests.
14
14
*/
15
15
interface KotlinTestRun <out SourceType : KotlinExecution .ExecutionSource > : KotlinExecution <SourceType > {
16
+
17
+ /* *
18
+ * Configures filtering for executable tests using the provided [configureFilter] configuration.
19
+ */
16
20
fun filter (configureFilter : TestFilter .() -> Unit )
17
21
22
+ /* *
23
+ * Configures filtering for executable tests using the provided [configureFilter] configuration.
24
+ */
18
25
fun filter (configureFilter : Closure <* >)
19
26
}
20
27
21
28
/* *
22
- * @suppress TODO: KT-58858 add documentation
29
+ * A [KotlinTargetExecution] that executes configured tests in the context of a specific [KotlinTarget].
23
30
*/
24
31
interface KotlinTargetTestRun <ExecutionSource : KotlinExecution .ExecutionSource > :
25
32
KotlinTestRun <ExecutionSource >,
26
33
KotlinTargetExecution <ExecutionSource >
27
34
28
35
/* *
29
- * @suppress TODO: KT-58858 add documentation
36
+ * A [KotlinExecution.ExecutionSource] that provides the [classpath] and [testClassesDirs] where JVM test classes can be found.
30
37
*/
31
38
interface JvmClasspathTestRunSource : KotlinExecution .ExecutionSource {
39
+
40
+ /* *
41
+ * The part of the classpath where JVM test classes are located for execution.
42
+ */
32
43
val testClassesDirs: FileCollection
44
+
45
+ /* *
46
+ * The tests classpath.
47
+ *
48
+ * This includes dependencies and/or test framework classes such as JUnit, TestNG, or any other test framework classes.
49
+ */
33
50
val classpath: FileCollection
34
51
}
35
52
36
53
/* *
37
- * @suppress TODO: KT-58858 add documentation
54
+ * Configures the [JvmClasspathTestRunSource].
38
55
*/
39
56
interface ClasspathTestRunSourceSupport {
57
+
40
58
/* *
41
- * Select the exact [classpath] to run the tests from .
59
+ * Configures values for the [JvmClasspathTestRunSource] .
42
60
*
43
- * Only the classes from [testClasses] will be treated as tests .
61
+ * Calling this method overwrites any already configured values in the [JvmClasspathTestRunSource] .
44
62
*
45
- * This overrides other [KotlinExecution.executionSource] selection options.
63
+ * @param [classpath] Tests classpath
64
+ * @param [testClassesDirs] Only the classes from this [FileCollection] are treated as tests.
46
65
*/
47
66
fun setExecutionSourceFrom (classpath : FileCollection , testClassesDirs : FileCollection )
48
67
}
0 commit comments