🥇स्थैतिक विश्लेषण - परिचय से एकीकरण तक

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

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

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

यदि आप निश्चित रूप से नहीं जानते कि स्थैतिक विश्लेषण क्या है और इसे कैसे कार्यान्वित किया जाए, इस लेख को पढ़ेंइस पद्धति के बारे में और अधिक जानने के लिए।

आपको स्थैतिक विश्लेषण की आवश्यकता क्यों है?

संक्षेप में: त्वरण और सरलीकरण।

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

auto x = obj.x;
auto y = obj.y;
auto z = obj.z;

आपने निम्नलिखित कोड लिखा है:

auto x = obj.x;
auto y = obj.y;
auto z = obj.x;

जैसा कि आप देख सकते हैं, अंतिम पंक्ति में एक त्रुटि है। उदाहरण के लिए, पीवीएस-स्टूडियो निम्नलिखित चेतावनी जारी करता है:

V537 'y' आइटम के उपयोग की शुद्धता की समीक्षा करने पर विचार करें।

यदि आप इस त्रुटि पर अपना हाथ डालना चाहते हैं, तो कंपाइलर एक्सप्लोरर में एक तैयार उदाहरण आज़माएं: *क्लिक*.

और जैसा कि आप समझते हैं, कोड के ऐसे अनुभागों पर तुरंत ध्यान देना हमेशा संभव नहीं होता है, और इस वजह से, आप एक घंटे तक डीबगिंग करते हुए बैठ सकते हैं, यह सोचते हुए कि सब कुछ इतना अजीब तरीके से क्यों काम करता है।

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

इन्हीं स्थितियों के लिए स्थैतिक विश्लेषण सामने आया। यह डेवलपर के लिए एक सहायक है जो कोड में विभिन्न समस्याओं को इंगित करेगा और दस्तावेज़ में समझाएगा कि इस तरह लिखना क्यों आवश्यक नहीं है, इससे क्या हो सकता है और इसे कैसे ठीक किया जा सकता है। यह कैसा दिख सकता है इसका एक उदाहरण यहां दिया गया है: *क्लिक*.

आप और भी दिलचस्प त्रुटियां पा सकते हैं जिन्हें विश्लेषक लेखों में पहचान सकता है:

अब जब आपने यह सामग्री पढ़ ली है और स्थैतिक विश्लेषण के लाभों से आश्वस्त हो गए हैं, तो हो सकता है कि आप इसे आज़माना चाहें। लेकिन कहां से शुरू करें? अपने वर्तमान प्रोजेक्ट में एक नया टूल कैसे एकीकृत करें? और उनसे टीम का परिचय कैसे कराया जाए? इन सवालों के जवाब आपको नीचे मिलेंगे।

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

0. टूल को जानना

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

इस स्तर पर आप क्या सीखेंगे:

विश्लेषक के साथ बातचीत करने के तरीके क्या हैं;
क्या विश्लेषक आपके विकास परिवेश के अनुकूल है?
आपकी परियोजनाओं में वर्तमान में क्या समस्याएँ हैं?

अपनी ज़रूरत की हर चीज़ इंस्टॉल करने के बाद, सबसे पहले आपको पूरे प्रोजेक्ट का विश्लेषण करना चाहिए (Windows, Linux, macOS). विजुअल स्टूडियो में पीवीएस-स्टूडियो के मामले में आपको एक समान तस्वीर दिखाई देगी (क्लिक करने योग्य):

तथ्य यह है कि स्थैतिक विश्लेषक आमतौर पर बड़े कोड आधार वाली परियोजनाओं के लिए बड़ी संख्या में चेतावनियाँ जारी करते हैं। उन सभी को ठीक करने की कोई आवश्यकता नहीं है, क्योंकि आपका प्रोजेक्ट पहले से ही काम कर रहा है, जिसका अर्थ है कि ये समस्याएं गंभीर नहीं हैं। हालाँकि, आप आप सबसे दिलचस्प चेतावनियाँ देख सकते हैं और यदि आवश्यक हो तो उन्हें सुधारें। ऐसा करने के लिए, आपको आउटपुट को फ़िल्टर करना होगा और केवल सबसे विश्वसनीय संदेश छोड़ना होगा। विज़ुअल स्टूडियो के लिए पीवीएस-स्टूडियो प्लगइन में, यह त्रुटि स्तरों और श्रेणियों के आधार पर फ़िल्टर करके किया जाता है। सबसे सटीक आउटपुट के लिए, केवल छोड़ें हाई и सामान्य जानकारी (क्लिक करने योग्य भी):

दरअसल, कई हज़ार चेतावनियों की तुलना में 178 चेतावनियाँ देखना बहुत आसान है...

टैब में मध्यम и निम्न अक्सर अच्छी चेतावनियाँ होती हैं, लेकिन इन श्रेणियों में वे निदान शामिल होते हैं जिनकी सटीकता (विश्वसनीयता) कम होती है। विंडोज़ के तहत काम करने के लिए चेतावनी स्तर और विकल्पों के बारे में अधिक जानकारी यहां पाई जा सकती है: *क्लिक*.

सबसे दिलचस्प त्रुटियों की सफलतापूर्वक समीक्षा करना (और उन्हें सफलतापूर्वक ठीक करना) सार्थक है शेष चेतावनियों को दबाएँ. यह आवश्यक है ताकि नई चेतावनियाँ पुरानी चेतावनियों के बीच लुप्त न हो जाएँ। इसके अलावा, एक स्थैतिक विश्लेषक प्रोग्रामर के लिए एक सहायक है, न कि बग की सूची। 🙂

1. स्वचालन

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

इस स्तर पर आप क्या सीखेंगे:

उपकरण कौन से स्वचालन विकल्प प्रदान करता है;
क्या विश्लेषक आपके असेंबली सिस्टम के अनुकूल है?

चूँकि सही दस्तावेज़ मौजूद नहीं है, कभी-कभी आपको लिखना पड़ता है समर्थन. यह सामान्य है और हम आपकी मदद करने में प्रसन्न हैं। 🙂

आइए अब सतत एकीकरण (सीआई) सेवाओं की ओर बढ़ते हैं। किसी भी विश्लेषक को बिना किसी गंभीर समस्या के उनमें लागू किया जा सकता है। ऐसा करने के लिए, आपको पाइपलाइन में एक अलग चरण बनाने की आवश्यकता है, जो आमतौर पर निर्माण और इकाई परीक्षणों के बाद स्थित होता है। यह विभिन्न कंसोल उपयोगिताओं का उपयोग करके किया जाता है। उदाहरण के लिए, पीवीएस-स्टूडियो निम्नलिखित उपयोगिताएँ प्रदान करता है:

पीवीएस-स्टूडियो_Cmd.exe (विंडोज़ पर समाधान, सी#, सी++ परियोजनाओं का विश्लेषण)
CLMonitor.exe (संकलन निगरानी)
पीवीएस-स्टूडियो-विश्लेषक (लिनक्स/मैकओएस पर सी++ परियोजनाओं का विश्लेषण)
पीवीएस-स्टूडियो-डॉटनेट (समाधान विश्लेषण, Linux/macOS पर C# प्रोजेक्ट)
pvs-studio.jar (जावा परियोजनाओं का विश्लेषण)
प्लॉग कनवर्टर (रिपोर्ट फ़ाइल कनवर्टर)

सीआई में विश्लेषण को एकीकृत करने के लिए, आपको तीन काम करने होंगे:

विश्लेषक स्थापित करें;
विश्लेषण चलाएँ;
परिणाम प्रदान करें.

उदाहरण के लिए, लिनक्स (डेबियन-बेस) पर पीवीएस-स्टूडियो स्थापित करने के लिए, आपको निम्नलिखित कमांड चलाने की आवश्यकता है:

wget -q -O - https://files.viva64.com/etc/pubkey.txt 
    | sudo apt-key add -
sudo wget -O /etc/apt/sources.list.d/viva64.list 
  https://files.viva64.com/etc/viva64.list
  
sudo apt-get update -qq
sudo apt-get install -qq pvs-studio

विंडोज़ चलाने वाले सिस्टम पर, पैकेज मैनेजर से विश्लेषक को स्थापित करने का कोई तरीका नहीं है, लेकिन कमांड लाइन से विश्लेषक को तैनात करना संभव है:

PVS-Studio_setup.exe /verysilent /suppressmsgboxes 
/norestart /nocloseapplications

आप विंडोज़ चलाने वाले सिस्टम पर पीवीएस-स्टूडियो को तैनात करने के बारे में अधिक पढ़ सकते हैं *यहां*.

स्थापना के बाद, आपको सीधे विश्लेषण चलाने की आवश्यकता है। हालाँकि, संकलन और परीक्षण पारित होने के बाद ही ऐसा करने की अनुशंसा की जाती है। ऐसा इसलिए है क्योंकि स्थैतिक विश्लेषण में आमतौर पर संकलन की तुलना में दोगुना समय लगता है।

चूँकि लॉन्च विधि प्लेटफ़ॉर्म और प्रोजेक्ट सुविधाओं पर निर्भर करती है, मैं उदाहरण के तौर पर C++ (लिनक्स) का विकल्प दिखाऊंगा:

pvs-studio-analyzer analyze -j8 
                            -o PVS-Studio.log
plog-converter -t errorfile PVS-Studio.log --cerr -w

पहला आदेश विश्लेषण करेगा, और दूसरा लिफाफेरिपोर्ट को टेक्स्ट प्रारूप में परिवर्तित करता है, इसे स्क्रीन पर प्रदर्शित करता है और चेतावनियां होने पर 0 के अलावा कोई रिटर्न कोड लौटाता है। त्रुटि संदेश आने पर किसी बिल्ड को ब्लॉक करने के लिए इस तरह की एक प्रणाली का उपयोग आसानी से किया जा सकता है। हालाँकि, आप हमेशा ध्वज को हटा सकते हैं -w और ऐसी असेंबली को ब्लॉक न करें जिसमें चेतावनियाँ हों।

ध्यान दें। पाठ स्वरूप असुविधाजनक है. इसे केवल एक उदाहरण के रूप में प्रदान किया गया है। अधिक दिलचस्प रिपोर्ट प्रारूप पर ध्यान दें - FullHtml। यह आपको कोड के माध्यम से नेविगेट करने की अनुमति देता है।

आप लेख में सीआई पर विश्लेषण स्थापित करने के बारे में अधिक पढ़ सकते हैं "पीवीएस-स्टूडियो और सतत एकीकरण" (विंडोज़) या "ट्रैविस सीआई में पीवीएस-स्टूडियो कैसे स्थापित करें(लिनक्स)।

ठीक है, आपने विश्लेषक को बिल्ड सर्वर पर कॉन्फ़िगर किया है। अब, यदि किसी ने अप्रयुक्त कोड अपलोड किया है, तो सत्यापन चरण विफल हो जाएगा, और आप समस्या का पता लगाने में सक्षम होंगे, हालांकि, यह पूरी तरह से सुविधाजनक नहीं है, क्योंकि शाखाओं के विलय के बाद नहीं, बल्कि परियोजना की जांच करना अधिक कुशल है। इससे पहले, पुल अनुरोध चरण में। ए.

सामान्य तौर पर, पुल अनुरोध विश्लेषण स्थापित करना सीआई पर विश्लेषण के सामान्य लॉन्च से बहुत अलग नहीं है। परिवर्तित फ़ाइलों की सूची प्राप्त करने की आवश्यकता को छोड़कर। इन्हें आमतौर पर git का उपयोग करके शाखाओं के बीच अंतर पूछकर प्राप्त किया जा सकता है:

git diff --name-only HEAD origin/$MERGE_BASE > .pvs-pr.list

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

pvs-studio-analyzer analyze -j8 
                            -o PVS-Studio.log 
                            -S .pvs-pr.list

आप पुल अनुरोधों के विश्लेषण के बारे में अधिक जानकारी प्राप्त कर सकते हैं*यहां*. भले ही आपका सीआई लेख में उल्लिखित सेवाओं की सूची में नहीं है, फिर भी आपको इस प्रकार के विश्लेषण के सिद्धांत के लिए समर्पित सामान्य अनुभाग उपयोगी लगेगा।

पुल अनुरोधों का विश्लेषण स्थापित करके, आप चेतावनियों वाले कमिट को ब्लॉक कर सकते हैं, जिससे एक सीमा बन जाएगी जिसे अप्रयुक्त कोड पार नहीं कर सकता है।

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

2. डेवलपर मशीनों पर एकीकरण

अब रोजमर्रा के विकास उपयोग के लिए विश्लेषक को स्थापित और कॉन्फ़िगर करने का समय आ गया है। इस बिंदु तक आप काम करने के अधिकांश तरीकों से परिचित हो चुके होंगे, इसलिए इसे सबसे आसान हिस्सा कहा जा सकता है।

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

फिर आपको आवश्यक प्लगइन्स इंस्टॉल करने की आवश्यकता होगी, उदाहरण के लिए विजुअल स्टूडियो, विचार, सवार इत्यादि

3. दैनिक उपयोग

इस स्तर पर, दैनिक उपयोग के दौरान विश्लेषक को गति देने के तरीकों के बारे में कुछ शब्द कहने का समय आ गया है। पूरे प्रोजेक्ट के संपूर्ण विश्लेषण में बहुत समय लगता है, लेकिन हम पूरे प्रोजेक्ट में एक ही बार में कितनी बार कोड बदलते हैं? शायद ही कोई रिफैक्टरिंग इतनी बड़ी हो कि यह तुरंत पूरे कोड बेस को प्रभावित कर दे। एक समय में बदली जाने वाली फ़ाइलों की संख्या शायद ही कभी एक दर्जन से अधिक हो, इसलिए उनका विश्लेषण करना समझ में आता है। ऐसी स्थिति के लिए वहाँ है वृद्धिशील विश्लेषण मोड. बस घबराएं नहीं, यह कोई दूसरा उपकरण नहीं है। यह एक विशेष मोड है जो आपको केवल परिवर्तित फ़ाइलों और उनकी निर्भरताओं का विश्लेषण करने की अनुमति देता है, और यदि आप स्थापित प्लगइन के साथ आईडीई में काम कर रहे हैं तो निर्माण के बाद यह स्वचालित रूप से होता है।

यदि विश्लेषक हाल ही में बदले गए कोड में समस्याओं का पता लगाता है, तो वह स्वतंत्र रूप से इसकी रिपोर्ट करेगा। उदाहरण के लिए, पीवीएस-स्टूडियो आपको अलर्ट का उपयोग करके इसके बारे में बताएगा:

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

ऐसे लेख रोजमर्रा के उपयोग के लिए आवश्यक सभी जानकारी प्रदान करते हैं और अधिक समय नहीं लेते हैं। 🙂

यहां तक कि टूल को जानने के चरण में भी, हमने पहले लॉन्च के दौरान कई चेतावनियों को दबा दिया था। दुर्भाग्य से, स्थैतिक विश्लेषक परिपूर्ण नहीं हैं, इसलिए समय-समय पर वे झूठी सकारात्मकताएँ देते हैं। आमतौर पर उन्हें दबाना आसान होता है; उदाहरण के लिए, विज़ुअल स्टूडियो के लिए पीवीएस-स्टूडियो प्लगइन में आपको बस एक बटन पर क्लिक करना होगा:

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

एकीकरण के बाद

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

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

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

यदि आप इस लेख को अंग्रेजी भाषी दर्शकों के साथ साझा करना चाहते हैं, तो कृपया अनुवाद लिंक का उपयोग करें: मैक्सिम ज़िवागिन्त्सेव। स्थैतिक विश्लेषण: आरंभ करने से एकीकरण तक.

स्रोत: www.habr.com

स्थैतिक विश्लेषण - परिचय से एकीकरण तक