જેનકિન્સ પર IntelliJ IDEA ઇન્સ્પેક્શન ચલાવો

IntelliJ IDEA આજે સૌથી અદ્યતન સ્ટેટિક જાવા કોડ વિશ્લેષક ધરાવે છે, જે તેની ક્ષમતાઓમાં આવા "નિવૃત્ત સૈનિકો"ને પાછળ છોડી દે છે. ચેકસ્ટાઇલ и સ્પોટબગ્સ. તેના અસંખ્ય "નિરીક્ષણો" કોડિંગ શૈલીથી લાક્ષણિક બગ્સ સુધીના વિવિધ પાસાઓમાં કોડને તપાસે છે.

જો કે, જ્યાં સુધી વિશ્લેષણ પરિણામો માત્ર વિકાસકર્તાના IDE ના સ્થાનિક ઈન્ટરફેસમાં જ પ્રદર્શિત થાય છે, ત્યાં સુધી તેનો વિકાસ પ્રક્રિયામાં બહુ ઓછો ઉપયોગ થતો નથી. સ્થિર વિશ્લેષણ થવું જોઈએ બિલ્ડ પાઇપલાઇનના પ્રથમ પગલા તરીકે, તેના પરિણામો ગુણવત્તાવાળા દરવાજાઓને વ્યાખ્યાયિત કરવા જોઈએ, અને જો ગુણવત્તાવાળા દરવાજા પસાર ન થાય તો બિલ્ડ નિષ્ફળ થવો જોઈએ. તે જાણીતું છે કે TeamCity CI IDEA સાથે સંકલિત છે. પરંતુ જો તમે TeamCity નો ઉપયોગ ન કરો તો પણ, તમે સરળતાથી કોઈપણ અન્ય CI સર્વરમાં IDEA નિરીક્ષણો ચલાવવાનો પ્રયાસ કરી શકો છો. હું સૂચન કરું છું કે તમે IDEA કોમ્યુનિટી એડિશન, જેનકિન્સ અને વોર્નિંગ્સ એનજી પ્લગઇનનો ઉપયોગ કરીને આ કેવી રીતે કરી શકાય તે જુઓ.

પગલું 1. કન્ટેનરમાં વિશ્લેષણ ચલાવો અને રિપોર્ટ મેળવો

શરૂઆતમાં, ગ્રાફિકલ ઇન્ટરફેસ ન હોય તેવી CI સિસ્ટમની અંદર IDE (ડેસ્કટોપ એપ્લિકેશન!) ચલાવવાનો વિચાર શંકાસ્પદ અને ખૂબ જ મુશ્કેલીભર્યો લાગે છે. સદનસીબે, 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 કોમ્યુનિટી એડિશન સાથે એક કન્ટેનરમાં એક ફોર્મમાં પેકેજ કરવું જે વિશ્લેષણ કરેલ પ્રોજેક્ટ્સ પર "પેટ" કરવા માટે તૈયાર છે. ચાલો યોગ્ય આધાર કન્ટેનર પસંદ કરીએ, અને આ અમારી ડોકરફાઈલ હશે:

ડોકરફાઇલ

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>

સમાપ્ત થયેલ છબી ડોકર હબ પર ઉપલબ્ધ છે.

આગળ વધતા પહેલા, ચાલો તપાસ કરીએ કે IDEA વિશ્લેષક કન્ટેનરમાં ચાલી રહ્યું છે:

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

વિશ્લેષણ સફળતાપૂર્વક ચાલવું જોઈએ, અને વિશ્લેષક અહેવાલો સાથે અસંખ્ય .xml ફાઈલો લક્ષ્ય/વિચાર_નિરીક્ષણ સબફોલ્ડરમાં દેખાવી જોઈએ.

હવે તેમાં કોઈ શંકા નથી કે IDEA વિશ્લેષક કોઈપણ CI વાતાવરણમાં એકલ રીતે ચલાવી શકાય છે, અને અમે બીજા પગલા પર આગળ વધીએ છીએ.

પગલું 2. રિપોર્ટ પ્રદર્શિત કરો અને તેનું વિશ્લેષણ કરો

.xml ફાઇલોના રૂપમાં રિપોર્ટ મેળવવો એ અડધી યુદ્ધ છે; હવે તમારે તેને માનવ-વાંચી શકાય તેવી બનાવવાની જરૂર છે. અને તેના પરિણામોનો ગુણવત્તાના દરવાજોમાં ઉપયોગ થવો જોઈએ - સ્વીકૃત ફેરફાર ગુણવત્તા માપદંડો અનુસાર પસાર થાય છે કે નિષ્ફળ જાય છે તે નક્કી કરવા માટેનો તર્ક.

આ અમને મદદ કરશે જેનકિન્સ ચેતવણીઓ એનજી પ્લગઇન, જે જાન્યુઆરી 2019 માં રિલીઝ થઈ હતી. તેના આગમન સાથે, જેનકિન્સ (ચેકસ્ટાઇલ, ફાઇન્ડબગ્સ, પીએમડી, વગેરે) માં સ્થિર વિશ્લેષણ પરિણામો સાથે કામ કરવા માટેના ઘણા વ્યક્તિગત પ્લગઇન્સ હવે અપ્રચલિત તરીકે ચિહ્નિત થયા છે.

પ્લગઇન બે ભાગો સમાવે છે:

• અસંખ્ય વિશ્લેષક સંદેશ કલેક્ટર્સ (સંપૂર્ણ સૂચિ AcuCobol થી ZPT Lint સુધી વિજ્ઞાન માટે જાણીતા તમામ વિશ્લેષકોનો સમાવેશ થાય છે),
• તે બધા માટે એક જ રિપોર્ટ દર્શક.

ચેતવણીઓ એનજી જે વસ્તુઓનું વિશ્લેષણ કરી શકે છે તેની યાદીમાં જાવા કમ્પાઈલરની ચેતવણીઓ અને મેવેન એક્ઝેક્યુશન લોગની ચેતવણીઓનો સમાવેશ થાય છે: જો કે તે સતત દૃશ્યમાન હોય છે, તેમ છતાં તેનું ભાગ્યે જ વિશિષ્ટ રીતે વિશ્લેષણ કરવામાં આવે છે. 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 રિપોર્ટ પાર્સરમાં આ એક બગ છે જેને ઠીક કરવાની જરૂર છે.

ચેતવણીઓ NG ની વિશેષતાઓમાં એક રિપોર્ટ અને પ્રોગ્રામ ક્વોલિટી ગેટ્સમાં વિવિધ સ્ત્રોતોમાંથી તારણો એકત્રિત કરવાની ક્ષમતા છે, જેમાં સંદર્ભ એસેમ્બલી માટે "રૅચેટ" શામેલ છે. કેટલાક ગુણવત્તા ગેટ્સ પ્રોગ્રામિંગ દસ્તાવેજો ઉપલબ્ધ છે અહીં - જો કે, તે પૂર્ણ નથી, અને તમારે સ્રોત કોડ જોવો પડશે. બીજી બાજુ, શું થઈ રહ્યું છે તેના પર સંપૂર્ણ નિયંત્રણ માટે, "રૅચેટ" સ્વતંત્ર રીતે લાગુ કરી શકાય છે (જુઓ મારા અગાઉની પોસ્ટ આ થીમ વિશે).

નિષ્કર્ષ

આ સામગ્રી તૈયાર કરવાનું શરૂ કરતા પહેલા, મેં શોધવાનું નક્કી કર્યું: શું કોઈએ આ વિષય પર પહેલાથી જ Habré પર લખ્યું છે? મને જ મળી ઇન્ટરવ્યુ 2017 с ગલીજ્યાં તે કહે છે:

જ્યાં સુધી હું જાણું છું, જેનકિન્સ અથવા મેવેન પ્લગઇન સાથે કોઈ એકીકરણ નથી […] સૈદ્ધાંતિક રીતે, કોઈપણ ઉત્સાહી IDEA કોમ્યુનિટી એડિશન અને જેનકિન્સ સાથે મિત્રતા કરી શકે છે, ઘણાને ફક્ત આનો ફાયદો થશે.

ઠીક છે, બે વર્ષ પછી અમારી પાસે ચેતવણીઓ એનજી પ્લગઇન છે, અને આખરે આ મિત્રતા ફળમાં આવી છે!

સોર્સ: www.habr.com