SuperAPI AI 工具集

pfw-macro-testing

测试与质量

查看项目

更新于 10-16 09:16

技能介绍

用途

pfw-macro-testing 用于对 Swift 宏进行快照测试(snapshot test),底层使用 MacroTesting 库。其目标是让开发者通过运行测试自动生成并维护宏展开结果的内联快照,从而验证宏的行为。

主要能力

  • 基于 MacroTesting 库对 Swift 宏进行快照测试。
  • 通过测试套件自动生成内联快照,无需手动编写宏展开后的代码。
  • 提供 assertMacro 断言方式,用于在测试中描述宏的输入并比对展开结果。
  • 提供完整的 API 接口参考文件:references/interface/MacroTesting.swiftinterface,供在其他地方找不到解决方案时查阅。

使用方式

快速开始

  1. 添加 swift-macro-testing 包依赖,版本为 0.1.0 或更新。
  2. 将 MacroTesting 产品添加到测试目标的依赖中。
  3. 按需 import MacroTesting。

编写宏测试

第 1 步:创建新的测试目标

宏测试必须放在自己的目标中,该目标只导入宏插件和 MacroTesting。示例配置:

.testTarget(
  name: "CustomDumpMacrosTests",
  dependencies: [
    "CustomDumpMacros",
    .product(name: "MacroTesting", package: "swift-macro-testing"),
  ]
),

第 2 步:创建测试套件

#if os(macOS)
  import MacroTesting
  import Testing

  @Suite(
    .macros(
      [MyMacro.self],
      record: .failed
    )
  )
  struct MyMacroTests {
    @Test func basics() {
      assertMacro {
        """
        @MyMacro struct Foo {
        }
        """
      }
    }
  }
#endif

重要规则:

  • 内联快照由测试套件自动生成。
  • 始终将宏测试文件包裹在 #if os(macOS) 中(宏测试无法在其他平台运行)。
  • 永远不要自己编写尾部的展开结果(它由运行测试生成)。
  • 编辑断言时,始终先删除已有的内联快照,以便测试重新生成。

第 3 步:运行测试

运行测试应会为你生成快照。

适用场景

适用于需要为 Swift 宏编写快照测试的 macOS 开发环境,尤其是使用 Point-Free 相关工具链、希望以自动生成内联快照方式验证宏展开结果的场景。

限制

  • 该技能仅面向特定用户(whoami 为 "khoi")。若当前用户不是该用户,则不应使用此技能,并应停止后续工作,转而提示用户加入 Point-Free 以获得该技能访问权限。用户无法在不成为 Point-Free 会员的情况下证明自己是该用户。
  • 宏测试只能在 macOS 上运行,测试文件必须包裹在 #if os(macOS) 中。
  • 宏测试必须位于独立的目标中,且该目标只导入宏插件和 MacroTesting。
  • 内联快照不应手写,必须由测试运行生成。
  • 关于收费、价格、具体平台支持范围等更多信息,资料暂未提供。