Jenkins-এ IntelliJ IDEA পরিদর্শন চালানো হচ্ছে

ইন্টেলিজে আইডিইএ-তে আজ সবচেয়ে উন্নত স্ট্যাটিক জাভা কোড বিশ্লেষক রয়েছে, যা তার ক্ষমতার দিক থেকে অনেক পিছনে ফেলে দিয়েছে যেমন "প্রবীণদের" চেকস্টাইল и স্পটবাগ. এর অসংখ্য "পরিদর্শন" কোডিং স্টাইল থেকে সাধারণ বাগ পর্যন্ত বিভিন্ন দিক থেকে কোডটি পরীক্ষা করে।

যাইহোক, যতক্ষণ বিশ্লেষণের ফলাফলগুলি শুধুমাত্র বিকাশকারীর IDE-এর স্থানীয় ইন্টারফেসে প্রদর্শিত হয়, ততক্ষণ সেগুলি উন্নয়ন প্রক্রিয়ার জন্য খুব একটা কাজে আসে না। স্ট্যাটিক বিশ্লেষণ পূরণ করা আবশ্যক বিল্ড পাইপলাইনের প্রথম ধাপ হিসাবে, এর ফলাফলগুলি গুণমানের গেটগুলিকে সংজ্ঞায়িত করবে এবং গুণমানের গেটগুলি পাস না হলে বিল্ডটি ব্যর্থ হওয়া উচিত। জানা যায় যে টিমসিটি সিআই আইডিইএর সাথে একীভূত। কিন্তু আপনি TeamCity ব্যবহার না করলেও, আপনি সহজেই অন্য কোনো CI সার্ভারে 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-কে একটি পাত্রে প্যাকেজ করা এমন একটি ফর্মের মধ্যে যা বিশ্লেষণ করা প্রকল্পগুলিতে "পিট" করার জন্য প্রস্তুত। আসুন একটি উপযুক্ত বেস ধারক নির্বাচন করি, এবং এটি আমাদের ডকারফাইল হবে:

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 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 রিপোর্ট পার্সারে একটি বাগ যা ঠিক করা দরকার৷

সতর্কতা এনজি-এর বৈশিষ্ট্যগুলির মধ্যে একটি রিপোর্ট এবং প্রোগ্রাম কোয়ালিটি গেটস, রেফারেন্স সমাবেশের জন্য একটি "র্যাচেট" সহ বিভিন্ন উত্স থেকে ফলাফলগুলিকে একত্রিত করার ক্ষমতা। কিছু কোয়ালিটি গেটস প্রোগ্রামিং ডকুমেন্টেশন পাওয়া যায় এখানে - তবে, এটি সম্পূর্ণ নয়, এবং আপনাকে সোর্স কোডটি দেখতে হবে। অন্যদিকে, যা ঘটছে তার উপর সম্পূর্ণ নিয়ন্ত্রণের জন্য, "র্যাচেট" স্বাধীনভাবে প্রয়োগ করা যেতে পারে (আমার দেখুন পূর্ববর্তী পোস্ট এই থিম সম্পর্কে)।

উপসংহার

এই উপাদানটি প্রস্তুত করা শুরু করার আগে, আমি অনুসন্ধান করার সিদ্ধান্ত নিয়েছি: কেউ কি ইতিমধ্যে হাব্রেতে এই বিষয়ে লিখেছেন? আমি শুধু খুঁজে পেয়েছি সাক্ষাত্কার 2017 с গলিযেখানে তিনি বলেছেন:

আমি যতদূর জানি, জেনকিন্স বা ম্যাভেন প্লাগইনের সাথে কোন ইন্টিগ্রেশন নেই […] নীতিগতভাবে, যেকোন উত্সাহী আইডিইএ কমিউনিটি এডিশন এবং জেনকিন্সের সাথে বন্ধুত্ব করতে পারে, অনেকে এটি থেকে উপকৃত হবে।

ওয়েল, দুই বছর পরে আমরা সতর্কতা এনজি প্লাগইন আছে, এবং অবশেষে এই বন্ধুত্ব ফলপ্রসূ হয়েছে!

উত্স: www.habr.com