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

अंतहीन कोड पुनरावलोकन किंवा डीबगिंगमुळे कंटाळले, कधीकधी आपण आपले जीवन कसे सोपे करावे याबद्दल विचार करता. आणि थोडासा शोध घेतल्यानंतर, किंवा चुकून अडखळल्यावर, आपण जादूचा वाक्यांश पाहू शकता: "स्थिर विश्लेषण". ते काय आहे आणि ते तुमच्या प्रकल्पाशी कसे संवाद साधू शकते ते पाहू या.

खरं तर, जर तुम्ही कोणत्याही आधुनिक भाषेत लिहिलं तर, ते लक्षात न घेता, तुम्ही ते स्थिर विश्लेषकाद्वारे चालवले. वस्तुस्थिती अशी आहे की कोणताही आधुनिक कंपाइलर कोडमधील संभाव्य समस्यांबद्दल चेतावणींचा एक छोटासा संच प्रदान करतो. उदाहरणार्थ, व्हिज्युअल स्टुडिओमध्ये 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;

तुम्ही बघू शकता, शेवटच्या ओळीत एक टायपो आहे. उदाहरणार्थ, PVS-Studio खालील चेतावणी जारी करते:

V537 'y' आयटमच्या वापराच्या अचूकतेचे पुनरावलोकन करण्याचा विचार करा.

जर तुम्हाला या त्रुटीत हात घालायचा असेल तर कंपाइलर एक्सप्लोररमध्ये तयार केलेले उदाहरण वापरून पहा: *रडणे*.

आणि जसे तुम्ही समजता, कोडच्या अशा विभागांकडे लगेच लक्ष देणे नेहमीच शक्य नसते आणि यामुळे, सर्वकाही इतके विचित्रपणे का कार्य करते याचा विचार करून तुम्ही चांगल्या तासासाठी डीबगिंग करत बसू शकता.

तथापि, ही स्पष्टपणे एक चूक आहे. जर विकसकाने सबऑप्टिमल कोड लिहिला कारण तो भाषेची काही सूक्ष्मता विसरला असेल तर? किंवा अगदी कोडमध्ये परवानगी दिली अपरिभाषित वर्तन? दुर्दैवाने, अशी प्रकरणे पूर्णपणे सामान्य आहेत आणि विशेषत: टायपोज, ठराविक चुका किंवा अपरिभाषित वर्तन असलेले कोड डीबग करण्यात मोठा वेळ जातो.

या परिस्थितींसाठीच स्थिर विश्लेषण दिसून आले. हे विकसकासाठी एक सहाय्यक आहे जो कोडमधील विविध समस्या दर्शवेल आणि दस्तऐवजीकरणात असे का लिहिणे आवश्यक नाही, यामुळे काय होऊ शकते आणि त्याचे निराकरण कसे करावे हे स्पष्ट करेल. ते कसे दिसू शकते याचे येथे एक उदाहरण आहे: *रडणे*.

लेखांमध्ये विश्लेषक शोधू शकणार्‍या अधिक मनोरंजक त्रुटी तुम्हाला सापडतील:

आता तुम्ही ही सामग्री वाचली आहे आणि स्थिर विश्लेषणाच्या फायद्यांची खात्री पटली आहे, तुम्हाला कदाचित ते वापरून पहावेसे वाटेल. पण सुरुवात कुठून करायची? तुमच्या सध्याच्या प्रोजेक्टमध्ये नवीन टूल कसे समाकलित करायचे? आणि त्याच्याशी संघाची ओळख कशी करायची? या प्रश्नांची उत्तरे तुम्हाला खाली सापडतील.

लक्षात ठेवा. स्थिर विश्लेषण कोड पुनरावलोकनांसारख्या उपयुक्त गोष्टीला पुनर्स्थित किंवा रद्द करत नाही. हे या प्रक्रियेस पूरक आहे, टायपिंग, अयोग्यता आणि धोकादायक डिझाईन्स आगाऊ लक्षात घेण्यास आणि सुधारण्यास मदत करते. चुकीचा कंस शोधण्याऐवजी अल्गोरिदम आणि कोड स्पष्टतेवर कोड पुनरावलोकनांवर लक्ष केंद्रित करणे अधिक फलदायी आहे किंवा कंटाळवाणे तुलना कार्ये वाचा.

0. साधन जाणून घेणे

हे सर्व चाचणी आवृत्तीसह सुरू होते. खरंच, जर तुम्ही साधन पूर्वी कधीही लाइव्ह पाहिले नसेल तर विकास प्रक्रियेत काहीतरी अंमलात आणण्याचा निर्णय घेणे कठीण आहे. म्हणून, आपण प्रथम गोष्ट डाउनलोड करावी चाचणी आवृत्ती.

या टप्प्यावर तुम्ही काय शिकाल:

विश्लेषकाशी संवाद साधण्याचे कोणते मार्ग आहेत;
विश्लेषक तुमच्या विकासाच्या वातावरणाशी सुसंगत आहे का?
तुमच्या प्रकल्पांमध्ये सध्या कोणत्या समस्या आहेत?

तुम्हाला आवश्यक असलेली प्रत्येक गोष्ट तुम्ही स्थापित केल्यानंतर, तुम्ही सर्वप्रथम संपूर्ण प्रकल्पाचे विश्लेषण केले पाहिजे (विंडोज, linux, MacOS). व्हिज्युअल स्टुडिओमधील पीव्हीएस-स्टुडिओच्या बाबतीत तुम्हाला एक समान चित्र दिसेल (क्लिक करण्यायोग्य):

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

खरंच, 178 चेतावणी अनेक हजारांपेक्षा पाहणे खूप सोपे आहे...

टॅबमध्ये मध्यम и कमी बर्‍याचदा चांगल्या इशारे असतात, परंतु या श्रेणींमध्ये कमी अचूकता (विश्वसनीयता) असलेल्या निदानांचा समावेश होतो. चेतावणी पातळी आणि विंडोज अंतर्गत काम करण्याच्या पर्यायांबद्दल अधिक माहिती येथे आढळू शकते: *रडणे*.

सर्वात मनोरंजक त्रुटींचे यशस्वीरित्या पुनरावलोकन करणे (आणि त्यांना यशस्वीरित्या दुरुस्त करणे) फायदेशीर आहे उर्वरित इशारे दडपून टाका. हे आवश्यक आहे जेणेकरुन नवीन इशारे जुन्यामध्ये गमावू नयेत. याव्यतिरिक्त, स्थिर विश्लेषक प्रोग्रामरसाठी सहाय्यक आहे, बग्सची सूची नाही. 🙂

1. ऑटोमेटिझेशन

परिचित झाल्यानंतर, प्लगइन कॉन्फिगर करण्याची आणि CI मध्ये समाकलित करण्याची वेळ आली आहे. प्रोग्रामर स्टॅटिक विश्लेषक वापरणे सुरू करण्यापूर्वी हे करणे आवश्यक आहे. वस्तुस्थिती अशी आहे की प्रोग्रामर विश्लेषण सक्षम करणे विसरू शकतो किंवा ते करू इच्छित नाही. हे करण्यासाठी, तुम्हाला प्रत्येक गोष्टीची काही अंतिम तपासणी करणे आवश्यक आहे जेणेकरून चाचणी न केलेला कोड सामान्य विकास शाखेत येऊ शकणार नाही.

या टप्प्यावर तुम्ही काय शिकाल:

साधन कोणते ऑटोमेशन पर्याय प्रदान करते;
विश्लेषक तुमच्या असेंब्ली सिस्टमशी सुसंगत आहे का?

परिपूर्ण दस्तऐवज अस्तित्वात नसल्यामुळे, कधीकधी तुम्हाला लिहावे लागते समर्थन. हे सामान्य आहे आणि आम्हाला तुमची मदत करण्यात आनंद होत आहे. 🙂

आता सतत एकात्मता (CI) सेवांकडे वळू. कोणत्याही गंभीर समस्यांशिवाय कोणतेही विश्लेषक त्यांच्यामध्ये लागू केले जाऊ शकतात. हे करण्यासाठी, आपल्याला पाइपलाइनमध्ये एक स्वतंत्र स्टेज तयार करणे आवश्यक आहे, जे सहसा बिल्ड आणि युनिट चाचण्यांनंतर स्थित असते. हे विविध कन्सोल उपयुक्तता वापरून केले जाते. उदाहरणार्थ, PVS-Studio खालील उपयुक्तता प्रदान करते:

PVS-Studio_Cmd.exe (विंडोजवरील उपायांचे विश्लेषण, C#, C++ प्रकल्प)
CLMonitor.exe (संकलन निरीक्षण)
pvs-स्टुडिओ-विश्लेषक (लिनक्स / मॅकओएसवरील C++ प्रकल्पांचे विश्लेषण)
pvs-studio-dotnet (सोल्यूशन अॅनालिसिस, लिनक्स/मॅकओएसवर सी# प्रोजेक्ट)
pvs-studio.jar (जावा प्रकल्पांचे विश्लेषण)
PlogConverter (अहवाल फाइल कनवर्टर)

CI मध्ये विश्लेषण समाकलित करण्यासाठी, तुम्हाला तीन गोष्टी करण्याची आवश्यकता आहे:

विश्लेषक स्थापित करा;
विश्लेषण चालवा;
परिणाम वितरीत करा.

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

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++ (Linux) साठी पर्याय दाखवतो:

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

पहिली कमांड विश्लेषण करेल आणि दुसरी लिफाफेअहवाल मजकूर स्वरूपात रूपांतरित करते, स्क्रीनवर प्रदर्शित करते आणि चेतावणी असल्यास 0 व्यतिरिक्त रिटर्न कोड देते. एरर मेसेज आल्यावर बिल्ड ब्लॉक करण्यासाठी यासारखी यंत्रणा सोयीस्करपणे वापरली जाऊ शकते. तथापि, आपण नेहमी ध्वज काढू शकता -w आणि चेतावणी असलेली असेंब्ली ब्लॉक करू नका.

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

आपण लेखात CI वर विश्लेषण सेट करण्याबद्दल अधिक वाचू शकता "पीव्हीएस-स्टुडिओ आणि सतत एकत्रीकरण"(विंडोज) किंवा"ट्रॅव्हिस सीआयमध्ये पीव्हीएस-स्टुडिओ कसा सेट करायचा" (लिनक्स).

ठीक आहे, तुम्ही बिल्ड सर्व्हरवर विश्लेषक कॉन्फिगर केले आहे. आता, जर कोणी चाचणी न केलेला कोड अपलोड केला असेल, तर पडताळणीचा टप्पा अयशस्वी होईल, आणि तुम्ही समस्या शोधण्यात सक्षम असाल, तथापि, हे पूर्णपणे सोयीचे नाही, कारण शाखांचे विलीनीकरण झाल्यानंतर नव्हे तर प्रकल्प तपासणे अधिक कार्यक्षम आहे. त्याच्या आधी, पुल विनंती टप्प्यावर. ए.

सर्वसाधारणपणे, पुल विनंती विश्लेषण सेट करणे हे CI वर विश्लेषणाच्या नेहमीच्या लाँचपेक्षा फारसे वेगळे नसते. बदललेल्या फायलींची यादी मिळविण्याची आवश्यकता वगळता. हे सहसा 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

आपण पुल विनंत्यांचे विश्लेषण करण्याबद्दल अधिक जाणून घेऊ शकता *येथे*. जरी तुमचा CI लेखात नमूद केलेल्या सेवांच्या सूचीमध्ये नसला तरीही, तुम्हाला या प्रकारच्या विश्लेषणाच्या सिद्धांतासाठी समर्पित सामान्य विभाग उपयुक्त वाटेल.

पुल विनंत्यांचे विश्लेषण सेट करून, तुम्ही इशारे असलेली कमिट अवरोधित करू शकता, ज्यामुळे चाचणी न केलेला कोड ओलांडू शकत नाही अशी सीमा तयार करू शकता.

हे सर्व नक्कीच चांगले आहे, परंतु मला सर्व इशारे एकाच ठिकाणी पाहण्यास सक्षम व्हायचे आहे. केवळ स्थिर विश्लेषकाकडूनच नाही तर युनिट चाचण्यांमधून किंवा डायनॅमिक विश्लेषकाकडूनही. यासाठी विविध सेवा आणि प्लगइन्स आहेत. पीव्हीएस-स्टुडिओ, उदाहरणार्थ, आहे SonarQube मध्ये एकत्रीकरणासाठी प्लगइन.

2. विकसक मशीनवर एकत्रीकरण

आता दैनंदिन विकासाच्या वापरासाठी विश्लेषक स्थापित आणि कॉन्फिगर करण्याची वेळ आली आहे. या क्षणापर्यंत तुम्ही काम करण्याच्या बहुतेक पद्धतींशी आधीच परिचित झाला आहात, म्हणून याला सर्वात सोपा भाग म्हणता येईल.

सर्वात सोपा पर्याय म्हणून, विकसक आवश्यक विश्लेषक स्वतः स्थापित करू शकतात. तथापि, यास बराच वेळ लागेल आणि विकासापासून त्यांचे लक्ष विचलित होईल, म्हणून आपण इंस्टॉलर आणि आवश्यक ध्वज वापरून ही प्रक्रिया स्वयंचलित करू शकता. पीव्हीएस-स्टुडिओसाठी विविध आहेत स्वयंचलित स्थापनेसाठी ध्वज. तथापि, नेहमी पॅकेज व्यवस्थापक असतात, उदाहरणार्थ, Chocolatey (Windows), Homebrew (macOS) किंवा Linux साठी डझनभर पर्याय.

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

3. रोजचा वापर

या टप्प्यावर, दैनंदिन वापरादरम्यान विश्लेषक वेगवान करण्याच्या मार्गांबद्दल काही शब्द बोलण्याची वेळ आली आहे. संपूर्ण प्रकल्पाच्या संपूर्ण विश्लेषणासाठी बराच वेळ लागतो, परंतु आपण संपूर्ण प्रकल्पात एकाच वेळी कोड किती वेळा बदलतो? क्वचितच कोणतेही रिफॅक्टरिंग इतके मोठे आहे की ते संपूर्ण कोड बेसवर त्वरित परिणाम करेल. एका वेळी बदलल्या जाणार्‍या फायलींची संख्या क्वचितच डझनपेक्षा जास्त असते, म्हणून त्यांचे विश्लेषण करणे अर्थपूर्ण आहे. अशी परिस्थिती आहे वाढीव विश्लेषण मोड. फक्त घाबरू नका, हे दुसरे साधन नाही. हा एक विशेष मोड आहे जो तुम्हाला फक्त बदललेल्या फाइल्स आणि त्यांच्या अवलंबित्वांचे विश्लेषण करण्याची परवानगी देतो आणि तुम्ही प्लगइन स्थापित केलेल्या IDE मध्ये काम करत असाल तर बिल्डिंगनंतर हे आपोआप होते.

विश्लेषकाला अलीकडेच बदललेल्या कोडमध्ये समस्या आढळल्यास, तो स्वतंत्रपणे याची तक्रार करेल. उदाहरणार्थ, पीव्हीएस-स्टुडिओ तुम्हाला सूचना वापरून याबद्दल सांगेल:

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

असे लेख रोजच्या वापरासाठी आवश्यक असलेली सर्व माहिती देतात आणि जास्त वेळ घेत नाहीत. 🙂

साधन जाणून घेण्याच्या टप्प्यावरही, आम्ही पहिल्या प्रक्षेपणादरम्यान अनेक चेतावणी दडपल्या. दुर्दैवाने, स्थिर विश्लेषक परिपूर्ण नाहीत, म्हणून ते वेळोवेळी खोटे सकारात्मक देतात. त्यांना दाबणे सहसा सोपे असते; उदाहरणार्थ, व्हिज्युअल स्टुडिओसाठी PVS-Studio प्लगइनमध्ये तुम्हाला फक्त एक बटण क्लिक करावे लागेल:

तथापि, आपण त्यांना दाबण्यापेक्षा बरेच काही करू शकता. उदाहरणार्थ, तुम्ही समर्थनासाठी समस्या नोंदवू शकता. जर चुकीचे सकारात्मक दुरुस्त केले जाऊ शकते, तर भविष्यातील अद्यतनांमध्ये तुम्ही लक्षात घेऊ शकता की प्रत्येक वेळी तुमच्या कोडबेससाठी कमी आणि कमी चुकीचे सकारात्मक आहेत.

एकीकरणानंतर

म्हणून आम्ही विकास प्रक्रियेत स्थिर विश्लेषण एकत्रित करण्याच्या सर्व टप्प्यांतून गेलो आहोत. CI वर अशी साधने सेट करण्याचे महत्त्व असूनही, त्यांना चालवण्याचे सर्वात महत्त्वाचे ठिकाण म्हणजे विकसकाचा संगणक. शेवटी, स्थिर विश्लेषक हा न्यायाधीश नाही जो तुमच्यापासून दूर कुठेतरी म्हणतो की कोड चांगला नाही. याउलट, तो एक असिस्टंट आहे जो तुम्हाला थकवा आला आहे का ते सांगतो आणि तुम्ही काही विसरलात तर तुम्हाला आठवण करून देतो.

खरे आहे, नियमित वापराशिवाय, स्थिर विश्लेषणामुळे विकास लक्षणीयरीत्या सुलभ होण्याची शक्यता नाही. शेवटी, विकसकासाठी त्याचा मुख्य फायदा कोडच्या जटिल आणि विवादास्पद विभागांचा शोध घेण्यामध्ये नाही तर त्यांच्या लवकर शोधण्यात आहे. सहमत आहे की संपादने चाचणीसाठी पाठविल्यानंतर समस्या शोधणे केवळ अप्रियच नाही तर खूप वेळ घेणारे देखील आहे. स्थिर विश्लेषण, नियमितपणे वापरले जाते तेव्हा, प्रत्येक बदल थेट तुमच्या संगणकावर पाहतो आणि कोडवर काम करत असताना संशयास्पद ठिकाणांचा अहवाल देतो.

आणि जर तुम्हाला किंवा तुमच्या सहकाऱ्यांना अजूनही खात्री नसेल की विश्लेषक लागू करणे योग्य आहे की नाही, तर मी सुचवितो की तुम्ही आता लेख वाचायला सुरुवात करा "विकास प्रक्रियेत स्थिर कोड विश्लेषक PVS-Studio सादर करण्याची कारणे". हे विकासकांच्या विशिष्ट चिंतेचे निराकरण करते की स्थिर विश्लेषणास त्यांचा वेळ लागेल इत्यादी.

जर तुम्हाला हा लेख इंग्रजी भाषिक प्रेक्षकांसह सामायिक करायचा असेल तर कृपया भाषांतर दुवा वापरा: Maxim Zvyagintsev. स्थिर विश्लेषण: प्रारंभापासून एकत्रीकरणापर्यंत.

स्त्रोत: www.habr.com

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