हमने सोनारक्यूब को कैसे लागू किया और इसकी महान क्षमता का एहसास किया

हम नेशनल सेटलमेंट डिपॉजिटरी के डीपीओ सिस्टम (अल्मेडा डिपॉजिटरी और क्लियरिंग अकाउंटिंग सिस्टम के अतिरिक्त) को विकसित करने के लिए मौजूदा प्रक्रियाओं में सोनारक्यूब कोड की गुणवत्ता के निरंतर विश्लेषण और माप के लिए एक मंच को लागू करने के अपने अनुभव को साझा करना चाहते हैं।

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

विभाग के बारे में संक्षेप में

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

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

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

कार्यान्वयन की प्रक्रिया

हमारे पास है:

• टीमसिटी में सिस्टम की स्वचालित असेंबली;
• GitLab में एक फीचर शाखा से मास्टर शाखा तक MergeRequest के माध्यम से कोड अपलोड करने की प्रक्रिया स्थापित करें (GitHub फ्लो के अनुसार विकास प्रक्रिया);
• सोनारक्यूब को निर्धारित समय पर डीपीओ प्रणाली के लिए कोड का विश्लेषण करने के लिए कॉन्फ़िगर किया गया है।

हमारा लक्ष्य: AVE की CI/CD प्रक्रियाओं में स्वचालित कोड विश्लेषण लागू करें।

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

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

सोनारक्यूब में क्वालिटीगेट को कॉन्फ़िगर करना

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

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

यह इस तरह काम करता है:

• हम अपने प्रोजेक्ट के लिए केवल PL/SQL कोड का विश्लेषण करते हैं।
• क्वालिटीगेट को सोनारक्यूब में कॉन्फ़िगर किया गया है ताकि कमिट के साथ त्रुटियों की संख्या में वृद्धि न हो।
• पहले रन पर त्रुटियों की संख्या 229 थी। यदि कमिट के दौरान अधिक त्रुटियाँ हैं, तो मर्ज की अनुमति नहीं है।
• इसके अलावा, त्रुटियों के सुधार के अधीन, क्वालिटीगेट को पुन: कॉन्फ़िगर करना संभव होगा।
• आप विश्लेषण के लिए नए आइटम भी जोड़ सकते हैं, उदाहरण के लिए, परीक्षणों के साथ कोड कवरेज आदि।

कार्य योजना:

स्क्रिप्ट की टिप्पणियों में आप देख सकते हैं कि फीचर शाखा में त्रुटियों की संख्या में वृद्धि नहीं हुई है। तो सब कुछ ठीक है.

मर्ज बटन उपलब्ध हो जाता है।

स्क्रिप्ट की टिप्पणियों में आप देख सकते हैं कि फीचर शाखा में त्रुटियों की संख्या अनुमति से अधिक हो गई है। तो सब कुछ ख़राब है.

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

बग से स्वयं निपटना

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

हम क्या करने आये हैं?

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

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

पाठ के लेखक: अतन्या

स्रोत: www.habr.com