iOS自動化探索（十）代碼覆蓋率統計 使用libimobiledevice + ifuse提取iOS沙盒文件

iOS APP代碼覆蓋率統計

 

今年Q3季度領導給加了個任務要作先後端代碼覆蓋率統計， 鑑於對iOS代碼比較熟就選擇先從iOS端入手，折騰一成天后終於初步把流程跑通了記錄以下

 

覆蓋率監測的原理

Xcode中配置編譯選項後， 編譯後會爲每一個可執行文件生成對應的 .gcno 文件；以後在代碼中調用覆蓋率分發函數，會生成對應的 .gcda 文件。

• gcno：包含基本的塊信息，以及代碼行與塊的映射關係；
• gcda：包含代碼行執行的狀況，以及覆蓋率的信息概括；

執行完測試後，提取goda並藉助工具與gcno作對比給出檢測報告

 

必要知識儲備或條件: 

• 項目源碼
• Xcode開發環境，包括開發者帳號
• Cocopods基礎用法
• Xcode真機運行基礎操做
• 抓取APP沙盒日誌基礎操做
• Git基礎操做

以上說的幾個都不懂也行， 讓開發幫忙作這些而後編個代碼覆蓋率統計的包給你測試， 測完把手機給開發取數據生成報告。 注意每次測試完先按下HOME鍵把程序退到後臺等幾秒讓app本身生成日誌文件

下面開始講步驟

 

步驟1： 拉取項目代碼

git clone XXXXXXXXXXX

 

步驟2： 編輯Podfile文件， 添加XcodeCoverage庫

打開終端， cd到項目路徑編輯Podfile

vi Podfile

添加：

pod 'XcodeCoverage', ‘~>1.0'

運行pod update安裝依賴庫

pod update

 

 步驟3：Xcode工程配置

1. 使用Xcode打開項目，Targes -> 選擇你的APP -> Build Settings -> 搜索Preprocessor Macros -> 展開在Debug一欄加入NT_COVERAGE=1

注意這裏咱們都只修改Debug模式下的屬性， 避免影響線上版本的打包發佈

2. 一樣在Build Settings中將如下3項的Debug模式改成Yes

• Generate Debug Symbols 配置成YES
• Generate Legacy Test Coverage Files 配置成YES
• Instrument Program Flow 配置成YES

 

3. Build Phase中 -> New Run Script Phase -> Run Scrip中添加Pods/XcodeCoverage/exportenv.sh

 這裏有個注意的地方， 若是本來項目中已經有一個run script也仍是新建一個

#4. AppDelegate.m中applicationDidEnterBackground方法添加如下代碼

    #if NT_COVERAGE
        #if !TARGET_IPHONE_SIMULATOR
            NSArray *paths = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES);
            NSString *documentsDirectory = [paths objectAtIndex:0];
            setenv("GCOV_PREFIX", [documentsDirectory cStringUsingEncoding:NSUTF8StringEncoding], 1);
            setenv("GCOV_PREFIX_STRIP", "13", 1);
        #endif
    
        extern void __gcov_flush(void);
        __gcov_flush();
    #endif

 

步驟4： 編譯安裝

選擇Debug模式安裝到手機或者模擬器上

 

步驟5：手動測試或者運行自動化測試

注意每次完成測試後先按Home鍵退到後臺， 等幾秒讓APP產生覆蓋率日誌不要直接殺掉APP進程

 

步驟6：提取真機上的.gcda文件

若是是在模擬器上運行測試能夠跳過此步

1. 打開Xcode -> window -> Devices and Simulaters， 選擇運行測試的真機

2. 在Installed Apps中選擇測試的應用，而後點擊底部的齒輪按鈕選擇Download Container

3. 會獲得一個xxxx.xcappdata文件

4. 右鍵點擊xcappdata文件 -> 顯示包內容， 進入AppData/Documents/arm64/, 拷貝里面的全部.gcda文件

5. 進入項目目錄/Pods/XcodeCoverage, 打開env.sh, 找到 OBJECT_FILE_DIR_normal屬性和CURRENT_ARCH屬性的值， 這裏要注意下若是CURRENT_ARCH的值是undefined就改爲arm64（關鍵）

6. 打開Finder，使用shift+command+G按鈕輸入<OBJECT_FILE_DIR_normal>/<CURRENT_ARCH>，其中 OBJECT_FILE_DIR_normal 及 CURRENT_ARCH 是上一步找到的值，(尖括號注意去掉)

7. 把上面第4步拷貝的全部.gcda文件拷貝到第六步打開的目錄中

 

步驟7：生成覆蓋率報告

打開終端， cd進入項目目錄/Pods/XcodeCoverage, 運行命令:

./getcov --show

便可自動生成覆蓋率報告

 

整個過程手動操做較多， 能夠繼續研究下若是實現自動化

其中步驟6可使用ifuse掛在沙盒來實現自動化提取.gcda文件， 方法能夠參考下面這篇

使用libimobiledevice + ifuse提取iOS沙盒文件