កំពុងដំណើរការការត្រួតពិនិត្យ IntelliJ IDEA នៅលើ Jenkins

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ដែលត្រូវបានចេញផ្សាយនៅក្នុងខែមករា 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 គឺសមត្ថភាពក្នុងការរកមើលកូដដោយផ្ទាល់នៅក្នុង Jenkins (ទោះបីជាសម្រាប់របាយការណ៍ផ្សេងទៀតឧទាហរណ៍ Checkstyle កម្មវិធីជំនួយនេះអាចធ្វើវាបានយ៉ាងស្រស់ស្អាត)។ វាមើលទៅដូចជានេះគឺជាកំហុសនៅក្នុងកម្មវិធីញែករបាយការណ៍ IDEA ដែលត្រូវការជួសជុល។

ក្នុងចំណោមលក្ខណៈពិសេសរបស់ Warnings NG គឺសមត្ថភាពក្នុងការប្រមូលផ្តុំការរកឃើញពីប្រភពផ្សេងៗគ្នានៅក្នុងរបាយការណ៍មួយ និងកម្មវិធី Quality Gates រួមទាំង "ratchet" សម្រាប់ការជួបប្រជុំគ្នាជាឯកសារយោង។ មានឯកសារសរសេរកម្មវិធី Quality Gates មួយចំនួន នៅទីនេះ - ទោះយ៉ាងណាក៏ដោយវាមិនពេញលេញទេ ហើយអ្នកត្រូវមើលកូដប្រភព។ ម៉្យាងវិញទៀត សម្រាប់ការគ្រប់គ្រងទាំងស្រុងលើអ្វីដែលកំពុងកើតឡើង “កន្ត្រក” អាចត្រូវបានអនុវត្តដោយឯករាជ្យ (សូមមើលរបស់ខ្ញុំ ប្រកាសមុន។ អំពីប្រធានបទនេះ) ។

សេចក្តីសន្និដ្ឋាន

មុននឹងចាប់ផ្តើមរៀបចំសម្ភារៈនេះ ខ្ញុំបានសម្រេចចិត្តស្វែងរក៖ តើមាននរណាម្នាក់បានសរសេរលើប្រធានបទនេះលើHabre រួចហើយឬនៅ? ខ្ញុំបានរកឃើញតែប៉ុណ្ណោះ បទសម្ភាសន៍ឆ្នាំ ២០១៧ с ឡានីដែលជាកន្លែងដែលគាត់និយាយថា:

តាមដែលខ្ញុំដឹង មិនមានការរួមបញ្ចូលជាមួយ Jenkins ឬកម្មវិធីជំនួយ maven […] ជាគោលការណ៍ អ្នកចូលចិត្តណាមួយអាចបង្កើតមិត្តជាមួយ IDEA Community Edition និង Jenkins មនុស្សជាច្រើននឹងទទួលបានអត្ថប្រយោជន៍ពីរឿងនេះប៉ុណ្ណោះ។

ជាការប្រសើរណាស់ ពីរឆ្នាំក្រោយមក យើងមានកម្មវិធី Warnings NG Plugin ហើយទីបំផុតមិត្តភាពនេះបានសម្រេចផលហើយ!

ប្រភព: www.habr.com