IOS और OS X प्रोजेक्ट्स के लिए कोड कवरेज का विश्लेषण (xCode 4.4)

प्रस्तावना

यह विषय कोड कवरेज के बारे में बात करने का इरादा नहीं करता है, और इस उपकरण की आवश्यकता है या नहीं। इसके अलावा, आईओएस परियोजनाओं में परीक्षणों की उपयुक्तता पर सवाल नहीं उठाया जाएगा (मान लीजिए कि उन्हें अभी भी किसी की ज़रूरत है, जिसका अर्थ है)।

प्रेरणा

यह बहुत सुविधाजनक है जब प्रोफाइल / विश्लेषण उपकरण आईडीई में बनाए जाते हैं। XCode में कोड कवरेज वाला इतिहास पूरी तरह से क्लाउडलेस नहीं है: xCode 3.x और GCC के दिनों में सबकुछ सरल था और एक समय में आवश्यक लिंक और कंपाइलर फ्लैग को हटा दिया गया था। XCode 4.1 के आगमन के साथ, LLVM-GCC के उपयोग के कारण सब कुछ थोड़ा और अधिक जटिल हो गया, मुझे कुछ तरकीबों (अपने हाथों से LLVM को इकट्ठा करने का अधिकार) पर जाना पड़ा। और 4.3 में libprofile_rt लाइब्रेरी को दूसरी निर्देशिका में ले जाया गया, जिससे बहुत सारी समस्याएं हुईं।

प्रायोगिक तौर पर यह पाया गया कि xCode 4.4 के लिए कोड कवरेज स्थापित करने में कई मिनट लगते हैं, और चूंकि यह सस्ता है, इसलिए इसका उपयोग क्यों न करें? व्यवहार में सिद्ध एक वैकल्पिक व्यावहारिक उपयोग मामला है, सीधे परियोजना कोड का परीक्षण करना और 'मृत' कोड की खोज करना, इसके बाद उसका विश्लेषण और सफाई।

XCode 4.4 में प्रोजेक्ट सेटअप

चेकमार्क यूनिट यूनिट टेस्ट के साथ एक नया प्रोजेक्ट (iOS / OS X) बनाएं। आप तैयार किए गए यूनिट परीक्षणों के साथ मेरी परीक्षण परियोजना का उपयोग कर सकते हैं।
एक परियोजना की स्थापना में दो चरण शामिल हैं:
1. लक्ष्य% प्रोजेक्ट-नाम% खोलें, और कोड पीढ़ी अनुभाग में झंडे सेट करें:
टेस्ट कवरेज फ़ाइलें उत्पन्न करें = हाँ
साधन कार्यक्रम प्रवाह = हाँ



2. केवल iOS के लिए। यहां वर्णित क्रैश से बचने के लिए, आपको निम्नलिखित फ़ाइल के साथ एक फ़ाइल को * .c प्रोजेक्ट में जोड़ना होगा:

#include <stdio.h> FILE* fopen$UNIX2003(const char* filename, const char* mode); size_t fwrite$UNIX2003(const void* ptr, size_t size, size_t nitems, FILE* stream); FILE* fopen$UNIX2003(const char* filename, const char* mode) { return fopen(filename, mode); } size_t fwrite$UNIX2003(const void* ptr, size_t size, size_t nitems, FILE* stream) { return fwrite(ptr, size, nitems, stream); } 

वह पूरा प्रोजेक्ट सेटअप है। अब% प्रोजेक्टनेम% टेस्ट चलाने के बाद, आपको निर्देशिका (iOS के लिए) / /User/%user%/Library/Developer/Xcode/DerivedData/%project-nameBLABLABABABLA%/Build/Intermediates/%project-name%.build/name/ खोलने की आवश्यकता है। "डिबग-आईफ़ोनिमुलेटर /% प्रोजेक्ट-नाम% .build / ऑब्जेक्ट्स-सामान्य / i386" । इस निर्देशिका में, हम * .gcda और * .gcno फ़ाइलों में रुचि रखते हैं, जिनमें कवरेज डेटा होता है। महत्वपूर्ण : यदि आप एप्लिकेशन कोड के कवरेज का परीक्षण करने जा रहे हैं, तो परीक्षण नहीं, तो आपको * .plist में UIApplicationExitsOnSuspend = YES को निर्दिष्ट करना होगा, क्योंकि * .gcda फाइलें प्रोग्राम के "त्रुटि" तरीके से समाप्त होने के बाद ही बनाई जाती हैं।

स्पष्टता के लिए, मैं परीक्षण किए गए वर्ग और कई परीक्षणों का कोड देता हूं:

 #import "MyCalc.h" @implementation MyCalc - (CGFloat)performOperation:(MyMathOperation)operation withA:(CGFloat)a B:(CGFloat)b { CGFloat result = 0.f; switch (operation) { case MyMathOperationAdd: result = a + b; break; case MyMathOperationSubtract: result = a - b; break; case MyMathOperationDivide: result = a / b; break; case MyMathOperationMultiply: result = a * b; break; default: NSLog(@"Unsupported operation"); break; } return result; } - (CGFloat)negate:(CGFloat)number { //this method works incorrectly return number; } @end 

 - (void)testNegation { CGFloat input = 3; CGFloat expected = -3; CGFloat result = [self.calculator negate:input]; STAssertEquals(result, expected, @"Negation failed. Expected: %f, Actual: %f", expected, result); } - (void)testAddition { CGFloat a = 3; CGFloat b = 4; CGFloat expected = a + b; CGFloat result = [self.calculator performOperation:MyMathOperationAdd withA:a B:b]; STAssertEquals(result, expected, @"Addition failed. Expected: %f, Actual: %f", expected, result); } - (void)testMultiplication { CGFloat a = 14; CGFloat b = 3; CGFloat expected = a * b; CGFloat result = [self.calculator performOperation:MyMathOperationMultiply withA:a B:b]; STAssertEquals(result, expected, @"Addition failed. Expected: %f, Actual: %f", expected, result); } 

परिणाम विश्लेषण

मानव-अनुकूल प्रारूप में आंकड़े प्रस्तुत करने के लिए कई उपकरणों पर विचार करें।

gcov

gcov एक उपयोगिता है जो * .gcda और * .gcno फ़ाइलों के आधार पर कवरेज आँकड़े उत्पन्न करती है। कुछ समय पहले तक, यह केवल जीसीसी के साथ काम करता था, फिलहाल यह पूरी तरह से एलएलवीएम के साथ काम करता है। आउटपुट एक सादा पाठ रिपोर्ट है।
उदाहरण के लिए, यहाँ परीक्षण परियोजना से MyCalc.gcda फ़ाइलों पर चलने का परिणाम है:



आउटपुट पर, हमारे पास कवरेज के प्रतिशत पर आंकड़े हैं, साथ ही फाइल MyCalc.m.gcov:

  -: 0:Source:/Users/dlebedev/src/sandbox/Coverage/iOS/iOSCoverage/../../Common/MyCalc.m -: 0:Graph:MyCalc.gcno -: 0:Data:MyCalc.gcda -: 0:Runs:0 -: 0:Programs:0 -: 1:// -: 2:// MyCalc.m -: 3:// iOSCoverage -: 4:// -: 5:// Created by Denis Lebedev on 23.08.12. -: 6:// Copyright (c) 2012 Denis Lebedev. All rights reserved. -: 7:// -: 8: -: 9:#import "MyCalc.h" -: 10: -: 11:@implementation MyCalc -: 12: 2: 13:- (CGFloat)performOperation:(MyMathOperation)operation withA:(CGFloat)a B:(CGFloat)b { 2: 14: CGFloat result = 0.f; -: 15: 2: 16: switch (operation) { -: 17: case MyMathOperationAdd: 1: 18: result = a + b; 1: 19: break; -: 20: case MyMathOperationSubtract: #####: 21: result = a - b; -: 22: #####: 23: break; -: 24: case MyMathOperationDivide: #####: 25: result = a / b; -: 26: #####: 27: break; -: 28: case MyMathOperationMultiply: 1: 29: result = a * b; 1: 30: break; -: 31: default: #####: 32: NSLog(@"Unsupported operation"); #####: 33: break; -: 34: } 2: 35: return result; -: 36:} 1: 37:- (CGFloat)negate:(CGFloat)number { -: 38: //this method works incorrectly 1: 39: return number; -: 40:} -: 41: -: 42:@end 

#####: - लाइन पूरी नहीं हुई।
n: - लाइन को n बार निष्पादित किया गया था।

अधिक विवरण यहां पाया जा सकता है ।

आवरण

CoverStory gcov के लिए एक GUI ऐड-ऑन है जो अतिरिक्त रूप से Apple स्क्रिप्ट का उपयोग करके HTML रिपोर्ट बनाने की अनुमति देता है।

lcov

lcov gcov के लिए एक और चित्रमय फ्रंट-एंड है। यह बहुत सुविधाजनक है जब बड़ी संख्या में फाइलें होती हैं, क्योंकि यह HTML को निर्देशिकाओं में समूहित करती है, साथ ही प्रक्रिया स्वचालन के दौरान - उपयोगिता टर्मिनल से काम करती है।

Lcov स्थापित करें:

 # sudo mkdir -p /usr/local/src; cd /usr/local/src # sudo wget http://downloads.sourceforge.net/ltp/lcov-1.6.tar.gz # sudo tar -xzvf lcov-1.6.tar.gz # cd lcov-1.6 

 # sudo vim /usr/local/src/lcov-1.6/bin/install.sh</code> 

34 लाइन पर (-D $ SOURCE $ TARGET को स्थापित करें), -D ध्वज को हटा दें।

 # sudo make install 

रिपोर्ट प्राप्त करने के लिए, .gcda-files के साथ फ़ोल्डर में निम्नलिखित कमांड निष्पादित करें:

 lcov -t 'Code coverage report' -o report.info -c -d . genhtml -o html-report report.info 

HTML- रिपोर्ट फ़ोल्डर में परिणाम:

स्वचालन

जैसा कि ऊपर उल्लेख किया गया है, एलसीओवी निरंतरता एकीकरण में सुविधाजनक है। प्रदर्शन किया गया उदाहरण विशेष रूप से अकादमिक होगा और कष्टप्रद खामियों के साथ (स्क्रिप्ट को कोकोपोड्स का उपयोग करके परियोजना पर लागू नहीं किया जा सकता है)।

स्क्रिप्ट कोड (यह iOS परीक्षण परियोजना के साथ फ़ोल्डर में भी पाया जा सकता है):

 #!/bin/sh TARGET_NAME="iOSCoverage" TEST_TARGET_NAME="iOSCoverageTests" BUILD_CONFIG="Debug" SDK_VERSION="iphonesimulator5.1" rm -rf build rm -rf html-report echo Building and running tests xcodebuild -target $TEST_TARGET_NAME OBJECT_FILE_DIR_normal=/build/ TEST_AFTER_BUILD=YES -sdk iphonesimulator5.1 -configuration $BUILD_CONFIG -xcconfig settings.xcconfig echo Copying files mkdir build/gcda cp build/$TARGET_NAME.build/$BUILD_CONFIG-iphonesimulator/$TARGET_NAME.build/Objects-normal/i386/*.gcda build/gcda/ cp build/$TARGET_NAME.build/$BUILD_CONFIG-iphonesimulator/$TARGET_NAME.build/Objects-normal/i386/*.gcno build/gcda/ echo Generating report cd build/gcda lcov -t 'Code coverage report' -o report.info -c -d . cd .. cd .. genhtml -o html-report build/gcda/report.info 

Settings.xcconfig की सामग्री (आप परियोजना में झंडे को छोड़ सकते हैं):

 GCC_INSTRUMENT_PROGRAM_FLOW_ARCS = YES GCC_GENERATE_TEST_COVERAGE_FILES = YES 

हमने प्रोजेक्ट के आगे स्क्रिप्ट और सेटिंग्स। Xcconfig फ़ाइल रखी (पहले हम लक्ष्य और एसडीके नाम चर को आवश्यक के साथ बदलते हैं), चलाएं ... और हमें एक त्रुटि मिलती है। चूंकि शुरू में iPhone सिम्युलेटर कमांड लाइन से परीक्षण चलाने में सक्षम नहीं है। इस कष्टप्रद गलतफहमी को कैसे ठीक करें, इसका वर्णन यहाँ किया गया है । उसके बाद, स्क्रिप्ट को फिर से चलाएं और आंकड़ों के साथ HTML-रिपोर्ट फ़ोल्डर प्राप्त करें।

UPD: जेनकिंस के साथ घनिष्ठ एकीकरण के लिए, आप gcovr + Cobertura Plugin का उपयोग कर सकते हैं। टिप के लिए धन्यवाद मोबोर ।