iOS 持续集成- xctool 安装、使用

最近在搞自动构建，用了一下xcodebuild感觉输出的log可读性很差、对test的支持不好。然后转向了xctool。

来看一眼xctool： 

---

xctool

xctool是facebook给出的自动化构建的解决方案，让构建和测试更容易，更好的支持持续集成。但xctool只是对xcodebuild的一个封装，因此xctool是基于xcodebuild的。

先看下xcodebuild是否可用

$ xcodebuild -version

---

安装

xctool 可以从 homebrew 安装：

1.安装Homebrew

Homebrew的网站：http://mxcl.github.com/homebrew/

ruby−e" (curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)”

2.安装xctool

$ brew install xctool

3.查看是否安装成功

$ xctool -version

---

使用

简单的使用见官方教程： 
https://github.com/facebook/xctool

xctool 的命令和选项是 xcodebuild 的一个扩展，在大多数情况下，你只需要替换 xcodebuild 为 xctool，会如期运行，但有更具吸引力的输出。

可以通过如下命令获取帮助和完整的配置列表：

$ xctool -help

---

编译

使用 xctool 编译项目和使用 xcodebuild 是一样的。

如果是使用 workspaces 和 schemes ：

xctool -workspace YourWorkspace.xcworkspace -scheme YourScheme build
   
1
   
1

如果使用的是 projects 和 schemes：

xctool -project YourProject.xcodeproj -scheme YourScheme build
   
1
   
1

常见配置比如 -configuration，-sdk，-arch 和 xcodebuild 是相同的。

注意：xctool 不支持使用 -target 来编译 targets，必须使用 schemes。

---

单元测试

xctool 的 test 命令，可以配置 scheme 中如何编译和运行测试。也可以限制哪些单元测试运行，或者指定运行的 SDK 版本。

使用如下命令，编译运行所有单元测试：

xctool -workspace YourWorkSpace.xcworkspace -scheme YourScheme test
   
1
   
1

在指定的 target 上编译运行单元测试，使用 -only 配置：

xctool -workspace YourWorkSpace.xcworkspace -scheme YourScheme test -only SomeTestTarget
   
1
   
1

可以进一步配置只运行特定的单元测试类：

xctool -workspace YourWorkSpace.xcworkspace -scheme YourScheme test -only SomeTestTarget:SomeTestClass
   
1
   
1

甚至只运行某个单元测试类的某个方法：

xctool -workspace YourWorkSpace.xcworkspace -scheme YourScheme test -only SomeTestTarget:SomeTestClass/testSomeMethod
   
1
   
1

也可以指定匹配前缀的类和方法：

xctool -workspace YourWorkSpace.xcworkspace -scheme YourScheme test -only SomeTestTarget:SomeTestClassPrefix*,SomeTestClass/testSomeMethodPrefix*
   
1
   
1

也可以在指定 SDK 版本上运行单元测试：

xctool -workspace YourWorkSpace.xcworkspace -scheme YourScheme test -test-sdk iphonesimulator5.1
   
1
   
1

---

编译单元测试

当编译和运行单元测试时，有时不需要运行只是编译，可以使用 build-tests 指令，例：

xctool -workspace YourWorkSpace.xcworkspace -scheme YourScheme build-tests
   
1
   
1

可以使用 -only 指定在某个 target 上编译：

xctool -workspace YourWorkSpace -scheme YourScheme build-tests -only SomeTestTarget
   
1
   
1

---

运行单元测试

如果已经使用 build-tests 编译，使用 run-tests 就可以直接运行单元测试。这样的作用是只需编译一次，便可运行在不同 SDK 版本上。

运行所有单元测试，你将使用：

xctool -workspace YourWorkSpace.xcworkspace -scheme YourScheme run-tests
   
1
   
1

和 test 指令一样，可以通过 -only 来限制哪些单元测试运行，也可以使用 -test-sdk 运行在指定的 SDK 版本上。

可以选择在运行单元测试时指定 -testTimeout。当某个独立的测试到了超时时间，会被认为失败而不是无限等待，可以防止测试任务因为发生错误而导致死锁。

默认情况下，模拟器启动程序单元测试等待最多 30s，可以使用 -launch-timeout 指令来修改超时时间。

---

并行运行单元测试

xctool 可以配置并行运行单元测试，以便更好地利用空闲的多核 CPU。

若要允许多个测试任务同时运行，使用 -parallelize 指令：

xctool -workspace YourWorkSpace.xcworkspace -scheme YourScheme run-tests -parallelize
   
1
   
1

上面给出的并行，仍限制于最慢的测试任务。比如，两个测试任务（’A’ 和 ‘B’），’B’ 因为包含 10 倍多测试需要花费 10 倍的时间来运行，这样上述并行运行帮助并不大。

可以使用 -logicTestBucketSize 指令将测试任务分为几个 bucket ：

xctool -workspace YourWorkSpace.xcworkspace -scheme YourScheme run-tests -parallelize -logicTestBucketSize 20
   
1
   
1

上面将测试任务分为每个 bucket 20 个测试用例，这些测试将同时运行，如果测试包比其他大得多，这样可以加快整体测试运行速度。

---

可持续集成（CI）

对于可持续集成服务器比如 Travis CI 或者 Jenkins 来运行单元测试，xctool 是不错的选择。为了在可持续集成环境中运行单元测试，必须为应用的 target 创建一个 Shared Schemes target，同时确保所有依赖已经正确添加到 Scheme 中（比如 CocoaPods）。参照如下步骤：

1. 选择 Product > Schemes > Manage Schemes 菜单，打开 Manage Schemes。

2. 在列表中找到应用的 target，确保在右手边的 Shared 复选框已经选中。

3. 如果应用或者单元测试的 target 包含跨项目的依赖比如 CocoaPods，还需要确保它们已经正确配置。可参照如下步骤：

   • 选中应用的 target，点击 Edit 按钮打开 Scheme 编辑弹窗。
   • 在 Scheme 编辑器里面点击左手边的 Build 选项。
   • 点击 + 号按钮为项目添加所有依赖，CocoaPods 将以名字为 Pods 的静态库出现。
   • 拖动依赖到应用的 target 下方，方便应用的 target 优先编译。 
     现在，在工程项目里的 xcshareddata/xcschemes 目录下会有一个文件，这就是刚刚配置好的 Shared Scheme，在 git\svn 仓库中添加该文件，xctool 将在下一次 CI 编译时，找到并执行单元测试。

---

Travis CI 配置示例

Travis CI 是一个非常流行的，免费提供给开源项目的可持续集成系统，它集成于 Github，并且对于 Objective-C 工程，Travis CI 默认使用 xctool 作为编译和测试工具。按照上面的步骤设置好 Shared Schemes 后，还需要配置 .travis.yml 文件。

如果是使用 workspace，.travis.yml 文件内容格式如下：

language: objective-c
xcode_workspace: path/to/YourApp.xcworkspace
xcode_scheme: YourApp
   
1
2
3
   
1
2
3

如果是使用 projects，.travis.yml 文件内容格式如下：

language: objective-c
xcode_project: path/to/YourApp.xcodeproj
xcode_scheme: YourApp
   
1
2
3
   
1
2
3

.travis.yml 文件还可以灵活配置怎样安装 Travis 和调用 xctool：

language: objective-c
before_install:
    - brew update
    - brew install xctool
script: xctool -workspace MyApp.xcworkspace -scheme MyApp test
   
1
2
3
4
5
   

    
   
   
1
2
3
4
5

你可以在 About OS X Travis CI Environment 这份文档中学到更多有关 iOS 和 OSX 应用的 Travis CI 环境，通过查阅 Getting Started 找到配置项目的详细文档。

原文地址：http://blog.youkuaiyun.com/jeikerxiao/article/details/51669451