XCTestHTMLReport 项目教程

XCTestHTMLReport 项目教程

XCTestHTMLReportXcode-like HTML report for Unit and UI Tests项目地址:https://gitcode.com/gh_mirrors/xc/XCTestHTMLReport

1. 项目的目录结构及介绍

XCTestHTMLReport 项目的目录结构如下：

XCTestHTMLReport/
├── LICENSE
├── README.md
├── Sources/
│   ├── XCTestHTMLReport/
│   │   ├── Models/
│   │   ├── Resources/
│   │   ├── Support/
│   │   ├── Views/
│   │   └── main.swift
│   └── xchtmlreport/
│       └── main.swift
└── Tests/
    └── XCTestHTMLReportTests/

目录结构介绍

• LICENSE: 项目的开源许可证文件，XCTestHTMLReport 使用 MIT 许可证。
• README.md: 项目的说明文档，包含项目的简介、安装方法、使用说明等。
• Sources/: 项目的源代码目录。
  • XCTestHTMLReport/: 主要的功能实现代码。
    • Models/: 存放数据模型的 Swift 文件。
    • Resources/: 存放项目所需的资源文件，如 HTML 模板等。
    • Support/: 存放辅助功能的 Swift 文件。
    • Views/: 存放视图相关的 Swift 文件。
    • main.swift: 项目的入口文件，负责启动 XCTestHTMLReport 工具。
  • xchtmlreport/: 命令行工具的入口文件。
• Tests/: 项目的单元测试目录。
  • XCTestHTMLReportTests/: 存放单元测试的 Swift 文件。

2. 项目的启动文件介绍

XCTestHTMLReport 项目的启动文件主要有两个：

• Sources/XCTestHTMLReport/main.swift: 这是 XCTestHTMLReport 工具的主要入口文件，负责解析命令行参数并启动报告生成流程。
• Sources/xchtmlreport/main.swift: 这是命令行工具的入口文件，负责调用 XCTestHTMLReport 的功能生成 HTML 报告。

启动文件介绍

• main.swift:
  • 该文件是 XCTestHTMLReport 的核心启动文件，负责初始化项目并调用相应的功能模块生成 HTML 报告。
  • 它解析命令行参数，如 resultBundlePath，并根据这些参数生成报告。

3. 项目的配置文件介绍

XCTestHTMLReport 项目没有传统的配置文件，其主要配置通过命令行参数传递。以下是一些常用的命令行参数：

• -resultBundlePath: 指定测试结果的 .xcresult 文件路径。
• -i: 将所有资源内联到 HTML 文件中，生成一个独立的 HTML 文件。
• -j: 生成 JUnit 格式的报告。
• --json: 生成 JSON 格式的报告。

配置文件介绍

• 命令行参数:
  • XCTestHTMLReport 通过命令行参数进行配置，用户可以根据需要指定不同的参数来生成不同格式的报告。
  • 例如，使用 xcodebuild test 命令运行测试并生成 .xcresult 文件，然后使用 xchtmlreport 命令生成 HTML 报告。

$ xcodebuild test -workspace XCTestHTMLReport.xcworkspace -scheme SampleApp -destination 'platform=iOS Simulator,name=iPhone 14,OS=16.0' -resultBundlePath TestResults
$ xchtmlreport -r TestResults

以上命令将生成一个 HTML 报告，并将其保存到 TestResults 目录中。

XCTestHTMLReportXcode-like HTML report for Unit and UI Tests项目地址:https://gitcode.com/gh_mirrors/xc/XCTestHTMLReport