2019 में सोनारक्बी और जैकोको के साथ एंड्रॉइड ऐप कोड गुणवत्ता को मापना

नमस्कार, हेब्र!

मेरा नाम एर्टोम डोब्रोविंस्की है, मैं फिनिच में एक एंड्रॉइड डेवलपर के रूप में काम करता हूं।

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

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

Habré में पहले से ही Sonarqube का उपयोग करने के लिए ट्यूटोरियल का बहुत अच्छा अनुवाद है - लेकिन यह 2016 से है, वहां कुछ पुराना है, कोई कोटलिन नहीं है और बस मुझे सभी बिल्डटाइप के अतिरेक के लिए रिपोर्टिंग पीढ़ी मिलती है।

पुस्तकालयों के बारे में थोड़ा, उन लोगों के लिए जो उनसे परिचित नहीं हैं।

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

जैकोको जावा में एक परियोजना के परीक्षण कवरेज की गणना के लिए एक मुफ्त पुस्तकालय है। लेकिन कोटलिन के साथ हम उसके दोस्त बनाएंगे।

सोनारक्बी और जैकोको को कैसे जोड़ा जाए

रूट मॉड्यूल के build.gradle में, निम्न कोड जोड़ें:

apply plugin: 'android.application' apply plugin: 'org.sonarqube' sonarqube { properties { property "sonar.host.url", "%url   sonarqube%" property "sonar.login", "%%" property "sonar.projectName", "% %" property "sonar.projectKey", "%  %" property "sonar.reportPath", "${project.buildDir}/sonarqube/test.exec" property "sonar.projectBaseDir", "$rootDir" property "sonar.sources", "." property "sonar.tests", "" property "sonar.coverage.exclusions", "**/src/androidTest/**, **/src/test/**" property "sonar.coverage.jacoco.xmlReportPaths", fileTree(include: ['*/*/jacoco*.xml'], dir: "$rootDir/app/build/reports/jacoco").collect() } } 

sonar.reportPath - इंगित करें कि सोनार को आगे के विश्लेषण के लिए रिपोर्ट कहां रखनी चाहिए।
sonar.projectBaseDir उस फ़ोल्डर को निर्दिष्ट करें जिसमें विश्लेषण शुरू में शुरू किया जाएगा; हमारे मामले में, यह $ rootDir है - परियोजना का रूट फ़ोल्डर।
sonar.coverage.exclusions कवरेज की गणना के अपवादों को सूचीबद्ध करता है, जहां ** कोई भी फ़ोल्डर है, * एक फ़ाइल नाम या संकल्प है।
sonar.sources स्रोत फ़ोल्डर है।
sonar.tests यहां एक खाली लाइन है, ताकि सोनारक्बी द्वारा परीक्षणों का विश्लेषण भी किया जा सके।
sonar.coverage.exclusions - हम परीक्षण कवरेज के विश्लेषण से परीक्षणों को बाहर करते हैं।
sonar.coverage.jacoco.xmlReportPaths - collect() का उपयोग करके collect() परीक्षण कवरेज की गणना करने के लिए जैकोको रिपोर्ट एकत्र करते हैं।

जैकोको को सक्रिय करने के लिए, एक jacoco.gradle फ़ाइल बनाना और वहां सभी आवश्यक तर्क लिखना बेहतर है। यह अन्य build.gradle अव्यवस्था से बचने में मदद करेगा।

प्रत्येक सबप्रोजेक्ट के बिल्ड.ग्रेड में जैकोको को पंजीकृत नहीं करने के लिए, हम सबप्रोजेक्ट क्लोजर में इसके आरंभीकरण को निर्धारित करते हैं। reportsDirPath लिए reportsDirPath , रूट फ़ोल्डर निर्दिष्ट करें। वहां से, सोनार सभी जैकोको रिपोर्ट लेंगे।

 subprojects { apply plugin: 'jacoco' jacoco { toolVersion = '0.8.5' def reportsDirPath = "${project.rootDir}/app/build/reports/jacoco/${project.name}" reportsDir = file(reportsDirPath) } } 

उसी फ़ाइल में, हम जैकोको को कॉन्फ़िगर करने के लिए एक फ़ंक्शन लिखते हैं।
यह फ़ंक्शन बहुत अच्छा है, इसलिए पहले मैं इसे लाऊंगा - और फिर मैं समझाऊंगा कि इसमें क्या हो रहा है।

 def configureJacoco = { project -> def variantName = project.name project.tasks.create(name: "getJacocoReports", type: JacocoReport) { group = "Reporting" description = "Generate Jacoco coverage reports for the $variantName build." reports { html.enabled = true xml.enabled = true } def excludes = [ '**/R.class', '**/R$*.class', '**/BuildConfig.*', '**/Manifest*.*', '**/AndroidManifest.xml', '**/*Test*.*', 'android/**/*.*', 'androidx/**/*.*', '**/*Fragment.*', '**/*Activity.*', '**/*Api.*', '**/injection/**/*.class', '**/ui/**/*.class', %  build- % ] def javaClasses = fileTree(dir: "${project.buildDir}/intermediates/javac", excludes: excludes) def kotlinClasses = fileTree(dir: "${project.buildDir}/tmp/kotlin-classes", excludes: excludes) classDirectories = files([javaClasses, kotlinClasses]) sourceDirectories = files([ "${project.projectDir}/src/main/java", "${project.projectDir}/src/main/kotlin", ]) executionData = files(fileTree(include: ['*.exec'], dir: "${project.buildDir}/jacoco").files) } } 

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

classDirectories - विश्लेषण के लिए कोड की तलाश करने के लिए एक संकेत। हम यहां जावा और कोटलिन दोनों फाइलों को शामिल करते हैं।
sourceDirectories - निर्दिष्ट करें जहां जैकोको स्रोत फ़ाइलों के लिए देखें।
executionData - जैसा कि सोनार के मामले में, कवरेज की गणना करने के लिए रिपोर्ट कहाँ उत्पन्न होगी, इसका एक संकेत।

इसके अलावा jacoco.gradle में आपको उपरोक्त फ़ंक्शन का उपयोग करके सभी मॉड्यूल के लिए इसके कॉन्फ़िगरेशन को जोड़ने की आवश्यकता है:

 allprojects { project -> configureJacoco(project) project.tasks.withType(Test) { enabled = true jacoco.includeNoLocationClasses = true } } 

और उत्पन्न रिपोर्ट एकत्र करने के लिए एक कार्य:

 task getJacocoReports() { group = "Reporting" subprojects.forEach { subproject -> subproject.tasks.withType(JacocoReport).forEach { task -> dependsOn task } } } 

सोनारक्बी को कमांड लाइन के माध्यम से चलाना

यह सरल रूप से ./gradlew % % && ./gradlew jacocoAggregateReports && ./gradlew sonarqube है:। ./gradlew % % && ./gradlew jacocoAggregateReports && ./gradlew sonarqube । कमांड को && माध्यम से चलाया जाता है, क्योंकि पिछले चरण के सफल नहीं होने पर निष्पादन बाधित होना चाहिए।

ऊपर दिए गए आदेश पर क्या होता है:

1. सबसे पहले, परीक्षण चलाएं (उसी समय हम बिल्ड फ़ोल्डर में सभी आवश्यक फाइलें उत्पन्न करते हैं)।
2. एक जैकोको रिपोर्ट उत्पन्न करें।
3. सोनारक्बी लॉन्च करें।

अगला आपको साइट पर जाने की जरूरत है, परियोजना में असफल और आपदा के पैमाने को देखें। प्रोजेक्ट पृष्ठ अंतिम जाँच का परिणाम दिखाता है।

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

यही सब है, दोस्तों!

पाठकों से सवाल - आप कोड का विश्लेषण करने और परीक्षण कवरेज को मापने के लिए क्या उपयोग करते हैं? क्या आपको बिंदु बिल्कुल दिखाई देता है?