在 Swift 项目中进行测试

Swift 测试支持与配置缓存不兼容。

本地生态系统中的测试是一个丰富的主题。有许多不同的测试库和框架，以及许多不同类型的测试。所有这些都需要成为构建的一部分，无论它们是频繁执行还是不频繁执行。本章致力于解释 Gradle 如何处理构建之间和构建内部的不同需求，并重点介绍它如何与 macOS 和 Linux 上的 XCTest 集成。

它解释了： - 控制测试运行方式的方法（测试执行） - 如何选择要运行的特定测试（测试过滤） - 生成哪些测试报告以及如何影响流程（测试报告） - Gradle 如何查找要执行的测试运行（测试检测）

但首先，我们了解 Gradle 中的本机测试的基础知识。

基础

Gradle 支持与 Swift 语言的 XCTest 测试框架深度集成，并围绕XCTest任务类型。这将使用macOS 上的Xcode XCTest或 Linux 上的开源 Swift 核心库替代方案运行一组测试用例，并整理结果。然后，您可以通过TestReport任务类型的实例将这些结果转换为报告。

为了运行，XCTest任务类型需要三条信息： - 在哪里可以找到构建的可测试包（在 macOS 上）或可执行文件（在 Linux 上）（属性：XCTest.getTestInstalledDirectory()） - 用于执行包的运行脚本或可执行文件（属性：XCTest.getRunScriptFile()） - 执行捆绑包或可执行文件的工作目录（属性：XCTest.getWorkingDirectory()）

当您使用XCTest 插件时，您将自动获得以下内容： - SwiftXCTestSuitexctest类型的专用扩展，用于配置测试组件及其变体 -运行这些单元测试的XCTest类型的任务- 与主程序链接的可测试包或可执行文件组件的目标文件xcTest

测试插件适当地配置所需的信息。此外，他们还将xcTest或run任务附加到check生命周期任务。它还创建testImplementation依赖项配置。仅测试编译、链接和运行时所需的依赖项可以添加到此配置中。脚本xctest块的行为与applicationorlibrary脚本块类似。

XCTest任务有许多配置选项。我们将在本章的其余部分介绍其中的大量内容。

测试执行

Gradle 在单独的（“分叉”）进程中执行测试。

您可以通过XCTest任务上的多个属性来控制测试流程的启动方式，包括以下内容：

ignoreFailures- 默认值：假: 如果此属性为true，Gradle 将在测试完成后继续项目的构建，即使其中一些测试失败。请注意，默认情况下，两种任务类型始终执行它检测到的每个测试，无论此设置如何。
testLogging- 默认值：未设置: 此属性代表一组选项，用于控制记录哪些测试事件以及记录的级别。您还可以通过此属性配置其他日志记录行为。设置TestLoggingContainer以获取更多详细信息。

有关所有可用配置选项的详细信息，请参阅XCTest 。

测试过滤

运行测试套件的子集是一种常见的要求，例如当您修复错误或开发新的测试用例时。 Gradle 提供了过滤来执行此操作。您可以根据以下条件选择要运行的测试：

一个简单的类名或方法名，例如SomeTest，SomeTest.someMethod
'*' 通配符匹配

您可以在构建脚本中或通过--tests命令行选项启用过滤。以下是每次构建运行时应用的一些过滤器的示例：

Example 1. Filter tests on every build

build.gradle.kts

xctest {
    binaries.configureEach {
        runTask.get().filter.includeTestsMatching("SomeIntegTest.*") // or `"Testing.SomeIntegTest.*"` on macOS
    }
}

build.gradle

xctest {
    binaries.configureEach {
        runTask.get().configure {
            // include all tests from test class
            filter.includeTestsMatching "SomeIntegTest.*" // or `"Testing.SomeIntegTest.*"` on macOS
        }
    }
}

有关在构建脚本中声明过滤器的更多详细信息和示例，请参阅 TestFilter 参考。

命令行选项对于执行单个测试方法特别有用。还可以提供多个--tests选项，所有模式都将生效。以下部分有几个使用命令行选项的示例。

测试过滤目前仅支持 XCTest 兼容过滤器。这意味着相同的过滤器在 macOS 和 Linux 上会有所不同。在 macOS 上，包基本名称需要添加到过滤器之前，例如TestBundle.SomeTest，有关有效过滤模式的更多信息， TestBundle.SomeTest.someMethod 请参阅下面的简单名称模式部分。

以下部分将介绍简单类/方法名称的具体情况。

简单的名字模式

Gradle支持简单的类名，或者类名+方法名的测试过滤。例如，以下命令行运行测试用例中的所有测试或仅运行其中一个测试SomeTestClass：

# Executes all tests in SomeTestClass
gradle xcTest --tests SomeTestClass
# or `gradle xcTest --tests TestBundle.SomeTestClass` on macOS

# Executes a single specified test in SomeTestClass
gradle xcTest --tests TestBundle.SomeTestClass.someSpecificMethod
# or `gradle xcTest --tests TestBundle.SomeTestClass.someSpecificMethod` on macOS

您还可以将在命令行定义的过滤器与连续构建结合起来，以便在每次更改生产或测试源文件后立即重新执行测试子集。每当更改触发测试运行时，以下代码都会执行“SomeTestClass”测试类中的所有测试：

gradle test --continuous --tests SomeTestClass

测试报告

XCTest任务默认生成以下结果：

HTML 测试报告
XML 测试结果的格式与 Ant JUnit 报告任务兼容 - 许多其他工具（例如 CI 服务器）都支持这种格式
任务使用结果的高效二进制格式XCTest来生成其他格式

XCTest在大多数情况下，您将使用标准 HTML 报告，该报告自动包含您的任务结果。

还有一个独立的TestReport任务类型，可用于生成自定义 HTML 测试报告。它所需要的只是一个值destinationDir以及您想要包含在报告中的测试结果。以下是为所有子项目的单元测试生成合并报告的示例：

Example 2. Combine test reports from all subprojects

buildSrc/src/main/kotlin/myproject.xctest-conventions.gradle.kts

plugins {
    id("xctest")
}

extensions.configure<SwiftXCTestSuite>() {
    binaries.configureEach {
        // Disable the test report for the individual test task
        runTask.get().reports.html.required = false
    }
}

configurations.create("binaryTestResultsElements") {
    isCanBeResolved = false
    isCanBeConsumed = true
    attributes {
        attribute(Category.CATEGORY_ATTRIBUTE, objects.named(Category.DOCUMENTATION))
        attribute(DocsType.DOCS_TYPE_ATTRIBUTE, objects.named("test-report-data"))
    }
    tasks.withType<XCTest>() {
        outgoing.artifact(binaryResultsDirectory)
    }
}

build.gradle.kts

plugins {
    `reporting-base`
}

val testReportData by configurations.creating {
    isCanBeConsumed = false
    attributes {
        attribute(Category.CATEGORY_ATTRIBUTE, objects.named(Category.DOCUMENTATION))
        attribute(DocsType.DOCS_TYPE_ATTRIBUTE, objects.named("test-report-data"))
    }
}

dependencies {
    testReportData(project(":core"))
    testReportData(project(":util"))
}

tasks.register<TestReport>("testReport") {
    destinationDirectory = reporting.baseDirectory.dir("allTests")
    // Use test results from testReportData configuration
    testResults.from(testReportData)
}

buildSrc/src/main/groovy/myproject.xctest-conventions.gradle

plugins {
    id 'xctest'
}

xctest {
    binaries.configureEach {
        runTask.get().configure {
            // Disable the test report for the individual test task
            reports.html.required = false
        }
    }
}

// Share the test report data to be aggregated for the whole project
configurations {
    binaryTestResultsElements {
        canBeResolved = false
        attributes {
            attribute(Category.CATEGORY_ATTRIBUTE, objects.named(Category, Category.DOCUMENTATION))
            attribute(DocsType.DOCS_TYPE_ATTRIBUTE, objects.named(DocsType, 'test-report-data'))
        }
        tasks.withType(XCTest).configureEach {
            outgoing.artifact(it.binaryResultsDirectory)
        }
    }
}

build.gradle

// A resolvable configuration to collect test reports data
plugins {
    id 'reporting-base'
}

configurations {
    testReportData {
        canBeConsumed = false
        attributes {
            attribute(Category.CATEGORY_ATTRIBUTE, objects.named(Category, Category.DOCUMENTATION))
            attribute(DocsType.DOCS_TYPE_ATTRIBUTE, objects.named(DocsType, 'test-report-data'))
        }
    }
}

dependencies {
    testReportData project(':core')
    testReportData project(':util')
}

tasks.register('testReport', TestReport) {
    destinationDirectory = reporting.baseDirectory.dir('allTests')
    // Use test results from testReportData configuration
    testResults.from(configurations.testReportData)
}

在此示例中，我们使用约定插件myproject.xctest-conventions将项目的测试结果公开给 Gradle 的变体感知依赖管理引擎。

该插件声明一个可使用的binaryTestResultsElements配置，表示任务的二进制测试结果test。在聚合项目的构建文件中，我们声明配置testReportData并依赖于我们想要聚合结果的所有项目。 Gradle 会自动从每个子项目中选择二进制测试结果变体，而不是项目的 jar 文件。最后，我们添加一个testReport任务来聚合属性的测试结果testResultsDirs，其中包含从配置解析的所有二进制测试结果testReportData。

您应该注意，TestReport类型组合了多个测试任务的结果，并且需要聚合各个测试类的结果。这意味着如果给定的测试类由多个测试任务执行，则测试报告将包括该类的执行，但很难区分该类的各个执行及其输出。

此页面是否有帮助？