მიმდინარეობს IntelliJ IDEA ინსპექტირება ჯენკინსზე

IntelliJ IDEA-ს დღეს აქვს ყველაზე მოწინავე სტატიკური Java კოდების ანალიზატორი, რომელიც თავისი შესაძლებლობებით შორს ტოვებს ისეთ „ვეტერანებს“, როგორიცაა შემოწმების სტილი и Spotbugs. მისი მრავალრიცხოვანი „ინსპექტირება“ ამოწმებს კოდს სხვადასხვა ასპექტში, კოდირების სტილიდან ტიპურ შეცდომებამდე.

თუმცა, სანამ ანალიზის შედეგები ნაჩვენებია მხოლოდ დეველოპერის IDE-ის ლოკალურ ინტერფეისში, ისინი ნაკლებად სარგებლობენ განვითარების პროცესში. სტატიკური ანალიზი უნდა შესრულდეს როგორც მილსადენის მშენებლობის პირველი ნაბიჯი, მისმა შედეგებმა უნდა განსაზღვროს ხარისხის კარიბჭეები და მშენებლობა უნდა ჩავარდეს, თუ ხარისხიანი კარიბჭეები არ გაივლის. ცნობილია, რომ TeamCity CI ინტეგრირებულია IDEA-სთან. მაგრამ მაშინაც კი, თუ არ იყენებთ TeamCity-ს, შეგიძლიათ მარტივად სცადოთ IDEA ინსპექტირების გაშვება ნებისმიერ სხვა CI სერვერზე. მე გირჩევთ ნახოთ, თუ როგორ შეიძლება ამის გაკეთება IDEA Community Edition, Jenkins და Warnings NG მოდულის გამოყენებით.

ნაბიჯი 1. ჩაატარეთ ანალიზი კონტეინერში და მიიღეთ ანგარიში

თავდაპირველად, IDE (დესკტოპ აპლიკაციის!) გაშვების იდეა CI სისტემის შიგნით, რომელსაც არ აქვს გრაფიკული ინტერფეისი, შეიძლება საეჭვო და ძალიან პრობლემური ჩანდეს. საბედნიეროდ, IDEA-ს დეველოპერებმა უზრუნველყო გაშვების შესაძლებლობა კოდის ფორმატირება и ინსპექტირება ბრძანების ხაზიდან. უფრო მეტიც, IDEA-ს ამ რეჟიმში გასაშვებად, გრაფიკული ქვესისტემა არ არის საჭირო და ეს ამოცანები შეიძლება შესრულდეს სერვერებზე ტექსტური გარსიით.

ინსპექტირება იწყება სკრიპტის გამოყენებით bin/inspect.sh IDEA ინსტალაციის დირექტორიადან. საჭირო პარამეტრებია:

• სრული გზა პროექტისკენ (ნათესავი არ არის მხარდაჭერილი),
• გზა .xml ფაილის ინსპექტირების პარამეტრებით (ჩვეულებრივ, მდებარეობს პროექტის შიგნით .idea/inspectionProfiles/Project_Default.xml)
• სრული გზა საქაღალდეში, რომელშიც შეინახება .xml ფაილები ანალიზის შედეგების შესახებ მოხსენებებით.

გარდა ამისა, მოსალოდნელია, რომ

• გზა Java SDK-მდე კონფიგურირებული იქნება IDE-ში, წინააღმდეგ შემთხვევაში ანალიზი არ იმუშავებს. ეს პარამეტრები შეიცავს კონფიგურაციის ფაილს jdk.table.xml IDEA გლობალური კონფიგურაციის საქაღალდეში. IDEA გლობალური კონფიგურაცია ნაგულისხმევად მდებარეობს მომხმარებლის მთავარ დირექტორიაში, მაგრამ ეს მდებარეობა შეიძლება ცალსახად დაზუსტდეს ფაილში idea.properties.
• გაანალიზებული პროექტი უნდა იყოს IDEA-ს მოქმედი პროექტი, რისთვისაც მოგიწევთ რამდენიმე ფაილის ჩაბარება, რომლებიც ჩვეულებრივ იგნორირებულია ვერსიის კონტროლისთვის, კერძოდ:
  • .idea/inspectionProfiles/Project_Default.xml - ანალიზატორის პარამეტრები, ისინი აშკარად გამოყენებული იქნება კონტეინერში ინსპექტირების დროს,
  • .idea/modules.xml - წინააღმდეგ შემთხვევაში მივიღებთ შეცდომას "ეს პროექტი არ შეიცავს მოდულებს",
  • .idea/misc.xml - წინააღმდეგ შემთხვევაში ჩვენ მივიღებთ შეცდომას "JDK არ არის სწორად კონფიგურირებული ამ პროექტისთვის",
  • *.iml-файлы — წინააღმდეგ შემთხვევაში ჩვენ მივიღებთ შეცდომას მოდულში არაკონფიგურირებული JDK-ის შესახებ.

მიუხედავად იმისა, რომ ეს ფაილები ჩვეულებრივ შედის .gitignore, ისინი არ შეიცავს რაიმე სპეციფიკურ ინფორმაციას კონკრეტული დეველოპერის გარემოსთვის - განსხვავებით, მაგალითად, ფაილისგან workspace.xml, სადაც ასეთი ინფორმაციაა და, შესაბამისად, არ არის საჭირო მისი ჩადენა.

აშკარა გამოსავალია JDK-ის შეფუთვა IDEA Community Edition-თან ერთად კონტეინერში იმ ფორმით, რომელიც მზად იქნება ანალიზურ პროექტებზე „გამოსატანად“. მოდით ავირჩიოთ შესაფერისი ბაზის კონტეინერი და ეს იქნება ჩვენი Dockerfile:

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, რადგან მომხმარებლის სახლის საქაღალდე CI-ში მუშაობისას გაურკვეველია და ხშირად სრულიად არ არსებობს.

ასე გამოიყურება კონტეინერში დაკოპირებული ფაილი: jdk.table.xml, რომელიც შეიცავს კონტეინერში დაინსტალირებულ OpenJDK-ის ბილიკებს (მსგავსი ფაილი თქვენივე დირექტორიაში IDEA პარამეტრებით შეიძლება იქნას მიღებული, როგორც საფუძველი):

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>

დასრულებული სურათი ხელმისაწვდომია Docker Hub-ზე.

სანამ გადავიდეთ, მოდით შევამოწმოთ, რომ IDEA ანალიზატორი მუშაობს კონტეინერში:

docker run --rm -v <путь/к/вашему/проекту>:/var/project inponomarev/intellij-idea-analyzer

ანალიზი წარმატებით უნდა ჩატარდეს და მრავალი .xml ფაილი ანალიზატორის ანგარიშებით უნდა გამოჩნდეს target/idea_inspections ქვესაქაღალდეში.

ახლა უკვე აღარ არის ეჭვი, რომ IDEA ანალიზატორის დამოუკიდებლად გაშვება შესაძლებელია ნებისმიერ CI გარემოში და ჩვენ გადავდივართ მეორე საფეხურზე.

ნაბიჯი 2. ანგარიშის ჩვენება და ანალიზი

ანგარიშის .xml ფაილების სახით მიღება საქმის ნახევარია; ახლა თქვენ უნდა გახადოთ ის ადამიანისათვის წასაკითხად. და ასევე, მისი შედეგები უნდა იქნას გამოყენებული ხარისხის კარიბჭეებში - ლოგიკა იმის დასადგენად, მიღებული ცვლილება გადის თუ არა ხარისხის კრიტერიუმების მიხედვით.

ეს დაგვეხმარება Jenkins Warnings NG Plugin, რომელიც გამოვიდა 2019 წლის იანვარში. მისი მოსვლასთან ერთად, Jenkins-ში სტატიკური ანალიზის შედეგებთან მუშაობის მრავალი ინდივიდუალური დანამატი (CheckStyle, FindBugs, PMD და ა.შ.) ახლა მონიშნულია, როგორც მოძველებული.

მოდული შედგება ორი ნაწილისგან:

• მრავალი ანალიზატორის შეტყობინებების შემგროვებელი (სრული სია მოიცავს მეცნიერებისთვის ცნობილ ყველა ანალიზატორს AcuCobol-დან ZPT Lint-მდე),
• ერთი ანგარიშის მაყურებელი ყველა მათგანისთვის.

იმ ნივთების სია, რომელთა გაანალიზებაც Warnings NG-ს შეუძლია, მოიცავს გაფრთხილებებს Java შემდგენლისგან და გაფრთხილებებს Maven-ის შესრულების ჟურნალებიდან: მიუხედავად იმისა, რომ ისინი მუდმივად ჩანს, ისინი იშვიათად აანალიზებენ სპეციალურად. IntelliJ IDEA ანგარიშები ასევე შედის აღიარებული ფორმატების სიაში.

ვინაიდან მოდული ახალია, ის თავდაპირველად კარგად ურთიერთობს Jenkins Pipeline-თან. მისი მონაწილეობით მშენებლობის ეტაპი ასე გამოიყურება (ჩვენ უბრალოდ ვეუბნებით დანამატს, თუ რა მოხსენების ფორმატს ვცნობთ და რა ფაილები უნდა დაასკანირდეს):

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 ინსპექტირებისთვის, იყო კოდის პირდაპირ ჯენკინსში დათვალიერების შესაძლებლობა (თუმცა სხვა მოხსენებებისთვის, მაგალითად Checkstyle, ამ დანამატს შეუძლია ამის გაკეთება ლამაზად). როგორც ჩანს, ეს არის IDEA ანგარიშის პარსერის შეცდომა, რომელიც უნდა გამოსწორდეს.

Warnings NG-ის მახასიათებლებს შორის არის სხვადასხვა წყაროდან მიღებული დასკვნების გაერთიანების შესაძლებლობა ერთ ანგარიშში და Quality Gates-ის პროგრამაში, მათ შორის, საცნობარო ასამბლეის „რატჩი“. ზოგიერთი Quality Gates პროგრამირების დოკუმენტაცია ხელმისაწვდომია აქ - თუმცა, ეს არ არის დასრულებული და თქვენ უნდა გადახედოთ წყაროს კოდს. მეორეს მხრივ, სრული კონტროლისთვის იმაზე, რაც ხდება, "რაჩეტი" შეიძლება დამოუკიდებლად განხორციელდეს (იხ. წინა პოსტი ამ თემის შესახებ).

დასკვნა

სანამ ამ მასალის მომზადებას დავიწყებდი, გადავწყვიტე მოძებნა: ჰაბრეზე უკვე ვინმემ დაწერა ამ თემაზე? მხოლოდ ვიპოვე ინტერვიუ 2017 წ с ლანისადაც ის ამბობს:

რამდენადაც მე ვიცი, არ არის ინტეგრაცია ჯენკინსთან ან maven დანამატთან [...] პრინციპში, ნებისმიერ ენთუზიასტს შეუძლია დაუმეგობრდეს IDEA Community Edition-სა და Jenkins-ს, ბევრი ამით მხოლოდ ისარგებლებს.

ორი წლის შემდეგ ჩვენ გვაქვს Warnings NG Plugin და საბოლოოდ ეს მეგობრობა შესრულდა!

წყარო: www.habr.com