Simctl 0.2.1

Simctl 0.2.1

×

由 Christian Treffs 维护。

 
依赖项
SimctlShared~> 0.2.1
Swifter~> 1.5
 

Simctl 0.2.1

Swift Simctl

CI license
swift-version-compatibility platform-compatibility

simctl-example-gif

这是一个小工具（SimctlCLI）和库（Simctl），用 Swift 编写，旨在自动化在单元和 UI 测试中与模拟器交互的 xcrun simctl 命令。

它支持诸如测试推送通知（具有动态内容的可靠完全自动化测试）等功能。

🚧架构

Swift Simctl 由两部分组成：SimctlCLI 和 Simctl。

Simctl 是一个 Swift 库，可以添加到您项目的测试束中。它提供了一个用于执行通常仅在测试代码中使用 xcrun simctl 的命令的接口。为了启用调用这些命令，Simctl 通过本地网络连接与 SimctlCLI 通信。

SimctlCLI 是一个小型命令行工具，它启动一个本地服务器，监听来自 Simctl（客户端库）的请求，并执行 xcrun simctl 命令。

⌨可用的命令

以下命令将在您的（测试）目标代码中可用

  • 发送带有自定义有效负载的推送通知
  • 授予或撤销隐私权限（例如摄像头、照片...）
  • 将设备 UI 外观设置为浅色或深色模式
  • 设置状态栏覆盖项（例如数据网络、时间...）
  • 通过捆绑标识符卸载应用
  • 通过捆绑标识符终止应用
  • 重命名设备
  • 触发 iCloud 同步

❔您为什么（或不）使用它

➕优点

  • 封闭系统（带 Xcode + 模拟器的 Mac）
  • 不依赖于像 APNS 这样的系统
  • 不会因不必要的自定义测试代码而膨胀代码库（例如 AppDelegate）
  • 可以模拟推送通知，并保留正常的应用程序周期
  • 在 CI 机器上运行
  • 您的应用程序保持不可见状态，无需修改

➖缺点

  • 需要在您的 Xcode 项目中进行一些配置
  • 仅适用于 Xcode 11.4+

有关具体用法，请参阅示例项目 Swift Simctl 包示例 或 Swift Simctl Cocoapod 示例

🚀入门

以下说明将使您的项目副本在您的机器上运行。

📋先决条件

💻使用方法

📦Swift Package

要在您的 Xcode 项目中使用 Swift Simctl，请添加以下包

  1. Xcode > 文件 > Swift Packages > 添加包依赖...
  2. 选择包仓库 > 搜索：SwiftSimctl 或查找 https://github.com/ctreffs/SwiftSimctl.git
  3. 选择 SwiftSimctl 包 > 下一步
  4. 别忘了将依赖添加到您的（测试）目标中
  5. 使用 import Simctl 在您的（测试）目标中访问库。

在与您的测试一同运行服务器

确保在测试运行期间，SimctlCLI 在您的宿主机上运行。要使用 Xcode 自动化此操作，请使用以下片段作为测试目标的预和后操作。

您的方案 > 测试 > 预操作 > 运行脚本
#!/bin/bash
killall SimctlCLI # cleaning up hanging servers
set -e # fail fast
# start the server non-blocking from the checked out package
${BUILD_ROOT}/../../SourcePackages/checkouts/SwiftSimctl/bin/SimctlCLI start-server > /dev/null 2>&1 &
您的方案 > 测试 > 后操作 > 运行脚本
#!/bin/bash
set -e
killall SimctlCLI
📝Swift Package 代码示例

请参阅示例项目，以了解详细代码示例 https://github.com/ctreffs/SwiftSimctlExample

☕Cocoapods

假设您已经设置了一个带有 Cocoapods 的项目（否则请参阅 这些说明）

  1. 在您的 Podfile 中为您的（测试）目标添加 pod 'Simctl', '~> 0.2.1'
  2. 运行 pod install
  3. 打开 <您的项目>.xcworkspace
  4. 使用 import Simctl 在您的（测试）目标中访问库。

与测试一起运行服务器

确保在测试运行期间，在您的宿主机器上执行SimctlCLI。要使用Xcode本身自动化该操作，请使用以下代码段作为测试目标的预操作和后操作。

您的方案 > 测试 > 预操作 > 运行脚本
#!/bin/bash
killall SimctlCLI # cleaning up hanging servers
set -e # fail fast
# start the server non-blocking from the checked out pod
${PODS_ROOT}/Simctl/bin/SimctlCLI start-server > /dev/null 2>&1 &
您的方案 > 测试 > 后操作 > 运行脚本
#!/bin/bash
set -e
killall SimctlCLI
📝代码示例 Cocoapod

请参阅示例项目以获取深入的代码示例 https://github.com/ctreffs/SwiftSimctlExamplePod

🙏赞

Swift Simctl 的实现离不开这些出色的库

  • ShellOut - 容易调用命令行
  • Swifter - 一个小巧的 http 服务器

✍️作者

有关参加此项目的贡献者列表，请参阅 此处。

🔏许可证

本项目受 MIT 许可证许可 - 请参阅 LICENSE 文件获取详细信息。