👸🏿 🙆 🔀 FxCop का उपयोग करके .NET प्रोजेक्ट फ़ाइलों का विश्लेषण करने के लिए डायनामिक रूप से एक बिल्ड प्लान बना रहा है 👨🏿‍🌾 😛 💭

ऐसा हुआ कि एक साल पहले, मुझे चींटी का उपयोग करके एक बिल्ड प्लान लिखना पड़ा। यह हमारी छोटी वेब परियोजना के लिए इरादा था, हडसन पर निष्पादित किया गया था और उत्पादन करना था: संकलन, NUnit परीक्षण चलाना, परीक्षणों के लिए कोड का% कवरेज गिनना, डुप्लिकेट कोड ढूंढना और कोड में मुख्य शैलीगत विसंगतियों की पहचान करना। लेकिन यह एक शुरूआत है, और फिर हम FxCop का उपयोग करके प्रोजेक्ट फ़ाइलों के विश्लेषण के लिए एक बिल्ड प्लान लिखने के बारे में बात करेंगे।

और इसलिए! चलो चलते हैं!

पृष्ठभूमि

हमेशा की तरह, मैंने बिल्ड प्लान को कई घटकों में तोड़ दिया:

dbdeploy.build.xml - एक परीक्षण डेटाबेस बनाने और दिखने वाली स्क्रिप्ट को रोल करने के लिए जिम्मेदार है
fxcop.build.xml - प्रोजेक्ट फ़ाइलों की FxCop द्वारा विश्लेषण और प्रसंस्करण शुरू करने और समस्याओं के बारे में रिपोर्ट बनाने के लिए जिम्मेदार है
main.build.xml - यहाँ मुख्य क्रियाओं को कॉन्फ़िगर को भरने के लिए किया जाता है, स्वचालित रूप से उनकी असेंबली के लिए स्लाइन फ़ाइलों को खोजते हैं
ncover.build.xml - इस भाग में, परीक्षणों के साथ कोड के कवरेज पर एक रिपोर्ट बनाई गई है
simian.build.xml - और यहाँ कोड में दोहराव पर रिपोर्ट है।
test.build.xml - ठीक है, तो यह प्रोजेक्ट फ़ोल्डर में सभी NUnit परीक्षणों की खोज करता है और उन्हें शुरू करता है

इस तरह का एक मॉड्यूलर निर्माण विशिष्ट जिम्मेदारियों से अलग, व्यक्तिगत भागों को बाहर करना आसान बनाता है। आपके और मेरे लिए, डिवाइस fxcop.build.xml फ़ाइल पर विचार करना आपके ऊपर है।

चलिए शुरू करते हैं

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

कार्यान्वयन

फ़ाइल डिवाइस पर विचार करें। इसमें कई कार्य शामिल हैं:

clean-fxcop-result-folder - FxCop रिपोर्ट फ़ोल्डर को साफ करता है और xxopop के लिए गतिशील रूप से उत्पन्न पैरामीटर फ़ाइल को हटाता है
रन-fxcop - मुख्य कार्य जो फाइलों का विश्लेषण FxCop'om शुरू करता है
बनाएँ-तर्क - एक कार्य जो विश्लेषण के लिए उपयुक्त फ़ाइलों के लिए पथ को संसाधित करता है और एक उप-निर्माण योजना के गतिशील रूप से उत्पन्न फ़ाइल के लिए लाइन-बाय-लाइन लिखता है।
राइट-हेड-पार्ट - एक हेडर को डायनामिकली जेनरेट की गई सब-बिल्ड फाइल में लिखता है
राइट-पाद लेख-भाग - FxCop कमांड लिखता है जो विश्लेषण की गई फ़ाइलों के पथ की सूची को पूरा करता है

अगला, समस्या को हल करने के लिए मूल अपाचे चींटी कमांड पर विचार करें।

basename - आपको पूर्ण पथ से एक्सटेंशन के साथ फ़ाइल नाम प्राप्त करने की अनुमति देता है।
loadfile - आपको किसी फ़ाइल से कुछ डेटा लोड करने की अनुमति देता है। इस स्थिति में, कार्य .NET प्रोजेक्ट फ़ाइल के proj को पार्स करने के लिए उपयोग किया जाता है।
सबंट - आपको किसी अन्य बिल्ड फ़ाइल से कार्य करने की अनुमति देता है, इस मामले में FxCop के लिए गतिशील रूप से उत्पन्न होता है
Propertyregex - आपको इनपुट लाइन पर दिए गए नियमित अभिव्यक्ति का उपयोग करके डेटा का चयन करने की अनुमति देता है।
यदि - बिल्ड फ़ाइल में तार्किक अभिव्यक्तियों के आधार पर निष्पादन के तर्क को जोड़ने की अनुमति देता है।

अब आप प्रत्येक कार्य पर अलग से विचार करने के लिए आगे बढ़ सकते हैं।

लिखने-सिर-भाग

<target name="write-head-part"> <echo file="${dynafile.path}\${dynafilename}">&lt;?xml version="1.0" encoding="UTF-8"?&gt; &lt;project name="dyna-fxcop-build" default="run-fx-cop-report-creation" basedir="."&gt; &lt;target name="run-fx-cop-report-creation"&gt; &lt;exec executable="${fxcop.path}\FxCopCmd.exe" failonerror="false"&gt;</echo> </target>

इस कार्य में, बिल्ड प्लान के मानक हेडर ${dynafile.path}\${dynafilename} , पथ पर स्थित फ़ाइल का उपयोग करते हुए लिखा जाता है < > < > , पात्रों से बचने के लिए < > । यह एफएक्सकोप एप्लिकेशन के लिए आवश्यक मापदंडों को पारित करने के लिए exec कार्य को भी रिकॉर्ड करता है। इस तरह, arg माध्यम से मापदंडों को पार करते हुए, हम विश्लेषण की गई फ़ाइलों के लिए रास्तों की एक लंबी सूची की समस्या को हल कर सकते हैं।

create-तर्कों

  <target name="create-arguments"> //        <echo message="${item.file}"/> //    ,     filename <basename property="filename" file="${item.file}"/> //   output.path   <OutputPath>   csproj <loadfile srcfile="${item.file}" property="output.path"> <filterchain> <linecontains> <contains value="&lt;OutputPath&gt;"/> </linecontains> </filterchain> </loadfile> //   <OutputType>   csproj   output.type <loadfile srcfile="${item.file}" property="output.type"> <filterchain> <linecontains> <contains value="&lt;OutputType&gt;"/> </linecontains> </filterchain> </loadfile> //   <AssemblyName>   csproj   assembly.name <loadfile srcfile="${item.file}" property="assembly.name"> <filterchain> <linecontains> <contains value="&lt;AssemblyName&gt;"/> </linecontains> </filterchain> </loadfile> //       OutputPath    output.path.info <propertyregex property="output.path.info" input="${output.path}" regexp="&lt;OutputPath&gt;(.*?)&lt;/OutputPath&gt;" select="\1" /> //       OutputType    output.type.info <propertyregex property="output.type.info" input="${output.type}" regexp="&lt;OutputType&gt;(.*?)&lt;/OutputType&gt;" select="\1" /> //       AssemblyName    assembly.name.info <propertyregex property="assembly.name.info" input="${assembly.name}" regexp="&lt;AssemblyName&gt;(.*?)&lt;/AssemblyName&gt;" select="\1" /> //       <propertyregex property="item.path" input="${item.file}" regexp="(.*)\\" select="\1" /> <echo message="output.type.info = ${output.type.info}"/> <echo message="output.path = ${output.path}"/> //         output.type.info <if> <contains string="WinExe" substring="${output.type.info}"/> <then> <property name="file.name.ext" value="${assembly.name.info}.exe"/> </then> <elseif> <contains string="Exe" substring="${output.type.info}"/> <then> <property name="file.name.ext" value="${assembly.name.info}.exe"/> </then> </elseif> <else> <property name="file.name.ext" value="${assembly.name.info}.dll"/> </else> </if> //  <arg value=""/>    value      . <echo file="${dynafile.path}\${dynafilename}" append="true"> &lt;arg value="/f:${item.path}\${output.path.info}${file.name.ext}"/&gt; </echo> </target>

इस कार्य में, एक्सटेंशन csproj के साथ प्रोजेक्ट फ़ाइलों का प्रसंस्करण किया जाता है। फ़ाइल से, टैग डेटा हाइलाइट किया गया है: OutputPath, OutputType और AssemblyName। यह आवश्यक है ताकि परियोजना फ़ाइल के नाम पर ध्यान केंद्रित न किया जा सके (क्योंकि ऐसी परियोजना फाइलें थीं जिनमें विधानसभा का नाम बदल दिया गया था)। और बिल्ड योजना की गतिशील रूप से बनाई गई फ़ाइल में, निष्पादन कार्य के लिए arg लाइनें / f: ध्वज निर्दिष्ट के साथ लिखी गई हैं।

लिखने-पाद-भाग

 <target name="write-footer-part"> <echo file="${dynafile.path}\${dynafilename}" append="true"> &lt;arg value="/r:${fxcop.path}\Rules"/&gt; &lt;arg value="/o:${fxcop.report.full.path}"/&gt; &lt;/exec&gt; &lt;/target&gt; &lt;/project&gt;</echo> </target>

यह कार्य डायनेमिक रूप से निर्मित बिल्ड प्लान के अंतिम भाग को रिकॉर्ड करता है, जो FxCop निर्देशों को नियमावली फोल्डर /r:${fxcop.path}\Rules और रिपोर्ट आउटपुट फोल्डर / /o:${fxcop.report.full.path} । exec , traget और project समापन टैग भी traget ।

रन-FxCop

 <target name="run-fxcop"> //   - <antcall target="write-head-part"/> //        <echo file="${dynafile.path}\${dynafilename}" append="true"> </echo> <var name="dll.names" value=""/> //  csproj    ,     ,    item.file, //  create-arguments <foreach target="create-arguments" param="item.file" inheritall="true"> <fileset dir="${basedir}" casesensitive="no"> <include name="**/*.csproj"/> //      /obj/Debug/ <exclude name="**/obj/Debug/**.*"/> </fileset> </foreach> //    - <antcall target="write-footer-part"/> //     -. <subant target="run-fx-cop-report-creation"> <fileset dir="${dynafile.path}" includes="${dynafilename}"/> </subant> </target>

ठीक है, FxCop बिल्ड प्लान का सबसे महत्वपूर्ण कार्य गतिशील रूप से बनाना है, इसलिए यह कहना है कि एक सब बिल्ड प्लान। इस तरह के एक दृष्टिकोण का उपयोग करके, .NET प्रोजेक्ट की फ़ाइलों का विश्लेषण किया जाएगा। इस कार्य में, राइट-हेड-पार्ट का उपयोग करते हुए, हेडर ${dynafile.path}\${dynafilename} पथ के साथ बनाई गई फ़ाइल में लिखा जाता है। अगला, फ़ाइल को अंत में डेटा जोड़ने के मोड में स्थानांतरित किया जाता है, append="true" पैरामीटर के साथ इको कमांड का उपयोग करते हुए।

इन चरणों के बाद, फ़ॉर्च का उपयोग करते हुए csproj एक्सटेंशन के साथ फ़ाइलों पर पुनरावृत्तियां होती हैं। इस स्थिति में, फ़ाइल का पथ चर item.file को लिखा जाता है, जिसे param="item.file" द्वारा परिभाषित किया गया है। ठीक है, इसलिए कि चींटी obj / Debug की सामग्री को नहीं देखती है, /> निर्देश का उपयोग करते हुए, हम इसे अनदेखा कर देते हैं।

फिर, write-footer-part का उपयोग करते हुए, गतिशील रूप से निर्मित बिल्ड फ़ाइल का अंतिम भाग लिखा जाता है।

और अब मज़ा हिस्सा! चूंकि हमने एक गतिशील बिल्ड प्लान में run-fx-cop-report-creation नामक एक टास्क बनाया, अब हम इसे सबंट टास्क का उपयोग करके निष्पादित कर सकते हैं। निर्माण करने के लिए मानकों में, निर्माण योजना की गतिशील रूप से उत्पन्न फ़ाइल के लिए पथ को इंगित करता है, जिसमें से run-fx-cop-report-creation कार्य निष्पादित किया जाएगा।

निष्कर्ष

मुझे आशा है कि यह सामग्री दिलचस्प थी :) आपका ध्यान के लिए धन्यवाद!

पूर्ण xml FxCop के लिए फ़ाइल कोड बनाएँ

 <?xml version="1.0" encoding="UTF-8"?> <project name="fxcop-xxx-project" default="run-fxcop" basedir="."> <property name="dynafile.path" value="${basedir}"/> <property name="dynafilename" value="dynabuild.xml"/> <property name="fxcop.report.dir" value="${basedir}\FxCopReports"/> <property name="fxcop.report.full.path" value="${fxcop.report.dir}\fxcop.report.xml"/> <target name="clean-fxcop-result-folder"> <echo message="Cleaning FxCop result report dir, and dynamic xml"/> <delete> <fileset dir="${fxcop.report.dir}" includes="**/*.*"/> </delete> <delete file="${dynafile.path}\${dynafilename}" failonerror="false"/> </target> <target name="run-fxcop"> <antcall target="write-head-part"/> <echo file="${dynafile.path}\${dynafilename}" append="true"> </echo> <var name="dll.names" value=""/> <foreach target="create-arguments" param="item.file" inheritall="true"> <fileset dir="${basedir}" casesensitive="no"> <include name="**/*.csproj"/> <exclude name="**/obj/Debug/**.*"/> </fileset> </foreach> <antcall target="write-footer-part"/> <subant target="run-fx-cop-report-creation"> <fileset dir="${dynafile.path}" includes="${dynafilename}"/> </subant> </target> <target name="create-arguments"> <echo message="${item.file}"/> <basename property="filename" file="${item.file}"/> <loadfile srcfile="${item.file}" property="output.path"> <filterchain> <linecontains> <contains value="&lt;OutputPath&gt;"/> </linecontains> </filterchain> </loadfile> <loadfile srcfile="${item.file}" property="output.type"> <filterchain> <linecontains> <contains value="&lt;OutputType&gt;"/> </linecontains> </filterchain> </loadfile> <loadfile srcfile="${item.file}" property="assembly.name"> <filterchain> <linecontains> <contains value="&lt;AssemblyName&gt;"/> </linecontains> </filterchain> </loadfile> <propertyregex property="output.path.info" input="${output.path}" regexp="&lt;OutputPath&gt;(.*?)&lt;/OutputPath&gt;" select="\1" /> <propertyregex property="output.type.info" input="${output.type}" regexp="&lt;OutputType&gt;(.*?)&lt;/OutputType&gt;" select="\1" /> <propertyregex property="assembly.name.info" input="${assembly.name}" regexp="&lt;AssemblyName&gt;(.*?)&lt;/AssemblyName&gt;" select="\1" /> <propertyregex property="item.path" input="${item.file}" regexp="(.*)\\" select="\1" /> <echo message="output.type.info = ${output.type.info}"/> <echo message="output.path = ${output.path}"/> <if> <contains string="WinExe" substring="${output.type.info}"/> <then> <property name="file.name.ext" value="${assembly.name.info}.exe"/> </then> <elseif> <contains string="Exe" substring="${output.type.info}"/> <then> <property name="file.name.ext" value="${assembly.name.info}.exe"/> </then> </elseif> <else> <property name="file.name.ext" value="${assembly.name.info}.dll"/> </else> </if> <echo file="${dynafile.path}\${dynafilename}" append="true"> &lt;arg value="/f:${item.path}\${output.path.info}${file.name.ext}"/&gt; </echo> </target> <target name="write-head-part"> <echo file="${dynafile.path}\${dynafilename}">&lt;?xml version="1.0" encoding="UTF-8"?&gt; &lt;project name="dyna-fxcop-build" default="run-fx-cop-report-creation" basedir="."&gt; &lt;target name="run-fx-cop-report-creation"&gt; &lt;exec executable="${fxcop.path}\FxCopCmd.exe" failonerror="false"&gt;</echo> </target> <target name="write-footer-part"> <echo file="${dynafile.path}\${dynafilename}" append="true"> &lt;arg value="/r:${fxcop.path}\Rules"/&gt; &lt;arg value="/o:${fxcop.report.full.path}"/&gt; &lt;/exec&gt; &lt;/target&gt; &lt;/project&gt;</echo> </target> </project>

FxCop का उपयोग करके .NET प्रोजेक्ट फ़ाइलों का विश्लेषण करने के लिए डायनामिक रूप से एक बिल्ड प्लान बना रहा है