(Code Coverage) Hướng dẫn thiết lập Code Coverage cho iOS

- Code coverage là gì?
- Code coverage là cách kiểm tra những chức năng bạn đã làm có viết Unit Test hay chưa và đã viết qua những đoạn code nào rồi. Bạn có thể kiểm tra bằng mắt thường nhưng chỉ với 1 project nhỏ, vì thế thông qua Frankencover bạn có thể tạo những báo cáo của code coverage bằng những file html và có màu sắc cho từng dòng và phương thức để dễ dàng kiểm tra 1 cách nhanh chóng và dễ dàng. Ngoài cách này ra có nhiều cách khác bạn có thể tìm hiểu thêm trên mạng.


Mình sẽ hướng dẫn cách cài Frankencover. Điều kiện trước khi đọc qua tài liệu này:
- Bạn đã biết cách viết Unit Test cho iOS.
- Biết những khái niệm về brew và gem trên hệ điều hành. Hướng dẫn cài brew xem tại đây.
- Project có sẵn code và unit test. Project mình giả sử để làm ví dụ là có 1 hàm cộng 2 số là kiểu NSString, và có viết sẵn Unit Test, có thể tải project tại đây.

Hướng dẫn cài fankencover để tạo code coverage trên local:
* Bước 1- Cài đặt: Những đoạn script chạy cần cài đặt những tool như: groovy, lcov, xcpretty.
Cài thông qua Brew:

 $ brew install groovy  
 $ brew install lcov  

Cài thông qua MacPorts:

 $ sudo port install groovy  
 $ sudo port install lcov  

Cài xcpretty:

 sudo gem install xcpretty  

* Bước 2 - Thiết lập:
Vào build setting của XCode, thiết lập những thuộc tính "Generate Test Coverage Files" và "Instrument Program Flow" là Yes cho chế độ Debug, như hình sau:

Tại thư mục project tạo file build.sh với nội dung như sau:

 #!/bin/sh  
 # First Run Tests  
 xcodebuild test -project DemoCodeCoverage.xcodeproj/ -scheme 'DemoCodeCoverage' -configuration Debug -destination 'platform=iOS Simulator,name=iPhone 6,OS=8.3' | xcpretty -c --report junit  
 #We set required coverage to 80% - build fails if coverage falls below this value.  
 # Now Produce Test Coverage Report  
 groovy http://frankencover.it/with -source-dir "DemoCodeCoverage/Classes" -required-coverage 80  
 # Use for local  
 #groovy frankencover -source-dir "DemoCodeCoverage/Classes" -required-coverage 80  

Nếu bạn dùng workspace thì dùng tham số "-workspace DemoCodeCoverage.xcworkspace/".
"platform=iOS Simulator,name=iPhone 6,OS=8.3": Platform để chạy unit test.
"-required-coverage 80" số phần trăm tối thiểu cần phải viết test case để pass.

* Bước 3 - Chạy script để build, chạy unit test và tạo report code coverage, với lệnh như sau:

 sh build.sh  

Giả sử mình mới viết 1 unit test. Sau khi chạy xong kết quả sẽ như sau:

Nó sẽ báo đỏ vì mình mới chỉ viết test case dc có 15.8% của những chức năng cần test. Để xem chi tiết bạn nên mở file html trong đường dẫn build/reports/coverage/index.html để xem chi tiết như sau:

Ở đây báo mình chỉ test được 3/19 dòng và 1/2 chức năng. Mở file ra nó sẽ báo chi tiết những đoạn code chưa viết test.

Bây giờ mình sẽ viết hết những test case cho những đoạn màu đỏ và kết quả build lại như sau:

Bạn đã hoàn thành xong việc kiểm tra code coverage rồi, bạn có thể tải file dự án hoàn chỉnh tại đây. Chúc các bạn thành công.

Công cụ dùng để viết: XCode 6.3, iOS 8.3

Tài liệu tham khảo:
- http://frankencover.it/