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

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

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

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

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

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

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

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

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

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

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

Dockerfile

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 को फ़ोल्डर में उसका वैश्विक कॉन्फ़िगरेशन देखने के लिए बाध्य किया /etc/idea, क्योंकि सीआई में काम करते समय उपयोगकर्ता का होम फ़ोल्डर एक अनिश्चित चीज है और अक्सर पूरी तरह से अनुपस्थित होता है।

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

jdk.table.xml

<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 फ़ाइलें target/idea_inspections सबफ़ोल्डर में दिखाई देनी चाहिए।

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

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

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

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

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

• असंख्य विश्लेषक संदेश संग्राहक (पूरी सूची इसमें एक्यूकोबोल से लेकर जेडपीटी लिंट तक विज्ञान में ज्ञात सभी विश्लेषक शामिल हैं),
• उन सभी के लिए एक एकल रिपोर्ट दर्शक।

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

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

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 с लानीजहाँ वह कहता है:

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

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

स्रोत: www.habr.com