原文:Continuous Integration & Deployment for iOS Projects
原作者:Matt Oakes
譯文出自:開發技術前線 www.devtf.cn
譯者:Sam Lau
校對:Mr.Simple

做新功能時如果為了趕進度而忽略可維護性、埋下技術債,那筆債遲早得還,而且利息通常比想像中高。
最近我們一直在思考該用什麼方式把程式碼品質往上拉,方向有兩個:
當程式碼品質開始下滑時,用工具第一時間提醒開發者。
把編碼規範寫成文檔,並整理過去幾個專案中該如何避開維護性差的問題。
下面簡單說明我們搭了哪些東西來自動監控程式碼品質。
我們選了 Jenkins 作為持續整合工具,跑在一台放在工作室的 Mac Mini 上。老實說我不算喜歡 Jenkins,但到目前為止,它是最穩定、也最能勝任這些工作的工具。
Jenkins 用 Homebrew 安裝,Ruby 則透過 rbenv 管理,這樣能拿到一個較新且穩定的 Ruby Gems 環境。有了 Homebrew 和 Ruby Gems 這兩個套件管理器,幾乎所有需要的工具都裝得上,而且不太容易動到 OS X 系統更新自帶的 Ruby。
我們用 Specta 與 Expecta 來測試 iOS 專案。
Specta 讓我們用行為驅動開發(BDD)風格的語法寫測試,比起 XCTest 更易讀;它還有一套強大的分組機制,能在測試前後執行特定程式碼塊,大幅減少重複代碼。
Expecta 則是匹配器框架,用來在測試中建立斷言。語法比內建的 XCAssert 系列清楚得多,例如:
expect(@"foo").to.equal(@"foo"); expect(foo).notTo.equal(1); expect([bar isBar]).to.equal(YES); expect(baz).to.equal(3.14159);
開發當下我們透過 Xcode 跑測試;而在用 Homebrew 裝好的 Jenkins 上,則改用 XCTool。XCTool 是 xcodebuild 的替代方案,能讓你在命令列輕鬆執行測試套件並輸出 JUnit 風格的報告。
$ xctool -workspace Project.xcworkspace -scheme Project -reporter junit:junit-report.xml test
這些報告會發布到 Jenkins 上,Jenkins 借助 JUnit Plugin 畫出隨時間變化的單元測試趨勢圖,同時讓我們看出測試是否穩定。

我們希望測試跑得越勤越好,這樣一旦弄壞了什麼,能馬上知道。我們在 feature branch 上改動,然後向 GitHub 發一個 pull request,由另一位開發者審查。只要 PR 被打開,我們就會跑一遍完整測試,確認沒有東西被弄壞。
為了自動化這件事,我們裝了 GitHub Pull Request Plugin,把 GitHub 上的訊息推送到 Jenkins。一旦有測試失敗,結果會顯示在 GitHub 上,我們就不合併,直到問題修好為止。
我們也用 Gcovr 產生覆蓋率報告,同樣以 Homebrew 安裝。專案這邊需要調整 main target 的 Debug 組態中兩個 build setting,把 Generate Test Coverage Files 與 Instrument Program Flow 都設為 YES。

跑單元測試產生覆蓋率報告時,需要在 XCTool 命令列尾端加上 OBJROOT=./build。
$ gcovr -r . — object-directory build/Project.build/Debug-iphonesimulator/Project.build/Objects-normal/x86_64 — exclude '.*Tests.*' — xml > coverage.xml
Gcovr 輸出的覆蓋率報告由 Cobertura Jenkins Plugin 發布,它能用視覺化的方式呈現覆蓋率隨時間的變化。現在我們不只知道測試有沒有通過,還看得到程式碼被測到多少。
工具集中最強的一項,大概就是靜態分析。這類工具會掃描你的程式碼並產出報告,指出哪些地方違反了程式碼風格規則。舉幾個例子:
未被使用的變數或參數
過長的變數名、方法名或程式碼行
覆寫了某個方法卻沒有呼叫 super
方法太長或過於複雜
以及更多規則……
我們用的是 OCLint,支援 C、C++ 與 Objective-C。它透過與 XCTool 搭配使用的 json-compilation-database reporter 來取得良好的整合性:我們先在 XCTool 命令列多帶一個 reporter,再把那份 report 交給 OCLint 做靜態分析。
$ xctool -workspace Project.xcworkspace -scheme Project -reporter junit:junit-report.xml -reporter json-compilation-database:compile_commands.json test $ oclint-json-compilation-database -e Pods -report-type pmd -o oclint-pmd.xml
這份 report 以 PMD 格式輸出,再由 PMD Plugin 發布到 Jenkins。有了這些插件,你還可以為警告(低、中、高)設定門檻,讓某些情況直接讓建置失敗。最初我們把門檻設得很低,只要引入新問題就會被提醒,藉此一步步把品質拉上來。

最後這件事跟程式碼品質無關,而是省時間。開發者常常得把編好的包丟給設計師做驗收,或在 sprint 結束演示時發給客戶。手動打一個已編譯的 App 大概要花某位開發者十分鐘,但真正貴的是切換任務、打斷心流的成本。
最近我們配了一個夜間建置流程,每天早上自動把新版本發給每個人。
做法是使用 fastlane。fastlane 是一套強大的工具集,讓你把一串操作定義成 lane 來執行。目前我們定義了三個 lane:一個發給 ribot 的開發者,一個發給公司內所有人,一個發給客戶。
before_all do |lane| cert sigh end desc “Deploy a new build to ribot iOS developers over crashlytics” lane :dev do ipa crashlytics({ groups: 'ribot-developers' }) end desc “Deploy a new build to people at ribot over crashlytics” lane :internal do ensure_git_status_clean append_build_time ipa crashlytics({ groups: 'ribot' }) reset_git_repo end desc “Deploy a new build to everyone over crashlytics” lane :external do ensure_git_status_clean increment_build_number ipa crashlytics({ groups: ['ribot', 'client'] }) commit_version_bump add_git_tag push_to_git_remote end after_all do |lane| clean_build_artifacts endfastlane 透過 Ruby Gems 安裝,跑一個 lane 就是一行命令:
fastlane internal
在跑任何 lane 之前,我們會先自動確認手上有有效的簽章憑證與最新的 provisioning profile。所有設定都放在一個 .env 檔裡,讓我們保有合理的預設值,需要時再按情況覆寫。
接下來,我們打算用 deliver 這個操作把 App Store 的提交流程也自動化掉。
到目前為止,這套流程已經在專案中實際跑過,成效不錯。我們期待只要用得得當,這些工具就能把程式碼品質往上推;而這些報告也讓我們能夠量化地看見品質隨時間的變化。下一個專案裡會發生什麼,我很期待。