जेनकींस पर IntelliJ IDEA निरीक्षण चल रहा है

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

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

चरण 1. कंटेनर में विश्लेषण चलाएं और एक रिपोर्ट प्राप्त करें

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

आईडीईए इंस्टॉलेशन डायरेक्टरी से bin/inspect.sh का उपयोग कर निरीक्षण शुरू किया जाता है। मापदंडों के रूप में आवश्यक हैं:

• परियोजना के लिए पूर्ण पथ (सापेक्ष समर्थित नहीं)
• निरीक्षण सेटिंग्स के साथ .xml फ़ाइल में पथ (आमतौर पर .idea / निरीक्षण में परियोजना के अंदर स्थित / Project_Default.xml),
• फ़ोल्डर में पूर्ण पथ जिसमें विश्लेषण परिणामों पर रिपोर्ट के साथ .xml फाइलें जोड़ी जाएंगी।

इसके अलावा, यह अपेक्षित है कि

• आईडीई जावा एसडीके के लिए पथ को कॉन्फ़िगर करेगा, अन्यथा विश्लेषण काम नहीं करेगा। ये सेटिंग्स IDEA वैश्विक कॉन्फ़िगरेशन फ़ोल्डर में jdk.table.xml कॉन्फ़िगरेशन फ़ाइल में निहित हैं। वैश्विक IDEA कॉन्फ़िगरेशन स्वयं उपयोगकर्ता की होम निर्देशिका में डिफ़ॉल्ट रूप से निहित है, लेकिन इस स्थान को स्पष्ट रूप से idea.properties फ़ाइल में निर्दिष्ट किया जा सकता है ।
• विश्लेषण की गई परियोजना एक मान्य IDEA परियोजना होनी चाहिए, जिसके लिए संस्करण नियंत्रण को कुछ फ़ाइलों को कम करना होगा, जिन्हें आमतौर पर अनदेखा किया जाता है, अर्थात्:
  
  • .idea/inspectionProfiles/Project_Default.xml - विश्लेषक सेटिंग्स, वे कंटेनर में निरीक्षण शुरू करते समय स्पष्ट रूप से उपयोग किए जाएंगे,
  • .idea/modules.xml - अन्यथा हमें त्रुटि मिलती है 'इस परियोजना में कोई मॉड्यूल नहीं है',
  • .idea/misc.xml - अन्यथा हमें त्रुटि मिलती है 'JDK को इस परियोजना के लिए ठीक से कॉन्फ़िगर नहीं किया गया है',
  • *.iml- - अन्यथा हमें मॉड्यूल में एक गैर-कॉन्फ़िगर JDK के बारे में एक त्रुटि मिलती है।

हालाँकि ये फाइलें आमतौर पर .gitignore में शामिल होती हैं, लेकिन इनमें किसी विशेष डेवलपर के वातावरण के लिए विशिष्ट कोई जानकारी नहीं होती है - इसके विपरीत, उदाहरण के लिए, workspace.xml । workspace.xml फ़ाइल, जहां ऐसी जानकारी निहित होती है, और इसलिए इसे करना आवश्यक नहीं है।

यह विश्लेषण परियोजनाओं को "सेट" करने के लिए तैयार एक रूप में एक कंटेनर में IDEA सामुदायिक संस्करण के साथ मिलकर JDK को पैक करने का एक तरीका बताता है। हम उपयुक्त आधार कंटेनर का चयन करेंगे, और यहां हमें मिलने वाला डॉकफेराइल मिलेगा:

 FROM openkbs/ubuntu-bionic-jdk-mvn-py3 ARG INTELLIJ_VERSION="ideaIC-2019.1.1" ARG INTELLIJ_IDE_TAR=${INTELLIJ_VERSION}.tar.gz ENV IDEA_PROJECT_DIR="/var/project" WORKDIR /opt COPY jdk.table.xml /etc/idea/config/options/ RUN wget https://download-cf.jetbrains.com/idea/${INTELLIJ_IDE_TAR} && \ tar xzf ${INTELLIJ_IDE_TAR} && \ tar tzf ${INTELLIJ_IDE_TAR} | head -1 | sed -e 's/\/.*//' | xargs -I{} ln -s {} idea && \ rm ${INTELLIJ_IDE_TAR} && \ echo idea.config.path=/etc/idea/config >> idea/bin/idea.properties && \ chmod -R 777 /etc/idea CMD idea/bin/inspect.sh ${IDEA_PROJECT_DIR} ${IDEA_PROJECT_DIR}/.idea/inspectionProfiles/Project_Default.xml ${IDEA_PROJECT_DIR}/target/idea_inspections -v2 

idea.config.path विकल्प का उपयोग करते idea.config.path हमने IDEA को /etc/idea फ़ोल्डर में इसके वैश्विक कॉन्फ़िगरेशन को देखने के लिए मजबूर किया, क्योंकि CI की शर्तों के तहत उपयोगकर्ता का होम फ़ोल्डर एक अपरिभाषित और अक्सर पूरी तरह से अनुपस्थित चीज है।

इस तरह से कंटेनर में कॉपी की गई jdk.table.xml फाइल दिखती है, जिसमें कंटेनर के अंदर स्थापित OpenJDK के रास्तों को लिखा गया है (IDEA सेटिंग्स के साथ आपकी अपनी निर्देशिका से एक समान फ़ाइल ली जा सकती है):

 <application> <component name="ProjectJdkTable"> <jdk version="2"> <name value="1.8" /> <type value="JavaSDK" /> <version value="1.8" /> <homePath value="/usr/java" /> <roots> <annotationsPath> <root type="composite"> <root url="jar://$APPLICATION_HOME_DIR$/lib/jdkAnnotations.jar!/" type="simple" /> </root> </annotationsPath> <classPath> <root type="composite"> <root url="jar:///usr/java/jre/lib/charsets.jar!/" type="simple" /> <root url="jar:///usr/java/jre/lib/deploy.jar!/" type="simple" /> <root url="jar:///usr/java/jre/lib/ext/access-bridge-64.jar!/" type="simple" /> <root url="jar:///usr/java/jre/lib/ext/cldrdata.jar!/" type="simple" /> <root url="jar:///usr/java/jre/lib/ext/dnsns.jar!/" type="simple" /> <root url="jar:///usr/java/jre/lib/ext/jaccess.jar!/" type="simple" /> <root url="jar:///usr/java/jre/lib/ext/jfxrt.jar!/" type="simple" /> <root url="jar:///usr/java/jre/lib/ext/localedata.jar!/" type="simple" /> <root url="jar:///usr/java/jre/lib/ext/nashorn.jar!/" type="simple" /> <root url="jar:///usr/java/jre/lib/ext/sunec.jar!/" type="simple" /> <root url="jar:///usr/java/jre/lib/ext/sunjce_provider.jar!/" type="simple" /> <root url="jar:///usr/java/jre/lib/ext/sunmscapi.jar!/" type="simple" /> <root url="jar:///usr/java/jre/lib/ext/sunpkcs11.jar!/" type="simple" /> <root url="jar:///usr/java/jre/lib/ext/zipfs.jar!/" type="simple" /> <root url="jar:///usr/java/jre/lib/javaws.jar!/" type="simple" /> <root url="jar:///usr/java/jre/lib/jce.jar!/" type="simple" /> <root url="jar:///usr/java/jre/lib/jfr.jar!/" type="simple" /> <root url="jar:///usr/java/jre/lib/jfxswt.jar!/" type="simple" /> <root url="jar:///usr/java/jre/lib/jsse.jar!/" type="simple" /> <root url="jar:///usr/java/jre/lib/management-agent.jar!/" type="simple" /> <root url="jar:///usr/java/jre/lib/plugin.jar!/" type="simple" /> <root url="jar:///usr/java/jre/lib/resources.jar!/" type="simple" /> <root url="jar:///usr/java/jre/lib/rt.jar!/" type="simple" /> </root> </classPath> </roots> <additional /> </jdk> </component> </application> 

तैयार छवि डोकर हब पर उपलब्ध है ।

आगे बढ़ने से पहले, कंटेनर में IDEA विश्लेषक की शुरुआत की जाँच करें:

 docker run --rm -v <///>:/var/project inponomarev/intellij-idea-analyzer 

विश्लेषण को सफलतापूर्वक काम करना चाहिए, और विश्लेषक रिपोर्ट वाली कई .xml फाइलें सबफ़ोल्डर लक्ष्य / idea_inspections में दिखाई देनी चाहिए।

अब इसमें कोई संदेह नहीं है कि आईडीई को किसी भी सीआई वातावरण में ऑफ़लाइन चलाया जा सकता है, और हम दूसरे चरण पर जाते हैं।

चरण 2. रिपोर्ट प्रदर्शित करें और उसका विश्लेषण करें

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

यह हमें जेनकिंस वार्निंग एनजी प्लगिन में मदद करेगा, जो जनवरी 2019 में जारी किया गया था। इसकी उपस्थिति के साथ, जेनकिंस (चेकसेल, फाइंडबग्स, पीएमडी, आदि) में स्थिर विश्लेषण के परिणामों के साथ काम करने के लिए कई व्यक्तिगत प्लगइन्स अब अप्रचलित के रूप में चिह्नित हैं।

प्लगइन दो भागों के होते हैं:

• कई विश्लेषक संदेश संग्राहक ( पूरी सूची में AcuCobol से ZPT Lint तक सभी ज्ञात विश्लेषक शामिल हैं),
• उन सभी के लिए एक एकल दर्शक।

चेतावनी एनजी का क्या विश्लेषण कर सकते हैं की सूची में जावा कंपाइलर से चेतावनी और मावेन रनटाइम लॉग से चेतावनी शामिल है: हालांकि वे लगातार दृष्टि में हैं, वे शायद ही कभी उद्देश्यपूर्ण विश्लेषण किया जाता है। इंटेलीज आईडीईए रिपोर्ट भी मान्यता प्राप्त प्रारूपों की सूची में शामिल हैं।

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

 stage ('Static analysis'){ sh 'rm -rf target/idea_inspections' docker.image('inponomarev/intellij-idea-analyzer').inside { sh '/opt/idea/bin/inspect.sh $WORKSPACE $WORKSPACE/.idea/inspectionProfiles/Project_Default.xml $WORKSPACE/target/idea_inspections -v2' } recordIssues( tools: [ideaInspection(pattern: 'target/idea_inspections/*.xml')] ) } 

रिपोर्ट इंटरफ़ेस इस तरह दिखता है:

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

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

निष्कर्ष

इस सामग्री को तैयार करने से पहले, मैंने खोज करने का निर्णय लिया: क्या किसी ने पहले से ही इस विषय पर हैबे में लिखा है? मैंने केवल 2017 में lany के साथ एक साक्षात्कार पाया जहां वह कहते हैं:

जहां तक ​​मुझे पता है, जेनकिंस या मावेन प्लगइन के साथ कोई एकीकरण नहीं है [...] सिद्धांत रूप में, कोई भी उत्साही मित्र आईडीईए सामुदायिक संस्करण और जेनकिंस बना सकता है, कई को इससे लाभ होगा।

खैर: दो साल बाद, हमारे पास चेतावनी एनजी प्लगिन है, और आखिरकार यह दोस्ती सच हो गई है!