怎样以编程方式分析 XCResult 包的内容

先容

XCResult 包是一个包罗运行一组测试效果详细信息的包或目次。这些包由 Xcode（或下令行中的 xcodebuild）生成，并提供了有关所运行测试的丰富信息，包罗测试的名称、持续时间、状态以及它们生成的任何附件（如截图或日志）。
查找 XCResult 包

在 Xcode 中，你可以在测试运行后通过转到“陈诉导航器”并从列表中选择你感爱好的包来查找和检查 XCResult 包：
分享 XCResult 包

假如你想与其他人分享该包，可以右键单击“陈诉导航器”中的包并选择“在 Finder 中体现”以打开包所在的目次。无论你是从下令利用用 xcodebuild 运行测试照旧在 Xcode 中运行测试，全部 .xcresult 包都生成在应用的 Logs/Test 目次中的 Derived Data 中，你可以双击 .xcresult 文件在 Xcode 中打开并检查包的内容。
分析 XCResult 包

当你在 CI/CD 环境中运行应用的测试时，XCResult 包变得更加告急，由于没有它们，关于测试失败的唯一信息将是 xcodebuild 下令的日志。别的，对 CI/CD 呆板的访问通常受到限定且繁琐，因此检索特定运行的 .xcresult 包并不总是那么简朴。
这就是为什么通常最好让你选择的 CI/CD 服务在测试失败时将 XCResult 包作为工件上传到你的工作流程中，以便开发职员可以下载并检查效果。固然这在开发者体验方面是一个庞大改进，但反馈并不是即时的，由于需要开发职员下载包并在他们的呆板上打开它。
主动分析 XCResult 包的内容

假如你可以或许以编程方式分析 XCResult 包的内容并提取所需信息，而无需打开 Xcode，那不是很好吗？这样，你可以主动化检查测试效果的过程，并为开发职员提供有关测试失败的即时反馈。这听起来很不错，但当你检查 .xcresult 包的内容时，你很快会发现内容不可读，这使得以编程方式分析它们的使命变得有些寻衅性：
使用 XCResultKit 分析包的内容

幸运的是，对于我们来说，有一些工具可以在分析 XCResult 包的内容时使我们的生存变得更轻松。此中一个用 Swift 编写的库，我们将在本文中使用的是 David House 的 XCResultKit。
初始化库

起首，我们需要将库导入到我们的项目中作为 Swift Package。在这种环境下，我们将构建一个 Swift 可执行文件，该文件将使用 XCResultKit 从 .xcresult 包中提取信息：
Package.swift

1. // swift-tools-version: 6.0
3. import PackageDescription
5. let package = Package(
6.     name: "ResultAnalyzer",
7.     platforms: [
8.         .macOS(.v13)
9.     ],
10.     dependencies: [
11.         .package(url: "https://github.com/apple/swift-argument-parser.git", exact: "1.5.0"),
12.         .package(url: "https://github.com/davidahouse/XCResultKit.git", exact: "1.2.0")
13.     ],
14.     targets: [
15.         .executableTarget(
16.             name: "ResultAnalyzer",
17.             dependencies: [
18.                 .product(name: "ArgumentParser", package: "swift-argument-parser"),
19.                 .product(name: "XCResultKit", package: "XCResultKit")
20.             ]
21.         ),
22.     ]
23. )

复制代码

在可执行文件的主文件中，我们如今可以导入库，要求提供 .xcresult 包的路径，并使用用户提供的路径初始化一个 XCResult 对象：
XCResultAnalyzer.swift

1. import ArgumentParser
2. import Foundation
3. import XCResultKit
5. @main
6. struct XCResultAnalyzer: ParsableCommand {
7.     @Argument(help: "The path to an `.xcresult` bundle")
8.     var bundle: String
9.    
10.     func run() throws {
11.         guard let url = URL(string: bundle) else { return }
12.         let result = XCResultFile(url: url)
13.     }
14. }

复制代码

获取调用纪录

读取包内容的第一步是获取信息纪录。该纪录包罗全部元数据和信息，用于从包中检索其余数据：
XCResultAnalyzer.swift

1. func run() throws {
2.     guard let url = URL(string: bundle) else { return }
3.     let result = XCResultFile(url: url)
5.     guard let invocationRecord = result.getInvocationRecord() else { return }
6. }

复制代码

信息纪录包罗有关测试运行的一些顶级信息，比方发生的操作、碰到的标题的详细择要以及测试运行的指标：
XCResultAnalyzer.swift

1. func run() throws {
2.     guard let url = URL(string: bundle) else { return }
3.     let result = XCResultFile(url: url)
5.     guard let invocationRecord = result.getInvocationRecord() else { return }
7.     print("✅ Ran \(invocationRecord.metrics.testsCount ?? .zero) tests and skipped \(invocationRecord.metrics.testsSkippedCount ?? .zero)")
8.     print("❌ \(invocationRecord.issues.testFailureSummaries.count) test failures")
9.     print("🧐 Ran actions: \(invocationRecord.actions.compactMap { $0.testPlanName })")
10. }

复制代码

使用我们之前检查的 .xcresult 包运行可执行文件，我们会得到以下输出：

1. ✅ Ran 3 tests and skipped 0
2. ❌ 1 test failures
3. 🧐 Ran actions: ["AutomatedTesting"]

复制代码

获取测试信息

获取给定测试的特定信息要复杂一些，由于你需要遍历包中的全部操作，获取测试计划信息，然后才能访问个别测试的特定信息。
让我们起首从包中检索全部失败的测试：
XCResultAnalyzer.swift

1. func run() throws {
2.     guard let url = URL(string: bundle) else { return }
3.     let result = XCResultFile(url: url)
4.    
5.     guard let invocationRecord = result.getInvocationRecord() else { return }
6.    
7.     // 1
8.     let testBundles = invocationRecord
9.         .actions
10.         .compactMap { action -> ActionTestPlanRunSummaries? in
11.             guard let id = action.actionResult.testsRef?.id, let summaries = result.getTestPlanRunSummaries(id: id) else {
12.                 return nil
13.             }
14.             
15.             return summaries
16.         }
17.         .flatMap(\.summaries)
18.         .flatMap(\.testableSummaries)
19.    
20.     let allFailingTests = testBundles
21.         // 2
22.         .flatMap(\.tests)
23.         // 3
24.         .flatMap(\.subtests)
25.         .filter { $0.testStatus.lowercased() == "failure" }
26. }

复制代码

让我们回顾一下包，并将其结构映射到代码中的解释：
导出屏幕录制

如今我们有了失败的测试，我们可以获取包罗全部步调的择要，检索第一步的屏幕录制附件并导出它：
XCResultAnalyzer.swift

1. func run() throws {
2.     // ...
3.     let screenRecordings = allFailingTests
4.     .compactMap { test -> ActionTestSummary? in
5.         guard let id = test.summaryRef?.id else { return nil }
6.         
7.         return result.getActionTestSummary(id: id)
8.     }
9.     // 1
10.     .flatMap(\.activitySummaries)
11.     // 2
12.     .first?
13.     // 3
14.     .attachments
15.     .filter { $0.name == "kXCTAttachmentScreenRecording" && $0.uniformTypeIdentifier == "public.mpeg-4" } ?? []
16.         
17.     for screenRecording in screenRecordings {
18.         let tempFileDirectory = URL.temporaryDirectory
19.         result.exportAttachment(attachment: screenRecording, outputPath: tempFileDirectory.path())
20.     }
21. }

复制代码

让我们再次查看包，并将其结构映射到代码中的解释。
可运行 Demo

上面详细先容了理论逻辑。下面根据这个些功能提供一个可以运行的 Demo。
这个 Demo 将使用 XCResultKit 库来分析 XCResult 包的内容，并提取测试运行的根本信息和失败测试的屏幕录制。
初始化 Swift Package

起首，我们创建一个新的 Swift Package 项目。在终端中运行以下下令来创建项目：

1. swift package init --type executable
2. cd [YourProjectName]

复制代码

然后编辑 Package.swift 文件以添加依赖项：

1. // swift-tools-version: 5.6
3. import PackageDescription
5. let package = Package(
6.     name: "XCResultParserDemo",
7.     platforms: [
8.         .macOS(.v12)
9.     ],
10.     dependencies: [
11.         .package(url: "https://github.com/apple/swift-argument-parser.git", exact: "1.5.0"),
12.         .package(url: "https://github.com/davidahouse/XCResultKit.git", exact: "1.2.0")
13.     ],
14.     targets: [
15.         .executableTarget(
16.             name: "XCResultParserDemo",
17.             dependencies: [
18.                 .product(name: "ArgumentParser", package: "swift-argument-parser"),
19.                 .product(name: "XCResultKit", package: "XCResultKit")
20.             ]
21.         ),
22.     ]
23. )

复制代码

编写主文件

接下来，我们在 Sources/XCResultParserDemo/main.swift 中编写主文件代码。这个文件将导入库，处理处罚下令行参数，并分析 XCResult 包的内容。

1. import ArgumentParser
2. import Foundation
3. import XCResultKit
5. @main
6. struct XCResultAnalyzer: ParsableCommand {
7.     @Argument(help: "The path to an `.xcresult` bundle")
8.     var bundle: String
9.    
10.     func run() throws {
11.         guard let url = URL(string: bundle) else {
12.             print("Invalid URL")
13.             return
14.         }
15.         let result = XCResultFile(url: url)
17.         // 获取调用记录
18.         guard let invocationRecord = result.getInvocationRecord() else {
19.             print("Could not retrieve invocation record")
20.             return
21.         }
23.         // 输出基本信息
24.         print("✅ Ran \(invocationRecord.metrics.testsCount ?? .zero) tests and skipped \(invocationRecord.metrics.testsSkippedCount ?? .zero)")
25.         print("❌ \(invocationRecord.issues.testFailureSummaries.count) test failures")
26.         print("🧐 Ran actions: \(invocationRecord.actions.compactMap { $0.testPlanName })")
28.         // 获取失败的测试
29.         let testBundles = invocationRecord
30.             .actions
31.             .compactMap { action -> ActionTestPlanRunSummaries? in
32.                 guard let id = action.actionResult.testsRef?.id, let summaries = result.getTestPlanRunSummaries(id: id) else {
33.                     return nil
34.                 }
35.                
36.                 return summaries
37.             }
38.             .flatMap(\.summaries)
39.             .flatMap(\.testableSummaries)
40.         
41.         let allFailingTests = testBundles
42.             .flatMap(\.tests)
43.             .flatMap(\.subtests)
44.             .filter { $0.testStatus.lowercased() == "failure" }
46.         // 导出失败测试的屏幕录制
47.         let screenRecordings = allFailingTests
48.         .compactMap { test -> ActionTestSummary? in
49.             guard let id = test.summaryRef?.id else { return nil }
50.             
51.             return result.getActionTestSummary(id: id)
52.         }
53.         .flatMap(\.activitySummaries)
54.         .first?
55.         .attachments
56.         .filter { $0.name == "kXCTAttachmentScreenRecording" && $0.uniformTypeIdentifier == "public.mpeg-4" } ?? []
57.             
58.         for screenRecording in screenRecordings {
59.             let tempFileDirectory = URL.temporaryDirectory
60.             let outputPath = tempFileDirectory.appendingPathComponent(UUID().uuidString).appendingPathExtension("mp4")
61.             try result.exportAttachment(attachment: screenRecording, outputPath: outputPath.path)
62.             print("Screen recording exported to: \(outputPath.path)")
63.         }
64.     }
65. }

复制代码

代码表明

• 导入库和界说下令：我们导入了 ArgumentParser、Foundation 和 XCResultKit 库，并界说了一个主结构体 XCResultAnalyzer，它遵循 ParsableCommand 协议以处理处罚下令行参数。
  
• 处理处罚下令行参数：@Argument 属性包装器用于界说下令行参数。在这里，我们要求用户提供一个 .xcresult 包的路径。
  
• 分析 URL 和初始化 XCResultFile：我们将用户提供的路径转换为 URL 对象，并使用 XCResultFile 类初始化它。
  
• 获取调用纪录：我们调用 getInvocationRecord() 方法来获取调用纪录，这包罗了测试运行的元数据和详细信息。
  
• 输出根本信息：我们输出了测试的总数、跳过的测试数量、失败的测试数量和执行的操作计划名称。
  
• 获取失败的测试：我们遍历调用纪录中的操作，获取测试计划运行择要，过滤出全部失败的测试。
  
• 导出屏幕录制：我们遍历失败测试的运动择要，过滤出屏幕录制附件，并将它们导出到临时目次中。
  

运行 Demo

确保你的项目目次中有一个 .xcresult 包。然后，在终端中导航到项目目次并运行以下下令：

1. swift run XCResultParserDemo /path/to/your.xcresult

复制代码

这将分析提供的 XCResult 包，并输出测试运行的根本信息和任何失败测试的屏幕录制路径。
通过这个 Demo，你可以以编程方式分析 XCResult 包的内容，并提取有用的信息以改进测试和 CI/CD 工作流。
结论

就是这样！下次运行可执行文件并提供 .xcresult 包的路径时，你将得到导出到临时目次的失败测试的屏幕录制，随时可以分享至任何需要的地方。