XCTest

目录

属性
方法
脚本块
属性详情
方法详情
API 文档XCTest

执行 XCTest 测试。测试始终在单个执行中运行。

属性

属性描述
binaryResultsDirectory

用于以内部二进制格式存储测试结果的根目录属性。

ignoreFailures

指定当此任务执行的验证失败时，构建是否应该中断。

reports

此任务可能生成的报告。

runScriptFile

返回测试套件 bundle 或可执行文件位置

testInstallDirectory

测试套件 bundle 或可执行文件位置

workingDirectory

此测试的工作目录属性。

方法

方法描述
addTestListener(listener)

为此任务注册一个测试监听器。还可以考虑以下便捷方法，以便更快地Hook到测试执行中： AbstractTestTask.beforeTest(groovy.lang.Closure), AbstractTestTask.afterTest(groovy.lang.Closure), AbstractTestTask.beforeSuite(groovy.lang.Closure), AbstractTestTask.afterSuite(groovy.lang.Closure)

addTestOutputListener(listener)

为此任务注册一个输出监听器。Hook到输出事件的更快方法是使用 AbstractTestTask.onOutput(groovy.lang.Closure) 方法。

afterSuite(closure)

添加一个闭包，以便在测试套件执行后得到通知。TestDescriptor 和 TestResult 实例作为参数传递给闭包。

afterTest(closure)

添加一个闭包，以便在测试执行后得到通知。TestDescriptor 和 TestResult 实例作为参数传递给闭包。

beforeSuite(closure)

添加一个闭包，以便在测试套件执行前得到通知。TestDescriptor 实例作为参数传递给闭包。

beforeTest(closure)

添加一个闭包，以便在测试执行前得到通知。TestDescriptor 实例作为参数传递给闭包。

onOutput(closure)

添加一个闭包，以便在收到来自测试的输出时得到通知。TestDescriptor 和 TestOutputEvent 实例作为参数传递给闭包。

removeTestListener(listener)

从此任务取消注册一个测试监听器。此方法只会移除通过在此任务上调用 AbstractTestTask.addTestListener(org.gradle.api.tasks.testing.TestListener) 添加的监听器。如果监听器是使用 Gradle.addListener(java.lang.Object) 在 Gradle 中注册的，则此方法不会执行任何操作。请改用 Gradle.removeListener(java.lang.Object)。

removeTestOutputListener(listener)

从此任务取消注册一个测试输出监听器。此方法只会移除通过在此任务上调用 AbstractTestTask.addTestOutputListener(org.gradle.api.tasks.testing.TestOutputListener) 添加的监听器。如果监听器是使用 Gradle.addListener(java.lang.Object) 在 Gradle 中注册的，则此方法不会执行任何操作。请改用 Gradle.removeListener(java.lang.Object)。

reports(configureAction)

配置此任务可能生成的报告。

setTestNameIncludePatterns(testNamePattern)

设置要包含在执行中的测试名称模式。支持类名或方法名，支持通配符 '*'。有关更多信息，请参阅用户指南中关于测试的章节。有关支持模式的更多信息，请参阅 TestFilter

脚本块

没有脚本块

属性详情

DirectoryProperty binaryResultsDirectory

用于以内部二进制格式存储测试结果的根目录属性。

默认值
project.testResultsDir/binary/task.name

boolean ignoreFailures

指定当此任务执行的验证失败时，构建是否应该中断。

TestTaskReports reports (只读)

此任务可能生成的报告。

RegularFileProperty runScriptFile

返回测试套件 bundle 或可执行文件位置

DirectoryProperty testInstallDirectory

测试套件 bundle 或可执行文件位置

DirectoryProperty workingDirectory

此测试的工作目录属性。

方法详情

void addTestListener(TestListener listener)

为此任务注册一个测试监听器。还可以考虑以下便捷方法，以便更快地Hook到测试执行中： AbstractTestTask.beforeTest(groovy.lang.Closure), AbstractTestTask.afterTest(groovy.lang.Closure), AbstractTestTask.beforeSuite(groovy.lang.Closure), AbstractTestTask.afterSuite(groovy.lang.Closure)

此监听器不会收到由其他任务执行的测试的通知。要获得该行为，请使用 Gradle.addListener(java.lang.Object)。

void addTestOutputListener(TestOutputListener listener)

为此任务注册一个输出监听器。Hook到输出事件的更快方法是使用 AbstractTestTask.onOutput(groovy.lang.Closure) 方法。

void afterSuite(Closure closure)

添加一个闭包，以便在测试套件执行后得到通知。TestDescriptor 和 TestResult 实例作为参数传递给闭包。

此方法也会在所有测试套件执行完毕后调用。提供的描述符将具有一个空父套件。

void afterTest(Closure closure)

添加一个闭包，以便在测试执行后得到通知。TestDescriptor 和 TestResult 实例作为参数传递给闭包。

void beforeSuite(Closure closure)

添加一个闭包，以便在测试套件执行前得到通知。TestDescriptor 实例作为参数传递给闭包。

此方法也会在任何测试套件执行之前调用。提供的描述符将具有一个空父套件。

void beforeTest(Closure closure)

添加一个闭包，以便在测试执行前得到通知。TestDescriptor 实例作为参数传递给闭包。

void onOutput(Closure closure)

添加一个闭包，以便在收到来自测试的输出时得到通知。TestDescriptor 和 TestOutputEvent 实例作为参数传递给闭包。

apply plugin: 'java'

test {
   onOutput { descriptor, event ->
       if (event.destination == TestOutputEvent.Destination.StdErr) {
           logger.error("Test: " + descriptor + ", error: " + event.message)
       }
   }
}

void removeTestListener(TestListener listener)

从此任务取消注册一个测试监听器。此方法只会移除通过在此任务上调用 AbstractTestTask.addTestListener(org.gradle.api.tasks.testing.TestListener) 添加的监听器。如果监听器是使用 Gradle.addListener(java.lang.Object) 在 Gradle 中注册的，则此方法不会执行任何操作。请改用 Gradle.removeListener(java.lang.Object)。

void removeTestOutputListener(TestOutputListener listener)

从此任务取消注册一个测试输出监听器。此方法只会移除通过在此任务上调用 AbstractTestTask.addTestOutputListener(org.gradle.api.tasks.testing.TestOutputListener) 添加的监听器。如果监听器是使用 Gradle.addListener(java.lang.Object) 在 Gradle 中注册的，则此方法不会执行任何操作。请改用 Gradle.removeListener(java.lang.Object)。

TestTaskReports reports(Action<? super TestTaskReports> configureAction)

配置此任务可能生成的报告。

AbstractTestTask setTestNameIncludePatterns(List<String> testNamePattern)

设置要包含在执行中的测试名称模式。支持类名或方法名，支持通配符 '*'。有关更多信息，请参阅用户指南中关于测试的章节。有关支持模式的更多信息，请参阅 TestFilter