🏖️ 🧓🏼 ✨ CI में PVS स्टूडियो के बारे में एक संक्षिप्त टिप्पणी (और क्या गायब है) 👏🏾 🏑 🤟🏼

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

तो, कुछ संगठन है, इसमें एक सीआई है जो बस काम करता है: जेनकिन्स को गिट में एक धक्का के बाद एक हुक प्राप्त होता है, जिसके बाद यह कुछ पाइपलाइन लॉन्च करता है। उपयोग किए गए औजारों के कारण, सी # (msbuild) और C ++ (msbuild, CMake) में बनाई गई परियोजनाओं के लिए असेंबली की जाती है। परिष्करण चरणों में से एक में, पीवीएस स्टूडियो (अन्य चीजों के साथ, कैपचेक का उपयोग करते हुए, सहित रिपोर्ट जेनरेशन शुरू किया गया है, लेकिन आगे के कथन के लिए यह महत्वपूर्ण नहीं है)।

PVS स्टूडियो में एक कंसोल विश्लेषण उपकरण है जो कमांड लाइन से लॉन्च किया गया है: PVS-Studio_Cmd.exe --target "${projectFile}" --output report.plog --progress

इनपुट पर - प्रोजेक्ट का नाम (.sln), आउटपुट में - रिपोर्ट।

रिपोर्ट - एक्सटेंशन .plog वाली एक फ़ाइल, एक नियमित XML फ़ाइल है। दस्तावेज़ योजना अंतर्निहित है, इसलिए आउटपुट प्रारूप में कोई आश्चर्य नहीं हो सकता है। कम से कम जब तक डेवलपर्स योजना को नहीं बदलते, लेकिन हम इस विकल्प पर विचार नहीं करेंगे।

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

लेकिन एक्सएमएल को अपनी आंखों से पढ़ना अपने आप में एक खुशी है, इसलिए आपको देखने और नेविगेट करने के लिए किसी तरह की आवश्यकता है।

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

तो चलो दूसरे रास्ते पर जाएं और देखें कि क्या किया जा सकता है। और एक काफी मानक तरीका है जो आपको XML को किसी और चीज़ में बदलने की अनुमति देता है: XSLT । अब, शायद, पाठकों में से एक ने विकृत कर दिया है, लेकिन, फिर भी, मैंने पढ़ना जारी रखने का प्रस्ताव किया है।

XSLT XML दस्तावेज़ों को किसी और चीज़ में परिवर्तित करने के लिए एक भाषा है। यह केवल इनपुट टेम्प्लेट में रूपांतरण नियम की तुलना करता है, लेकिन हमने स्वयं के लिए HTML रिपोर्ट में रूपांतरण किया है।

मुझे उम्मीद है कि कोई भी मुझे टेबल बनाने के लिए जज नहीं करेगा, क्योंकि डेटा प्रकृति में सारणीबद्ध है। रिपोर्ट में प्रत्येक रिकॉर्ड निम्नलिखित स्तंभों के साथ एक तालिका पंक्ति के अनुरूप होगा:

तालिका में पंक्ति संख्या।
फ़ाइल का नाम।
पंक्ति संख्या।
त्रुटि कोड।
त्रुटि संदेश।

चर्चा में मौखिक संदर्भ के लिए लाइन नंबर सिर्फ सुविधाजनक है।

लाइन नाम के साथ फाइल का नाम आपको रिपॉजिटरी का लिंक बनाने की अनुमति देता है। लेकिन उस पर और बाद में।

त्रुटि कोड पीवीएस-स्टूडियो डेवलपर्स वेबसाइट के एक लिंक द्वारा तैयार किया गया है: http://viva64.com/en/unningErrorCode } (या / ru /, जैसा आप चाहते हैं)।

त्रुटि संदेश कोई टिप्पणी नहीं है।

इससे निपटने के लिए कुछ बिंदु हैं।

सबसे पहले, मैं चाहूंगा कि संदेशों को महत्व स्तर के आधार पर क्रमबद्ध किया जाए, साथ ही प्रत्येक प्रकार के संदेशों की कुल संख्या भी हो। पहला कार्य xsl:sort एक्सप्रेशन का उपयोग करके हल किया जाता है, दूसरा count([]) ।

दूसरा: फ़ाइल नाम को पूर्ण रूप से इंगित किया गया है, और संस्करण नियंत्रण प्रणाली का लिंक बनाने के लिए एक रिश्तेदार नाम की आवश्यकता है। आपको केवल उस परियोजना के साथ निर्देशिका के नाम के अनुरूप उपसर्ग को काटने की आवश्यकता है जिसमें रिपॉजिटरी को क्लोन किया गया है (हमारे पास गिट है, लेकिन यह आसानी से adapts है)। लेकिन इस रास्ते पर आने के लिए, हमें एक्सएसएल xsl:param निर्माण का उपयोग करके एक्सएसएल परिवर्तन को पैरामीटर करना होगा। बाकी अपेक्षाकृत सरल है: फ़ाइल के साथ लाइन से हटा दें नाम निर्देशिका के नाम के साथ एक सामान्य उपसर्ग है जहां रिपॉजिटरी को क्लैप किया गया है। मुझे कहना होगा कि XSLT में यह समस्या काफी परिष्कृत रूप से हल हो गई है।

तीसरा: सत्यापन रिपॉजिटरी में एक विशिष्ट संशोधन को संदर्भित करता है, और इसे भी ध्यान में रखा जाना चाहिए। यह प्रतिबद्ध पहचानकर्ता के साथ पैरामीटर का उपयोग करके हल किया जाता है। इसी तरह शाखाओं के लिए।
चौथा: यदि आप स्रोत कोड के साथ तीसरे पक्ष के पुस्तकालयों का उपयोग करते हैं, तो हमारे प्रोजेक्ट में चेतावनी के साथ उन्हें चेतावनी न मिलाएं। समस्या इस प्रकार हल की गई है: हम सभी बाहरी परियोजनाओं को एक निश्चित निर्देशिका में रखते हैं, जिसका नाम हमारी परियोजना में निहित नहीं है। अब, यदि फ़ाइल नाम में यह उपनिर्देशिका (वास्तव में सिर्फ एक विकल्प) है, तो पोगल में प्रविष्टि रिपोर्ट में नहीं मिलती है, लेकिन इसे रिपोर्ट हेडर में "छिपा हुआ" माना जाता है। अधिक लचीलेपन के लिए, आप परिवर्तन को माप सकते हैं और इस निर्देशिका के लिए एक डिफ़ॉल्ट नाम निर्दिष्ट कर सकते हैं: <xsl:param name="external" select="'External'" />

अच्छी तरह से और एक और छोटा कार्य: एक भंडार के लिए लिंक एकत्र करना। हम Redmine + gitolite का उपयोग करते हैं। फिर से, अनुकूलनीय।

चूंकि रूपांतरण के लिए कई पैरामीटर स्थिर हैं, आप एक निरंतर URL उपसर्ग तैयार कर सकते हैं:

 <xsl:variable name="repo"> <xsl:text>http://redmine.your-site.com/projects/</xsl:text> <xsl:value-of select="$project" /> <xsl:text>/revisions/</xsl:text> <xsl:value-of select="$revision" /> <xsl:text>/entry/</xsl:text> </xsl:variable>

शैलीकरण के साथ कुछ सुंदरियां, और आप इसका उपयोग कर सकते हैं। हम पृष्ठ में सीएसएस एम्बेड करते हैं, बस एक ही फाइल रिपोर्ट है। हमें चित्रों की भी आवश्यकता नहीं है।

स्पॉइलर के तहत पूर्ण परिवर्तन कोड

XSLT

 <?xml version="1.0" encoding="utf-8"?> <xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:msxsl="urn:schemas-microsoft-com:xslt" xmlns="http://www.w3.org/1999/xhtml" exclude-result-prefixes="msxsl" > <xsl:output method="html" indent="yes"/> <xsl:param name="project" /> <xsl:param name="base-path" /> <xsl:param name="branch" select="'master'" /> <xsl:param name="revision" select="'[required]'" /> <xsl:param name="external" select="'External'" /> <xsl:variable name="repo"> <xsl:text>http://redmine.your-company.com/projects/</xsl:text> <!-- # !!!attention!!! # --> <xsl:value-of select="$project" /> <xsl:text>/revisions/</xsl:text> <xsl:value-of select="$revision" /> <xsl:text>/entry/</xsl:text> </xsl:variable> <xsl:template name="min-len"> <xsl:param name="a" /> <xsl:param name="b" /> <xsl:variable name="la" select="string-length($a)" /> <xsl:variable name="lb" select="string-length($b)" /> <xsl:choose> <xsl:when test="$la &lt; $lb"> <xsl:value-of select="$la"/> </xsl:when> <xsl:otherwise> <xsl:value-of select="$lb" /> </xsl:otherwise> </xsl:choose> </xsl:template> <xsl:template name="strdiff-impl"> <xsl:param name="mask" /> <xsl:param name="value" /> <xsl:param name="n" /> <xsl:param name="lim" /> <xsl:choose> <xsl:when test="$n = $lim"> <xsl:value-of select="substring($value, $lim + 1)" /> </xsl:when> <xsl:when test="substring($mask, 0, $n) = substring($value,0, $n)"> <xsl:call-template name="strdiff-impl"> <xsl:with-param name="lim" select="$lim" /> <xsl:with-param name="mask" select="$mask" /> <xsl:with-param name="value" select="$value" /> <xsl:with-param name="n" select="$n + 1" /> </xsl:call-template> </xsl:when> <xsl:otherwise> <xsl:value-of select="substring($value, $n - 1)"/> </xsl:otherwise> </xsl:choose> </xsl:template> <xsl:template name="strdiff"> <xsl:param name="mask" /> <xsl:param name="value" /> <xsl:choose> <xsl:when test="not($value)" /> <xsl:when test="not($mask)"> <xsl:value-of select="$value" /> </xsl:when> <xsl:otherwise> <xsl:call-template name="strdiff-impl"> <xsl:with-param name="mask" select="$mask" /> <xsl:with-param name="value" select="$value" /> <xsl:with-param name="lim"> <xsl:call-template name="min-len"> <xsl:with-param name="a" select="$mask" /> <xsl:with-param name="b" select="$value" /> </xsl:call-template> </xsl:with-param> <xsl:with-param name="n" select="1" /> </xsl:call-template> </xsl:otherwise> </xsl:choose> </xsl:template> <xsl:template match="/*"> <xsl:variable select="Solution_Path/SolutionPath" name="solution" /> <xsl:variable select="PVS-Studio_Analysis_Log [not(contains(File, $external))] [ErrorCode!='Renew'] " name="input" /> <html lang="en"> <head> <style type="text/css"> <![CDATA[ #report * {font-family: consolas, monospace, sans-serif; } #report {border-collapse: collapse; border: solid silver 1px;} #report th, #report td {padding: 6px 8px; border: solid silver 1px;} .sev-1 {background-color: #9A2617;} .sev-2 {background-color: #C2571A;} .sev-3 {background-color: #BCA136;} .sev-hidden {background-color: #999; } #report tbody * {color: white;} .fa * { color: #AAA; } a {color: #006;} .stat {padding: 20px;} .stat * {color: white; } .stat span {padding: 8px 16px; } html {background-color: #EEE;} .success {color: #3A3; } ]]> </style> </head> <body> <h1>PVS-Studio report</h1> <h2> <xsl:call-template name="strdiff"> <xsl:with-param name="value"> <xsl:value-of select="$solution" /> </xsl:with-param> <xsl:with-param name="mask"> <xsl:value-of select="$base-path" /> </xsl:with-param> </xsl:call-template> </h2> <div class="stat"> <span class="sev-1"> High: <b> <xsl:value-of select="count($input[Level=1])" /> </b> </span> <span class="sev-2"> Meduim: <b> <xsl:value-of select="count($input[Level=2])" /> </b> </span> <span class="sev-3"> Low: <b> <xsl:value-of select="count($input[Level=3])" /> </b> </span> <span class="sev-hidden" title="Externals etc"> Hidden: <b> <xsl:value-of select="count(PVS-Studio_Analysis_Log) - count($input)"/> </b> </span> </div> <xsl:choose> <xsl:when test="count($input) = 0"> <h2 class="success">No error messages.</h2> </xsl:when> <xsl:otherwise> <table id="report"> <thead> <tr> <th> # </th> <th> File </th> <th> Line </th> <th> Code </th> <th> Message </th> </tr> </thead> <tbody> <xsl:for-each select="$input"> <xsl:sort select="Level" data-type="number"/> <xsl:sort select="DefaultOrder" /> <tr> <xsl:attribute name="class"> <xsl:text>sev-</xsl:text> <xsl:value-of select="Level" /> <xsl:if test="FalseAlarm = 'true'"> <xsl:text xml:space="preserve"> fa</xsl:text> </xsl:if> </xsl:attribute> <th> <xsl:value-of select="position()" /> </th> <td> <xsl:variable name="file"> <xsl:call-template name="strdiff"> <xsl:with-param name="value" select="File" /> <xsl:with-param name="mask" select="$base-path" /> </xsl:call-template> </xsl:variable> <a href="{$repo}{translate($file, '\', '/')}#L{Line}"> <xsl:value-of select="$file" /> </a> </td> <td> <xsl:value-of select="Line"/> </td> <td> <a href="http://viva64.com/en/{ErrorCode}" target="_blank"> <xsl:value-of select="ErrorCode" /> </a> </td> <td> <xsl:value-of select="Message" /> </td> </tr> </xsl:for-each> </tbody> </table> </xsl:otherwise> </xsl:choose> </body> </html> </xsl:template> <xsl:template match="@* | node()"> <xsl:copy> <xsl:apply-templates select="@* | node()"/> </xsl:copy> </xsl:template> </xsl:stylesheet>

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

और अब डेवलपर्स की ओर थोड़ा रोना। एक बग है, एक विशेषता नहीं है, जो ऊपर वर्णित के अनुसार पूरी तरह से करना असंभव बनाता है, इसके अलावा, यह केवल C ++ परियोजनाओं पर लागू होता है, C # में ऐसी कोई परेशानी नहीं है। जब एक plog फ़ाइल बनती है, तो <File> नाम हमेशा लोअरकेस में डाला जाता है। और जब रेडिमाइन (और अन्य वेब) को केस-संवेदी फ़ाइल नामों के साथ UNIX जैसी प्रणालियों पर होस्ट किया जाता है, तो फ़ाइलों के लिंक बनाते समय केस टूट जाता है, जिससे लिंक निष्क्रिय हो जाते हैं। ऐसी उदासी।

मुझे तकनीकी सहायता पत्र का जवाब मिला कि यह व्यवहार बाहरी API के कारण है, लेकिन यह स्पष्ट नहीं है कि यह इतना चयनात्मक क्यों है और केवल C ++ पर लागू होता है, और C # पर लागू नहीं होता है।
इसलिए, अभी के लिए, जैसा कि वादा किया गया था, मैं पुल की निरंतरता और फलदायी सहयोग की आशा करता हूं।

आपका ध्यान के लिए धन्यवाद।

अद्यतन : Paull और खंडेलेंट द्वारा प्रस्तुत डेवलपर्स के साथ पत्राचार के परिणामों के अनुसार, गहरी खुदाई की गई थी, जिसके परिणामस्वरूप एक बीटा जारी किया गया था जिसमें ऊपर वर्णित समस्या हल हो गई थी। लेकिन इसके लिए काम करने के लिए, छोटे रास्तों के लिए समर्थन की आवश्यकता होती है, कम से कम उस ड्राइव पर जहां विश्लेषण किया जा रहा है। ऐसा करने के लिए, पथ HKLM \ SYSTEM \ CurrentControlSet \ Control \ FileSystem के साथ रजिस्ट्री में, आपको छोटी फ़ाइल नाम सहेजने वाले मान के लिए NtfsDisable8dot3NameCreation (DWORD) पैरामीटर सेट करने की आवश्यकता होती है। MSDN पर विवरण देखें।
NTFS की गति बढ़ाने के लिए छोटे नामों पर डिफ़ॉल्ट प्रतिबंध की आवश्यकता है।
आप या तो मान 0 सेट कर सकते हैं और परेशान नहीं कर सकते हैं, या 3 यदि सिस्टम विभाजन पर उपयोगकर्ता प्रोफ़ाइल में CI कार्य किए जाते हैं या सिस्टम विभाजन पर कहीं और 2 में, या कमांड fsutil 8dot3name set Z: 0 चलाएं (Z के बजाय आपका डिस्क) :), जहां CI कार्यक्षेत्र तैनात किया जाएगा (वैसे भी रैम डिस्क पर लागू होता है)।

मुझे उम्मीद है कि यह जानकारी viva64 वेबसाइट पर कहीं दिखाई देगी।

अब ऐसा लगता है कि जेस्टाल्ट बंद हो गया है, आपके ध्यान के लिए फिर से धन्यवाद।

CI में PVS स्टूडियो के बारे में एक संक्षिप्त टिप्पणी (और क्या गायब है)

More articles: