代码覆盖率入门

什么是代码覆盖率

代码覆盖率,是一种通过核算测验过程中被履行的源代码占悉数源代码的份额,从而直接衡量软件质量的方法。它在确保测验质量的时分潜在确保实际产品的质量,能够基于此在程序中寻找没有被测验用例测验过的地方,进一步创立新的测验用例来增加覆盖率。按性质,它属于白盒测验的范畴,即主要依据源代码的内部结构来规划测验用例,通过规划不同的输入来测验软件的不同部分。常见的编程语言,如C/C ,python和Java等,都有相应的代码覆盖率测验工具。

本篇是入门篇,带大家入门代码覆盖率,全量代码覆盖率,关于原理、增加代码进行代码覆盖率后面会逐个共享

操作过程

第一步

创立一个demo,名为CodeCoverageRate01

终究目录如下

代码覆盖率入门

第二步

增加编译配置,用于生成覆盖率.profraw文件

代码覆盖率入门

第三步

确认覆盖率的范围,因为是demo这儿是 all targets

代码覆盖率入门

第四步

4.1 增加一个 InstrProfiling.h 文件 引进llvm api

因为我的demo是swift项目会提示增加桥接文件,这儿不赘述操作过程

#ifndef InstrProfiling_h
#define InstrProfiling_h
#ifndef PROFILE_INSTRPROFILING_H_
#define PROFILE_INSTRPROFILING_H_
int __llvm_profile_runtime = 0;
void __llvm_profile_initialize_file(void);
const char *__llvm_profile_get_filename();
void __llvm_profile_set_filename(const char *);
int __llvm_profile_write_file();
int __llvm_profile_register_write_file_atexit(void);
const char *__llvm_profile_get_path_prefix();
#endif /* PROFILE_INSTRPROFILING_H_ */
#endif /* InstrProfiling_h */

4.2 增加CodeCoverageTool类提供API

import Foundation
import UIKit
private let instance:CodeCoverageTool = CodeCoverageTool()
@objc public class CodeCoverageTool:NSObject {
    var isRegister:Bool = false
    public static func shared() -> CodeCoverageTool {
        return instance
    }
    //注册
    func registerCoverage(moduleName: String) {
        if isRegister {
            return
        }
        isRegister = true
        NotificationCenter.default.addObserver(self,
                                               selector: #selector(didEnterBackgroudNotification),
                                               name: UIApplication.didEnterBackgroundNotification,
                                               object: nil)
        let name = "(moduleName).profraw"
        print("registerCoverage, moduleName: (moduleName)")
        let fileManager = FileManager.default
        do {
            let documentDirectory = try fileManager.url(for: .documentDirectory, in: .userDomainMask, appropriateFor:nil, create:false)
            let filePath: NSString = documentDirectory.appendingPathComponent(name).path as NSString
            print("registerCoverage filePath: (filePath)")
            __llvm_profile_set_filename(filePath.utf8String)
        } catch {
            print(error)
        }
    }
    //适宜的时机代码覆盖率上报
    func saveAndUpload() {
        __llvm_profile_write_file()
    }
    @objc private func didEnterBackgroudNotification() {
        self.saveAndUpload()
    }
}

4.3 增加测验 TestSwift.swift

import Foundation
class TestSwift {
    public func test() {
        print("hello, i`m swift class")
    }
    public func test11() {
        print("hello, i`m test11")
    }
}

TestObjc

#import "TestObjc.h"
@implementation TestObjc
- (void)test {
    NSLog(@"hello , i`m objc class");
}
- (void)test11 {
    NSLog(@"hello , i`m test11");
}
@end

在ViewController.swift里调用

import UIKit
class ViewController: UIViewController {
    override func viewDidLoad() {
        super.viewDidLoad()
        // Do any additional setup after loading the view.
        test()
    }
    @objc private func test() {
        TestObjc().test()
        TestSwift().test()
    }
}

第五步

业务运用

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        // Override point for customization after application launch.
        CodeCoverageTool.shared().registerCoverage(moduleName: "testCodeCoverage")
        return true
}

运行APP,随便操作几下,退到后台

第六步

抓取.profraw文件 过程 xcode -> windows -> devices and simulators

代码覆盖率入门

下载后,点击查看包内容,如下能够拿到.profraw文件

代码覆盖率入门

第七步

合成.testCodeCoverage.profdata

首先把.profraw和对应的二进制文件放在一个文件夹里,如下

代码覆盖率入门

履行如下指令

xcrun llvm-profdata merge -sparse testCodeCoverage.profraw -o testCodeCoverage.profdata

生成.profdata文件

代码覆盖率入门

第八步

生成陈述

履行如下指令

xcrun llvm-cov show [二进制文件途径] --instr-profile=testCodeCoverage.profdata --format=html -use-color --output-dir ./coverage_report

[二进制文件途径]我的为 /Users/gegaozhao/Library/Developer/Xcode/DerivedData/CodeCoverageRate01-ahzrkhfjrajjnjaolknrsjgxmabw/Build/Products/Debug-iphoneos/CodeCoverageRate01.app/CodeCoverageRate01

效果

代码覆盖率入门
点击index.html,跳转到浏览器

代码覆盖率入门

到这儿流程就讲完了,感谢阅览!