आम्ही सोनारक्यूब कसे कार्यान्वित केले आणि त्याची मोठी क्षमता ओळखली

नॅशनल सेटलमेंट डिपॉझिटरीच्या DPO सिस्टीम (अल्मेडा डिपॉझिटरी आणि क्लिअरिंग अकाउंटिंग सिस्टीमला जोडलेले) विकसित करण्याच्या विद्यमान प्रक्रियेमध्ये सोनारक्यूब कोडच्या गुणवत्तेचे सतत विश्लेषण आणि मोजमाप करण्यासाठी व्यासपीठ लागू करण्याचा आमचा अनुभव शेअर करू इच्छितो.

नॅशनल सेटलमेंट डिपॉझिटरी (मॉस्को एक्सचेंज ग्रुप ऑफ कंपनीज) ही प्रमुख आर्थिक पायाभूत सुविधा कंपन्यांपैकी एक आहे जी 50 ट्रिलियन रूबल पेक्षा जास्त किमतीच्या रशियन आणि परदेशी जारीकर्त्यांच्या सिक्युरिटीज संग्रहित आणि रेकॉर्ड करते. सिस्टमद्वारे चालवल्या जाणार्‍या ऑपरेशन्सचे वाढते प्रमाण, तसेच कार्यक्षमतेत सतत वाढ, सिस्टमच्या स्त्रोत कोडची उच्च गुणवत्ता राखणे आवश्यक आहे. हे ध्येय साध्य करण्यासाठी साधनांपैकी एक म्हणजे सोनारक्यूब स्टॅटिक अॅनालायझर. या लेखात, आम्ही आमच्या विभागाच्या विद्यमान विकास प्रक्रियांमध्ये सोनारक्यूब स्थिर विश्लेषक अखंडपणे कार्यान्वित करण्याच्या यशस्वी अनुभवाचे वर्णन करतो.

विभागाबद्दल थोडक्यात

आमच्या सक्षमतेमध्ये खालील मॉड्यूल समाविष्ट आहेत: NSD क्लायंटना पेमेंट, इलेक्ट्रॉनिक दस्तऐवज व्यवस्थापन (EDF), ट्रेड रिपॉझिटरी मेसेजची प्रक्रिया (ऑफ-एक्सचेंज व्यवहारांची नोंदणी), क्लायंट आणि NSD यांच्यातील इलेक्ट्रॉनिक संवाद चॅनेल आणि बरेच काही. सर्वसाधारणपणे, ऑपरेशन्सच्या तांत्रिक बाजूवर कामाचा एक मोठा थर. आम्ही अर्जांच्या आधारे काम करतो. टेलरच्या अर्जांवर विश्लेषकांद्वारे प्रक्रिया केली जाते: ते ग्राहकांच्या गरजा गोळा करतात आणि ते प्रोग्राममध्ये कसे बसावेत याची त्यांची दृष्टी आम्हाला सादर करतात. पुढे, मानक योजना: कोड विकास - चाचणी - चाचणी ऑपरेशन - थेट ग्राहकांना उत्पादक सर्किटमध्ये कोडचे वितरण.

सोनारक्यूब का?

कोड गुणवत्ता नियंत्रणासाठी प्लॅटफॉर्म लागू करण्याचा आमच्या विभागाचा हा पहिला अनुभव आहे - यापूर्वी आम्ही ते मॅन्युअली केले होते, फक्त कोड पुनरावलोकन. परंतु कामाच्या वाढत्या प्रमाणात या प्रक्रियेचे ऑटोमेशन आवश्यक आहे. याशिवाय, संघात अननुभवी कर्मचारी देखील आहेत जे अंतर्गत विकास नियमांशी पूर्णपणे परिचित नाहीत आणि अधिक चुका करतात. कोडची गुणवत्ता नियंत्रित करण्यासाठी, स्थिर विश्लेषक लागू करण्याचा निर्णय घेण्यात आला. सोनारक्यूब आधीच काही एनएसडी प्रणालींमध्ये वापरले गेले असल्याने, ते निवडण्यास जास्त वेळ लागला नाही. पूर्वी, इतर विभागातील सहकाऱ्यांनी अल्मेडा प्रणाली (NSD ची स्वतःची डिपॉझिटरी आणि क्लिअरिंग अकाउंटिंग सिस्टम), CFT (लेखा, शिल्लक, अनिवार्य आणि अंतर्गत अहवाल तयार करण्यासाठी माहिती प्रणाली) मध्ये मायक्रो सर्व्हिसेसच्या कोडचे विश्लेषण करण्यासाठी याचा वापर केला. प्रणाली प्रयोगासाठी, आम्ही सोनारक्यूबच्या विनामूल्य आवृत्तीसह प्रारंभ करण्याचा निर्णय घेतला. तर चला आपल्या केसकडे जाऊया.

अंमलबजावणी प्रक्रिया

आमच्याकडे आहे:

• टीमसिटीमध्ये सिस्टमची स्वयंचलित असेंब्ली;
• MergeRequest द्वारे GitLab (GitHub Flow नुसार विकास प्रक्रिया) मधील वैशिष्ट्य शाखेतून मास्टर शाखेत कोड अपलोड करण्याची प्रक्रिया सेट करा;
• वेळापत्रकानुसार DPO प्रणालीसाठी कोडचे विश्लेषण करण्यासाठी SonarQube कॉन्फिगर केले.

आमचे ध्येय: AVE च्या CI/CD प्रक्रियेमध्ये स्वयंचलित कोड विश्लेषण लागू करा.

सानुकूलित करणे आवश्यक आहे: मुख्य शाखेला प्रत्येक MergeRequest सह स्थिर विश्लेषकाद्वारे कोड आपोआप तपासण्याची प्रक्रिया.

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

सोनारक्यूबमध्ये क्वालिटीगेट कॉन्फिगर करत आहे

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

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

हे असे कार्य करते:

• आम्ही आमच्या प्रकल्पासाठी फक्त PL/SQL कोडचे विश्लेषण करतो.
• क्वालिटीगेट सोनारक्यूबमध्ये कॉन्फिगर केले आहे जेणेकरून कमिटसह त्रुटींची संख्या वाढू नये.
• पहिल्या रनवर त्रुटींची संख्या 229 होती. कमिट दरम्यान अधिक त्रुटी असल्यास, विलीनीकरणास परवानगी नाही.
• पुढे, त्रुटी सुधारण्याच्या अधीन, क्वालिटीगेट पुन्हा कॉन्फिगर करणे शक्य होईल.
• तुम्ही विश्लेषणासाठी नवीन आयटम देखील जोडू शकता, उदाहरणार्थ, चाचण्यांसह कोड कव्हरेज इ.

कामाची योजना:

स्क्रिप्टच्या टिप्पण्यांमध्ये, आपण पाहू शकता की वैशिष्ट्य शाखेतील त्रुटींची संख्या वाढलेली नाही. त्यामुळे सर्व काही ठीक आहे.

मर्ज बटण उपलब्ध होईल.

स्क्रिप्टच्या टिप्पण्यांमध्ये, आपण पाहू शकता की वैशिष्ट्य शाखेतील त्रुटींची संख्या परवानगीपेक्षा जास्त झाली आहे. त्यामुळे सर्व काही वाईट आहे.

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

बग्ससह स्वत: ची वागणूक

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

आम्ही काय आलो आहोत

आमच्या बाबतीत कोड पडताळणी ऑटोमेशनमध्ये हस्तांतरित करणे योग्य आहे की नाही हे समजून घेणे हे आमचे ध्येय होते. आणि निकाल अपेक्षेप्रमाणे जगला. SonarQube आम्हाला आवश्यक असलेल्या भाषांसह कार्य करण्यास अनुमती देते, बर्‍यापैकी सक्षम विश्लेषण करते आणि विकसक टिपांकडून शिकण्याची क्षमता आहे. सर्वसाधारणपणे, आम्ही सोनारक्यूबच्या आमच्या पहिल्या अनुभवाने खूश आहोत आणि आम्ही या दिशेने आणखी विकसित होण्याची योजना आखत आहोत. आम्ही अपेक्षा करतो की भविष्यात आम्ही कोड पुनरावलोकनावर अधिक वेळ आणि श्रम वाचवू शकू आणि मानवी घटक काढून टाकून ते अधिक चांगले बनवू. कदाचित या प्रक्रियेत आम्हाला प्लॅटफॉर्मच्या उणिवा सापडतील किंवा त्याउलट, आम्ही पुन्हा एकदा खात्री करून घेऊ की ही एक उत्तम क्षमता आहे.

या विहंगावलोकन लेखात, आम्ही सोनारक्यूब स्टॅटिक अॅनालायझरशी असलेल्या आमच्या ओळखीबद्दल बोललो. आपल्याकडे प्रश्न असल्यास, कृपया टिप्पण्यांमध्ये लिहा. आपल्याला या विषयामध्ये स्वारस्य असल्यास, नवीन प्रकाशनात आम्ही सर्वकाही योग्यरित्या कसे सेट करावे आणि अशी तपासणी करण्यासाठी कोड कसा लिहावा याबद्दल अधिक तपशीलवार वर्णन करू.

मजकूर लेखक: अतन्या

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