CruiseControl.NET में कोड कवरेज संग्रह को एम्बेड करें

परिचय

हाल ही में, परीक्षण-संचालित विकास सॉफ्टवेयर विकास के अभ्यास को सक्रिय रूप से बढ़ावा दिया गया है। निस्संदेह, यह बहुत उपयोगी है, लेकिन हमेशा नहीं और सभी इसका उपयोग नहीं करते हैं। इसलिए, कोड का हिस्सा इकाई परीक्षणों द्वारा कवर किया गया है, और भाग खुला रहता है। प्रत्येक परियोजना को मैन्युअल रूप से ट्रैक करना, चाहे परीक्षण वहां सामान्य रूप से लिखे गए हों या नहीं, लगभग असंभव कार्य है।

मैंने हाल ही में सोचा कि कैसे मीट्रिक इकट्ठा करने की प्रक्रिया को स्वचालित किया जाए, जो परीक्षणों द्वारा कोड कवरेज का प्रतिशत दर्शाता है। क्रूज़कॉन्ट्रोल.नेट में उसके संग्रह को एम्बेड करने का निर्णय लिया गया। स्वाभाविक रूप से, 100% कवरेज बग की अनुपस्थिति की गारंटी नहीं देता है, लेकिन कम से कम यह परीक्षण लिखने के प्रति डेवलपर्स के रवैये को दर्शाता है।









इस लेख में, मैं प्रोजेक्ट्स बनाने और यूनिट परीक्षण चलाने के लिए क्रूज़कंट्रोल की स्थापना के बारे में बिंदुओं पर ध्यान केंद्रित नहीं करूंगा। चरण जो आपको कोड की कवरेज के बारे में आवश्यक जानकारी एकत्र करने और परीक्षण पृष्ठ पर प्रदर्शित करने की अनुमति देंगे, वर्णित किए जाएंगे। इकाई परीक्षण लिखने के लिए, हमारी कंपनी Microsoft - MSTest से रूपरेखा का उपयोग करती है। इस ढांचे के साथ काम करने के परिणामों को लेख में वर्णित किया जाएगा। यह ध्यान देने योग्य है कि कोड कवरेज को एम्बेड करने के लिए एक शर्त परीक्षणों को चलाने के लिए क्रूज़कंट्रोल का प्रारंभिक सेटअप है।



जहां तक ​​मुझे पता है, क्रूज़कंट्रोल ने एनसीओवर का उपयोग करके एकत्र किए गए डेटा को प्रदर्शित करने के लिए अंतर्निहित क्षमताओं का निर्माण किया है। लेकिन क्योंकि हमारे पास इस लाइब्रेरी को खरीदने का अवसर नहीं है, इसलिए हम अपने पास मौजूद तरीकों का उपयोग करते हैं।



निम्नलिखित सभी विजुअल स्टूडियो 2010 में लिखी गई परियोजनाओं पर लागू होते हैं। 2008 के संस्करण के साथ अंतर, हालांकि छोटे हैं।

एक बिल्ड सर्वर पर एक data.coverage फ़ाइल बनाना

विज़ुअल स्टूडियो आपको परीक्षणों के निष्पादन को कॉन्फ़िगर करने की अनुमति देता है ताकि सभी परीक्षणों को पारित करने के बाद, एक फ़ाइल बनाई जाए जिसमें कोड के कवर किए गए वर्गों के बारे में जानकारी संग्रहीत हो। इस फाइल को data.coverage कहा जाएगा (यह परीक्षणों को पारित करने के परिणामों के साथ इन फ़ोल्डर में संग्रहीत है)।

यह सेटिंग आपके प्रोजेक्ट की .testrunconfig फ़ाइल में संग्रहीत है। UI के माध्यम से इसे निम्नानुसार सेट किया जा सकता है:

1. अपनी .testrunconfig फ़ाइल खोलें
2. डेटा और डायग्नोस्टिक्स का चयन करें
3. कोड कवरेज के बगल में स्थित बॉक्स को चेक करें और कॉन्फ़िगर करें पर क्लिक करें
4. उस लाइब्रेरी का चयन करें जिसके लिए आप कवरेज एकत्र करना चाहते हैं
5. जगह में उपकरण असेंबलियों को अनचेक करें

फ़ाइल को सहेजने के बाद, निम्न पाठ इसके अंदर होगा:

<?xml version="1.0" encoding="UTF-8"?> <TestSettings name="Local Test Run" id="de0d45b4-4fed-4acb-a663-2cfdf0ce4fd7" xmlns="http://microsoft.com/schemas/VisualStudio/TeamTest/2010"> <Description>This is a default test run configuration for a local test run.</Description> <Deployment enabled="false" /> <Execution> <Timeouts testTimeout="300000" /> <TestTypeSpecific> <UnitTestRunConfig testTypeId="13cdc9d9-ddb5-4fa4-a97d-d965ccfc6d4b"> <AssemblyResolution> <TestDirectory useLoadContext="true" /> </AssemblyResolution> </UnitTestRunConfig> </TestTypeSpecific> <AgentRule name="LocalMachineDefaultRole"> <DataCollectors> <DataCollector uri="datacollector://Microsoft/CodeCoverage/1.0" assemblyQualifiedName="Microsoft.VisualStudio.TestTools.CodeCoverage.CoveragePlugIn, Microsoft.VisualStudio.QualityTools.Plugins.CodeCoverage, PublicKeyToken=b03f5f7f11d50a3a" friendlyName="Code Coverage"> <Configuration> <CodeCoverage xmlns=""> <Regular> <CodeCoverageItem binaryFile="YourProject\bin\Debug\YourProject.dll" pdbFile="YourProject\bin\Debug\YourProject.pdb" /> </Regular> </CodeCoverage> </Configuration> </DataCollector> </DataCollectors> </AgentRule> </Execution> </TestSettings>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

DataCollectors अनुभाग सिर्फ MSTest को कोड कवरेज बनाने के लिए कहता है।



अब हम जानते हैं कि विन्यास में क्या निर्दिष्ट होना चाहिए, और बिल्ड सर्वर पर इसके उपयोग के लिए हमारे पास 3 विकल्प हैं:

• अपने प्रोजेक्ट से तैयार-तैयार कॉन्फ़िगरेशन फ़ाइल का उपयोग करें;
• प्रोजेक्ट में बिल्ड सर्वर के लिए एक अलग कॉन्फ़िगरेशन स्टोर करें;
• मक्खी पर एक विन्यास फाइल बनाएँ।

पहला मामला हमें शोभा नहीं देता, क्योंकि यह फ़ाइल संस्करण नियंत्रण प्रणाली में संग्रहीत है, इसलिए कोई भी डेवलपर कोड कवरेज संग्रह विकल्प को बंद कर सकता है और इस फ़ाइल को वापस रख सकता है। या इसके विपरीत, यदि, उदाहरण के लिए, हम कुछ मामलों में इस मीट्रिक को इकट्ठा नहीं करना चाहते हैं। इन कारणों के लिए, यह निर्धारित करना कि मीट्रिक एकत्र करना या नहीं करना है क्रूज़कंट्रोल में शामिल किया जाना चाहिए। दूसरा विकल्प भी ऊपर वर्णित समस्या को पूरी तरह से रोकता नहीं है। उपरोक्त कारणों से, हम अपनी कंपनी में तीसरे विकल्प पर बस गए। मैं एक्सएमएल फ़ाइल बनाने के तरीके का वर्णन नहीं करूंगा, वहां सब कुछ काफी सरल है।



जब कॉन्फ़िगरेशन तैयार हो जाता है, तो आप परीक्षण चला सकते हैं। ऐसा करने के लिए, कार्य अनुभाग में निम्नलिखित कोड को क्रूज़कंट्रोल कॉन्फ़िगरेशन फ़ाइल में जोड़ें:

 <exec> <executable>C:\Program Files (x86)\Microsoft Visual Studio 10.0\Common7\IDE\MSTest.exe</executable> <buildArgs>"/testcontainer:PathToWorkingDirectory\Source\bin\Release\YourTestProject.dll" "/runconfig:PathToYourConfig\localtestrun.testrunconfig" "/resultsfile:PathToWorkingDirectory\TestResults.xml"</buildArgs> <description>Executing MSTest</description> </exec>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

यदि आप अभी CruiseControl चलाते हैं, तो Path.coWorkingDirectory \ [USERNAME] _ [MACHINE-NAME] [DATE AND TIME] \ In \ "MACHINE-NAME] फ़ोल्डर में Data.coverage फ़ाइल बनाई जाएगी। क्योंकि फ़ोल्डर के नाम पर समय है, फिर भविष्य में इसका उपयोग करने के लिए बहुत सुविधाजनक नहीं होगा। इसलिए, .testrunconfig में आपको निम्नलिखित सेक्शन (<TestSettings> के अंदर) जोड़ना होगा:

 <NamingScheme baseName="FolderName" appendTimeStamp="false" useDefault="false" />
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

अब Data.coverage फ़ाइल PathToWorkingDirectory \ FolderName \ In \ [MACHINE-NAME] फ़ोल्डर में मिल सकती है।



कार्रवाई किए जाने के बाद, Data.coverage फ़ाइल फ़ोल्डर में क्रूज़कंट्रोल के साथ मशीन पर इस परियोजना के लिए परीक्षण परिणामों के साथ होगी। समस्या यह है कि यह फ़ाइल बाइनरी है, इसलिए हमें इसे xml में बदलने की आवश्यकता है।

XML में data.coverage कन्वर्ट करें

इस फ़ाइल को परिवर्तित करने के लिए, आपको एक कंसोल एप्लिकेशन लिखना होगा जो सभी परीक्षणों को पारित करने के बाद निष्पादित किया जाएगा। यहां सब कुछ काफी सरल है, रूपांतरण करने वाले कोड को नीचे प्रस्तुत किया गया है:

 using (CoverageInfo info = CoverageInfo.CreateFromFile(PathToDataCoverageFile)) { CoverageDS data = info.BuildDataSet(); string outputXml = data.GetXml(); File.WriteAllText(PathToOutputXmlCoverageFile,outputXml)); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

XML आउटपुट में बहुत सारी जानकारी होगी जिसकी हमें ज़रूरत नहीं है, इसलिए आप XSL ट्रांसफ़ॉर्म लागू कर सकते हैं और केवल उन्हीं सेक्शन को छोड़ सकते हैं जिनकी हमें ज़रूरत है। इसके अलावा, विधियों के नामों में एक पूरा नाम होगा, जिसमें नाम स्थान भी शामिल है, जो कि कवरेज के बारे में विस्तृत जानकारी प्रदर्शित करते समय कुछ हद तक असुविधाजनक है, और यह परिणामस्वरूप XML फ़ाइल के एक साधारण संशोधन द्वारा हल किया जाता है।



हमारा कंसोल एप्लिकेशन बिल्ड सर्वर कॉन्फ़िगरेशन में एक अतिरिक्त अनुभाग के लिए लॉन्च किया गया है:

 <exec> <executable>PathToConverter\Coverage2XmlConverter.exe</executable > <buildArgs>"PathToDataCoverage\data.coverage" "PathToOutputXml\coverage.xml"</buildArgs> <description>Calculation code coverage data</description> </exec>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

परिणाम बनाने के लिए डेटा जोड़ना

अब हमारे पास लगभग सब कुछ तैयार है। निर्माण परिणाम के लिए बस परिणामी XML फ़ाइल जोड़ें। यह काफी सरलता से किया जाता है, आपको निम्नलिखित अनुभाग को प्रकाशक अनुभाग के अंदर क्रूज़कंट्रोल के विन्यास में जोड़ना होगा:

 <merge> <files> <file>PathToResults\TestResult.xml</file> <file>PathToCoverage\coverage.xml</file> </files> </merge>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

यदि आपने परीक्षण के साथ काम को कॉन्फ़िगर किया है, तो TestResult.xml फ़ाइल पहले से ही आपके कॉन्फ़िगरेशन में होनी चाहिए।

बिल्ड पृष्ठ पर डेटा प्रदर्शित करना

यह बिल्ड के साथ पेज पर एकत्र किए गए डेटा को प्रदर्शित करने के लिए एक्सएसएलटी फ़ाइल लिखने के लिए बनी हुई है। बिल्ड पर जहां कवरेज 20% से कम है, कोड कवरेज संकेतक लाल होगा, 20% -50% के मामले में सूचक पीला होगा और> 50% के मामले में यह हरा होगा। इन मूल्यों को XSLT में आसानी से बदला जा सकता है, और उन लोगों का उपयोग करें जो आपके लिए सबसे उपयुक्त हैं।



बिल्ड के साथ पृष्ठ पर दिखाए जाने वाले कवरेज का कुल मूल्य, यहां बताया गया है कि अब यह कैसा दिखता है:







ऐसा करने के लिए, मुझे MSTestReport2008.xsl को मानक CruiseControl.NET सेट से थोड़ा संशोधित करना पड़ा।



और यह है कि कोड कवरेज मीट्रिक का विवरण कैसा है:







मैं XSLT पाठ के साथ लेख में एक स्थान पर कब्जा नहीं करूंगा, इसलिए मैंने GitHub 2 XSLT फाइलों पर पोस्ट किया, साथ ही डेटा.ऑवरेज फ़ाइल को XML में कनवर्ट करने के लिए एक आवेदन के साथ।



बहुत-बहुत धन्यवाद, मैं एक बार टिप्पणी और जोड़ दूंगा।