અમે SonarQube ને કેવી રીતે અમલમાં મૂક્યું અને તેની મહાન ક્ષમતાનો અહેસાસ કર્યો

અમે નેશનલ સેટલમેન્ટ ડિપોઝિટરીની ડીપીઓ સિસ્ટમ (અલમેડા ડિપોઝિટરી અને ક્લિયરિંગ એકાઉન્ટિંગ સિસ્ટમનો ઉમેરો) વિકસાવવા માટેની હાલની પ્રક્રિયાઓમાં સોનારક્યુબ કોડની ગુણવત્તાના સતત વિશ્લેષણ અને માપન માટેના પ્લેટફોર્મના અમલીકરણના અમારા અનુભવને શેર કરવા માંગીએ છીએ.

નેશનલ સેટલમેન્ટ ડિપોઝિટરી (મોસ્કો એક્સચેન્જ ગ્રૂપ ઓફ કંપનીઝ) એ મુખ્ય નાણાકીય માળખાકીય કંપનીઓમાંની એક છે જે 50 ટ્રિલિયન રુબેલ્સથી વધુ મૂલ્યની રશિયન અને વિદેશી ઇશ્યુઅર્સની સિક્યોરિટીઝનો સંગ્રહ અને રેકોર્ડ કરે છે. સિસ્ટમ દ્વારા કરવામાં આવતી કામગીરીની વધતી જતી માત્રા, તેમજ કાર્યક્ષમતામાં સતત વધારો, સિસ્ટમના સ્રોત કોડની ઉચ્ચ ગુણવત્તા જાળવવાની જરૂર છે. આ ધ્યેય હાંસલ કરવા માટેનું એક સાધન સોનારક્યુબ સ્ટેટિક વિશ્લેષક છે. આ લેખમાં, અમે અમારા વિભાગની હાલની વિકાસ પ્રક્રિયાઓમાં સોનારક્યુબ સ્ટેટિક વિશ્લેષકને એકીકૃત રીતે અમલમાં મૂકવાના સફળ અનુભવનું વર્ણન કરીએ છીએ.

વિભાગ વિશે સંક્ષિપ્તમાં

અમારી યોગ્યતામાં નીચેના મોડ્યુલોનો સમાવેશ થાય છે: NSD ક્લાયન્ટને ચૂકવણી, ઇલેક્ટ્રોનિક દસ્તાવેજ વ્યવસ્થાપન (EDF), ટ્રેડ રિપોઝીટરી સંદેશાઓની પ્રક્રિયા (ઑફ-એક્સચેન્જ ટ્રાન્ઝેક્શનની નોંધણી), ક્લાયન્ટ અને NSD વચ્ચે ઇલેક્ટ્રોનિક ક્રિયાપ્રતિક્રિયા ચેનલો અને ઘણું બધું. સામાન્ય રીતે, કામગીરીની તકનીકી બાજુ પર કામનો મોટો સ્તર. અમે અરજીઓના આધારે કામ કરીએ છીએ. ટેલર્સની અરજીઓ વિશ્લેષકો દ્વારા પ્રક્રિયા કરવામાં આવે છે: તેઓ ગ્રાહકની જરૂરિયાતો એકત્રિત કરે છે અને પ્રોગ્રામમાં તે કેવી રીતે ફિટ થવો જોઈએ તે અંગેનું તેમનું વિઝન અમને રજૂ કરે છે. આગળ, પ્રમાણભૂત યોજના: કોડ ડેવલપમેન્ટ - ટેસ્ટિંગ - ટ્રાયલ ઓપરેશન - સીધા ગ્રાહકને ઉત્પાદક સર્કિટમાં કોડની ડિલિવરી.

શા માટે SonarQube?

કોડ ક્વોલિટી કંટ્રોલ માટે પ્લેટફોર્મ લાગુ કરવામાં અમારા વિભાગનો આ પહેલો અનુભવ છે - અગાઉ અમે તે મેન્યુઅલી કર્યું હતું, માત્ર કોડ રિવ્યૂ. પરંતુ કામના વધતા જથ્થાને આ પ્રક્રિયાના ઓટોમેશનની જરૂર છે. આ ઉપરાંત, ટીમમાં એવા બિનઅનુભવી કર્મચારીઓ પણ છે જેઓ આંતરિક વિકાસના નિયમોથી સંપૂર્ણપણે પરિચિત નથી અને વધુ ભૂલો કરવાનું વલણ ધરાવે છે. કોડની ગુણવત્તાને નિયંત્રિત કરવા માટે, સ્ટેટિક વિશ્લેષકનો અમલ કરવાનો નિર્ણય લેવામાં આવ્યો હતો. SonarQube નો ઉપયોગ પહેલાથી જ કેટલીક NSD સિસ્ટમમાં કરવામાં આવ્યો હોવાથી, તેને પસંદ કરવામાં લાંબો સમય લાગ્યો નથી. અગાઉ, અન્ય વિભાગોના સહકાર્યકરો તેનો ઉપયોગ અલમેડા સિસ્ટમ (એનએસડીની પોતાની ડિપોઝિટરી અને ક્લિયરિંગ એકાઉન્ટિંગ સિસ્ટમ), CFT (એકાઉન્ટિંગ, બેલેન્સ, ફરજિયાત અને આંતરિક રિપોર્ટિંગની તૈયારી માટેની માહિતી સિસ્ટમ) માં માઇક્રોસર્વિસિસના કોડનું વિશ્લેષણ કરવા માટે કરતા હતા. સિસ્ટમો પ્રયોગો માટે, અમે SonarQube ના મફત સંસ્કરણથી પ્રારંભ કરવાનું નક્કી કર્યું છે. તો ચાલો આપણા કેસ તરફ આગળ વધીએ.

અમલીકરણ પ્રક્રિયા

અમારી પાસે:

• ટીમસિટીમાં સિસ્ટમની સ્વચાલિત એસેમ્બલી;
• GitLab (GitHub ફ્લો અનુસાર વિકાસ પ્રક્રિયા) માં ફીચર શાખામાંથી માસ્ટર બ્રાન્ચમાં MergeRequest મારફતે કોડ અપલોડ કરવાની પ્રક્રિયા સેટ કરો;
• SonarQube શેડ્યૂલ પર DPO સિસ્ટમ માટે કોડનું વિશ્લેષણ કરવા માટે ગોઠવેલું છે.

આપણો લક્ષ: AVE ની CI/CD પ્રક્રિયાઓમાં સ્વચાલિત કોડ વિશ્લેષણનો અમલ કરો.

કસ્ટમાઇઝ કરવાની જરૂર છે: મુખ્ય શાખામાં દરેક મર્જરિક્વેસ્ટ સાથે સ્ટેટિક વિશ્લેષક દ્વારા કોડને આપમેળે તપાસવાની પ્રક્રિયા.

તે. લક્ષ્ય ચિત્ર નીચે મુજબ છે: વિકાસકર્તા ફીચર શાખામાં ફેરફારો અપલોડ કરે તે જલદી, કોડમાં નવી ભૂલો માટે સ્વચાલિત તપાસ શરૂ થાય છે. જો ત્યાં કોઈ ભૂલો ન હોય, તો ફેરફારો સ્વીકારવાની મંજૂરી છે, અન્યથા ભૂલો સુધારવી પડશે. પહેલેથી જ પ્રારંભિક તબક્કે, અમે કોડમાં ચોક્કસ સંખ્યામાં ભૂલોને ઓળખવામાં સક્ષમ હતા. સિસ્ટમમાં ખૂબ જ લવચીક સેટિંગ્સ છે: તે એવી રીતે ગોઠવી શકાય છે કે તે વિકાસકર્તાઓના ચોક્કસ કાર્યો માટે, દરેક સિસ્ટમ અને પ્રોગ્રામિંગ શૈલી માટે કાર્ય કરે છે.

સોનારક્યુબમાં ક્વોલિટીગેટને ગોઠવી રહ્યું છે

ક્વોલિટીગેટ વિશ્લેષણ એ એવી વસ્તુ છે જે આપણે ઇન્ટરનેટના આંતરડામાં વાંચીએ છીએ. શરૂઆતમાં, અમે એક અલગ અભિગમનો ઉપયોગ કર્યો, વધુ જટિલ અને કોઈક રીતે તદ્દન યોગ્ય નથી. સૌપ્રથમ, અમે SonarQube દ્વારા બે વાર સ્કેન ચલાવ્યું: અમે ફીચર બ્રાન્ચ અને તે બ્રાન્ચને સ્કેન કરી જ્યાં અમે ફીચર બ્રાન્ચને મર્જ કરવા જઈ રહ્યા હતા, અને પછી અમે ભૂલોની સંખ્યાની સરખામણી કરી. આ પદ્ધતિ સ્થિર ન હતી અને હંમેશા યોગ્ય પરિણામ આપતી ન હતી. અને પછી અમે શીખ્યા કે સોનારક્યુબને બે વાર ચલાવવાને બદલે, તમે કરેલી ભૂલોની સંખ્યા (ક્વોલિટીગેટ) પર મર્યાદા સેટ કરી શકો છો અને તમે અપલોડ કરો છો અને સરખામણી કરો છો તે જ શાખાનું વિશ્લેષણ કરી શકો છો.

હમણાં માટે, અમે હજી પણ આદિમ કોડ ચેકનો ઉપયોગ કરીએ છીએ. એ નોંધવું જોઈએ કે SonarQube ડેલ્ફી સહિત કેટલીક પ્રોગ્રામિંગ ભાષાઓ સાથે સુસંગત નથી. આ ક્ષણે, અમારી સિસ્ટમ માટે, અમે ફક્ત PLSql કોડનું વિશ્લેષણ કરીએ છીએ.

તે આની જેમ કાર્ય કરે છે:

• અમે અમારા પ્રોજેક્ટ માટે માત્ર PL/SQL કોડનું વિશ્લેષણ કરીએ છીએ.
• ક્વોલિટીગેટ સોનારક્યુબમાં ગોઠવેલ છે જેથી કમિટ સાથે ભૂલોની સંખ્યામાં વધારો ન થાય.
• પ્રથમ રન પર ભૂલોની સંખ્યા 229 હતી. જો કમિટ દરમિયાન વધુ ભૂલો હોય, તો મર્જ કરવાની મંજૂરી નથી.
• આગળ, ભૂલોના સુધારણાને આધિન, ક્વોલિટીગેટને ફરીથી ગોઠવવાનું શક્ય બનશે.
• તમે વિશ્લેષણ માટે નવી આઇટમ પણ ઉમેરી શકો છો, ઉદાહરણ તરીકે, પરીક્ષણો સાથે કોડ કવરેજ વગેરે.

કાર્ય યોજના:

સ્ક્રિપ્ટની ટિપ્પણીઓમાં, તમે જોઈ શકો છો કે સુવિધા શાખામાં ભૂલોની સંખ્યામાં વધારો થયો નથી. તેથી બધું બરાબર છે.

મર્જ બટન ઉપલબ્ધ બને છે.

સ્ક્રિપ્ટની ટિપ્પણીઓમાં, તમે જોઈ શકો છો કે સુવિધા શાખામાં ભૂલોની સંખ્યા મંજૂરી કરતાં વધુ થઈ ગઈ છે. તેથી બધું ખરાબ છે.

મર્જ બટન લાલ છે. આ ક્ષણે, ભૂલભરેલા કોડમાં ફેરફારો અપલોડ કરવા પર કોઈ પ્રતિબંધ નથી, પરંતુ આ જવાબદાર વિકાસકર્તાના વિવેકબુદ્ધિથી કરવામાં આવે છે. ભવિષ્યમાં, તમે આવા કમિટ્સને મુખ્ય શાખામાં થતા અટકાવી શકો છો.

ભૂલો સાથે સ્વ-વ્યવહાર

આગળ, તમારે સિસ્ટમ દ્વારા શોધાયેલ બધી ભૂલો તપાસવાની જરૂર છે, કારણ કે SonarQube તેના કડક ધોરણો અનુસાર વિશ્લેષણ કરે છે. તે જેને ભૂલ માને છે તે વાસ્તવમાં આપણા કોડમાં એક ન હોઈ શકે. તેથી, તમારે તપાસવાની અને નોંધ લેવાની જરૂર છે કે શું આ ખરેખર ભૂલ છે, અથવા અમારી શરતોમાં ફેરફાર કરવાની જરૂર નથી. આમ, અમે ભૂલોની સંખ્યા ઘટાડીએ છીએ. સમય જતાં, સિસ્ટમ આ ઘોંઘાટને સમજવાનું શીખશે.

આપણે શું કરવા આવ્યા છીએ

અમારો ધ્યેય એ સમજવાનો હતો કે અમારા કિસ્સામાં કોડ વેરિફિકેશનને ઓટોમેશનમાં ટ્રાન્સફર કરવું યોગ્ય છે કે કેમ. અને પરિણામ અપેક્ષાઓ પ્રમાણે રહ્યું. SonarQube અમને જરૂરી ભાષાઓ સાથે કામ કરવાની મંજૂરી આપે છે, એકદમ સક્ષમ વિશ્લેષણ કરે છે અને વિકાસકર્તા ટિપ્સ પાસેથી શીખવાની ક્ષમતા ધરાવે છે. સામાન્ય રીતે, અમે સોનારક્યુબ સાથેના અમારા પ્રથમ અનુભવથી ખુશ છીએ અને આ દિશામાં વધુ વિકાસ કરવાની યોજના બનાવીએ છીએ. અમે અપેક્ષા રાખીએ છીએ કે ભવિષ્યમાં અમે કોડ રિવ્યૂ પર વધુ સમય અને મહેનત બચાવી શકીશું અને માનવ પરિબળને દૂર કરીને તેને વધુ સારું બનાવી શકીશું. કદાચ આ પ્રક્રિયામાં આપણે પ્લેટફોર્મની ખામીઓ શોધી શકીશું, અથવા તેનાથી વિપરીત, અમે ફરી એકવાર ખાતરી કરીશું કે આ મહાન સંભવિતતા સાથે એક સરસ વસ્તુ છે.

આ વિહંગાવલોકન લેખમાં, અમે સોનારક્યુબ સ્ટેટિક વિશ્લેષક સાથેની અમારી ઓળખાણ વિશે વાત કરી. જો તમને પ્રશ્નો હોય, તો કૃપા કરીને ટિપ્પણીઓમાં લખો. જો તમને આ વિષયમાં રુચિ છે, તો નવા પ્રકાશનમાં અમે વધુ વિગતવાર વર્ણન કરીશું કે કેવી રીતે બધું યોગ્ય રીતે સેટ કરવું અને આવી તપાસ કરવા માટે કોડ લખવો.

ટેક્સ્ટ લેખક: અતન્યા

સોર્સ: www.habr.com